+j^dZddlmZddlZddlZddlZddlZddlZddlZddl m Z m Z ddl m Z ddlmZmZddlmZmZddlmZd d lmZd agad ad agadadadad Z Gd dej!Z"dZ#dZ$dZ%dZ&d#dZ'd#dZ(dZ)dZ*dZ+dZ,dZ-dZ.dZ/dZ0dZ1e2dkrGd d!e"Z3e-e3d"fgdSdS)$a This module attempts to make it easy to create VTK-Python unittests. The module uses unittest for the test interface. For more documentation on what unittests are and how to use them, please read these: http://www.python.org/doc/current/lib/module-unittest.html http://www.diveintopython.org/roman_divein.html This VTK-Python test module supports image based tests with multiple images per test suite and multiple images per individual test as well. It also prints information appropriate for CDash (http://open.kitware.com/). This module defines several useful classes and functions to make writing tests easy. The most important of these are: class vtkTest: Subclass this for your tests. It also has a few useful internal functions that can be used to do some simple blackbox testing. compareImage(renwin, img_fname, threshold=0.15): Compares renwin with image and generates image if it does not exist. The threshold determines how closely the images must match. The function also handles multiple images and finds the best matching image. compareImageWithSavedImage(src_img, img_fname, threshold=0.15): Compares given source image (in the form of a vtkImageData) with saved image and generates the image if it does not exist. The threshold determines how closely the images must match. The function also handles multiple images and finds the best matching image. getAbsImagePath(img_basename): Returns the full path to the image given the basic image name. main(cases): Does the testing given a list of tuples containing test classes and the starting string of the functions used for testing. interact(): Interacts with the user if necessary. The behavior of this is rather trivial and works best when using Tkinter. It does not do anything by default and stops to interact with the user when given the appropriate command line arguments. isInteractive(): If interact() is not good enough, use this to find if the mode is interactive or not and do whatever is necessary to generate an interactive view. Examples: The best way to learn on how to use this module is to look at a few examples. The end of this file contains a trivial example. Please also look at the following examples: Rendering/Testing/Python/TestTkRenderWidget.py, Rendering/Testing/Python/TestTkRenderWindowInteractor.py Created: September, 2002 Prabhu Ramachandran )absolute_importN) vtkCommand vtkDebugLeaks) vtkTimerLog) vtkPNGReader vtkPNGWriter)vtkImageDifferencevtkImageShiftScale)vtkWindowToImageFilter)BlackBoxc.tjddS)z>Cause the test to be skipped due to insufficient requirements.}N)sysexitQ/DATA/AppData/hermes/venv/lib/python3.11/site-packages/vtkmodules/test/Testing.pyskiprlsHSMMMMMrceZdZdZejdZeZe ddZdZ gfdZ gfdZ dZ d Zd Zd ZdS) vtkTestaA simple default VTK test class that defines a few useful blackbox tests that can be readily used. Derive your test cases from this class and use the following if you'd like to. Note: Unittest instantiates this class (or your subclass) each time it tests a method. So if you do not want that to happen when generating VTK pipelines you should create the pipeline in the class definition as done below for _blackbox. r)debugNc:|j|dS)aDoes a blackbox test by attempting to parse the class for its various methods using vtkMethodParser. This is a useful test because it gets all the methods of the vtkObject, parses them and sorts them into different classes of objects.N) _blackbox testParse)selfobjs r _testParsezvtkTest._testParses   %%%%%rc<|j||dS)zChecks the Get/Set method pairs by setting the value using the current state and making sure that it equals the value it was originally. This effectively calls _testParse internally. N)r testGetSetrrexcluded_methodss r _testGetSetzvtkTest._testGetSets# !!#'788888rc<|j||dS)zChecks the Boolean methods by setting the value on and off and making sure that the GetMethod returns the set value. This effectively calls _testParse internally. N)r testBooleanr"s r _testBooleanzvtkTest._testBooleans# ""3(899999rc|stStD]/}|tj|dkr|cS0|S)aqGiven a filename with no path (i.e., no leading directories prepended), return the full path to a file as specified on the command line with a '-D' option. As an example, if a test is run with "-D /path/to/grid.vtu" then calling self.pathToData('grid.vtu') in your test will return "/path/to/grid.vtu". This is useful in combination with ExternalData, where data may be staged by CTest to a user-configured directory at build time. In order for this method to work, you must specify the JUST_VALID option for your test in CMake. )VTK_DATA_PATHSospathsplitrfilenamer,s r pathToDatazvtkTest.pathToDatasR$ "! !"  D27==..r222 3rc|stStD]/}|tj|dkr|cS0|S)aGiven a filename with no path (i.e., no leading directories prepended), return the full path to a file as specified on the command line with a '-V' option. As an example, if a test is run with "-V /path/to/validImage.png" then calling self.pathToData('validImage.png') in your test will return "/path/to/validImage.png". This is useful in combination with ExternalData, where data may be staged by CTest to a user-configured directory at build time. In order for this method to work, you must specify the JUST_VALID option for your test in CMake. r))VTK_BASELINE_PATHSr+r,r-r.s rpathToValidatedOutputzvtkTest.pathToValidatedOutputsR$ &% %&  D27==..r222 3rc ddljgfd}fd}fd}|tj||tj||tj||tj|||}d}d|vrt}| | || |d} tj| d}t!} | | | | | n8#t*$r+|| YnwxYw|} |fdt3D} gd } gd }gd }t7| dkrV| d}|} |}|}tAd !| ||| | S)Nrctd|zdzjz ||fdS)Nzkey is "")print GetKeySymappendtimecallereventIdevents startTimer:s r onKeyPressz,vtkTest.prepareTestImage..onKeyPresss_ *v//111C7 8 8 8 MM949;;2GV=M=M=O=OP Q Q Q Q QrcVjz |fdSN)r9r:r;s ronButtonz*vtkTest.prepareTestImage..onButtons- MM949;;2G< = = = = =rc|jz ||fdSrB)r9r:GetEventPositionr;s r onMovementz,vtkTest.prepareTestImage..onMovements; MM949;;2GV=T=T=V=VW X X X X XrbaselineFilenamer/r)c:g|]}|Sr)GetItemAsObject).0irrcs r z,vtkTest.prepareTestImage..s'MMM!s""1%%MMMr)rrr )rrr)rr ra% Replace prepareTestImage() in your script with the following to make a test: camera.SetPosition({eye[0]}, {eye[1]}, {eye[2]}) camera.SetFocalPoint({aim[0]}, {aim[1]}, {aim[2]}) camera.SetViewUp({up[0]}, {up[1]}, {up[2]}) renwin.SetSize({rsz[0]}, {rsz[1]}) self.assertImageMatch(renwin, '{baseline}') Be sure that "renwin" and "camera" are valid variables (or rename them in the snippet above) referencing the vtkRenderWindow and vtkCamera, respectively. )eyeaimuprszbaseline)"r: AddObserverr KeyPressEventLeftButtonPressEventLeftButtonReleaseEventMouseMoveEventStartGetRenderWindowr ReadFrontBufferOffSetInputUpdater+r,r-r SetFileNameSetInputConnection GetOutputPortWrite RuntimeErrorReadFrontBufferOnGetSize GetRenderersrangeGetNumberOfItemslenGetActiveCamera GetPosition GetFocalPoint GetViewUpr7format)r interactorkwargsr@rCrFrwrRw2ifbaselineWithPathpngwrQrrsrNrOrPcamr>rLr?r:s @@@@rprepareTestImagezvtkTest.prepareTestImages DIKK  R R R R R R R > > > > > > > Y Y Y Y Y Y Y z7DDDz>IIIz@(KKKz8*EEE  ' ' ) )%   )++D  # # % % % MM"    KKMMM%j1 w}}%566r:H>>D   - . . .  # #D$6$6$8$8 9 9 9     &&(((  jjllooMMMMuS5I5I5K5K/L/LMMMgggggg s88a<<a&((**C//##C##%%C--//B   FshF G G I I I s!F662G+*G+c v|} t|dn#t|}YnxYwt||fi|dS)aThrow an error if a rendering in the render window does not match the baseline image. This method accepts a threshold keyword argument (with a default of 0.15) that specifies how different a baseline may be before causing a failure. rN)opengetAbsImagePath compareImage)rrenwinrRrnabsoluteBaselines rassertImageMatchzvtkTest.assertImageMatch s_ $ 9 !3 ' ' ' ' 9.x88   V-8888888s()__name__ __module__ __qualname____doc__r Testerrrdl SetExitErrorrr$r'r0r3rur}rrrrrqs a(((I BOOA B&&&13999924:::: 22===~ 9 9 9 9 9rrc6trtddSdS)z&Interacts with the user if necessary. z6 Press Enter/Return to continue with the testing. --> N) _INTERACT raw_inputrrrinteractrs.MKLLLLLMMrctS)z]Returns if the currently chosen mode is interactive or not based on command line options.)rrrr isInteractivers  rctD])}tj||kr|cS*tjt |S)zBReturns the full path to the image given the basic image name.)r2r+r,basenamejoinVTK_BASELINE_ROOT) img_basenamer,s rryry!sS# 7  D ! !\ 1 1KKK 2 7<<)< 8 88rctjttj|d}tj|S)Nr )r+r,r VTK_TEMP_DIRr-abspath) img_fnamexs r_getTempImagePathr)s>  \27==#;#;A#>??A 7??1  r333333?ctrdStj|\}}tj|st }|t||| | t|d|zdzt|z}dt_ t|t}|||t#}|| || ||} | } d} d} | |krd} d} d} |d| zz}tj|snr|||||}||kr | } d} |} |} n|| kr| } |} |} | dz} | rTt+|||t-| | |d|z}dt_ t|t/| | dS) ahCompares a source image (src_img, which is a vtkImageData) with the saved image file whose name is given in the second argument. If the image file does not exist the image is generated and stored. If not the source image is compared to that of the figure. This function also handles multiple images and finds the best matching image. NzMissing baseline image: z Test image created: rr r)z_%d.pngzFailed image test: %f ) _NO_IMAGEr+r,splitextisfilerr]rr^r_r`_printCDashImageNotFoundErrorrtracebacklimitrarr\r SetImageConnectionGetThresholdedErrorexists_handleFailedImage_printCDashImageError_printCDashImageSuccess)src_imgr thresholdf_basef_extrrmsgpngridiffmin_errimg_err err_indexcount test_failed new_fnamealt_errs rcompareImageWithSavedImager-sG$$Y//MFE 7>>) $ $  ~~ *955666  5 5 7 7888 %i000(947OORcdmRnRnn3 >>DYKKMMM  E W2244555 T//11222 LLNNN''))GGI E   50I7>>),,    Y ' ' ' KKMMM LLNNN//11G""!  !!W$$ %I%G%GAIE1 6  $ udI 6 6 6 !'9f = = =+E,E,E,G,GGC!"C s## #GY/////rc>trdSt}|||| t |||n5#t $r(|t |||YnwxYwdS)aaCompares renwin's (a vtkRenderWindow) contents with the image file whose name is given in the second argument. If the image file does not exist the image is generated and stored. If not the image in the render window is compared to that of the figure. This function also handles multiple images and finds the best matching image. N)rr rZr[r\rrarb)r{rrrps rrzrz~s ! # #DMM&KKMMM?"4I>>>> ???    "4I>>>>>? FsA((/BBc:t|}td|ztd|z|dkrtdntd|ztd|dzztd|d zztd |d zzd S) z(Prints the XML data necessary for CDash.z Failed image test with error: %fO %f rSStandardS %d zQ %s .pngzW %s .diff.pngzR %s .valid.pngN)rr7)rrimg_bases rrrs **H ,W 4555  "") *+++A~~ ghhhh &&/0 1 1 1  &'/&'8 :;;;  &'/+'= ?@@@  &'/,'> @AAAAArc0td|zdzdS)zLPrints the XML data necessary for Dart when the baseline image is not found.z9zNr7)rs rrrs" II UXl lmmmmmrc|td|z|dkrtddStd|zdS)z3Prints XML data for Dart when image test succeeded.rrrrNr)rrs rrrsh  "") *+++A~~ ghhhhh %%./00000rcltj|\}}t}|||d|dt}| t|dz||| || dd| t|dz| || dd| t|dz| dS)zDWrites all the necessary images when an image comparison failed.r rrr rN) r+r,rr r^r_SetShiftSetScalerr]rr`GetInputConnection)rrrrrgammarrs rrrssG$$Y//MFE  E U0022333 NN1 NN2 >>D&v ';<<===E//11222JJLLL E44Qq99:::&v77888JJLLL E44Qq99:::&v '<==>>>JJLLLLLrctt}|}tj}t |}||z }t tj|z }t d|zt d|z~~|rtj ddStj ddS)z Pass a list of tuples containing test classes and the starting string of the functions used for testing. Example: main ([(vtkTestClass, 'test'), (vtkTestClass1, 'test')]) zN %f zM %f rr N) processCmdLiner GetCPUTimer:testfloatr7 wasSuccessfulrr)casestimers_time s_wall_timeresulttot_time tot_wall_times rmainrs MME     F)++K%[[F!!F*H$)++ 344M  ##0 1222  ##+ ,--- u     rcg}|D]6}|tj|d|d7tj|}tjt }||}|S)a Pass a list of tuples containing test classes and the functions used for testing. It returns a unittest._TextTestResult object. Example: test = test_suite([(vtkTestClass, 'test'), (vtkTestClass1, 'test')]) rr ) verbosity)r9unittest makeSuite TestSuiteTextTestRunner_VERBOSErun)rsuitescase test_suiterunnerrs rrrs}F<< h(a$q'::;;;;#F++J $x 8 8 8F ZZ # #F Mrc d}|S)Na Usage: TestScript.py [options] Where options are: -D /path/to/VTKData --data-dir /path/to/VTKData Directory containing VTK Data use for tests. If this option is not set via the command line the environment variable VTK_DATA_ROOT is used. If the environment variable is not set the value defaults to '../../../../../VTKData'. -B /path/to/valid/image_dir/ --baseline-root /path/to/valid/image_dir/ This is a path to the directory containing the valid images for comparison. If this option is not set via the command line the environment variable VTK_BASELINE_ROOT is used. If the environment variable is not set the value defaults to the same value set for -D (--data-dir). -T /path/to/valid/temporary_dir/ --temp-dir /path/to/valid/temporary_dir/ This is a path to the directory where the image differences are written. If this option is not set via the command line the environment variable VTK_TEMP_DIR is used. If the environment variable is not set the value defaults to '../../../../Testing/Temporary'. -V /path/to/validated/output.png --validated-output /path/to/valid/output.png This is a path to a file (usually but not always an image) which is compared to data generated by the test. -v level --verbose level Sets the verbosity of the test runner. Valid values are 0, 1, and 2 in increasing order of verbosity. -I --interact Interacts with the user when chosen. If this is not chosen the test will run and exit as soon as it is finished. When enabled, the behavior of this is rather trivial and works best when the test uses Tkinter. -n --no-image Does not do any image comparisons. This is useful if you want to run the test and not worry about test images or image failures etc. -h --help Prints this message. r)rs rusagers< Cz Jrctjdd}d}gd} d}t|D]\}}|dr|}nt j||d||\}}ni#tj$rW}t tt dt |tjdYd}~nd}~wwxYw||fS)Nr z B:D:T:V:v:hnI)zbaseline-root=z data-dir=z temp-dir=zvalidated-output=zverbose=helpzno-imagerr-zF----------------------------------------------------------------------) rargv enumerate startswithgetopterrorr7rr) argumentsoptions long_optionsfirstrKargoptsargsrs r parseCmdLinerRs IG,,,L  **  FAs~~c""  ]9UVV#4g|LL dd < egg f  c  !  :sAA..C=A CCcnt\}} tjdan/#t$r"tjdaYnwxYw tjdan#t$rYnwxYw tjdan/#t$r"tjdaYnwxYw|D]e\}}|dvr[tj |}tj |rt |n|a|dvrtj |a|dvrtj |a|d vr7t tj ||d vrd a|d vrd a|d vr= t!|an,#d}t%|t'jd YnxYw|dvr.t%t+t'jgts tadSdS)N VTK_DATA_ROOTz../../../../../VTKDatarrz../../../../Testing/Temporary)z-Dz --data-dir)z-Bz--baseline-root)z-Tz --temp-dir)z-Vz--validated-output)z-nz --no-imager )z-Iz --interact)z-vz --verbosez3Verbosity should be an integer. 0, 1, 2 are valid.)z-hz--help)rr+environrKeyErrorr,normpathrrrrr*r9r2rrintrr7rrr)rroaoars rrrksaJD$ C ?3 CCC(()ABB C J':;      Iz.1 IIIw''(GHH I1 $ $ $##Bw~~b!! #%%b)))) " ) ) ) " 2 2  $ $ $7??1--L , , ,  % %bgooa&8&8 9 9 9 $ $ $I $ $ $I # # # q66 Ic   %''NNN HJJJ *)**s?&)AAA)) A65A6:B )B98B95G'G.__main__c@eZdZddlmZeZdZdZdZdS) SampleTestr)vtkActorc:||jdS)zTest if class is parseableN)rrrs rrzSampleTest.testParses OODH % % % % %rc:||jdS)zTesting Get/Set methodsN)r$rrs rr!zSampleTest.testGetSets   TX & & & & &rc:||jdS)zTesting Boolean methodsN)r'rrs rr&zSampleTest.testBooleans   dh ' ' ' ' 'rN) r~rrvtkmodules.vtkRenderingCorerrrr!r&rrrrrs^888888hjj & & & ' ' ' ( ( ( ( (rrr)r)4r __future__rrr+r:os.pathrrvtkmodules.vtkCommonCorerrvtkmodules.vtkCommonSystemrvtkmodules.vtkIOImagerrvtkmodules.vtkImagingCorer r rr rr rr*rrr2rrrrTestCaserrrryrrrzrrrrrrrrrr~rrrrr sAAD'&&&&&>>>>>>>>222222<<<<<<<<LLLLLLLL>>>>>>       c9c9c9c9c9hc9c9c9JMMM  999N0N0N0N0b    0AAA(nnn0008!!!H0>>>B23*3*3*n z ( ( ( ( (W ( ( (  DZ "$$$$$'r