Smoke Test
Getting Started
Getting Started
CLI Command
Smoke Testing CLI Command
On this page you can see the Skyramp CLI command for generating Smoke tests against REST APIs. You can find additional explanations on the different flags here [LINK].
$ skyramp generate smoke rest --help
Generate smoke tests for REST protocol
Usage:
skyramp generate smoke rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate smoke rest <endpoint_url> -X <rest-method> --request-data <sample-request> [flags]
skyramp generate smoke rest <endpoint_url> -X POST --form-params <form-paramss> [flags]
skyramp generate smoke rest --help
Arguments:
endpoint_url Test is created for this endpoint url
Examples:
skyramp generate smoke rest https://skyramp.dev/api/products -X POST --request-data @request.json --language typescript --framework playwright
skyramp generate smoke rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language python --framework pytest
skyramp generate smoke rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language typescript --framework playwright --output skyramp_test.spec.ts --output-dir ./tests/
Input Flags:
--api-schema Path to OpenAPI specification
-X, --method REST method to be tested
--request-data Sample request data as JSON/YAML blob or @path to a file
--response-status-code Expected response status code [default: 20X]
Param Flags:
--auth-header Authorization header type
--form-params Form parameters for POST methods
--path-params Comma-separated list of path parameters
--query-params Comma-separated list of query parameters
Output Flags:
--deploy-dashboard Deploy the Skyramp dashboard for test result collection [default: false]
--framework Testing framework for generated test [playwright, pytest, robot] [default: pytest]
--language Language for generated test [python, typescript] [default: python]
--output Generated test name
--output-dir Location to write generated tests
--overwrite Overwrite existing tests without additional confirmation [default: false]
Runtime Flags:
--docker-network Docker network for skyramp worker [default: skyramp]
--docker-skyramp-port Docker port for skyramp worker [default: 35142]
-k, --insecure Skip ssl server verification [default: false]
--runtime Environment where test should run [docker, local]
Inherited Flags:
-h, --help Show help for
Smoke Testing CLI Command
On this page you can see the Skyramp CLI command for generating Smoke tests against REST APIs. You can find additional explanations on the different flags here [LINK].
$ skyramp generate smoke rest --help
Generate smoke tests for REST protocol
Usage:
skyramp generate smoke rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate smoke rest <endpoint_url> -X <rest-method> --request-data <sample-request> [flags]
skyramp generate smoke rest <endpoint_url> -X POST --form-params <form-paramss> [flags]
skyramp generate smoke rest --help
Arguments:
endpoint_url Test is created for this endpoint url
Examples:
skyramp generate smoke rest https://skyramp.dev/api/products -X POST --request-data @request.json --language typescript --framework playwright
skyramp generate smoke rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language python --framework pytest
skyramp generate smoke rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language typescript --framework playwright --output skyramp_test.spec.ts --output-dir ./tests/
Input Flags:
--api-schema Path to OpenAPI specification
-X, --method REST method to be tested
--request-data Sample request data as JSON/YAML blob or @path to a file
--response-status-code Expected response status code [default: 20X]
Param Flags:
--auth-header Authorization header type
--form-params Form parameters for POST methods
--path-params Comma-separated list of path parameters
--query-params Comma-separated list of query parameters
Output Flags:
--deploy-dashboard Deploy the Skyramp dashboard for test result collection [default: false]
--framework Testing framework for generated test [playwright, pytest, robot] [default: pytest]
--language Language for generated test [python, typescript] [default: python]
--output Generated test name
--output-dir Location to write generated tests
--overwrite Overwrite existing tests without additional confirmation [default: false]
Runtime Flags:
--docker-network Docker network for skyramp worker [default: skyramp]
--docker-skyramp-port Docker port for skyramp worker [default: 35142]
-k, --insecure Skip ssl server verification [default: false]
--runtime Environment where test should run [docker, local]
Inherited Flags:
-h, --help Show help for
Smoke Testing CLI Command
On this page you can see the Skyramp CLI command for generating Smoke tests against REST APIs. You can find additional explanations on the different flags here [LINK].
$ skyramp generate smoke rest --help
Generate smoke tests for REST protocol
Usage:
skyramp generate smoke rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate smoke rest <endpoint_url> -X <rest-method> --request-data <sample-request> [flags]
skyramp generate smoke rest <endpoint_url> -X POST --form-params <form-paramss> [flags]
skyramp generate smoke rest --help
Arguments:
endpoint_url Test is created for this endpoint url
Examples:
skyramp generate smoke rest https://skyramp.dev/api/products -X POST --request-data @request.json --language typescript --framework playwright
skyramp generate smoke rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language python --framework pytest
skyramp generate smoke rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language typescript --framework playwright --output skyramp_test.spec.ts --output-dir ./tests/
Input Flags:
--api-schema Path to OpenAPI specification
-X, --method REST method to be tested
--request-data Sample request data as JSON/YAML blob or @path to a file
--response-status-code Expected response status code [default: 20X]
Param Flags:
--auth-header Authorization header type
--form-params Form parameters for POST methods
--path-params Comma-separated list of path parameters
--query-params Comma-separated list of query parameters
Output Flags:
--deploy-dashboard Deploy the Skyramp dashboard for test result collection [default: false]
--framework Testing framework for generated test [playwright, pytest, robot] [default: pytest]
--language Language for generated test [python, typescript] [default: python]
--output Generated test name
--output-dir Location to write generated tests
--overwrite Overwrite existing tests without additional confirmation [default: false]
Runtime Flags:
--docker-network Docker network for skyramp worker [default: skyramp]
--docker-skyramp-port Docker port for skyramp worker [default: 35142]
-k, --insecure Skip ssl server verification [default: false]
--runtime Environment where test should run [docker, local]
Inherited Flags:
-h, --help Show help for