Idam Simulator

This is a small spring-boot app that stub only the endpoints of Idam Api required to request a Bearer Token and login.

Any call made by Idam Client are correctly handled by the Idam Simulator. The call from XUI for login and redirection is also handled.

It can be run from a docker image or from IntelliJ (so with debugger potentially).

How to pull an image from acr of the simulator and run it with docker

Execute these 3 commands

az acr login --name hmctspublic
docker pull hmctspublic.azurecr.io/hmcts/rse/rse-idam-simulator:latest
docker run -d -P --name rse-idam-simulator -p 5556:5556 hmctspublic.azurecr.io/hmcts/rse/rse-idam-simulator:latest

Running/Debugging the application with IntelliJ Idea

Right click on Application.java and choose Run Application.main() or Debug Application.main()

Open this url http://localhost:5556/health to check it has started correctly

How to use the simulator with Post Man

Check IdamSimulatorController to see how the endpoints work. These endpoints are all the endpoints required to have the idam-java-client working correctly, and one endpoint to add a user in the local memory map of the simulator. Keep in mind that username and email are the same in Idam system.

Here is a quick start and having a request a token using postman and the open id route.

Add a user by doing this request:

POST http://localhost:5556/testing-support/accounts
Content-Type: application/json

{
  "email": "myemail-test@hmcts.net",
  "forename": "John",
  "surname": "Smith",
  "roles": [
    {
      "code": "role1"
    },
    {
      "code": "role2"
    }
  ],
  "password": "onePassword"
}

Have an Open ID Token using this call. Notice this is not JSON content but x-www-form-urlencoded content.

POST http://localhost:5556/o/token
Content-Type: application/x-www-form-urlencoded

client_id: sometestservice
client_secret: sometestservice
grant_type: password
redirect_uri: https://davidtestservice.com
username: myemail-test@hmcts.net
password: somePassword
scope: openid profile roles

How to log in and have a session cookie like Expert UI does?

• Start the application and add a user like in How to use the simulator with Postman above section
• Let's say we have added the user myemail-test@hmcts.net and after login we want to be redirected to https://www.gov.uk
• Use any browser to login by an url similar to this one

http://localhost:5556/login?redirect_uri=https%3A%2F%2Fwww.gov.uk&client_id=oneClientId&state=12345&ui_local=en

• Login with user myemail-test@hmcts.net
• After login the response is redirected to https://www.gov.uk/?code=lBApYbFkrfLOsKtgkYRwAcACisa&state=12345&client_id=oneClientId&iss=http://fr-am:8080/openam/oauth2/hmcts
• This response contains 2 idam cookies: Idam.Session and idam_ui_local

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

  ./gradlew build

Running the application with Docker

Create the image of the application by executing the following command:

  ./gradlew assemble

Create docker image:

  docker-compose build

Run the distribution (created in build/install/rse-idam-simulator directory) by executing the following command:

  docker-compose up -d

This will start the API container exposing the application's port (set to 5556 in this template app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:5556/health

You should get a response similar to this:

  {"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}

Alternative script to run application

To skip all the setting up and building, just execute the following command:

./bin/run-in-docker.sh

For more information:

./bin/run-in-docker.sh -h

Script includes bare minimum environment variables necessary to start api instance. Whenever any variable is changed or any other script regarding docker image/container build, the suggested way to ensure all is cleaned up properly is by this command:

docker-compose rm

It clears stopped containers correctly. Might consider removing clutter of images too, especially the ones fiddled with:

docker images

docker image rm <image-id>

There is no need to remove postgres and java or similar core images.

License

This project is licensed under the MIT License - see the LICENSE file for details.