Laserfiche WebLink
Quality Control TSTool Documentation <br />• Name the command file with prefix Test_, extension .TSTool , and use the following guidelines: <br />o for the default case using the filename pattern Test_CommandName.TSTool <br />o If there is a reason to define a test for a specific data set or input, add additional <br />information to the filename, for example: Test_CommandName_RiverX.TSTool or <br />Test_CommandName_6Hour.TSTool <br />o If defining a test for legacy syntax, name the command file as follows (and see the <br />@readOnly comment tag described in Section 9 .3.3 ): <br />Test_CommandName_Legacy.TSTool <br />o If defining a test for parameter values other than the default values, use a command file <br />name similar to the following, where the parameters are listed at the end of the file name <br />body: Test_CommandName_Param1=Value1,Param2=Value2.TSTool <br />Although this can result in very long names, the explicit naming clarifies the purpose of <br />the test. The name of the example command file shown above is <br />Test_FillInterpolate_MaxIntervals=2.TSTool . <br />• Add a short comment to the top of the test case explaining the test. <br />• Use as little data as possible to perform the test – long time series cause tests to run longer and <br />take up more space in the repository that is used for revision control. Even though hundreds or <br />thousands of tests may ultimately be defined, it is important to be able to run them in a short time <br />to facilitate testing. <br />• If possible, test only one command in the test – more complicated testing is described in Section <br />9 .3.4 . <br />• If an input file is needed, place it in a folder named Data , if necessary copying the same input <br />from another command – this may require additi onal disk space but ensures that each command <br />can stand alone. <br />• Write the expected results to a folder named ExpectedResults. <br />• Write the generated results and other dynamic c ontent, including log file, to a folder named <br />Results . <br />• (Recommended) When creating output files, use _out in the filename before the extension and <br />use an extension that is appropriate for the file content – this helps identify final output products <br />in cases where intermediate files might be produced. <br /> <br />9.3.2 Creating and Running a Test Suite <br /> <br />The previous section described how to define a single test case. However, opening and running each test <br />case command file would be very tedious and inefficien t. Therefore, TSTool provides a way to generate <br />and run test suites, which is the approach taken to perform a full regression test prior to a software <br />release. <br /> <br />Quality Control - 4 120