uk-gov-mirror / ministryofjustice.opg-sirius-user-management

User management frontend for Sirius: Managed by opg-org-infra & Terraform

Sirius user management

User management frontend for Sirius. It provides a UI to the Sirius API for the following features:

• view and edit your own details
• change your password
• manage teams
• manage users

Quick start

Major dependencies

• Go (>= 1.14)
• Pact (>= 1.88.3)
• docker-compose (>= 1.27.4)
• Node (>= 14.15.1)

Running the application

docker-compose -f docker/docker-compose.yml up -d --build

This will run the application at http://localhost:8888/, and assumes that Sirius is running at http://localhost:8080/.

Alternatively the application can be run without the use of Docker

yarn && yarn build
SIRIUS_PUBLIC_URL=http://localhost:8080 SIRIUS_URL=http://localhost:8080 PORT=8888 go run main.go

Testing

go test ./...

This will run the Go unit tests. It relies on pact being available on your $PATH. The tests will produce a ./pacts directory which is then used to provide a stub service for the Cypress tests.

docker-compose -f docker/docker-compose.cypress.yml up -d --build
yarn && yarn cypress

Will start the application in a way that uses the stub service, then opens Cypress in the current project.

Development

On CI we lint using golangci-lint. It may be useful to install locally to check changes. This will include a check on formatting so it is recommended to setup your editor to use go fmt.

Architecture

The Go code is mostly split between two internal packages. The static assets are built with Webpack.

./internal/sirius

This package provides a client to call the Sirius API. Each action is defined in its own file as a method against *Client. Tests are mostly written using Pact so that we can define a contract with Sirius, but this is not the case for all tests: in some cases it is not possible to get consistent behaviour from Sirius, also we may want to test the behaviour in case of an unexpected status but not know a consistent way to produce such a response.

./internal/server

This package provides the HTTP handlers for the application. Routes and permissions are defined in internal/server/server.go. We split each handler into its own file and provide a specific subset of the client as an interface to depend on.

Environment variables

Name	Description
PORT	Port to run on
WEB_DIR	Path to the 'web' directory
SIRIUS_URL	Base URL to call Sirius
SIRIUS_PUBLIC_URL	Base URL to redirect to Sirius
PREFIX	Path to prefix to each page's route

Prototype

The prototype for this repo is part of ministryofjustice/opg-sirius-prototypes.