ResInsight/docs/RegressionTestSystem.md

---
layout: docs
prev_section: octaveinterfacereference
next_section: commandlineparameters
title: Regression test system
permalink: /docs/regressiontestsystem/
---

## 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](http://www.imagemagick.org/script/compare.php).


You can start the tests either from the command line or from the ResInsight Gui.
From the ResInsight Gui select : **File->Testing->Regression Test Dialog**

![]({{ site.baseurl }}/images/RegressionTestDialog.png)

Specify location of compare tool in **Folder containing compare**. The current working directory 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 test case. 
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.