schema_config.md

Config file Schema

schema_config.json

This is the main configuration for a test

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	schema_config.json

Config file Type

object (Config file)

Config file Properties

Property	Type	Required	Nullable	Defined by
name	string	Required	cannot be null	Config file
host	string	Required	cannot be null	Config file
headless	boolean	Optional	cannot be null	Config file
muted	boolean	Optional	cannot be null	Config file
timeout	number	Optional	cannot be null	Config file
close	boolean	Optional	cannot be null	Config file
executable	string	Optional	cannot be null	Config file
output	Merged	Optional	cannot be null	Config file
view	boolean	Optional	cannot be null	Config file
viewport	object	Optional	cannot be null	Config file
cookies	array	Optional	cannot be null	Config file
localStorage	array	Optional	cannot be null	Config file

name

Test suit name

name

• is required

• Type: string

• cannot be null

• defined in: Config file

name Type

string

host

Website hostname for this test suite (only one)

host

• is required

• Type: string

• cannot be null

• defined in: Config file

host Type

string

host Constraints

pattern: the string must match the following regular expression:

^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$

try pattern

headless

Run Chrome in headless (hidden) mode

headless

• is optional

• Type: boolean

• cannot be null

• defined in: Config file

headless Type

boolean

headless Default Value

The default value is:

true

muted

Mute Chrome entirely (only when not headless)

muted

• is optional

• Type: boolean

• cannot be null

• defined in: Config file

muted Type

boolean

muted Default Value

The default value is:

true

timeout

Default timeout (ms) used in all tests

timeout

• is optional

• Type: number

• cannot be null

• defined in: Config file

timeout Type

number

timeout Constraints

minimum: the value of this number must greater than or equal to: 0

timeout Default Value

The default value is:

30000

close

Automatically close Chrome after finish (only when not headless)

close

• is optional

• Type: boolean

• cannot be null

• defined in: Config file

close Type

boolean

close Default Value

The default value is:

true

executable

Path to Chrome executable

executable

• is optional

• Type: string

• cannot be null

• defined in: Config file

executable Type

string

output

Path to the output dir or disabling output (if false)

output

• is optional

• Type: merged type (Details)

• cannot be null

• defined in: Config file

output Type

merged type (Details)

one (and only one) of

• Untitled string in Config file

• Untitled boolean in Config file

view

Open generated Viewer file in a browser after finish (if output is enabled)

view

• is optional

• Type: boolean

• cannot be null

• defined in: Config file

view Type

boolean

viewport

Used to set the viewport before executing a test suit

viewport

• is optional

• Type: object (Viewport object)

• cannot be null

• defined in: Config file

viewport Type

object (Viewport object)

cookies

Cookies to set before running test cases

cookies

• is optional

• Type: object[] (Cookie object)

• cannot be null

• defined in: Config file

cookies Type

object[] (Cookie object)

localStorage

Local Storage items to set before running test cases

localStorage

• is optional

• Type: object[] (Local Storage object)

• cannot be null

• defined in: Config file

localStorage Type

object[] (Local Storage object)