Provides sign in / sign out and attribute storage functionality to other GOV.UK applications.
In production this app currently uses the GOV.UK account manager prototype as an authentication service and the GOV.UK attribute service prototype as a user data store.
This app does not serve any user-facing pages. To see the app working, you must run an app which uses it, such as Finder Frontend.
After starting Finder Frontend, you should be able to access the following links:
- the Brexit checker journey start page
- the Brexit checker results page that reflects the answers you give during the Brexit checker journey
- the account sign up page to save your answers
When you have set up your local account, you can sign into your account.
This is a Ruby on Rails app, and should follow our Rails app conventions.
Use GOV.UK Docker to run any of the following commands.
This repository follows the standards for testing described in the GOV.UK RFC on continuous deployment:
- code coverage in excess of 95%
- API contract tests ("pact tests") between the Account API and its consumers
- a smoke test to check the application is running after a deployment
The default rake
task runs all the tests and records code coverage:
bundle exec rake
If you make changes to the API, you must update the Pact tests.
A Pact test has two parts:
-
The consumer test (defined in gds-api-adapters), which:
- specifies the state it expects the provider to be in
- gives a request to make
- and a response to match against
-
The provider configuration (defined in this repo), which defines all of the provider states referenced by the consumer tests.
See the GOV.UK Developer Docs for how to update a Pact test.