Skip to content

Improve documentation for test-suite #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinWheelerMT merged 1 commit into from
Jan 8, 2026
Merged

Improve documentation for test-suite #403

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion test-suite/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Local

### Prerequisites

To run the testing scenarios, you will need to ensure that you have version of the adaptor and its dependencies.

You can use the `start-local-environment.sh` script located in the `docker` folder to ensure that the no configuration changes have to be made.

### Installing

Run the shell script for local development:
Expand All @@ -8,7 +14,6 @@ Run the shell script for local development:
sh start-local.sh
```


If you do not have nodejs installed as a CLI, you will get an error.

The error will point you to the nodejs website, alternatively you can use
Expand All @@ -32,6 +37,40 @@ You can check if the backend instance is active by running:
curl -v http://localhost:7070/healthcheck
```

#### Performing Tests

In the UI:

* Scroll down to the test you want to perform and click `Run Test`.
* This will display a form, which you can send as is, or adjust the values according to your specific test requirements.
* Click the `Send` button, and wait for the test to complete.

Once completed, you should see a response box in the browser which resembles this:

```
API Status: 200
Adaptor Status: 200

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<soap:Header>
<wsa:MessageID>
93466F14-221D-417C-83A9-DE9CAAD0A68D
</wsa:MessageID>
<wsa:Action>
urn:nhs-itk:services:201005:SendNHS111Report-v2-0Response
</wsa:Action>
</soap:Header>
<soap:Body>
<itk:SimpleMessageResponse xmlns:itk="urn:nhs-itk:ns:201005">
OK:2B77B3F5-3016-4A6D-821F-152CE420E58D
</itk:SimpleMessageResponse>
</soap:Body>
</soap:Envelope>
```

You can then retrieve the FHIR message from your running activeMQ instance on the `encounter-report` queue.

## Production

### Installing
Expand Down