restassured_cli 0.1.1

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

@@ -0,0 +1,129 @@
+package GROUPID.tests.serviceintegration;
+
+import GROUPID.tests.library.sample.base.SampleTestBase;
+
+import com.jayway.restassured.http.ContentType;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
+import java.util.concurrent.Callable;
+import java.util.concurrent.TimeUnit;
+
+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.urlMatching;
+import static com.github.tomakehurst.wiremock.stubbing.Scenario.STARTED;
+import static com.jayway.awaitility.Awaitility.await;
+import static com.jayway.restassured.RestAssured.given;
+
+/**
+ * Sample test to demonstrate working with an asynchronous batch transaction.
+ * TODO: WireMock is used to stub responses but <b>should be removed for service integration testing</b>.
+ * Stubbing in this test is only for demonstrating purpose.
+ * @author eing
+ */
+public class SampleServiceIntegrationTest extends SampleTestBase {
+
+    public SampleServiceIntegrationTest() {
+    }
+
+    /**
+     * Add stubs to WireMock server for this test.
+     * TODO: Remove this for actual service integration testing.
+     */
+    @BeforeClass
+    public void setup() {
+        //@formatter:off
+        // returns 202: request has been accepted for processing, but the processing has not been completed
+        wireMockServer.
+                givenThat(
+                        any(urlMatching("/batch")).
+                                willReturn(aResponse().
+                                        withHeader("Content-Type", ContentType.JSON.toString()).
+                                        withHeader("X-AX-TRANSACTIONID", "1290").
+                                        withStatus(202)));
+        // returns
+        // 1. state:IN_PROGRESS in header for first and second requests
+        // 2. state:COMPLETE in header on the third request
+        wireMockServer.
+                givenThat(
+                        get(urlMatching("/batch/[0-9]+/status")).
+                                inScenario("Get batch status").
+                        whenScenarioStateIs(STARTED).
+                                willReturn(aResponse().
+                                    withStatus(200).
+                                    withHeader("Content-Type", ContentType.JSON.toString()).
+                                    withHeader("state", "IN_PROGRESS")).
+                                willSetStateTo("Second get status attempt"));
+
+        wireMockServer.
+                givenThat(
+                        get(urlMatching("/batch/[0-9]+/status")).
+                                inScenario("Get batch status").
+                        whenScenarioStateIs("Second get status attempt").
+                                willReturn(aResponse().
+                                        withStatus(200).
+                                        withHeader("Content-Type", ContentType.JSON.toString()).
+                                        withHeader("state", "IN_PROGRESS")).
+                                willSetStateTo("Third get status attempt"));
+
+        wireMockServer.
+                givenThat(
+                        get(urlMatching("/batch/[0-9]+/status")).
+                                inScenario("Get batch status").
+                        whenScenarioStateIs("Third get status attempt").
+                                willReturn(aResponse().
+                                        withStatus(200).
+                                        withHeader("Content-Type", ContentType.JSON.toString()).
+                                        withHeader("state", "COMPLETE")).
+                                willSetStateTo("Batch activity completed"));
+        //@formatter:on
+    }
+
+    /**
+     * Example of an asynchronous request and how to use awaitability.
+     */
+    @Test
+    public void testAsyncOperation() throws Exception {
+        /**
+         * Typically an identifier is returned to the user on a batch process
+         * so that you can use it to poll for its status.
+         */
+        //@formatter:off
+        String batchId =
+                given().
+                    spec(requestSpec).
+                when().
+                        post("/batch").
+                then().
+                        statusCode(202).
+                        extract().header("X-AX-TRANSACTIONID");
+        //@formatter:on
+        await().atMost(3, TimeUnit.SECONDS).until(batchActivityCompleted(batchId));
+    }
+
+    /**
+     * Callback method for Java7. In Java8, you can code it inline in the test i.e.
+     * await().atMost(3, TimeUnit.SECONDS).until(() -> batchActivityCompleted(batchId));
+     * @param batchId batch job identifier to check status on
+     * @return true if state is completed
+     * @throws Exception
+     */
+    private Callable<Boolean> batchActivityCompleted(final String batchId) throws Exception {
+        return new Callable<Boolean>() {
+            public Boolean call() throws Exception {
+                //@formatter:off
+                String state =
+                        given().
+                            spec(requestSpec).
+                        when().
+                                get("/batch/{batchId}/status", batchId).
+                        thenReturn().header("state");
+                //@formatter:on
+                return state.equals("COMPLETE");
+            }
+        };
+    }
+
+}

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/full/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.SampleComponentTest">
+                <methods>
+                    <include name="testSimpleGet"/>
+                </methods>
+            </class>
+        </classes>
+    </test>
+</suite>

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/full/testng-e2e.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-e2e-tests">
+    <test name="SERVICENAME service integration tests">
+        <packages>
+            <package name="GROUPID.tests.serviceintegration.*"/>
+        </packages>
+    </test>
+</suite>

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/full/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/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-service-tests/pom.xml

