pension-scheme-return

Pension scheme return is the backend service for pension scheme return which is a feature on manage your pension.

---

Technical documentation

Before running the app

Run the following command to start all of the related services for this project:

sm2 -start PSR_ALL

Included in the above command is PENSION_SCHEME_RETURN, which is this repository's most recent release. If you want to run your local version of this code instead, run:

sm2 -stop PENSION_SCHEME_RETURN

then:

sbt 'run'

Note: this service runs on port 10700 by default, but a different port (e.g. 17000) may be specified, as shown in the example below:

sbt 'run 17000'

---

Running the test suite

sbt clean coverage test it/test coverageReport

or

You can execute the runtests.sh file to run the tests and generate coverage report easily.

/bin/bash ./runtests.sh

---

Importing the Bruno Collection

In order to use bruno script instead of frontend with full journey you need to import the bru files these are collections and environments, into Bruno.

1. Open Bruno

2. Select open collection

3. Navigate to the /test/resources/PSR with Login

4. Select PSR with Login and open

5. Gets all the collections and environment vars

Environment variable overview

• pension-scheme-return sets the host of the service requests to match the environment
• auth sets the host of the service requests to match the environment
• bearer_token sets the Authorization token to satisfy backend authentication

LOGIN

PSR-Login request in the collection is required in order to hit the secured backend endpoints. When you hit the PSR-LOGIN, we obtained the authToken from government-gateway/session/login url and setting it to the bearer_token field of environment variable. This bearer_token then will be used in any subsequent requests for Authorization.

---

Useful links

• confluence

---

License

This code is open source software licensed under the Apache 2.0 License.