Quickstart

java

Run the following command in your terminal to generate an integration test:

skyramp generate integration rest https://demoshop.skyramp.dev/api/v1/products \
--language java \
--framework junit \
--api-schema

Upon completion, Skyramp creates a fully executable Java test file (ProductsIntegrationTest.java) that can be compiled and run immediately.

Explanation of Command

https://demoshop.skyramp.dev/api/v1/products: Defines the URL to the endpoint we aim to test.
--language: Specifies the test output language. We currently support Python, Java, and TypeScript.
--framework: 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 any authentication, you can immediately compile and execute the generated test using the following commands:

Compile your test

javac -cp "./lib/*" -d

Execute your test

JUNIT_PLATFORM_VER="1.9.3"
classpath="target:$(echo ./lib/*.jar | tr ' ' ':')"
java -jar "./lib/junit-platform-console-standalone-${JUNIT_PLATFORM_VER}.jar" \
    --classpath "$classpath" \
    --include-engine=junit-jupiter \
    --select-class=ProductsIntegrationTest \
    --reports-dir

Your 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.

Review Test Results

By default, JUnit 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 summarized for easy debugging at the end.

You can adjust the output behavior following this 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!

Execute your Test

Since the Skyramp Demo Shop does not require any authentication, you can immediately compile and execute the generated test using the following commands:

Compile your test

javac -cp "./lib/*" -d

Execute your test

JUNIT_PLATFORM_VER="1.9.3"
classpath="target:$(echo ./lib/*.jar | tr ' ' ':')"
java -jar "./lib/junit-platform-console-standalone-${JUNIT_PLATFORM_VER}.jar" \
    --classpath "$classpath" \
    --include-engine=junit-jupiter \
    --select-class=ProductsIntegrationTest \
    --reports-dir

Your 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.

Review Test Results

By default, JUnit 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 summarized for easy debugging at the end.

You can adjust the output behavior following this 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!

Execute your Test

Since the Skyramp Demo Shop does not require any authentication, you can immediately compile and execute the generated test using the following commands:

Compile your test

javac -cp "./lib/*" -d

Execute your test

JUNIT_PLATFORM_VER="1.9.3"
classpath="target:$(echo ./lib/*.jar | tr ' ' ':')"
java -jar "./lib/junit-platform-console-standalone-${JUNIT_PLATFORM_VER}.jar" \
    --classpath "$classpath" \
    --include-engine=junit-jupiter \
    --select-class=ProductsIntegrationTest \
    --reports-dir

Your 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.

Review Test Results

By default, JUnit 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 summarized for easy debugging at the end.

You can adjust the output behavior following this 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!

java

Explanation of Command

Execute your Test

Review Test Results

Next Steps

Related topics

Explanation of Command

Execute your Test

Review Test Results

Next Steps

Related topics

Explanation of Command

Execute your Test

Review Test Results

Next Steps

Related topics