diff options
author | Max Benjamin <max.benjamin@att.com> | 2019-12-11 18:09:20 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2019-12-11 18:09:20 +0000 |
commit | 02c068ce771ee4522936f2d15f41c2b631e965a8 (patch) | |
tree | 31c0b733ea40e5e575ae17271a46841e72386378 /so-simulator/README.md | |
parent | 6acf5b81168724ca4c889daf9b9cfcc5100e02e1 (diff) | |
parent | 6514e3bded45ec57f5157afc6d2833fb4e40f271 (diff) |
Merge "Add so-simulator project"Java-11-upgrade1212master
Diffstat (limited to 'so-simulator/README.md')
-rw-r--r-- | so-simulator/README.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/so-simulator/README.md b/so-simulator/README.md new file mode 100644 index 0000000000..e059a97956 --- /dev/null +++ b/so-simulator/README.md @@ -0,0 +1,62 @@ +SO Citrus REST Simulator ![Logo][1] +================ + +This is a standalone simulator application for REST messaging. + +Clients are able to access the simulator endpoints and the simulator responds with predefined response +messages according to its scenarios. The simulator response logic is very powerful and enables us to simulate +any kind of server interface. + +Read the simulator [user manual](https://citrusframework.org/citrus-simulator/) for more information. + +Message processing +--------- + +First of all the simulator identifies the simulator scenario based on a mapping key that is extracted from the incoming request. Based +on that operation key the respective simulator scenario is executed. + +There are multiple ways to identify the simulator scenario from incoming request messages: + +* Message-Type: Each request message type (XML root QName) results in a separate simulator scenario +* REST request mappings: Identifies the scenario based on Http method and resource path on server +* SOAP Action: Each SOAP action value defines a simulator scenario +* Message Header: Any SOAP or Http message header value specifies a new simulator scenario +* XPath payload: An XPath expression is evaluated on the message payload to identify the scenario + +Once the simulator scenario is identified the respective test logic builder is executed. The Citrus test logic provides +proper response messages as a result to the calling client. The response messages can hold dynamic values and the +simulator is able to perform complex response generating logic. The test logic is built in Java classes that use the Citrus test +DSL for defining the simulator scenario steps. + +Quick start +--------- + +You can build the simulator application locally with Maven: + +``` +mvn clean install +``` + +This will compile and package all resources for you. Also some prepared Citrus integration tests are executed during the build. +After the successful build you are able to run the simulator with: + +``` +mvn spring-boot:run +``` + +Open your browser and point to [http://localhost:8080](http://localhost:8080). You will see the simulator user interface with all available scenarios and +latest activities. + +You can execute the Citrus integration tests now in order to get some interaction with the simulator. Open the Maven project in your favorite IDE and +run the tests with TestNG plugins. You should see the tests calling operations on the simulator in order to receive proper responses. The simulator user interface should track those +interactions accordingly. + +Information +--------- + +Read the [user manual](https://citrusframework.org/citrus-simulator/) for detailed instructions and features. +For more information on Citrus see [citrusframework.org][2], including a complete [reference manual][3]. + + [1]: https://citrusframework.org/img/brand-logo.png "Citrus" + [2]: https://citrusframework.org + [3]: https://citrusframework.org/reference/html/ |