@@ -0,0 +1,22 @@
+<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-service-tests</artifactId>
+    <name>SERVICENAME-service-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-service-tests/resources/default/sample.properties

@@ -0,0 +1,2 @@
+http.baseurl=http://localhost
+http.port=9999

data/lib/restassured_cli/source/maven/testing/sampleservice-service-tests/resources/e2e/sample.properties

@@ -0,0 +1 @@
+

data/lib/restassured_cli/source/maven/testing/sampleservice-test-library/default/BaseConstant.java

@@ -0,0 +1,48 @@
+package GROUPID.tests.library.base;
+
+/**
+ * Constants used by ServiceTestBase and InternalConfigManager.
+ * TODO: This package should be in a separate project and added as a dependency.
+ * For the purpose of demo, keeping it in the test library module.
+ */
+public final class BaseConstant {
+
+    /**
+     * Private constructor to prevent instantiation.
+     */
+    private BaseConstant() {
+    }
+
+    /**
+     * Key in property file to look for for user specified base url e.g. http://www.intuit.com
+     */
+    public static final String HTTP_PROPERTY_BASEURL = "http.baseurl";
+
+    /**
+     * Key in property file to look for user specified port.
+     */
+    public static final String HTTP_PROPERTY_PORT = "http.port";
+
+    /**
+     * Default directory containing properties file where it will contain all common properties
+     * agnostic of the environment e.g. basePath
+     */
+    public static final String DEFAULT_CONFIG_DIRECTORY = "/default";
+
+    /**
+     * Attribute name to read in environment value i.e. -Dtargetenv=[ci|qa|e2e|perf|production]
+     */
+    public static final String ENVIRONMENT_PROPERTY = "targetenv";
+
+    /**
+     * Default targetenv (target environment) if -Dtargetenv is not specified during test execution outside of
+     * maven profiles e.g. running tests in IDE (with right click, run test).
+     */
+    public static final String ENVIRONMENT_DEFAULT = "qa";
+
+    /**
+     * Default properties file that ServiceTestBase will look for if no file is specified in the constructor.
+     */
+    public static final String PROPERTIES_FILENAME_DEFAULT = "/config.properties";
+}
+

data/lib/restassured_cli/source/maven/testing/sampleservice-test-library/default/InternalConfigManager.java

@@ -0,0 +1,52 @@
+package GROUPID.tests.library.base;
+
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
+
+/**
+ * Helper class to return list of properties.
+ * TODO: This package should be in a separate project and added as a dependency.
+ * For the purpose of demo, keeping it in the test library module.
+ */
+public class InternalConfigManager {
+
+    private final static Logger logger = LoggerFactory.getLogger(InternalConfigManager.class);
+
+    /**
+     * Reads all properties from file.
+     * @return properties
+     */
+    public synchronized static Properties getAllConfig(String propertiesFile) {
+        try {
+            InputStream is = InternalConfigManager.class.getResourceAsStream(propertiesFile);
+            if (is == null) {
+                File file = new File(propertiesFile);
+                if (!file.isDirectory()) {
+                    if (file.exists()) {
+                        is = new FileInputStream(file);
+                    } else {
+                        throw new IOException("File not exist: " + propertiesFile);
+                    }
+                } else {
+                    throw new IOException("Unexpected dir path passed (a file path should be passed): " +
+                            propertiesFile);
+                }
+            }
+            Properties testProperties = new Properties();
+            testProperties.load(is);
+            return testProperties;
+        }
+        catch (Exception ex)
+        {
+            logger.error("Cannot load test configuration");
+            return null;
+        }
+    }
+}

data/lib/restassured_cli/source/maven/testing/sampleservice-test-library/default/ServiceTestBase.java

