settings.json

The settings.json file allows the user to specify global settings for a kosher project. Some values in the file are defaults but can be overridden by flags of the run command (e.g. --appVersion, --environment).

Format

{
    "projectName": "kosher",
    "appVersion": "1.0.0",
    "driver": "chrome",
    "reportFormat": "pretty",
    "dateFormat": "MM/DD/YYYY",
    "defaultEnvironment": "test",
    "screenFormat": "desktop",
    "quitOnFail": false,
    "ignoreInvisible": true,
    "waitAfterScenario": 0,
    "waitAfterStep": 0,
    "accessibility": {
		"ruleSets": [
			"wcag21aa",
			"section508"
		],
		"impactThreshold": "serious"
	},
    "screenFormats": {
        "desktop": {
            "width": 2000,
            "height": 980
         },
        "mobile": {
            "width": 362,
            "height": 868
        },
        "tablet": {
            "width": 814,
            "height": 868
        },
        "landscape": {
            "width": 522,
            "height": 362
        }
    },
	"integrations": {
		"jira": {
			"host": "http://127.0.0.1",
			"defaults": {
				"projectKey": "PROJE",
				"issueType": "Bug",
				"affectsVersion": "1.0.0",
				"labels": "test,functional,kosher",
				"priority": "Normal"
			}
		}
	}
}

Properties

projectName

Sets the name of the project recorded in results files.

appVersion

Sets the version of the project recorded in results files.

driver

Specifies which webdriver is used to execute the tests. Valid options are chrome, ie, phantomjs, desktop

reportFormat

Specifies what format is used to report test results. Valid options are: pretty, bootstrap, simple, progress, junit, cucumber-json

For descriptions of the reports, see Reports

You can use multiple formats by setting the reportFormat to a JSON string array: ["pretty", "bootstrap"]

dateFormat

Specifies the format used when validating or setting dates.

Valid placeholders are:

defaultEnvironment

Specifies the default environment to execute tests in. For more information, see environments.json.

screenFormat

Specifies which dimensions to apply to newly opened window and when the I maximize the window step is executed. For more information, see screenFormats below.

quitOnFail

Specifies if kosher continues executing remaining scenarios after a step fails.

ignoreInvisible

Specifies if kosher should act as if elements that are invisible to the user do not exist.

waitAfterScenario

Specifies a wait time to pause for following every scenario. This is measured in milliseconds.

waitAfterStep

Specifies a wait time to pause for following every step. This is measured in milliseconds.

accessibility

Configures how the Axe accessiblity API will scan the page for issues.

ruleSets

The Axe tags to apply to the page. These are effectively sets of rules. You can find a list of available rule sets at Axe API Documentation.

impactThreshold

Specifies the impact (i.e. severity) that an accessibility finding must be to fail the I test the page for accessibility step. See the Axe API Documentation for more details.

screenFormats

Defines available screen formats. One of these must be selected by the screenFormat option above.

Each option in the screenFormats object must define a width and height property, both of type int.

{
    "desktop": {
        "width": 2000,
        "height": 980
    },
    "mobile": {
        "width": 362,
        "height": 868
    },
    "tablet": {
        "width": 814,
        "height": 868
    },
    "landscape": {
        "width": 522,
        "height": 362
    }
}