diff --git a/CHANGELOG.md b/CHANGELOG.md index 74da5ce..c4d4d40 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,8 @@ -# 0.2.8 (20/08/2016) +# 0.2.10 (21/08/2016) +- Bug fixes +- Added the ability to retrieve the last request from the route + +# 0.2.9 (20/08/2016) - Bug fixes # 0.2.8 (29/07/2016) diff --git a/README.md b/README.md index 261fb4b..91503c3 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ WSSimulator is an open source library that easily allows for you to simulate ext **Getting Started** * Java 8 -* The dependency from JCenter or the Standalone [distro](https://github.com/CognitiveJ/wssimulator/releases/download/0.2.9/wssimulator-0.2.9.zip "Download Standalone Version") +* The dependency from JCenter or the Standalone [distro](https://github.com/CognitiveJ/wssimulator/releases/download/0.2.10/wssimulator-0.2.10.zip "Download Standalone Version") To simulate web service calls, you first need to describe the simulation. This process is very easy as Simulations are created in a YAML format and you don't need to 'simulate' much to get start as the only required field for you to define is _path_ and WSSimulator will default the other options. @@ -54,7 +54,7 @@ There are 2 ways to use WSSimulator; as a standalone application or as an embedd WSSimulator is packaged here and supports been executed on both *nix & windows systems; * For *nix systems - - Unizip the ws-simulator-0.2.9.zip file to a local directory + - Unizip the ws-simulator-0.2.10.zip file to a local directory - Then Call: ```shell @@ -62,7 +62,7 @@ WSSimulator is packaged here and supports been executed on both *nix & windows s ``` * For Windows - - Unizip the ws-simulator-0.2.9.zip file to a local directory + - Unizip the ws-simulator-0.2.10.zip file to a local directory - Then Call: ```shell ./wssimulator.bat @@ -96,7 +96,7 @@ repositories { } dependencies { - compile "cognitivej:wssimulator:0.2.9" + compile "cognitivej:wssimulator:0.2.10" ... } @@ -107,7 +107,7 @@ repositories { cognitivej wssimulator - 0.2.9 + 0.2.10 pom ``` @@ -170,4 +170,24 @@ request: filterType: contains filter: Hello World ``` -_Filters by any request containing the phrase 'Hello World'_ \ No newline at end of file +_Filters by any request containing the phrase 'Hello World'_ + +### Call Count & Last Request + +WSSimulator can return the total call count and the last route request body for routes. For example + +```java + int addedSimulationId = WSSimulator.addSimulation(new File(getClass().getResource("/lastRequest/request.yml").toURI())) + given().port(port) + .contentType(ContentType.XML) + .body("Last Request - 1") + .post("/hello"); + + given().port(port) + .contentType(ContentType.XML) + .body("Last Request - 2") + .post("/hello"); + + WSSimulator.calledCount(addedSimulationId) == 2; + WSSimulator.lastRequest(addedSimulationId) == "Last Request - 2"; +``` \ No newline at end of file diff --git a/build.gradle b/build.gradle index b1f6587..3fb6ec1 100644 --- a/build.gradle +++ b/build.gradle @@ -33,13 +33,12 @@ dependencies { compile "com.intellij:annotations:12.0" compile 'org.slf4j:slf4j-simple:1.7.21' compile 'commons-cli:commons-cli:1.3.1' - compile('com.github.fge:json-schema-validator:2.2.6'); + compile('com.github.fge:json-schema-validator:2.2.6') testCompile('org.codehaus.groovy:groovy-all:2.4.6') testCompile "org.spockframework:spock-core:1.0-groovy-2.4" testCompile 'io.rest-assured:rest-assured:3.0.0' - } mainClassName = "wssimulator.Bootstrap" diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 1f0c27e..df9d91c 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ -#Wed Jul 06 09:30:23 BST 2016 +#Fri Aug 19 14:49:38 BST 2016 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-2.14-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-2.14-all.zip diff --git a/src/main/java/wssimulator/WSSimulationContext.java b/src/main/java/wssimulator/WSSimulationContext.java index e2f6243..760b125 100644 --- a/src/main/java/wssimulator/WSSimulationContext.java +++ b/src/main/java/wssimulator/WSSimulationContext.java @@ -212,4 +212,5 @@ public class WSSimulationContext { * Holds the call count for this simulation */ public int callCount; + public String lastRequest; } diff --git a/src/main/java/wssimulator/WSSimulator.java b/src/main/java/wssimulator/WSSimulator.java index 18a90cd..54a09ef 100644 --- a/src/main/java/wssimulator/WSSimulator.java +++ b/src/main/java/wssimulator/WSSimulator.java @@ -321,6 +321,18 @@ public static int calledCount(int simulationId) { return wsSimulatorServiceManager.calledCounter(simulationId); } + + /** + * Returns the last request for a given simulation. + * + * @param simulationId - the simulation id + * @return the the text of the last request + */ + public static String lastRequest(int simulationId) { + return wsSimulatorServiceManager.lastRequest(simulationId); + } + + /** * Return the ID of a simulation path based on its logical path * diff --git a/src/main/java/wssimulator/WSSimulatorServiceManager.java b/src/main/java/wssimulator/WSSimulatorServiceManager.java index 64ece76..212106a 100644 --- a/src/main/java/wssimulator/WSSimulatorServiceManager.java +++ b/src/main/java/wssimulator/WSSimulatorServiceManager.java @@ -271,7 +271,6 @@ private static WSSimulatorServiceManager startup() { } - /** * Adds and starts a web service simulator simulation * @@ -345,7 +344,7 @@ public void shutdown() { Spark.stop(); validSimulations.clear(); handlers.clear(); - counter=0; + counter = 0; } /** @@ -383,6 +382,18 @@ public int calledCounter(int simulationId) { return wsSimulation.wsSimulationContext.callCount; } + + /** + * Last request received for an endpoint + * + * @param simulationId + * @return the last request (or null if not yet called) + */ + public String lastRequest(int simulationId) { + WSSimulation wsSimulation = getWSSimulation(simulationId); + return wsSimulation.wsSimulationContext.lastRequest; + } + public int findSimulationIdByPath(@NotNull String path, @NotNull HttpMethod httpMethod) { return validSimulations.entrySet() .stream() diff --git a/src/main/java/wssimulator/handler/BaseHandler.java b/src/main/java/wssimulator/handler/BaseHandler.java index c229d89..fd2e5e4 100644 --- a/src/main/java/wssimulator/handler/BaseHandler.java +++ b/src/main/java/wssimulator/handler/BaseHandler.java @@ -249,6 +249,7 @@ public final Object processRequest(@NotNull Request request, @NotNull Response r WSSimulation wsSimulation = loadSimulation(request); if (wsSimulation != null) { wsSimulation.wsSimulationContext.callCount++; + wsSimulation.wsSimulationContext.lastRequest = request.body(); if (!validate(wsSimulation, request.body())) { LOG.info("Validation failed for request, returning status code:{}", wsSimulation.badRequestResponseCode); response.status(wsSimulation.badRequestResponseCode); diff --git a/src/main/resources/wssimulator-version.txt b/src/main/resources/wssimulator-version.txt index d81f1c3..d156ab4 100644 --- a/src/main/resources/wssimulator-version.txt +++ b/src/main/resources/wssimulator-version.txt @@ -1 +1 @@ -0.2.9 \ No newline at end of file +0.2.10 \ No newline at end of file diff --git a/src/test/groovy/wssimulator/CalledCounterTestSpecification.groovy b/src/test/groovy/wssimulator/CalledCounterTestSpecification.groovy index 6b21af7..95ae03c 100644 --- a/src/test/groovy/wssimulator/CalledCounterTestSpecification.groovy +++ b/src/test/groovy/wssimulator/CalledCounterTestSpecification.groovy @@ -230,30 +230,4 @@ class CalledCounterTestSpecification extends Specification { cleanup: WSSimulator.shutdown() } - - def "simulator Test to lookup path"() { - setup: - int port = TestUtils.randomPort() - when: - WSSimulator.setPort(port) - int addedSimulationId = WSSimulator.addSimulation(new File(getClass().getResource("/simple.yml").toURI())) - int foundSimulationId = WSSimulator.findSimulationId("/hello",HttpMethod.get) - then: - addedSimulationId == foundSimulationId - cleanup: - WSSimulator.shutdown() - } - - def "simulator Test to lookup path that is not found"() { - setup: - int port = TestUtils.randomPort() - when: - WSSimulator.setPort(port) - int addedSimulationId = WSSimulator.addSimulation(new File(getClass().getResource("/simple.yml").toURI())) - int foundSimulationId = WSSimulator.findSimulationId("/notfound",HttpMethod.get) - then: - addedSimulationId != foundSimulationId - cleanup: - WSSimulator.shutdown() - } } diff --git a/src/test/groovy/wssimulator/LastRequestTestSpecification.groovy b/src/test/groovy/wssimulator/LastRequestTestSpecification.groovy new file mode 100644 index 0000000..48636b5 --- /dev/null +++ b/src/test/groovy/wssimulator/LastRequestTestSpecification.groovy @@ -0,0 +1,242 @@ +/* + * Apache License + * Version 2.0, January 2004 + * http://www.apache.org/licenses/ + * + * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + * + * 1. Definitions. + * + * "License" shall mean the terms and conditions for use, reproduction, + * and distribution as defined by Sections 1 through 9 of this document. + * + * "Licensor" shall mean the copyright owner or entity authorized by + * the copyright owner that is granting the License. + * + * "Legal Entity" shall mean the union of the acting entity and all + * other entities that control, are controlled by, or are under common + * control with that entity. For the purposes of this definition, + * "control" means (i) the power, direct or indirect, to cause the + * direction or management of such entity, whether by contract or + * otherwise, or (ii) ownership of fifty percent (50%) or more of the + * outstanding shares, or (iii) beneficial ownership of such entity. + * + * "You" (or "Your") shall mean an individual or Legal Entity + * exercising permissions granted by this License. + * + * "Source" form shall mean the preferred form for making modifications, + * including but not limited to software source code, documentation + * source, and configuration files. + * + * "Object" form shall mean any form resulting from mechanical + * transformation or translation of a Source form, including but + * not limited to compiled object code, generated documentation, + * and conversions to other media types. + * + * "Work" shall mean the work of authorship, whether in Source or + * Object form, made available under the License, as indicated by a + * copyright notice that is included in or attached to the work + * (an example is provided in the Appendix below). + * + * "Derivative Works" shall mean any work, whether in Source or Object + * form, that is based on (or derived from) the Work and for which the + * editorial revisions, annotations, elaborations, or other modifications + * represent, as a whole, an original work of authorship. For the purposes + * of this License, Derivative Works shall not include works that remain + * separable from, or merely link (or bind by name) to the interfaces of, + * the Work and Derivative Works thereof. + * + * "Contribution" shall mean any work of authorship, including + * the original version of the Work and any modifications or additions + * to that Work or Derivative Works thereof, that is intentionally + * submitted to Licensor for inclusion in the Work by the copyright owner + * or by an individual or Legal Entity authorized to submit on behalf of + * the copyright owner. For the purposes of this definition, "submitted" + * means any form of electronic, verbal, or written communication sent + * to the Licensor or its representatives, including but not limited to + * communication on electronic mailing lists, source code control systems, + * and issue tracking systems that are managed by, or on behalf of, the + * Licensor for the purpose of discussing and improving the Work, but + * excluding communication that is conspicuously marked or otherwise + * designated in writing by the copyright owner as "Not a Contribution." + * + * "Contributor" shall mean Licensor and any individual or Legal Entity + * on behalf of whom a Contribution has been received by Licensor and + * subsequently incorporated within the Work. + * + * 2. Grant of Copyright License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * copyright license to reproduce, prepare Derivative Works of, + * publicly display, publicly perform, sublicense, and distribute the + * Work and such Derivative Works in Source or Object form. + * + * 3. Grant of Patent License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * (except as stated in this section) patent license to make, have made, + * use, offer to sell, sell, import, and otherwise transfer the Work, + * where such license applies only to those patent claims licensable + * by such Contributor that are necessarily infringed by their + * Contribution(s) alone or by combination of their Contribution(s) + * with the Work to which such Contribution(s) was submitted. If You + * institute patent litigation against any entity (including a + * cross-claim or counterclaim in a lawsuit) alleging that the Work + * or a Contribution incorporated within the Work constitutes direct + * or contributory patent infringement, then any patent licenses + * granted to You under this License for that Work shall terminate + * as of the date such litigation is filed. + * + * 4. Redistribution. You may reproduce and distribute copies of the + * Work or Derivative Works thereof in any medium, with or without + * modifications, and in Source or Object form, provided that You + * meet the following conditions: + * + * (a) You must give any other recipients of the Work or + * Derivative Works a copy of this License; and + * + * (b) You must cause any modified files to carry prominent notices + * stating that You changed the files; and + * + * (c) You must retain, in the Source form of any Derivative Works + * that You distribute, all copyright, patent, trademark, and + * attribution notices from the Source form of the Work, + * excluding those notices that do not pertain to any part of + * the Derivative Works; and + * + * (d) If the Work includes a "NOTICE" text file as part of its + * distribution, then any Derivative Works that You distribute must + * include a readable copy of the attribution notices contained + * within such NOTICE file, excluding those notices that do not + * pertain to any part of the Derivative Works, in at least one + * of the following places: within a NOTICE text file distributed + * as part of the Derivative Works; within the Source form or + * documentation, if provided along with the Derivative Works; or, + * within a display generated by the Derivative Works, if and + * wherever such third-party notices normally appear. The contents + * of the NOTICE file are for informational purposes only and + * do not modify the License. You may add Your own attribution + * notices within Derivative Works that You distribute, alongside + * or as an addendum to the NOTICE text from the Work, provided + * that such additional attribution notices cannot be construed + * as modifying the License. + * + * You may add Your own copyright statement to Your modifications and + * may provide additional or different license terms and conditions + * for use, reproduction, or distribution of Your modifications, or + * for any such Derivative Works as a whole, provided Your use, + * reproduction, and distribution of the Work otherwise complies with + * the conditions stated in this License. + * + * 5. Submission of Contributions. Unless You explicitly state otherwise, + * any Contribution intentionally submitted for inclusion in the Work + * by You to the Licensor shall be under the terms and conditions of + * this License, without any additional terms or conditions. + * Notwithstanding the above, nothing herein shall supersede or modify + * the terms of any separate license agreement you may have executed + * with Licensor regarding such Contributions. + * + * 6. Trademarks. This License does not grant permission to use the trade + * names, trademarks, service marks, or product names of the Licensor, + * except as required for reasonable and customary use in describing the + * origin of the Work and reproducing the content of the NOTICE file. + * + * 7. Disclaimer of Warranty. Unless required by applicable law or + * agreed to in writing, Licensor provides the Work (and each + * Contributor provides its Contributions) on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied, including, without limitation, any warranties or conditions + * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + * PARTICULAR PURPOSE. You are solely responsible for determining the + * appropriateness of using or redistributing the Work and assume any + * risks associated with Your exercise of permissions under this License. + * + * 8. Limitation of Liability. In no event and under no legal theory, + * whether in tort (including negligence), contract, or otherwise, + * unless required by applicable law (such as deliberate and grossly + * negligent acts) or agreed to in writing, shall any Contributor be + * liable to You for damages, including any direct, indirect, special, + * incidental, or consequential damages of any character arising as a + * result of this License or out of the use or inability to use the + * Work (including but not limited to damages for loss of goodwill, + * work stoppage, computer failure or malfunction, or any and all + * other commercial damages or losses), even if such Contributor + * has been advised of the possibility of such damages. + * + * 9. Accepting Warranty or Additional Liability. While redistributing + * the Work or Derivative Works thereof, You may choose to offer, + * and charge a fee for, acceptance of support, warranty, indemnity, + * or other liability obligations and/or rights consistent with this + * License. However, in accepting such obligations, You may act only + * on Your own behalf and on Your sole responsibility, not on behalf + * of any other Contributor, and only if You agree to indemnify, + * defend, and hold each Contributor harmless for any liability + * incurred by, or claims asserted against, such Contributor by reason + * of your accepting any such warranty or additional liability. + * + * END OF TERMS AND CONDITIONS + * + * APPENDIX: How to apply the Apache License to your work. + * + * To apply the Apache License to your work, attach the following + * boilerplate notice, with the fields enclosed by brackets "[]" + * replaced with your own identifying information. (Don't include + * the brackets!) The text should be enclosed in the appropriate + * comment syntax for the file format. We also recommend that a + * file or class name and description of purpose be included on the + * same "printed page" as the copyright notice for easier + * identification within third-party archives. + * + * Copyright 2016 Ian Kelly + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package wssimulator + +import io.restassured.http.ContentType +import spock.lang.Specification + +import static io.restassured.RestAssured.given +import static org.hamcrest.core.IsEqual.equalTo + +/** + * Tests related around the the endpoint called counterfeatures within wssimulator + */ +class LastRequestTestSpecification extends Specification { + + def "Simple simulator Test using file: simple.yaml"() { + setup: + int port = TestUtils.randomPort() + when: + WSSimulator.setPort(port) + int addedSimulationId = WSSimulator.addSimulation(new File(getClass().getResource("/lastRequest/request.yml").toURI())) + then: + given().port(port) + .contentType(ContentType.XML) + .body("Last Request - 1") + .post("/hello"); + + given().port(port) + .contentType(ContentType.XML) + .body("Last Request - 2") + .post("/hello"); + + + WSSimulator.calledCount(addedSimulationId) == 2; + WSSimulator.lastRequest(addedSimulationId) == "Last Request - 2"; + cleanup: + WSSimulator.shutdown() + } +} diff --git a/src/test/resources/lastRequest/request.yml b/src/test/resources/lastRequest/request.yml new file mode 100644 index 0000000..f40524f --- /dev/null +++ b/src/test/resources/lastRequest/request.yml @@ -0,0 +1,3 @@ +path: /hello +httpMethod: post +response: hello world