Test, Configuration gepard.properties - epam/Gepard GitHub Wiki
gepard.properties file is stored usually in folder src/main/resources. Add all necessary (general, like the gepard.properties, and any other project specific properties) as arguments for Gepard.
When Gepard starts, it loads the properties file given as program arguments. See build.gradle how gepard.properties file is passed to Gepard. In gepard-examples module you may see several property files used.
There is no restriction on the properties defined in these files, except that they must not begin with „gepard” because this word is reserved for the framework’s own properties and ensure future extensibility.
Any property defined in a property file or the build script can be overridden with the
–Dpropname=propvalue in gradle.build properties. Currently this only affects the build script properties, the properties remain unchanged in the test cases due to the fact that those are handled by the
Environment class.
| Property Name | Meaning | Default Value |
|---|---|---|
| gepard.threads | How many threads should be used in parallel to execute the tests. Such number depends on the available hardware capabilities and nature of the tests. Like in case you use Selenium Grid, it is not recommended to use more threads than test heads you have in a grid. | 10 |
| gepard.basefolder | The root directory of your test project. | . |
| gepard.datadriven.pathbase | This folder will be used by Gepard when in case of data-driven tests, Gepard searches for the data (csv or txt) files. | ${gepard.basefolder}/src/main/java |
| gepard.datadriven.columnsplitter | Specifies the character Gepard will use to separate the data in a data txt file. | % |
| gepard.datadriven.feeder.class | Specifies the default Data Feeder class, in case only feeder parameter exists, and the parameter is not number. (See Test Data Feeders about the Feeders.) Note: In case there is no feeder class specified, but the feeder parameter is a number, then the SimpleMultiplierDataFeeder will be applied. | LabelBasedDataFeeder |
| gepard.test.resource.path | Path to project resource files. | ${gepard.basefolder}/build/resources/main |
| gepard.testlist.file | Main test list file. This specifies the test cases to be executed. | ${gepard.test.resource.path}/testlist.txt |
| gepard.public.enabled | It is possible to give proper link in mail notifications to the stored HTML (or other) reports. Set this to true, if the next two parameter is properly configured and you would like to use this link in the result mails. | false |
| gepard.public.path | Path to the place where the test results are stored. Will be used only if the above parameter is true, and only as part of the link in the result mail. | |
| gepard.public.result | Second part of the path to the place where the test results are stored. Will be used only if the above parameter is true, and only as part of the link in the result mail. | |
| system-under-test.version | Identifies the version of the tested system/application/component. Will be presented in the HTML test reports and mails. It is suggested to be detected and set during the test run, by a dedicated test case. | <undetected> |
There are other config parameters, those are not really important ones, and usually don't require changing. Of course if you want to change it, you may, their names are descriptive ones.
Three property file is in use to set up test environment related properties:
default.properties
environment.properties
selenium.properties
log4j.properties
In default.properties, the main properties are:
| Property Name | Meaning | Default Value |
|---|---|---|
| TEID | Identifies the Test Environment ID (TEID). Used to select the right (environment specific) properties from `environment.properties` file. | LOCAL |
| system-under-test.version | Identifies the version of the tested system/application/component. Will be presented in the HTML test reports and mails. It is suggested to be detected and set during the test run, by a dedicated test case. | Unknown |
In environment.properties, use property names in the following format: env.<TEID>.xxxx. Be aware that env.default should contain default values.
Example:
# default values
env.default.url=http://i.should.test.it.com
env.default.browser=*firefox
# LOCAL environment
env.LOCAL.url=http://localhost
From the example above, the value of env.LOCAL.browser should be considered as *firefox.
In selenium.properties you may find basic selenium related properties, like identifying the host and port of the Selenium server. If you don't use Selenium for your tests, of course you don't need this file (if you remove this, don't forget to remove it from gradle.build file too).
In log4j.properties settings you may find for Lsf4j-Log4j logging tool, its modification is not necessary.