tj8v8dZdadaddlmZ ddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZ ddlmZddlZddlZ ddlZddlmZ ddlZgd ZGd d ZGddeZGddeZd'dZdZdZdZ dZ!dZ"dZ#d(dZ$d)dZ%Gdde&Z'Gdde'Z(Gdd e(Z)d!Z*d"Z+d#Z,d$Z-d%Z.d&Z/y#tdz aYxYw#e$rddlZYxYw#tdz aYxYw#td z aYxYw#td z aYxYw)*a This module provides some testing functionality for paraview and vtk web applications. It provides the ability to run an arbitrary test script in a separate thread and communicate the results back to the service so that the CTest framework can be notified of the success or failure of the test. This test harness will notice when the test script has finished running and will notify the service to stop. At this point, the test results will be checked in the main thread which ran the service, and in the case of failure an exception will be raised to notify CTest of the failure. Test scripts need to follow some simple rules in order to work within the test harness framework: 1) implement a function called "runTest(args)", where the args parameter contains all the arguments given to the web application upon starting. Among other important items, args will contain the port number where the web application is listening. 2) import the testing module so that the script has access to the functions which indicate success and failure. Also the testing module contains convenience functions that might be of use to the test scripts. from vtk.web import testing 3) Call the "testPass(testName)" or "testFail(testName)" functions from within the runTest(args) function to indicate to the framework whether the test passed or failed. N) vtkTestingz0 Unable to load at least one basic Python module)ImagezC Unable to load at least one modules necessary for image comparison) webdriverz? Unable to load at least one module necessary for browser testsz< Unable to load at least one module necessary for HTTP tests)firefoxchromeinternet_explorersafari nobrowserc(eZdZed\ZZZZZy)TestModuleBrowsersN) __name__ __module__ __qualname__rangerrr r r C/DATA/.local/lib/python3.12/site-packages/vtkmodules/web/testing.pyr r Ss This should be the full path to the test script to be run. --baseline-img-dir => This should be the 'Baseline' directory where the baseline images for this test are located. --test-use-browser => This should be one of the supported browser types, or else 'nobrowser'. The choices are 'chrome', 'firefox', 'internet_explorer', 'safari', or 'nobrowser'. z--run-test-scriptrz The path to a test script to runr.)defaulthelpdestz--baseline-img-dirzAThe path to the directory containing the web test baseline imagesbaselineImgDirz--test-use-browserr zJOne of 'chrome', 'firefox', 'internet_explorer', 'safari', or 'nobrowser'. useBrowserz--temporary-directory.z7A temporary directory for storing test images and diffs tmpDirectoryz--test-image-file-namez3Name of file in which to store generated test image testImgFileN) add_argument)parsers r add_argumentsrCs"  /    P    Y    F     B  rctjatjtgt tt j d}|jy)z This function checks whether testing is required and if so, sets up a Queue for the purpose of communicating with the thread. then it starts the after waiting 5 seconds for the server to have a chance to start up. ) serverOpts commQueue testScript)targetargskwargsN)Queuetest_module_comm_queue threadingThreadlaunch_web_testr+r.start)ts rr2r2sE#[[] +/+::  AGGIrc6|di}tj|y)z Test scripts should call this function to indicate that the test passed. A note is recorded that the test succeeded, and is checked later on from the main thread so that CTest can be notified of this result. passNrLputtestName resultObjs r test_passrYs6"Iy)rc6|di}tj|y)a Test scripts should call this function to indicate that the test failed. A note is recorded that the test did not succeed, and this note is checked later from the main thread so that CTest can be notified of the result. The main thread is the only one that can signal test failure in CTest framework, and the main thread won't have a chance to check for passage or failure of the test until the main loop has terminated. So here we just record the failure result, then we check this result in the processTestResults() function, throwing an exception at that point to indicate to CTest that the test failed. failNrTrVs r test_failr\s6"Iy)rc:tjj|S)a* A very simple convenience function so that test scripts can build platform independent paths out of a list of elements, without having to import the os module. pathElts: Any number of strings which should be concatenated together in a platform independent manner. )ospathjoin)pathEltss r concat_pathsrb*s 77<< ""rc\tjjjdS)zT This function returns the current time as a string, using ISO 8601 format.  )datetimenow isoformatrrrget_current_time_stringrh;s$    " , ,S 11rct}|jd|j||jd|j||j|dS)a This function creates a vtkTesting object, and specifies the name of the baseline image file, using a fully qualified path (baseline_img must be fully qualified). Then it calls the vtkTesting method which compares the image (test_img, specified only with a relative path) against the baseline image as well as any other images in the same directory as the baseline image which follow the naming pattern: 'img.png', 'img_1.png', ... , 'img_N.png' test_img: File name of output image to be compared against baseline. baseline_img: Fully qualified path to first of the baseline images. tmp_dir: Fully qualified path to a temporary directory for storing images. z-Tz-Vg)r AddArgumentRegressionTest)test_img baseline_imgtmp_dirrQs rcompare_imagesroJsP"  AMM$MM'MM$MM,  Hc **rctjD],}| |ry||z|kDrytj|.y)z This function provides the ability to wait for a certain number of seconds, or else to wait for a specific criterion to be met. NTF) itertoolscounttimesleep)delaylimit criterionis rwait_with_timeoutryhs= __   Y[ QY  JJu  rcVeZdZdZGddZd dZdZdZdZd Z d Z d Z d Z y)WebTesta This is the base class for all automated web-based tests. It defines five stages that any test must run through, and allows any or all of these stages to be overridden by subclasses. This class defines the run_test method to invoke the five stages overridden by subclasses, one at a time: 1) initialize, 2) setup, 3) capture, 4) postprocess, and 5) cleanup. c eZdZy) WebTest.AbortN)rrrrrrAbortr}s rr~Nc ||_||_yr)urltestname)rrrrJs rrzWebTest.__init__s  rc |j|j|j|j|j |jy#t j $rY&|jxYwr)checkdependenciesr7setupcapture postprocessr{r~cleanuprs rrun_testzWebTest.run_testsj   " " $ OO  JJL LLN     }}    LLN sAA##B 8B cyrrrs rrzWebTest.checkdependencies rcyrrrs rr7zWebTest.initializerrcyrrrs rrz WebTest.setuprrcyrrrs rrzWebTest.capturerrcyrrrs rrzWebTest.postprocessrrcyrrrs rrzWebTest.cleanuprrNN) rrr__doc__r~rrrr7rrrrrrrr{r{zs9  !       rr{c$eZdZdZddZdZdZy)BrowserBasedWebTesta This class can be used as a base for any browser-based web tests. It introduces the notion of a selenium browser and overrides phases (1) and (3), initialization and cleanup, of the test phases introduced in the base class. Initialization involves selecting the browser type, setting the browser window size, and asking the browser to load the url. Cleanup involves closing the browser window. Nc Z||_||_d|_tj|fi|yr)sizebrowserwindowr{r)rrrrJs rrzBrowserBasedWebTest.__init__s*   ((rc |j|jtjk(rtj|_n|jtj k(rtj|_nO|jtjk(rtj|_ntd|jz|j6|j j|jd|jd|j&|j j|jyy#t$r}d}~wt$r}t|d}~wwxYw)Nz*self.browser argument has illegal value %rr)rr rrChromerrFirefoxr Ier Exceptionrset_window_sizerget)rdErrinsts rr7zBrowserBasedWebTest.initializes  (||#t||7I7P7P'P'..0 !3!;!;;'//1 !3!E!EE'lln %@DLLQ 99 KK ' ' ! diil C 88  KKOODHH %    (!$' ' (s$C E E& E  E& E!!E&c^ |jjy#tdYyxYw)NzYUnable to call window.quit, perhaps this is expected because of unmet browser dependency.)rquitr0rs rrzBrowserBasedWebTest.cleanups)  KK     k s ,r)rrrrrr7rrrrrrs)&.rrc$eZdZdZddZdZdZy)ImageComparatorWebTestaY This class extends browser based web tests to include image comparison. It overrides the capture phase of testing with some functionality to simply grab a screenshot of the entire browser window. It overrides the postprocess phase with a call to vtk image comparison functionality. Derived classes can then simply override the setup function with a series of selenium-based browser interactions to create a complete test. Derived classes may also prefer to override the capture phase to capture only certain portions of the browser window for image comparison. Nc | td| tdtj|fi|||_||_||_y)Nzmissing argument 'filename'zmissing argument 'baseline') TypeErrorrrfilenamebaselinetmpDir)rrr temporaryDirrJs rrzImageComparatorWebTest.__init__sN  9: :  9: :$$T4V4    " rcN|jj|jyr)rsave_screenshotrrs rrzImageComparatorWebTest.captures ##DMM2rct|j|j|j}|dk(rt |j yt |j y)Nr)rorrrrYrr\)rresults rrz"ImageComparatorWebTest.postprocesss; t}}dkkJ Q; dmm $ dmm $r)NNN)rrrrrrrrrrrrs  #3%rrc|j|}|jd}tjd}|j |}t j |jd}|S)a# This function takes a selenium browser and a css selector string and uses them to find the target HTML image element. The desired image element should contain it's image data as a Base64 encoded JPEG image string. The 'src' attribute of the image is read, Base64-decoded, and then returned. browser: A selenium browser instance, as created by webdriver.Chrome(), for example. cssSelector: A string containing a CSS selector which will be used to find the HTML image element of interest. srcdata:image/jpeg;base64,(.+)r)find_element_by_css_selector get_attributerecompilematchbase64 b64decodegroup)r cssSelectorimageElt base64Stringb64RegEx b64Matcherimgdatas rget_image_datar sc 33K@H))%0Lzz89H -Jz//23G Nrc J|j|}|jd}tjd}|j |}t j tjtj|jd}|j|y)a This function takes a selenium browser instance, a css selector string, and a file name. It uses the css selector string to finds the target HTML Image element, which should contain a Base64 encoded JPEG image string, it decodes the string to image data, and then saves the data to the file. The image type of the written file is determined from the extension of the provided filename. browser: A selenium browser instance as created by webdriver.Chrome(), for example. cssSelector: A string containing a CSS selector which will be used to find the HTML image element of interest. imgFilename: The filename to which to save the image. The extension is used to determine the type of image which should be saved. rrrN) rrrrrropenioBytesIOrrrsave)rr imgfilenamerrrrimgs rsave_image_data_as_pngr*sz$33K@H))%0Lzz89H -J **RZZ 0 01A1A!1D EF GCHH[rcht|d5}|j|dddy#1swYyxYw)aQ This function takes an image data, as returned by this module's get_image_data() function for example, and writes it out to the file given by the filePath parameter. imgData: An image data object filePath: The full path, including the file name and extension, where the image should be written. wbN)rwrite)imgDatafilePathfs rwrite_image_to_diskrHs( h     s(1c tjd|}d}tj|D]Q\}}tj|s|j |}|j dk(s= |jdi||S|S#t$r1}tdtt|zt|d}~wwxYw)a' This function takes the fully qualified path to a test file, along with any needed keyword arguments, then dynamically loads the file as a module and finds the test class defined inside of it via inspection. It then uses the keyword arguments to instantiate the test class and return the instance. pathToScript: Fully qualified path to python file containing defined subclass of one of the test base classes. kwargs: Keyword arguments to be passed to the constructor of the testing subclass. dynamicTestModuleNzCaught exception: r) imp load_sourceinspect getmembersisclass__new__rrrr0strtype) pathToScriptrJ moduleNameinstancenameobjrs rinstantiate_test_subclassr\s!4lCJH'' 3 c ??3 {{3'H""&99%H%%// O4 O !.T$Z@A$Ks,B B> ,B99B>c Rd}d}d|vr|d}d|vr|d}d}|tdt|tjd}tj||}|r|j d}n)tdt tzd zt||dk7r|d z}t|j|}|j} |j} tj|j} t|||j |j"| | || } |  | j%ntd t|yd|vr |dyy#t&$r } td t)|Yd} ~ 4d} ~ wwxYw#t*$r}ddl}ddl}|j1d}tdtdt t3|ztdt |ztddj5|j7|zt|Yd}~d}~wwxYw)a This function loads a python file as a module (with no package), and then instantiates the class it must contain, and finally executes the run_test() method of the class (which the class may override, but which is defined in both of the testing base classes, WebTest and ImageComparatorBaseClass). After the run_test() method finishes, this function will stop the web server if required. This function expects some keyword arguments will be present in order for it to complete it's task: kwargs['serverOpts']: An object containing all the parameters used to start the web service. Some of them will be used in the test script in order perform the test. For example, the port on which the server was started will be required in order to connect to the server. kwargs['testScript']: The full path to the python file containing the testing subclass. NrErGunknownz6No test script file found, no test script will be run.z([^\.\/\\]+)\.pyrz Unable to parse testScriptFile (z), no test will be runz.png)rhostportrrrrz=Some dependency of this test was not met, allowing it to passz1Unable to instantiate test instance, failing testrz.Caught an exception while running test script:z rr*)r0r\rrsearchrrtestScriptfilerbr<r?r@test_module_browsersindexr=rrrrrrYrsys tracebackexc_inforr` format_tb)rIrJrEtestScriptFilerW fnamePatternfmatch imgFileNameknownGoodFileNametempDirtestImgFileName testBrowser testInstancederrrrrtbs rrOrOs'&JNvL) v -H FG( ::12L YY|^ 4F <<? ..! "& ' (9' ()B)BKP))$00*001F1FG $ 4!____#(*$ L'( ))+IJ(#*$# ?#%%-'(Wh'' ( !"B B C $T$Z( ) $T" # $!4!4R!899 : h   sC1)E?E+E? E<E72E?7E<<E?? H&BH!!H&ctNtj}d}|D]#}||}|dk(std|zdz|zd}%|dur tdyy)a This function checks the module's global test_module_comm_queue variable for a test result. If one is found and the result is 'fail', then this function raises an exception to communicate the failure to the CTest framework. In order for a test result to be found in the test_module_comm_queue variable, the test script must have called either the testPass or testFail functions provided by this test module before returning. NFr[z Test -> z: Tz]At least one of the requested tests failed. See detailed output, above, for more information)rLrr0r) resultObject failedATestrW testResults rfinalizers|)-113  $H%h/JV#lX-4zAB" % $ E  *rr)r>)NrN)0rr/rLvtkmodules.vtkTestingRenderingrr^rrsrerMrrrKtypesrPILr ImportErrorrrqseleniumrrequestsrr rrdictr"r7rCr2rYr\rbrhroryobjectr{rrrrrrrOrrrrrse D5OLLLLL  "YEE i ##:!@2p4 **, #"2+< $0 f0 l.'.h %0 %N>< (!Pk&h[ONN  NJGsK(C CC, C<D C C)%C,'C))C,, C9< D  D