@@ -0,0 +1,103 @@
+package GROUPID.tests.library.base;
+
+import com.jayway.restassured.RestAssured;
+import com.jayway.restassured.builder.RequestSpecBuilder;
+import com.jayway.restassured.builder.ResponseSpecBuilder;
+import com.jayway.restassured.response.Response;
+import com.jayway.restassured.specification.RequestSpecification;
+import com.jayway.restassured.specification.ResponseSpecification;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Properties;
+
+/**
+ * This is a generic business agnostic base class which provides properties management,
+ * logging and common RestAssured variables such as requestSpec and responseSpec.
+ *
+ * TODO: This package should be in a separate project and added as a dependency.
+ * For the purpose of demo, keeping it in the test library module.
+ * @author eing
+ */
+public class ServiceTestBase {
+
+    public RequestSpecification requestSpec;
+    public RequestSpecBuilder requestSpecBuilder = null;
+    public Response response;
+    public ResponseSpecification responseSpec;
+    public ResponseSpecBuilder responseSpecBuilder;
+    public String propertiesFile = null;
+    public static String configDir = null;
+    protected final Logger logger;
+    protected Properties internalProperties = null;
+
+    /**
+     * Default settings:
+     *  Property file: config.properties
+     *  -Dtargetenv=QA
+     */
+    public ServiceTestBase() {
+        this(BaseConstant.PROPERTIES_FILENAME_DEFAULT);
+    }
+
+    public ServiceTestBase(String propertiesFile) {
+        logger = LoggerFactory.getLogger(getClass());
+        if (configDir == null) {
+            String currentEnvironment = System
+                    .getProperty(BaseConstant.ENVIRONMENT_PROPERTY);
+            if (currentEnvironment == null) {
+                currentEnvironment = System
+                        .getenv(BaseConstant.ENVIRONMENT_PROPERTY);
+                if (currentEnvironment == null) {
+                    currentEnvironment = BaseConstant.ENVIRONMENT_DEFAULT;
+                }
+            }
+            configDir = "/" + currentEnvironment;
+        }
+        this.propertiesFile = propertiesFile;
+        requestSpecBuilder = new RequestSpecBuilder();
+        responseSpecBuilder = new ResponseSpecBuilder();
+
+        if (internalProperties == null) {
+            // Only need to read from properties file and set http defaults once for all tests
+            readFromPropertiesFile();
+            setHttpDefaults();
+        }
+    }
+
+    /**
+     * Read properties file from both /default and /[targetenv] folder.
+     * The latter properties file will overwrite the default properties.
+     */
+    protected void readFromPropertiesFile() {
+        // Read default/<properties file> first
+        String defaultPropertiesFile = BaseConstant.DEFAULT_CONFIG_DIRECTORY + propertiesFile;
+        internalProperties = InternalConfigManager.getAllConfig(defaultPropertiesFile);
+
+        // Read <targetenv>/<properties file> next which overwrites default
+        String configPath = configDir + propertiesFile;
+        internalProperties.putAll(InternalConfigManager.getAllConfig(configPath));
+    }
+
+    /**
+     * Initialize from property file if specified
+     *  1. http.baseurl : base url e.g. http://www.intuit.com (default is localhost)
+     *  2. http.port : http port e.g. 9999 (default is 80)
+     */
+    protected void setHttpDefaults() {
+
+        // Set the base URI
+        String baseUri = internalProperties.getProperty(BaseConstant.HTTP_PROPERTY_BASEURL);
+        if (baseUri != null) {
+            RestAssured.baseURI = baseUri;
+            requestSpecBuilder.setBaseUri(baseUri);
+        }
+        // Set default port
+        String defaultPort = internalProperties.getProperty(BaseConstant.HTTP_PROPERTY_PORT);
+        if (defaultPort != null) {
+            int port = Integer.parseInt(defaultPort);
+            RestAssured.port = port;
+            requestSpecBuilder.setPort(port);
+        }
+    }
+}

data/lib/restassured_cli/source/maven/testing/sampleservice-test-library/default/sample/base/Constant.java

@@ -0,0 +1,12 @@
+package GROUPID.tests.library.sample.base;
+
+/**
+ * Consolidates all the constants into 1 file for code reuse.
+ */
+public class Constant {
+
+    /**
+     * Properties file
+     */
+    public static final String PROPERTIES_FILE = "/sample.properties";
+}

data/lib/restassured_cli/source/maven/testing/sampleservice-test-library/default/sample/base/SampleTestBase.java

@@ -0,0 +1,15 @@
+package GROUPID.tests.library.sample.base;
+
+import GROUPID.tests.library.base.ServiceTestBase;
+
+/**
+ * Base class for common business logic that applies to all tests.
+ * Please put any utility/helper functions in SampleServiceHelper in test-library module.
+ */
+public class SampleTestBase extends ServiceTestBase {
+
+    public SampleTestBase() {
+        super(Constant.PROPERTIES_FILE);
+    }
+
+}