OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update CommandLineParameters.md

Browse Source 
Updated Command Line /Regression test system doc.
This commit is contained in:
Jacob Støren 2013-10-24 11:45:51 +02:00
parent a1e4f02665
commit 8f44ba33be
1 changed files with 42 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
Documentation/UsersGuide/CommandLineParameters.md
View File

@ -1,38 +1,56 @@
# Command Line Parameters #
## Basic usage ##
## Command Line Parameters #
Parameter|Description
---------|-----------
`-help, -?` | Displays help text and version info
`-last` | Open last used project
`-project <filename>` | Open project file <filename>
`-case <casename>` | Import Eclipse case <casename> (do not include .GRID/.EGRID)
`-help, -?` | Displays help text
`-savesnapshots` | Save snapshot of all views to 'snapshots' folder in project file folder. Application closes after snapshots are written to file.
`-regressiontest <folder>` | Run a regression test on all sub-folders starting with `TestCase*` of the given folder. **RegressionTest.rip** files in the sub-folders will be opened and snapshots of all the views is written to the sub-sub-folder **RegTestGeneratedImages**. Then difference images is generated in the sub-sub-folder **RegTestDiffImages** based on the images in sub-sub-folder **RegTestBaseImages**. The results are presented in **ResInsightRegressionTestReport.html** that is written in the given folder.
`-updateregressiontestbase <folder>` | For all sub-folders starting with `TestCase*`, copy the images in the sub-sub-folder **RegTestGeneratedImages** to the sub-sub-folder **RegTestBaseImages** after deleting **RegTestBaseImages** completely.
## Regression test ##
A regression tool for QA is build into ResInsight. This tool will read a project file, open all views in this project, save snapshot images to file, and close the project. When snapshot images from all projects are completed, difference images based on generated and QA-approved images are computed. Based on these three sets of images, an HTML report is created and automatically displayed.
## Regression test system
### Regression test folder structure ###
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**
![](images/RegressionTestDialog.png)
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:
```
MyRegressionTestFolder
TestCase_Faults
RegTestBaseImages
RegTestDiffImages
RegTestGeneratedImages
TestCase_SOIL
RegTestBaseImages
RegTestDiffImages
RegTestGeneratedImages
...
RegressionTestFolder/
TestCase1/
RegressionTest.rip
RegTestBaseImages/
RegTestDiffImages/
RegTestGeneratedImages/
TestCase2/
...
```
`-savesnapshots`
Save snapshot of all views to 'snapshots' folder in project file folder. Application closes after snapshots are written to file.
To create regression tests you need to do the following:
`-regressiontest <folder>`
Run a regression test on all sub-folders starting with `TestCase*` of the given folder. **RegressionTest.rip** files in the sub-folders will be opened and snapshots of all the views is written to the sub-sub-folder **RegTestGeneratedImages**. Then difference images is generated in the sub-sub-folder **RegTestDiffImages** based
on the images in sub-sub-folder **RegTestBaseImages**. The results are presented in **ResInsightRegressionTestReport.html** that is written in the given folder.
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.
`-updateregressiontestbase <folder>`
For all sub-folders starting with `TestCase*`, copy the images in the sub-sub-folder **RegTestGeneratedImages** to the sub-sub-folder **RegTestBaseImages** after deleting **RegTestBaseImages** completely.