CLI and configuration file options
browserDisableExtensions run browser without extensionsdefault value: false browserHeadless run browser in headless modedefault value: false browserHeight browser window heightdefault value: 0 browserId browser to use: chrome, firefoxdefault value: chrome browserRemoteDriverUrl browser remote driver url browserSameDriverInThreads set to true if you want only a single browser across multiple threads. Use case is notebook like apps.Personas will still have their own driversdefault value: false browserStaleElementRetry number of times to automatically retry for browser stale element actionsdefault value: 5 browserStaleElementRetryWait wait time in between browser stale element retriesdefault value: 100 browserTestcontainersEnabled pass true to get connection to web drivers using Test Containersdefault value: false browserUrl browser base url for application under test. It is being used instead of url when provided browserUseFakeMedia use fake microphone/camera to avoid asking for permission on browser/OS leveldefault value: false browserVersion browser version for automatic driver download browserWidth browser window widthdefault value: 0 cachePath user driven cache base dirdefault value: ${workingDir}/.webtau-cache chromeBinPath path to chrome binary chromeDriverPath path to chrome driver binary cliEnv cli common environment variablesdefault value: {} cliPath path items to append to path used for cli runsdefault value: [] cliTimeout cli foreground command run timeout (ms)default value: 30000 config config file pathdefault value: webtau.cfg.groovy consoleOutputCaptureDir path to a directory where overall and per test console output will be stored consolePayloadOutputLimit max number of lines to display in console for outputs (e.g. http response)default value: 500 dbDriverClassName primary database driver class name dbPassword primary database password dbUrl primary database url dbUserName primary database user name disableConsoleOverallReport do not print failed tests, overall summary and path to the generated report at the enddefault value: false disableRedirects disable following of redirects from HTTP callsdefault value: false docPath path for captured request/responses, screenshots and other generated artifacts for documentationdefault value: ${workingDir}/doc-artifacts env environment iddefault value: local failedReportPath failed report file path firefoxBinPath path to firefox binary firefoxDriverPath path to firefox driver binary fullAssertionError Always include detailed message in assertion error (even when console output is present)default value: false fullStackTrace print full stack trace to consoledefault value: false graphQLEndpoint override the default graphQL endpointdefault value: /graphql graphQLIgnoreIntrospectionFailures ignore graphQL introspection failures, introspection is required for coverage reportingdefault value: true graphQLShowOperationAsQueryParam pass the graphQL operation as operation= query parameter if presentdefault value: true httpDataCoverageOutput path to generated data coverage JSON result for additional processing httpProxy http proxy host:port httpRoutesPath path to a file or a resource with operations in a format METHOD route httpTimeout http connect and read timeout in millisecondsdefault value: 30000 jsonSchemasDir url of directory containing JSON schemasdefault value: /home/runner/work/webtau/webtau/webtau-groovy-app maxRedirects Maximum number of redirects to follow for an HTTP calldefault value: 20 noColor disable ANSI colorsdefault value: false numberOfThreads number of threads on which to run test files (one file per thread), -1 will use as many threads as there are filesdefault value: 1 openApiIgnoreAdditionalProperties ignore additional OpenAPI propertiesdefault value: false openApiSpecUrl url of OpenAPI 2 spec against which to validate http calls parallel run tests in parallel using numberOfThreads equals to number of filesdefault value: false removeWebTauFromUserAgent By default webtau appends webtau and its version to the user-agent, this disables that partdefault value: false reportName report name to showdefault value: WebTau report reportNameUrl report name url to navigate to when clicked reportPath report file pathdefault value: ${workingDir}/webtau.report.html serverProxyMaxThreads max number of threads for proxy servers (default number of CPUs * 2)default value: 8 tableVerticalSeparator string to use as a vertical separator when print TableDatadefault value: │ termui enable terminal UI to monitor tests (experimental)default value: false url base url for application under test userAgent User agent to send on HTTP requestsdefault value: webtau/2.4 verbosityLevel output verbosity level. 0 - no output; 1 - test names; 2 - first level steps; etcdefault value: 2147483647 waitTick wait tick in millisecondsdefault value: 100 waitTimeout wait timeout in millisecondsdefault value: 5000 webSocketMaxMessages max number of received messages to keep for polling/waitingdefault value: 1000 webSocketPollTimeout poll new message timeoutdefault value: 5000 workingDir logical working dirdefault value:
Environment variable options
WEBTAU_BROWSER_DISABLE_EXTENSIONS run browser without extensionsdefault value: false WEBTAU_BROWSER_HEADLESS run browser in headless modedefault value: false WEBTAU_BROWSER_HEIGHT browser window heightdefault value: 0 WEBTAU_BROWSER_ID browser to use: chrome, firefoxdefault value: chrome WEBTAU_BROWSER_REMOTE_DRIVER_URL browser remote driver url WEBTAU_BROWSER_SAME_DRIVER_IN_THREADS set to true if you want only a single browser across multiple threads. Use case is notebook like apps.Personas will still have their own driversdefault value: false WEBTAU_BROWSER_STALE_ELEMENT_RETRY number of times to automatically retry for browser stale element actionsdefault value: 5 WEBTAU_BROWSER_STALE_ELEMENT_RETRY_WAIT wait time in between browser stale element retriesdefault value: 100 WEBTAU_BROWSER_TESTCONTAINERS_ENABLED pass true to get connection to web drivers using Test Containersdefault value: false WEBTAU_BROWSER_URL browser base url for application under test. It is being used instead of url when provided WEBTAU_BROWSER_USE_FAKE_MEDIA use fake microphone/camera to avoid asking for permission on browser/OS leveldefault value: false WEBTAU_BROWSER_VERSION browser version for automatic driver download WEBTAU_BROWSER_WIDTH browser window widthdefault value: 0 WEBTAU_CACHE_PATH user driven cache base dirdefault value: ${workingDir}/.webtau-cache WEBTAU_CHROME_BIN_PATH path to chrome binary WEBTAU_CHROME_DRIVER_PATH path to chrome driver binary WEBTAU_CLI_ENV cli common environment variablesdefault value: {} WEBTAU_CLI_PATH path items to append to path used for cli runsdefault value: [] WEBTAU_CLI_TIMEOUT cli foreground command run timeout (ms)default value: 30000 WEBTAU_CONFIG config file pathdefault value: webtau.cfg.groovy WEBTAU_CONSOLE_OUTPUT_CAPTURE_DIR path to a directory where overall and per test console output will be stored WEBTAU_CONSOLE_PAYLOAD_OUTPUT_LIMIT max number of lines to display in console for outputs (e.g. http response)default value: 500 WEBTAU_DB_DRIVER_CLASS_NAME primary database driver class name WEBTAU_DB_PASSWORD primary database password WEBTAU_DB_URL primary database url WEBTAU_DB_USER_NAME primary database user name WEBTAU_DISABLE_CONSOLE_OVERALL_REPORT do not print failed tests, overall summary and path to the generated report at the enddefault value: false WEBTAU_DISABLE_REDIRECTS disable following of redirects from HTTP callsdefault value: false WEBTAU_DOC_PATH path for captured request/responses, screenshots and other generated artifacts for documentationdefault value: ${workingDir}/doc-artifacts WEBTAU_ENV environment iddefault value: local WEBTAU_FAILED_REPORT_PATH failed report file path WEBTAU_FIREFOX_BIN_PATH path to firefox binary WEBTAU_FIREFOX_DRIVER_PATH path to firefox driver binary WEBTAU_FULL_ASSERTION_ERROR Always include detailed message in assertion error (even when console output is present)default value: false WEBTAU_FULL_STACK_TRACE print full stack trace to consoledefault value: false WEBTAU_GRAPH_QLENDPOINT override the default graphQL endpointdefault value: /graphql WEBTAU_GRAPH_QLIGNORE_INTROSPECTION_FAILURES ignore graphQL introspection failures, introspection is required for coverage reportingdefault value: true WEBTAU_GRAPH_QLSHOW_OPERATION_AS_QUERY_PARAM pass the graphQL operation as operation= query parameter if presentdefault value: true WEBTAU_HTTP_DATA_COVERAGE_OUTPUT path to generated data coverage JSON result for additional processing WEBTAU_HTTP_PROXY http proxy host:port WEBTAU_HTTP_ROUTES_PATH path to a file or a resource with operations in a format METHOD route WEBTAU_HTTP_TIMEOUT http connect and read timeout in millisecondsdefault value: 30000 WEBTAU_JSON_SCHEMAS_DIR url of directory containing JSON schemasdefault value: /home/runner/work/webtau/webtau/webtau-groovy-app WEBTAU_MAX_REDIRECTS Maximum number of redirects to follow for an HTTP calldefault value: 20 WEBTAU_NO_COLOR disable ANSI colorsdefault value: false WEBTAU_NUMBER_OF_THREADS number of threads on which to run test files (one file per thread), -1 will use as many threads as there are filesdefault value: 1 WEBTAU_OPEN_API_IGNORE_ADDITIONAL_PROPERTIES ignore additional OpenAPI propertiesdefault value: false WEBTAU_OPEN_API_SPEC_URL url of OpenAPI 2 spec against which to validate http calls WEBTAU_PARALLEL run tests in parallel using numberOfThreads equals to number of filesdefault value: false WEBTAU_REMOVE_WEB_TAU_FROM_USER_AGENT By default webtau appends webtau and its version to the user-agent, this disables that partdefault value: false WEBTAU_REPORT_NAME report name to showdefault value: WebTau report WEBTAU_REPORT_NAME_URL report name url to navigate to when clicked WEBTAU_REPORT_PATH report file pathdefault value: ${workingDir}/webtau.report.html WEBTAU_SERVER_PROXY_MAX_THREADS max number of threads for proxy servers (default number of CPUs * 2)default value: 8 WEBTAU_TABLE_VERTICAL_SEPARATOR string to use as a vertical separator when print TableDatadefault value: │ WEBTAU_TERMUI enable terminal UI to monitor tests (experimental)default value: false WEBTAU_URL base url for application under test WEBTAU_USER_AGENT User agent to send on HTTP requestsdefault value: webtau/2.4 WEBTAU_VERBOSITY_LEVEL output verbosity level. 0 - no output; 1 - test names; 2 - first level steps; etcdefault value: 2147483647 WEBTAU_WAIT_TICK wait tick in millisecondsdefault value: 100 WEBTAU_WAIT_TIMEOUT wait timeout in millisecondsdefault value: 5000 WEBTAU_WEB_SOCKET_MAX_MESSAGES max number of received messages to keep for polling/waitingdefault value: 1000 WEBTAU_WEB_SOCKET_POLL_TIMEOUT poll new message timeoutdefault value: 5000 WEBTAU_WORKING_DIR logical working dirdefault value: