readyapi4j

Swagger Assert4j TestServer executor

The testserver module provides a test execution engine that utilizes a remote TestServer instance for executing recipes.

See Concepts for general info and the Core Module for an overview of the Java API.

TestServer Extensions

ReadyAPI TestServer provides a number of additional features that are not available when using swagger-assert4j with the local execution engine, namely;

• The possibility to execute tests in existing ReadyAPI/SoapUI projects
• The possibility to validate APIs based on their Swagger definition
• The possibility to perform data-driven testing in Test Recipes

The corresponding REST API exposed by the TestServer for this functionality is available on SwaggerHub This module provides a Java API for these extensions, as described below

Using the TestServerClient

The TestServerClient class is the main entry point to the additional features provided by TestServer:

TestServerClient testServerClient = TestServerClient.fromUrl(TESTSERVER_URL)
                .withCredentials(TESTSERVER_USER, TESTSERVER_PASSWORD);

Executing TestRecipes on the server is done via the TestServerRecipeExecutor created with TestServerClient.createRecipeExecutor, which is the same Executor created when using the facade for remote execution.

Running existing projects

Use the ProjectExecutor to execute existing SoapUI / ReadyAPI projects.

TestServerClient testServerClient = TestServerClient.fromUrl(TESTSERVER_URL)
                .withCredentials(TESTSERVER_USER, TESTSERVER_PASSWORD);

ProjectExecutor projectExecutor = testServerClient.createProjectExecutor();

Projects to be executed can reside either locally or remotely on the server (using the TestServer Repository functionality), create and pass corresponding instances of ProjectExecutionRequest and RepositoryProjectExecutionRequest to the execute/submitProject methods.

Before executing tests you can further narrow down which TestSuites/TestCases to run, specify tags, properties, endpoints, etc. by setting the corresponding properties in either of these execution request classes.

Continuing from the above example:

ProjectExecutionRequest request = ProjectExecutionRequest.Builder.forProjectFile(file).build();

// run all tests in entire project asynchronously
projectExecutor.submitProject( request );

// run only one test synchronously
request.setTestCaseName( "My TestCase")
projectExecutor.executeProject( request );

Validating Swagger-defined APIs

ReadyAPI TestServer supports “instant validation” of an API based on its Swagger definition; the server will generate an ad-hoc TestSuite based on this Swagger definition, execute it, and return the result.

This functionality is exposed in Java via the SwaggerApiValidator class, use as follows:

TestServerClient testServerClient = TestServerClient.fromUrl(TESTSERVER_URL)
                .withCredentials(TESTSERVER_USER, TESTSERVER_PASSWORD);

SwaggerApiValidator validator = testServerClient.createApiValidator();

// validate the petstore
Execution execution = validator.validateApiSynchronously( "http://petstore.swagger.io/v2/swagger.json", null, null );

// do something with the result
RecipeExecutionResult result = execution.getExecutionResult();
...

TestServer data-driven testing

The ReadyAPI TestServer adds a number of constructs to the JSON Recipe format to allow for data-driven testing, similar to what is possible with Data Driven testing in SoapUI Pro.

A ServerTestSteps class makes it easy to build the corresponding TestStep, matching the TestSteps class in core.

A quick example of what’s possible with dataGen DataSources, taken from the samples module:

TestRecipe recipe = TestRecipeBuilder.buildRecipe(
        dataGenDataSource()
                .withNumberOfRows(10)
                .withProperties(
                    cityTypeProperty("cityProperty").duplicatedBy(2),
                    mac48ComputerAddressTypeProperty("computerAddressProperty"),
                    randomIntegerTypeProperty("integerProperty")
                )
                .named("DataSourceStep")
                .withTestSteps(
                    GET("http://www.google.se/")
                        .withParameters(
                            query("a", "${DataSourceStep#cityProperty}"),
                            query("b", "${DataSourceStep#computerAddressProperty}"),
                            query("c", "${DataSourceStep#integerProperty}")
                        )
                )
        );

Here we create a recipe that runs a Google search 10 times, each with different values retrieved from the DataSource using PropertyExpansion syntax in the query parameters.

This site is open source. Improve this page.