Skip to content

Commit

Permalink
[wssimulator-0.2.8] - Added support for request content based routing
Browse files Browse the repository at this point in the history
  • Loading branch information
kellizer committed Aug 4, 2016
1 parent 9254a55 commit 92459cf
Show file tree
Hide file tree
Showing 26 changed files with 1,558 additions and 91 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# 0.2.8 (29/07/2016)
- Added request routing feature

# 0.2.7 (24/07/2016)
- Added 'Called Times' feature sets
- More Bug fixes and fixing failing tests
Expand Down
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.7/wssimulator-0.2.7.zip "Download Standalone Version")
* The dependency from JCenter or the Standalone [distro](https://github.com/CognitiveJ/wssimulator/releases/download/0.2.8/wssimulator-0.2.8.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.
Expand All @@ -32,7 +32,8 @@ httpMethod: post
successResponseCode:201
badRequestResponseCode: 500
response: <results>ok</results>
requestStructure: <?xml version="1.0" encoding="UTF-8"?>
request:
requestStructure: <?xml version="1.0" encoding="UTF-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="customer" type="customerType"/>
Expand All @@ -53,15 +54,15 @@ 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.7.zip file to a local directory
- Unizip the ws-simulator-0.2.8.zip file to a local directory
- Then Call:
```shell
./wssimulator <options>
```

* For Windows
- Unizip the ws-simulator-0.2.7.zip file to a local directory
- Unizip the ws-simulator-0.2.8.zip file to a local directory
- Then Call:
```shell
./wssimulator.bat <options>
Expand Down Expand Up @@ -95,7 +96,7 @@ repositories {
}
dependencies {
compile "cognitivej:wssimulator:0.2.7"
compile "cognitivej:wssimulator:0.2.8"
...
}
Expand All @@ -106,7 +107,7 @@ repositories {
<dependency>
<groupId>cognitivej</groupId>
<artifactId>wssimulator</artifactId>
<version>0.2.7</version>
<version>0.2.8</version>
<type>pom</type>
</dependency>
```
Expand Down Expand Up @@ -155,3 +156,18 @@ resilience: 1
resilienceFailureCode: 501
```
### Request based routing
WSimulator allows for content within the request payload to determine what specification is called allowing for
```yaml
path: /publish
consumes: application/xml
httpMethod: post
successResponseCode:201
badRequestResponseCode: 500
response: <results>ok</results>
request:
filterType: contains
filter: Hello World
```
_Filters by any request containing the phrase 'Hello World'_
3 changes: 2 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,5 @@ jar {
test.onlyIf {
// run tests locally until we get the circleci port issue sorted.
Boolean.getBoolean('run.tests')
}
}

214 changes: 214 additions & 0 deletions src/main/java/wssimulator/RouteRequestFilterType.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
/*
* 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;

/**
*
* The Route Filter options
*/
public enum RouteRequestFilterType {
none, contains
}
7 changes: 4 additions & 3 deletions src/main/java/wssimulator/WSSimulation.java
Original file line number Diff line number Diff line change
Expand Up @@ -236,10 +236,11 @@ public class WSSimulation {
*/
public String response;


/**
* Validate the structure of the request.
* Holds request logic for validation/filtering
*/
public String requestStructure;
public WSSimulatorRequest request = new WSSimulatorRequest();

/**
* sets the successful response code to send back to the server
Expand All @@ -264,7 +265,7 @@ public class WSSimulation {
* Context object for this simulation
*/
@JsonIgnore
public final WSSimulationContext wsSimulationContext=new WSSimulationContext();
public final WSSimulationContext wsSimulationContext = new WSSimulationContext();

@Override
public String toString() {
Expand Down
11 changes: 7 additions & 4 deletions src/main/java/wssimulator/WSSimulator.java
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@

import java.io.File;
import java.util.Collection;
import java.util.concurrent.TimeUnit;

/**
* Base simulator for web services.
Expand Down Expand Up @@ -307,6 +308,7 @@ public static int loadedSimulationCount() {

/**
* Holds the times a simulation has been called.
*
* @param simulationId - the simulation id
* @return the number of times a service has been called.
*/
Expand All @@ -316,11 +318,12 @@ public static int calledCount(int simulationId) {

/**
* Return the ID of a simulation path based on its logical path
* @param path the path that the simulation
*
* @param path the path that the simulation
* @param httpMethod the httpmethod of the specification
* @return the id or -1 if not loaded.
*/
public static int findSimulationIdByPath(@NotNull String path)
{
return wsSimulatorServiceManager.findSimulationIdByPath(path);
public static int findSimulationId(@NotNull String path, @NotNull HttpMethod httpMethod) {
return wsSimulatorServiceManager.findSimulationIdByPath(path, httpMethod);
}
}
Loading

0 comments on commit 92459cf

Please sign in to comment.