๐งช wmio-wmtestsuite
A containerized version of WmTestSuite. It can generate and run unit tests from input and output for wm.io-Flow and IS packages.
---
๐ What is wmio-wmtestsuite?
This solution can run unit tests for:
* a wm.io Flow service which you exported from IWHI. You need additionally the input and output of the service as JSON
* a IS package and the input and output of services as XML
---
๐ง Build & Run
๐
Step 1: Clone the Repository
```bash
git clone https://github.ibm.com/webMethods-Accelerators/wmio-wmtestsuite.git
cd wmio-wmtestsuite
```
---
๐๏ธ Step 2a: Login to Container Registry
Go to
https://containers.webmethods.io/user-profile
and get the credentials in order to run in environment with docker:
```bash
docker login \
-u myId \
-p mySecret \
ibmwebmethods.azurecr.io
```
---
๐๏ธ Step 2b: Build the Docker Image
```bash
docker build -t wmio-wmtestsuite:latest .
```
---
โถ๏ธ Run the Container
Hint: You have to provide now folders like "review" and "results", which you have to point to in the following command (as relative or absolute path). If you ran the command like below you have to provide a subfolder "review" which contains the wm.io Flow or IS package to be reviewed.
```bash
docker run \
-v "./review:/mnt/code_review" \
-v "./results:/mnt/code_review_results" \
wmio-wmtestsuite:latest
```
---
๐ฆ Input Parameters
| Parameter / Volume | Mount Path in Container | Purpose |
| ------------------ | -------------------------- | ---------------|
| `./review` | `/mnt/code_review` | Directory containing one wm.io Flow export (zip) + folder "test" with input and output pipelines or IS package (zip), compare with wmio-wmtestsuite/examples, subfolders are not supported under ./review |
| `./results` | `/mnt/code_review_results` | Output location for test result |
---
๐ Output
Once the container finishes running, the `./results` directory will contain:
* `execute_report_<executionID>.xml` โ A custom log of the tool
* `junitxmlreport_<executionID>.xml` โ The standardized JUnit report
---
๐ง Tips
* Export zipped packages:
* Export wm.io-Flow Service from wm.io by clicking on the 3 dots of this Flow Service and then "Export"
* Export IS package from Packages -> Management by using the "Archive" function or zip the package by yourself
* The pipelines under the folder "test" can have the following format:
* "normal" xml pipelines from IS
* Input pipelines from wm.io-Flow: Open the Flow Service, click on "Run". In the following window add a proper name like "myFirstTest-input" in "Save the value set as (optional)" and execute. "Run" the service again. Choose now this value set and click on "Download input values". You can use it as is or "normalize" it by removing the top level of the JSON structure.
* Output pipelines from wm.io-Flow which you have save by using the button "Download the results". You can use it as is or "normalize" it by using only the content of the "pipeline" object.
* The filenames of the pipelines has to follow the convetion: \<serviceName without namespace\>-\<description with or without "-"\>-\<"input" or "output"\>.\<extension\>
Example: subtractIntsFlow-myFirstTest-input.json, subtractIntsFlow-myFirstTest-output.json
* For all valid pairs of input and output there will be generated a test case.
* If you provide a wm.io-Flow.zip, you have to provide the "test" directory, too. In case of an IS package you can place your pipelines within the package under resource/test or also in the "test" directory
* For running WmTestSuite you need a wmTestSuite.xml. This is generated on the fly in a standardized way if you do not provide such a file under <myPackage>/resources/test/wmTestSuite.xml
* If ./review contains more than 1 zip file the first one which was found is used.
---
๐ค Contributing
Pull requests, feature suggestions, and issues are welcome!
Letโs improve Flow Service quality, one scan at a time.
---
Disclaimer
IBM Public Repository Disclosure
All content in these repositories including code has been provided by IBM under the associated open source software license and IBM is under no obligation to provide enhancements, updates, or support. IBM developers produced this code as an open source project (not as an IBM product), and IBM makes no assertions as to the level of quality nor security, and will not be maintaining this code going forward.