testflowkit Configuration

CLI Configuration

Configure settings for running the test application. This YAML file controls global settings, application information, and reporting options.

Option	Description	Default Value	Example
`timeout`	Maximum test execution time (in seconds).	`15s`	`timeout: 30s`
`parallel`	Number of tests to run in parallel.	`5`	`parallel: 10`
`slowMotion`	Slow down test execution (in seconds) - useful for debugging.	`0s`	`slowMotion: 1s`
`gherkin_location`	Path to the directory containing the Gherkin feature files.	`e2e/features`	`gherkin_location: "tests/features"`


configuration:
    timeout: 30s
    parallel: 10
    slowMotion: 0s
    gherkin_location: "tests/features"
  
  application:
    app_name: "My Application"
    app_description: "A sample application for testing"
    app_version: "1.0.0"
  
  reporting:
    report_format: "json"

Test Configuration

Define variables, page objects, and base URLs for your tests. This YAML file helps organize your tests and makes them more maintainable.

Define reusable selectors for common UI elements.


elements:
  login_button:
    - "#login-button"
    - ".login-button"
  username_field: "#username"
  password_field: "#password"

Define URLs for different pages used in your tests.


pages:
  home: "/home"
  login: "/login"

Define the base URL for your application. Relative paths in the `pages` section will be relative to this base URL.


base_url: "http://localhost:3000"


global:
  elements:
    login_button:
      - "#login-button"
      - ".login-button"
    username_field: "#username"
    password_field: "#password"
  pages:
    home: "/home"
    login: "/login"
base_url: "http://localhost:3000"

CLI Arguments

Override settings from the YAML configuration files using command-line arguments.

Argument	Description	Example
`-l, --location <path>`	Specifies the path to the Gherkin feature files.	`--location ./features`
`-c, --config <path>`	Sets the path to the main configuration YAML file.	`--config config.yaml`
`-f, --front-config <path>`	Sets the path to the frontend configuration YAML file.	`--front-config frontend.yaml`
`-t, --tags <tags>`	Filters tests based on tags.	`--tags "@smoke,@regression"`
`-p, --parallel <number>`	Defines the number of parallel tests.	`--parallel 4`
`--timeout <duration>`	Sets the maximum test suite duration.	`--timeout 30s`
`--headless <bool>`	Run browser in headless mode (true/false).	`--headless false`
`-v, --version <string>`	Specifies the application version.	`--version 2.1.0`