restassured_cli 0.1.1

data/lib/restassured_cli/source/maven/pom.xml

@@ -0,0 +1,14 @@
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>GROUPID</groupId>
+    <artifactId>PROJECTNAME</artifactId>
+    <version>PROJECTVERSION</version>
+    <packaging>pom</packaging>
+    <name>PROJECTNAME</name>
+
+    <modules>
+        <module>testing</module>
+    </modules>
+
+</project>

data/lib/restassured_cli/source/maven/testing/README.md

@@ -0,0 +1,26 @@
+## About
+This testing project is generated by [restassured-cli](https://github.com/eing/restassured-cli).
+
+### To run pre-production tests
+ - Tests are run *without* recompiling. Artifacts are downloaded and testng files are extracted.
+```
+$ cd testing
+$ mvn clean install
+
+$ cd testing/<project>-test-runner
+$ mvn clean install -U -P ci
+$ mvn clean install -U -P qa
+$ mvn clean install -U -P e2e
+$ mvn clean install -U -P perf
+```
+ - For non-standard profiles (other than ci, qa, e2e, perf and production), create your own profiles in test-parent-pom.
+
+## Eclipse
+
+* To import testing project into Eclipse :
+
+ - cd testing; mvn eclipse:eclipse
+
+ - File > Import > Maven > Existing Maven Projects > Browse to testing root directory (all selections checked) and click Finish
+
+* To run tests for environments other than qa, e.g. for CI, add **-Dtargetenv=ci** in Run Configuration’s VM arguments/options.

data/lib/restassured_cli/source/maven/testing/pom.xml

@@ -0,0 +1,27 @@
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <!-- TODO: add your project parent pom here -->
+    <!--
+    <parent>
+        <groupId>com.intuit.sbg</groupId>
+        <artifactId>SBG-Parent-pom</artifactId>
+        <version>1.0.0</version>
+    </parent>
+    -->
+
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>GROUPID.tests</groupId>
+    <artifactId>SERVICENAME-tests</artifactId>
+    <version>PROJECTVERSION</version>
+    <name>SERVICENAME-tests</name>
+    <packaging>pom</packaging>
+
+    <modules>
+        <module>SERVICENAME-test-parent-pom</module>
+        <module>SERVICENAME-test-library</module>
+        <module>SERVICENAME-service-tests</module>
+        <module>SERVICENAME-perf-tests</module>
+        <module>SERVICENAME-production-tests</module>
+    </modules>
+</project>

data/lib/restassured_cli/source/maven/testing/sampleservice-perf-tests/LoginTest.java

@@ -0,0 +1,14 @@
+package GROUPID.tests.perf;
+
+import org.testng.annotations.Test;
+
+/**
+ * Placeholder for Perf tests.
+ */
+public class LoginTest {
+
+    @Test
+    public void sampleTest() {
+
+    }
+}

data/lib/restassured_cli/source/maven/testing/sampleservice-perf-tests/pom.xml

@@ -0,0 +1,14 @@
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>GROUPID.tests</groupId>
+        <artifactId>SERVICENAME-test-parent-pom</artifactId>
+        <version>PROJECTVERSION</version>
+        <relativePath>../SERVICENAME-test-parent-pom</relativePath>
+    </parent>
+
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>SERVICENAME-perf-tests</artifactId>
+    <name>SERVICENAME-perf-tests</name>
+
+</project>

data/lib/restassured_cli/source/maven/testing/sampleservice-perf-tests/testng-perf-notests.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+<suite name="SERVICENAME-perf-tests">
+    <test name="SERVICENAME performance tests">
+        <packages>
+            <package name="GROUPID.tests.perf.*"/>
+        </packages>
+    </test>
+</suite>

data/lib/restassured_cli/source/maven/testing/sampleservice-perf-tests/testng-perf.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+<suite name="SERVICENAME-perf-tests">
+    <test name="SERVICENAME performance tests">
+        <classes>
+            <class name="GROUPID.tests.perf.LoginTest"/>
+        </classes>
+    </test>
+</suite>

data/lib/restassured_cli/source/maven/testing/sampleservice-production-tests/logback.xml

@@ -0,0 +1,15 @@
+<configuration>
+    <statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener"/>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <!-- encoders are assigned the type
+             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="DEBUG">
+        <appender-ref ref="STDOUT"/>
+    </root>
+
+</configuration>

data/lib/restassured_cli/source/maven/testing/sampleservice-production-tests/pom.xml

@@ -0,0 +1,21 @@
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>GROUPID.tests</groupId>
+        <artifactId>SERVICENAME-test-parent-pom</artifactId>
+        <version>PROJECTVERSION</version>
+        <relativePath>../SERVICENAME-test-parent-pom</relativePath>
+    </parent>
+
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>SERVICENAME-production-tests</artifactId>
+    <name>SERVICENAME-production-tests</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>GROUPID.tests</groupId>
+            <artifactId>SERVICENAME-test-library</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+</project>

data/lib/restassured_cli/source/maven/testing/sampleservice-production-tests/testng-production.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+<suite name="SERVICENAME-production-tests">
+    <test name="SERVICENAME production tests">
+        <packages>
+            <package name="GROUPID.tests.production.*"/>
+        </packages>
+    </test>
+</suite>

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/default/SampleTest.java

@@ -0,0 +1,30 @@
+package GROUPID.tests.service;
+
+import GROUPID.tests.library.sample.base.SampleTestBase;
+import GROUPID.tests.library.sample.base.Constant;
+import com.jayway.restassured.path.json.JsonPath;
+import org.testng.Assert;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
+import static com.jayway.restassured.RestAssured.given;
+import static org.hamcrest.Matchers.equalTo;
+
+/**
+ * Default test generated to demonstrate coding best practices with
+ *  1. SampleTestBase (business domain base class) and
+ *  2. ServiceTestBase (business agnostic base class).
+ */
+public class SampleTest extends SampleTestBase {
+
+    public SampleTest() {
+    }
+
+    /**
+     */
+    @Test
+    public void testDummy() {
+        logger.debug("use Logger and not System.out");
+    }
+
+}

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/default/testng-ci.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+<suite name="SERVICENAME-ci-tests">
+    <test name="SERVICENAME service BATS">
+        <classes>
+            <class name="GROUPID.tests.service.SampleTest">
+                <methods>
+                    <include name="testDummy"/>
+                </methods>
+            </class>
+        </classes>
+    </test>
+</suite>

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/default/testng-e2e.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+<suite name="SERVICENAME-e2e-tests">
+    <test name="SERVICENAME service integration tests">
+        <classes>
+            <class name="GROUPID.tests.service.SampleTest">
+                <methods>
+                    <include name="testDummy"/>
+                </methods>
+            </class>
+        </classes>
+    </test>
+</suite>

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/default/testng-qa.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+<suite name="SERVICENAME-qa-tests">
+    <test name="SERVICENAME service tests">
+        <packages>
+            <package name="GROUPID.tests.service.*"/>
+        </packages>
+    </test>
+</suite>

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/full/SampleComponentTest.java

@@ -0,0 +1,312 @@
+package GROUPID.tests.service;
+
+import GROUPID.tests.library.sample.base.SampleTestBase;
+import GROUPID.tests.library.schema.Customer;
+import GROUPID.tests.library.schema.Phone;
+
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.jayway.restassured.filter.session.SessionFilter;
+import com.jayway.restassured.http.ContentType;
+import com.jayway.restassured.response.Response;
+import org.hamcrest.Matchers;
+import org.testng.Assert;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
+import javax.xml.soap.MessageFactory;
+import javax.xml.soap.Name;
+import javax.xml.soap.SOAPBody;
+import javax.xml.soap.SOAPBodyElement;
+import javax.xml.soap.SOAPElement;
+import javax.xml.soap.SOAPEnvelope;
+import javax.xml.soap.SOAPMessage;
+import javax.xml.soap.SOAPPart;
+import java.io.ByteArrayOutputStream;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+
+import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.any;
+import static com.github.tomakehurst.wiremock.client.WireMock.get;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching;
+import static com.jayway.restassured.RestAssured.given;
+import static org.hamcrest.CoreMatchers.hasItems;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.notNullValue;
+
+/**
+ * Sample tests to show how to use RestAssured, and hamcrest assertions.
+ * WireMock is used to stub responses to http://localhost:9999.
+ * @author eing
+ */
+public class SampleComponentTest extends SampleTestBase {
+
+    public SampleComponentTest() {
+    }
+
+    /**
+     * Add stubs to WireMock server for this set of tests.
+     */
+    @BeforeClass
+    public void setup() {
+        /**
+         * Create a JSON response using JsonNodeFactory instead of hardcoding in string which is error prone.
+         * {
+                "customer": {
+                    "firstname": "Jane", "lastname": "Smith",
+                    "phone": [
+                        { "number": "650-123-4566", "type": "work" },
+                        { "number": "650-123-4567", "type": "work" },
+                        { "number": "650-123-4568", "type": "fax" } ],
+                    "city": "Mountain View", "state": "CA", "zip": 94040 }
+         }
+         */
+        ObjectNode phone1 = new ObjectNode(JsonNodeFactory.instance);
+        phone1.put("number", "650-123-4566");
+        phone1.put("type", "work");
+        ObjectNode phone2 = new ObjectNode(JsonNodeFactory.instance);
+        phone2.put("number", "650-123-4567");
+        phone2.put("type", "work");
+        ObjectNode phone3 = new ObjectNode(JsonNodeFactory.instance);
+        phone3.put("number", "650-123-4568");
+        phone3.put("type", "fax");
+        ArrayList<ObjectNode> phones = new ArrayList<ObjectNode>();
+        phones.add(phone1);
+        phones.add(phone2);
+        phones.add(phone3);
+        ObjectNode customerJson = new ObjectNode(JsonNodeFactory.instance);
+        customerJson.
+                putObject("customer").
+                put("firstname", "Jane").
+                put("lastname", "Smith").
+                putPOJO("phone", phones).
+                put("city", "Mountain View").
+                put("state", "CA").
+                put("zip", 94040);
+        // Stub response for SimpleGet
+        wireMockServer.
+                givenThat(
+                        (any(urlMatching("/customers/[0-9]+")).
+                                willReturn(aResponse().
+                                        withHeader("Content-Type", ContentType.JSON.toString()).
+                                        withStatus(200).
+                                        withBody(customerJson.toString()))));
+        // Stub response for Auth
+        wireMockServer.
+                givenThat(
+                        (get(urlEqualTo("/auth")).
+                                willReturn(aResponse().
+                                        withHeader("Content-Type", ContentType.ANY.toString()).
+                                        withHeader("JSESSIONID", "AS34979870H").
+                                        withStatus(200))));
+        // Stub response for all other requests (setting to lowest priority)
+        wireMockServer.
+                givenThat(
+                        (any(urlPathMatching(".*")).atPriority(10).
+                                willReturn(aResponse().
+                                        withHeader("Content-Type", ContentType.ANY.toString()).
+                                        withStatus(200))));
+
+    }
+
+    /**
+     * Example of simple get request.
+     */
+    @Test
+    public void testSimpleGet() {
+        //@formatter:off
+        given().
+                spec(requestSpec).
+                contentType(ContentType.JSON).
+        when().
+                get("/customers/1").
+        then().assertThat().
+                statusCode(200).
+                body("customer.firstname", equalTo("Jane")).
+                body("customer.lastname", equalTo("Smith"));
+        //@formatter:on
+    }
+
+    /**
+     * Example of session filter in request.
+     */
+    @Test
+    public void testSessionFilter() {
+        SessionFilter filter = new SessionFilter();
+        //@formatter:on
+        given().
+                spec(requestSpec).
+                auth().basic("janesmith", "xx93k2m3b1").
+                filter(filter).
+        when().
+                get("/auth").
+        then().assertThat().
+                header("JSESSIONID", notNullValue());
+
+        // Reuse session filter that is now populated with session id
+        given().
+                spec(requestSpec).
+                filter(filter).
+        when().
+                get("/customers/2");
+        //@formatter:on
+    }
+
+    /**
+     * Example of object serialization in request.
+     */
+    @Test
+    public void testObjectSerialization() {
+        Customer customer = new Customer();
+        customer.setFirstname("Jane");
+        customer.setLastname("Smith");
+        //@formatter:off
+        Response response =
+                given().
+                        spec(requestSpec).
+                        body(customer).
+                when().
+                        post("/customers/");
+        //@formatter:on
+    }
+
+    /**
+     * Example of object deserialization in response.
+     */
+    @Test
+    public void testObjectDeserialization() {
+        //@formatter:off
+        Customer customer =
+                given().
+                        spec(requestSpec).
+                when().
+                        get("/customers/3").
+                then().assertThat().
+                        extract().jsonPath().getObject("customer", Customer.class);
+        //@formatter:on
+        logger.debug(customer.toString());
+    }
+
+    /**
+     * Example of asserting an array item.
+     */
+    @Test
+    public void testComplexAssertionsGetArrayItem() {
+        //@formatter:off
+        Phone phone =
+                given().
+                        spec(requestSpec).
+                when().
+                        get("/customers/4").
+                then().
+                        body("customer.phone.type", hasItems("work", "fax")).
+                        extract().jsonPath().getObject("customer.phone[0]", Phone.class);
+        //@formatter:on
+        assertThat(phone.getType(), is("work"));
+    }
+
+    /**
+     * Example of asserting arrays.
+     */
+    @Test
+    public void testComplexAssertionsGetList() {
+        //@formatter:off
+        List<HashMap> phoneList =
+                given().
+                        spec(requestSpec).
+                when().
+                        get("/customers/4").
+                then().
+                        body("customer.phone.type", hasItems("work", "fax")).
+                        extract().jsonPath().getList("customer.phone", HashMap.class);
+        //@formatter:on
+        assertThat(phoneList.size(), Matchers.is(3));
+        for (HashMap phone : phoneList) {
+            logger.debug(phone.toString());
+            String phoneNumber = phone.get("number").toString();
+            switch (phoneNumber) {
+                case "650-123-4566":
+                    assertThat(phone.get("type").toString(), is("work"));
+                    break;
+                case "650-123-4567":
+                    assertThat(phone.get("type").toString(), is("work"));
+                    break;
+                case "650-123-4568":
+                    assertThat(phone.get("type").toString(), is("fax"));
+                    break;
+                default:
+                    Assert.fail(phoneNumber + "Did not match any of the expected phone numbers");
+                    break;
+            }
+        }
+    }
+
+    /**
+     * Example of asserting using groovy closures.
+     */
+    @Test
+    public void testComplexAssertionsUsingGroovyClosures() {
+        //@formatter:off
+        List<HashMap> phoneList =
+                given().
+                        spec(requestSpec).
+                when().
+                        get("/customers/5").
+                then().
+                        extract().jsonPath().get("customer.phone.findAll { phone -> phone.type == \"work\" }");
+        //@formatter:on
+        assertThat(phoneList.size(), Matchers.is(2));
+    }
+
+    /**
+     * Example of soap messaging in RestAssured.
+     * @throws Exception
+     */
+    @Test
+    public void testSOAPMessage() throws Exception {
+        /*
+        Construct SOAP Request Message instead of hardcoding as a string which is error prone:
+        <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
+            <SOAP-ENV:Header/>
+            <SOAP-ENV:Body>
+                <GetVendor>
+                    <id>1290</id>
+                </GetVendor>
+            </SOAP-ENV:Body>
+        </SOAP-ENV:Envelope>
+         */
+        MessageFactory messageFactory = MessageFactory.newInstance();
+        SOAPMessage soapMessage = messageFactory.createMessage();
+        SOAPPart soapPart = soapMessage.getSOAPPart();
+        SOAPEnvelope envelope = soapPart.getEnvelope();
+        SOAPBody soapBody = envelope.getBody();
+
+        Name bodyName = envelope.createName("GetVendor");
+        SOAPBodyElement vendorElement = soapBody.addBodyElement(bodyName);
+        SOAPElement firstnameElement = vendorElement.addChildElement(envelope.createName("id"));
+        firstnameElement.addTextNode("1290");
+        soapMessage.saveChanges();
+
+        ByteArrayOutputStream out = new ByteArrayOutputStream();
+        soapMessage.writeTo(out);
+        String soapMessageInText = new String(out.toByteArray());
+        //@formatter:off
+        given().
+                spec(requestSpec).
+                header("SOAPAction", "http://localhost/getVendor").
+                contentType("application/soap+xml; charset=UTF-8;").
+                body(soapMessageInText).
+        when().
+                post("/v1/vendors").
+        then().assertThat().
+                statusCode(200);
+        //@formatter:off
+    }
+
+}