CLI Flags Glossary

Skyramp allows you to tune your test with several different inputs in order to provide you flexibility in test generation and execution.

Input Flags

Input flags aim to specify additional information about the endpoint / method being tested in order to build out the test properly. Skyramp will typically require some combination of input flags in order to generate a test.

• --api-schema: Specify the path to your OpenAPI spec, e.g. specification/public.yaml. You can use it when generating tests for a single method or all methods specified in the schema.

• --request-data: This flag allows you to define sample data when testing a specified method. You can provide the sample request data as JSON/YAML blob directly in the command or specify a path to a file containing the sample data. Please indicate the path with an @ symbol, e.g. @data/request-data.json. If providing the JSON blob directly in the command please use apostrophes around the blob, e.g. '{"value": "skyramp"}'.

• --response-data: This flag allows you to define sample data when testing a specified method. You can provide the sample response data as JSON/YAML blob directly in the command or specify a path to a file containing the sample data. Please indicate the path with an @ symbol, e.g. @data/response-data.json. If providing the JSON blob directly in the command please use apostrophes around the blob, e.g. '{"value": "skyramp"}'.

• --response-status-code: This flag allows you to specify the expected response code for the test of a single method.

• --trace: This flag allows you to specify a path to a Skyramp trace for integration, load, and E2E tests. For more information on Skyramp traces, please refer to the Integration Testing guide.

• --playwright-trace: This flag allows you to specify a path to a Playwright trace for UI and E2E tests. For more information on Playwright traces, please refer to the UI Testing guide.

• --include: This flag allows you to specify a comma separated list of URLs to include in a test. This flag must be used with --trace as it filters URLs directly from the trace file. For more information on Skyramp traces, please refer to the Integration Testing guide.

• --exclude: This flag allows you to specify a comma separated list of URLs to exclude from a test. This flag must be used with --trace as it filters URLs directly from the trace file. For more information on Skyramp traces, please refer to the Integration Testing guide.

Parameter Flags

Parameter flags allow you to tune your test generation requests with specific parameters relevant to your API requests.

• --auth-header: This flag allows you to specify the key of your authentication header, e.g. --auth-header X-API-KEY. By default, we assume Bearer.

• --path-params: This flag allows you to override path parameters from your endpoint URL or the pre-defined values in the API schema, e.g. --path-params id=3fa85f64-5717-4562-b3fc-2c963f66afa6.

• --query-params: This flag allows you to specify query parameters for your single method request, e.g. --query-parms limit=5.

• --form-params: You can specify form parameters instead of request-data for POST methods. However, form-params cannot be passed in combination with request-data.

Runtime flags

Runtime flags allow you to tune the execution of your test within an environment of your choice.

• --runtime: Select the environment in which you want to run the test. [local, docker, k8s]

• --docker-network: specify the name (string) of your docker network (default=bridge)

• --docker-skyramp-port: provide port number override (default=35142)

• --insecure: e.g. proceed with caution on browser. test servers that dont have certification and to proceed immediately

• --k8s-config: Specify the path to the relevant kubeconfig

• --k8s-context: The relevant context for the test (if there are multiple contexts in the kubeconfig)

• --k8s-namespace: Namespace to deploy Skyramp worker for test execution

Output flags

Output flags allow you to tune how the final test should be written as the end result.

• --framework:  Testing framework for generated test [playwright, pytest, robot] (default "pytest")

• --language:  Language for generated test [python, typescript] (default "python")

• --deploy-dashboard:    Deploy the Skyramp dashboard for test result collection

• --output: Allows you to specify the name of the generated test file.

• --output-dir: Allows you to specify the directory to store the generated test file.

• --overwrite: Overwrite existing tests without additional confirmation

Load Flags

Skyramp’s load testing capabilities support a number of flags geared at configuring simulated traffic for evaluation of API performance.

• --default-count: Number of times Skyramp executes the defined request [default=None]; this flag needs to be set if default-duration is not specified.

• --default-duration: Duration of the load test execution in seconds; this flag cannot be used in combination with default-count[default=5]

• --default-num-threads: Number of concurrent threads for load test [default=1]. Concurrent threads represent virtual users enabling you to test the vertical scalability of the service.

• --default-rampup-duration: Specify the duration that Skyramp incrementally increases the requests per second (RPS) until the target RPS are reached [default=None]

• --default-rampup-interval: Specify how often Skyramp increases the RPS until target RPS are reached [default=None]

• --default-target-rps: Specify the maximum RPS of the load test [default=None]