A small Java web application that is used primarily for the use of interacting with CHS services. The testing with this harness focuses on obtaining the correct scopes and permissions that are requested via this web application for use of Companies House Enabled API's This is an example application of a third party app gaining an Oauth token and using it for access to APIs and displaying the correct scopes.
- In application.properties file changes need to be made to environment variables in order to get the application to work locally.
- Entrypoint is http://localhost:8090/login
- This test harness is built and tested for local use and is not intended to be run in production
- Ensure that Docker-chs-development is up to date
- Required modules: ch-gov-uk, account-ch-gov-uk and mongo
- Pull image from private CH registry by running
docker pull 169942020521.dkr.ecr.eu-west-1.amazonaws.com/local/third-party-test-harness:latestcommand or run the following steps to build image locally:Make- Run:
mvn compile jib:dockerBuild -Dimage=169942020521.dkr.ecr.eu-west-1.amazonaws.com/local/third-party-test-harness
- Entrypoint is http://chs.local/login
| Variable | Description | Example |
|---|---|---|
| THIRD_PARTY_DUMMY_PORT | http://localhost:PORT | 8090 |
| CLIENT_ID | A value you set yourself within a Mongo collection | THIRDPARTYCLIENT |
| CLIENT_SECRET | A value you set yourself within a Mongo collection | CLIENTSECRET |
| REDIRECT_URI | The redirect URI after you've finished your CHS journey | http://localhost:8090/redirect |
| TOKEN_URI | The token URI for CHS live | https://identity.company-information.service.gov.uk/oauth2/token |
| PROTECTED_URI | The protected URI for CHS live | https://api.company-information.service.gov.uk/company |
| USER_URI | The user URI for CHS live | https://identity.company-information.service.gov.uk/user/profile |
| AUTHORISE_URI | The authorise URI for CHS live | https://identity.company-information.service.gov.uk/oauth2/authorise |