README.md

Overview

Bastion is a library that eases the development of end-to-end tests for HTTP APIs. A typical user would write tests using Bastion based off of some sort of API specification. This API specification can be anything like a WADL file, RAML file or a JSON schema. A test engineer would prepare requests and responses based on these specifications to test the overall process of calling these APIs.

Usage

Test

• GET Request:

Bastion.request("Get the Restaurant's Name", GeneralRequest.get("http://localhost:9876/restaurant"))
        .withAssertions((statusCode, response, model) -> assertThat(model).isEqualTo("The Sushi Parlour"))
        .call();

• POST Request:

Bastion.request("Change the Restaurant's Name", GeneralRequest.post("http://localhost:9876/restaurant", "The Fish Parlour"))
        .withAssertions((statusCode, response, model) -> assertThat(model).isEqualTo("The Fish Parlour"))
        .call();

• JSON Assertion: (property order in response does not affect test)

Bastion.request("Get Nigiri Info", GeneralRequest.get("http://localhost:9876/nigiri"))
        .withAssertions(JsonResponseAssertions.fromString(200, "{ \"id\":5, \"name\":\"Salmon Nigiri\", \"price\":23.55 }"))
        .call();

• JSON Request:

Bastion.request("First Request", JsonRequest.postFromString("http://localhost:9876/sushi", "{ " +
        "\"name\":\"sashimi\", " +
        "\"price\":\"5.60\", " +
        "\"type\":\"SASHIMI\" " +
        "}"
)).withAssertions(JsonResponseAssertions.fromString(201, "{ " +
                "\"id\":5, " +
                "\"name\":\"sashimi\", " +
                "\"price\":5.60, " +
                "\"type\":\"SASHIMI\" " +
                "}"
        ).ignoreValuesForProperties("/id")
).call();

• JSON Request/Assertion loaded from file:

Bastion.request("Create Sushi", JsonRequest.postFromResource(BASE_URL, "classpath:/json/create_sushi_request.json"))
        .withAssertions(JsonResponseAssertions.fromResource(201, "classpath:/json/create_sushi_response.json").ignoreValuesForProperties("/id"))
        .call();

• Form URL Encoded Data Request:

Bastion.request("Order Sashimi", FormUrlEncodedRequest.post("http://localhost:9876/sashimi")
        .addDataParameter("quantity", "5")
        .addDataParameter("table", "61")
).withAssertions(JsonResponseAssertions.fromString(200, "{ \"id\":5, \"name\":\"Sashimi\", \"price\":5.95 }"))
        .call();

• Bind the response entity to a model object:

Sushi createdSushi = Bastion.request("Create Sushi", JsonRequest.postFromString("http://localhost:9876/sushi", "{ " +
        "\"name\":\"sashimi\", " +
        "\"price\":\"5.60\", " +
        "\"type\":\"SASHIMI\" " +
        "}"
)).bind(Sushi.class).withAssertions(JsonResponseAssertions.fromString(201, "{ " +
                "\"id\":5, " +
                "\"name\":\"sashimi\", " +
                "\"price\":5.60, " +
                "\"type\":\"SASHIMI\" " +
                "}"
        ).ignoreValuesForProperties("id")
).call().getModel();

• Groovy (using multi-line strings):

Bastion.request("First Request", JsonRequest.postFromString("http://localhost:9876/sushi",
        '''{
        "name":"sashimi",
        "price":"5.60",
        "type":"SASHIMI"
    }'''
)).withAssertions(JsonResponseAssertions.fromString(201,
        '''{
           "id":5,
           "name":"sashimi",
           "price":5.60,
           "type":"SASHIMI"
        }'''
).ignoreValuesForProperties("/id")
).call()

Dependency

Use a dependency management tool such as Maven to download the Bastion library for use in your project. Add the following dependency to your POM file:

<dependency>
    <groupId>rocks.bastion</groupId>
    <artifactId>bastion</artifactId>
    <version>0.4-BETA</version>
    <scope>test</scope>
</dependency>

Alternatively, use Groovy Grapes to use Bastion in your Groovy tests/scripts:

@Grapes(
    @Grab(group='rocks.bastion', module='bastion', version='0.4-BETA')
)

Building

Use Maven to build Bastion and run the associated tests. After checking out the repository use the following command to build and test the source code.

mvn install

Contribute

Bastion is an open-source project! Open-source means that we encourage you to contribute in any way you can. We will accept all contributions, in any shape or form, that help make Bastion better. Here are some things you can do to contribute:

• Send a positive comment to the Bastion contributers. :)
• Submit an issue on GitHub containing a bug report or suggestion. We ask you to spend a couple minutes before submitting an issue to check that it has not been submitted earlier. When opening an issue, try to include as much detail as possible so that the community can more easily address your concern.
• Submit a pull request for any of our open issues. Some issues are more easy to implement than others and, if you're just starting out, these issues let you get used to the Bastion code structure. If you need any assistance, simply comment on the issue at hand and we'll be glad to help. We ask that you adhere to a consistent code style and employ good programming practice but don't worry if you're unsure about anything: we'll help you get your submission up to scratch as well.
• You can also submit a pull request which is not related to any of the issues currently on GitHub. If you have developed your own Request or Assertions implementations, for example, and you believe they could be useful to the rest of the Bastion community, we will add them to the library for use in future versions of Bastion.
• Make our User Guide better. Our User Guide is very important to us and we strive to keep it as up to date as possible. If you spot any omissions, typos, grammatical errors or have an idea of how it can be improved, please submit a pull request. The files for our user guide can be found in the src/docs/md directory.
• Spread the word. Tell your colleagues about Bastion or write a blog post about Bastion. The more people we can tell Bastion about, the better!