Test Generation using OpenAPI Spec

1. Generate test from request data

Skyramp can generate load tests for a single method based on sample request data. This enables users to quickly generate tests if no API spec is available or test scenarios depend on specific data.

When generating for all methods of an endpoint, you can also specify request data in combination with the API schema to override the request body from the schema for the POST request.

request.json

{
    "category": "electronics",
    "description": "speaker",
    "image_url": "photo",
    "in_stock": false,
    "name": "boombox",
    "price": 25
}

Generate Command

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--request-data

2. Specify form parameters for a POST request

For POST requests, you can provide form parameters instead of an API schema or sample request data to define the request body.

When generating for all methods of an endpoint, you can also specify form params in combination with the API schema to override the request body from the schema for the POST request.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--form-params category=electronics \
--form-params description=speaker \
--form-params image_url=photo \
--form-params in_stock=false \
--form-params name=boombox \
--form-params price=25

3. Change the authentication type

By default, Skyramp assumes a Bearer token. You can define the key of your authentication header with the auth-header flag.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--auth-header X-API-KEY \
--api-schema

4. Specification of path parameters

Skyramp also allows you to define path parameters in the generation command. The path-param flag will override all relevant path parameters with your specified value.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
--language python \
--framework pytest \
--path-params product_id=2 \
--api-schema

5. Specify query parameters

You can specify query parameters when generating tests for a specific method.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X GET \
--language python \
--framework pytest \
--query-params limit=5 \
--query-params order=desc \
--api-schema

6. Specify test name and directory

You can override the default test name and specify the directory to save the generated test.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.json \
--output post_products_load_test.py \
--output-dir

7. Test generation for Robot framework

Skyramp also supports the Robot framework in Python. This section shows you how to generate and execute tests using Robot.

Generate Command

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework robot \
--api-schema

This command generates two files:

• products_POST_load_test.py

• products_POST_load_test.robot (simple Robot wrapper file)

Execute the load test

Ensure that authentication is properly set up. Run the test using the Robot framework. You can reference the generated Python file either in an existing robot file of yours or leverage the simple wrapper file we generate.

# Prerequisites
pip3 install robotframework

# Execution of load test for products/POST 
python3 -m

The results will be outputted following the typical stdout from Robot. You can find more information on the generated outputs in the Robot documentation.

8. Change the test execution runtime to Docker

Skyramp also offers seamless support for testing applications in Docker. This allows you to test your services without worrying about network configurations and port mapping while developing locally. By default, Skyramp provides a Docker network where the test can be executed.

In this example, we are using api-sample as the service alias for our application. When testing your service, replace it with the service name you want to test.

skyramp generate load rest http://api-sample:8000/api/v1/products \
-X POST \
--language python \
--framework pytest \
--runtime docker \
--api-schema

You can also specify your own Docker network as follows:

skyramp generate load rest http://api-sample:8000/api/v1/products \
-X POST \
--language python \
--framework pytest \
--runtime docker \
--docker-network api-insight_default \
--docker-skyramp-port 35142 \
--api-schema

9. Deploy the Skyramp Dashboard

Skyramp also offers a simple dashboard to collect and help you analyze your test results. The Skyramp Dashboard is a lightweight Docker image that will automatically be brought up when executing the test. Please specify the --deploy-dashboard flag in the generation command.

Post execution, the dashboard will be available under http://localhost:3000/tests.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.json \
--deploy-dashboard

Load Test Configuration Examples

10. Specify load count

Skyramp can execute a load test scenario as many times as specified by the user with the --default-count flag. This flag cannot be used in combination with the --default-duration flag.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.json \
--default-count 10

11. Specify load duration

Skyramp can execute a load test scenario as many times as possible in a duration (in seconds) specified by the user with the --default-duration flag. This flag cannot be used in combination with the --default-count flag.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.json \
--default-duration 10

12. Specify rampup parameters

You can specify conditions around how quickly and often Skyramp should increase load to your system. Use the --default-rampup-interval to specify how many times to increase the RPS and --default-rampup-duration to specify how long (in seconds) Skyramp should take to ramp up to the target/maximum RPS.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.json \
--default-duration 20
--default-rampup-interval 3
--default-rampup-duration 10

13. Specify target load

You can specify a target load for the test with --default-target-rps

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.json \
--default-duration 20
--default-rampup-interval 3
--default-rampup-duration 10
--default-target-rps 10

14. Test Vertical Scalability

You can specify --default-num-threads to open concurrent threads for your load test. Concurrent threads represent virtual users enabling you to test the vertical scalability of the service.

skyramp generate load rest https://demoshop.skyramp.dev/api/v1/products \
-X POST \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.json \
--default-duration 20
--default-num-threads 3

Test Generation from Skyramp Trace

For these examples, please ensure you have the following sample trace file saved in your local directory.

Recap: Including / Excluding URLs from Trace

Skyramp provides special flags related to filtering certain URLs from traces to focus your load test generation on the most critical flows.

URLs need to be specified either as an exact path to the endpoint or in combination with a wildcard. For example:

• demoshop.skyramp.dev/products will only filter for POST and GET of the products endpoint.

• demoshop.skyramp.dev/products* will filter for all products endpoints + any nested endpoints.

• demoshop.skyramp.dev/products/* will filter only for any nested endpoints that require a product ID. It will not generate requests for POST and GET products.

For endpoints that require path parameters, please replace the path parameter with the wildcard:

• Convert demoshop.skyramp.dev/products/{product_id}/reviews to demoshop.skyramp.dev/products/*/reviews.

15. Include certain URLs from the trace in the test

If you are only looking to test specific requests collected in your trace, you can filter for those URLs using the --include flag.

skyramp generate load rest \
--language python \
--framework pytest \
--trace trace.json \
--include

16. Exclude certain URLs from the trace in the test

If your trace collected requests that are irrelevant to your load test, you can exclude those URLs using the --exclude flag.

skyramp generate load rest \
--language python \
--framework pytest \
--trace trace.json \
--exclude