Quickstart
Generate Your First Test
Generate Your First Test
Introduction
This guide will show you how to rapidly generate and execute your first test using Skyramp. By following these simple steps, you'll immediately experience how Skyramp simplifies the automation of functional testing, ensuring deterministic and reliable test execution from the first run.
Prerequisites
Skyramp CLI installed
Skyramp Python Library installed
Pytest installed
Refer to the Installation Guide if you haven't completed these steps yet.
Generate Your First Test
For this quickstart, we will generate an integration test for the /products endpoint of our Demo Shop application. The Demo Shop simulates a basic e-commerce application where users can create, update, and manage products and orders. Refer to the Demo Shop documentation for additional details.
Run the following command in your terminal to generate the integration test:
skyramp generate integration rest https://demoshop.skyramp.dev/api/v1/products \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.jsonUpon completion, Skyramp creates a fully executable Python test file (products_integration_test.py) that can be run immediately.
Explanation of Command
https://demoshop.skyramp.dev/api/v1/products: Defines the URL to the endpoint we aim to test.--language python: Specifies the test output language. We currently support Python, Java, and TypeScript.--framework pytest: Specify the test execution framework of choice.--api-schema: Points to the OpenAPI schema used to generate the test. We also support sample data and traces as inputs for test generation.
Execute your Test
Since the Skyramp Demo Shop does not require authentication, you can immediately execute the generated test using Pytest:
python3 -m pytest products_integration_test.pyYour integration test will perform the following sequence of actions:
Creation: Adds a new product to the Demo Shop.
Retrieval: Confirms the product has been successfully added.
Update: Modifies details of the created product.
Deletion: Deletes the created and modified product.
The test automatically identifies the relevant path parameters, intelligently chains the different requests together, and executes the test against the specified URL
Reviewing Test Results
By default, Pytest provides clear and concise output indicating the success or failure of each step executed:
Each executed test will be displayed clearly in the terminal.
All encountered errors or issues will be neatly summarized for easy debugging at the end.
You can customize Pytest’s output to suit your team's preferences by following the Pytest documentation.
Next Steps
Congratulations on generating and executing your first Skyramp test! To learn more about the generated test and understand customization options, please visit the Integration Test Documentation.
Let’s automate testing together!
Related topics
Generate Your First Test
Introduction
This guide will show you how to rapidly generate and execute your first test using Skyramp. By following these simple steps, you'll immediately experience how Skyramp simplifies the automation of functional testing, ensuring deterministic and reliable test execution from the first run.
Prerequisites
Skyramp CLI installed
Skyramp Python Library installed
Pytest installed
Refer to the Installation Guide if you haven't completed these steps yet.
Generate Your First Test
For this quickstart, we will generate an integration test for the /products endpoint of our Demo Shop application. The Demo Shop simulates a basic e-commerce application where users can create, update, and manage products and orders. Refer to the Demo Shop documentation for additional details.
Run the following command in your terminal to generate the integration test:
skyramp generate integration rest https://demoshop.skyramp.dev/api/v1/products \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.jsonUpon completion, Skyramp creates a fully executable Python test file (products_integration_test.py) that can be run immediately.
Explanation of Command
https://demoshop.skyramp.dev/api/v1/products: Defines the URL to the endpoint we aim to test.--language python: Specifies the test output language. We currently support Python, Java, and TypeScript.--framework pytest: Specify the test execution framework of choice.--api-schema: Points to the OpenAPI schema used to generate the test. We also support sample data and traces as inputs for test generation.
Execute your Test
Since the Skyramp Demo Shop does not require authentication, you can immediately execute the generated test using Pytest:
python3 -m pytest products_integration_test.pyYour integration test will perform the following sequence of actions:
Creation: Adds a new product to the Demo Shop.
Retrieval: Confirms the product has been successfully added.
Update: Modifies details of the created product.
Deletion: Deletes the created and modified product.
The test automatically identifies the relevant path parameters, intelligently chains the different requests together, and executes the test against the specified URL
Reviewing Test Results
By default, Pytest provides clear and concise output indicating the success or failure of each step executed:
Each executed test will be displayed clearly in the terminal.
All encountered errors or issues will be neatly summarized for easy debugging at the end.
You can customize Pytest’s output to suit your team's preferences by following the Pytest documentation.
Next Steps
Congratulations on generating and executing your first Skyramp test! To learn more about the generated test and understand customization options, please visit the Integration Test Documentation.
Let’s automate testing together!
Related topics
Generate Your First Test
Introduction
This guide will show you how to rapidly generate and execute your first test using Skyramp. By following these simple steps, you'll immediately experience how Skyramp simplifies the automation of functional testing, ensuring deterministic and reliable test execution from the first run.
Prerequisites
Skyramp CLI installed
Skyramp Python Library installed
Pytest installed
Refer to the Installation Guide if you haven't completed these steps yet.
Generate Your First Test
For this quickstart, we will generate an integration test for the /products endpoint of our Demo Shop application. The Demo Shop simulates a basic e-commerce application where users can create, update, and manage products and orders. Refer to the Demo Shop documentation for additional details.
Run the following command in your terminal to generate the integration test:
skyramp generate integration rest https://demoshop.skyramp.dev/api/v1/products \
--language python \
--framework pytest \
--api-schema https://demoshop.skyramp.dev/openapi.jsonUpon completion, Skyramp creates a fully executable Python test file (products_integration_test.py) that can be run immediately.
Explanation of Command
https://demoshop.skyramp.dev/api/v1/products: Defines the URL to the endpoint we aim to test.--language python: Specifies the test output language. We currently support Python, Java, and TypeScript.--framework pytest: Specify the test execution framework of choice.--api-schema: Points to the OpenAPI schema used to generate the test. We also support sample data and traces as inputs for test generation.
Execute your Test
Since the Skyramp Demo Shop does not require authentication, you can immediately execute the generated test using Pytest:
python3 -m pytest products_integration_test.pyYour integration test will perform the following sequence of actions:
Creation: Adds a new product to the Demo Shop.
Retrieval: Confirms the product has been successfully added.
Update: Modifies details of the created product.
Deletion: Deletes the created and modified product.
The test automatically identifies the relevant path parameters, intelligently chains the different requests together, and executes the test against the specified URL
Reviewing Test Results
By default, Pytest provides clear and concise output indicating the success or failure of each step executed:
Each executed test will be displayed clearly in the terminal.
All encountered errors or issues will be neatly summarized for easy debugging at the end.
You can customize Pytest’s output to suit your team's preferences by following the Pytest documentation.
Next Steps
Congratulations on generating and executing your first Skyramp test! To learn more about the generated test and understand customization options, please visit the Integration Test Documentation.
Let’s automate testing together!