mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
|
|
||
|
|
## Regression test system
|
||
|
|
|
||
|
|
A regression tool for QA is build into ResInsight. This tool will do the following:
|
||
|
|
|
||
|
|
1. Scan a directory for sub directories containing a RegressionTest.rip files.
|
||
|
|
2. Each found project file will be opened, and all views in this project will be exported as snapshot images to file.
|
||
|
|
3. When snapshot images from all projects are completed, difference images based on generated and QA-approved images are computed.
|
||
|
|
4. Based on these three sets of images, an HTML report is created and automatically displayed.
|
||
|
|
|
||
|
|
### Starting regression tests
|
||
|
|
|
||
|
|
To be able to run regression tests you need the *compare* tool from the ImageMagic suite.
|
||
|
|
|
||
|
|
You can start the tests either from the command line or from the ResInsight Gui.
|
||
|
|
From the ResInsight Gui select : **Debug -> Regression Test Dialog**
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
The **Application Working Folder** is basically the path to the executable of the image compare utility used, even though the CWD of Resinsight is temporarily changed to this path during execution.
|
||
|
|
|
||
|
|
### Creating regression tests
|
||
|
|
|
||
|
|
An example of the folder structure is shown below:
|
||
|
|
|
||
|
|
```
|
||
|
|
RegressionTestFolder/
|
||
|
|
TestCase1/
|
||
|
|
RegressionTest.rip
|
||
|
|
RegTestBaseImages/
|
||
|
|
RegTestDiffImages/
|
||
|
|
RegTestGeneratedImages/
|
||
|
|
TestCase2/
|
||
|
|
...
|
||
|
|
```
|
||
|
|
|
||
|
|
To create regression tests you need to do the following:
|
||
|
|
|
||
|
|
1. Create a root directory containing one directory for each testcase.
|
||
|
|
2. In each of the Test Case folders create a Resinsight project file called RegressionTest.rip.
|
||
|
|
3. Run the regression test for the first time, and thereby creating images that can be used as Base images.
|
||
|
|
4. Rename the generated RegTestGeneratedImages/ folder to RegTestBaseImages/
|
||
|
|
|
||
|
|
Now you are all set to test new releases of ResInsight towards your own Regression tests.
|