This application is an adaptor or anti-corruption layer that connects to HMCTS’ Common Platform and transmits data between HMCTS Common Platform and various LAA systems.
Its main function is data translation / adaptation, and queueing of requests.
The application is commonly referred to by its acronym "CDA".
- Contact the team
- Architecture Diagrams
- Environments
- Dependencies
- Set up
- API Authentication
- API Schema
- Deployment
- Dev: running locally
- Stage
- UAT
- Monitoring and Debugging
- Pre-commit Hooks
- Contributing
Court Data Adaptor is maintained by staff in the Legal Aid Agency. If you need support, you can contact the team on our Slack channel:
- #laa-crime-apps-core on MOJ Digital & Technology
View the architecture diagram for this project. It's defined as code and can be edited by anyone.
-
Ruby version
-
System dependencies
- postgres 14.3
- redis
Install dependencies with bundler:
bundle install
To set up CDA in your local machine, you can run the following services manually:
- Rails (the application server)
- Postgres
- Brew formula for PostgreSQL@14
- Docker -
docker run -d --name cda-db -e POSTGRES_USER postgres -e POSTGRES_PASSWORD <PASSWORD> -p 5432:5432 cimg/postgres:14
- Redis and Sidekiq
or you can use docker-compose.
A faster way is to use docker-compose, which uses the docker-compose.yaml.
On your shell run:
$ docker-compose up --build
The env files has been encrypted with git-crypt.md. This requires your gpg key to have been added to git-crypt. Liaise with another developer to action the steps in git-crypt.md
Once the pull request has been merged, re-pull master and run:
git-crypt unlock
Create an .env.test.local file at the root
To get the tests running you will need to set the following value:
DATABASE_URL=postgres://postgres:postgres@localhost:5432/laa_court_data_adaptor_test
Then run:
$ RAILS_ENV=test rails db:setup
$ rspec
Create an .env.development.local file at the root. You can copy it from .env and then change it based on your needs.
To get the localhost running you will need to set the following value:
DATABASE_URL=postgres://postgres:postgres@localhost:5432/laa_court_data_adaptor_development
Now you can manually run Rails and Redis/Sidekiq.
$ RAILS_ENV=development rails db:setup
$ bin/rails s
To run background jobs, You also need to start sidekiq and redis in separate terminal windows:
redis-server
$ bundle exec sidekiq
Alternatively, to process jobs inline in .env.development.local set:
INLINE_SIDEKIQ: true
The other way run the services is by using docker-compose: docker-compose up --build
Create an OAuth Application for each system that needs to authenticate to the adaptor via the console.
rails console
application = Doorkeeper::Application.create(name: 'HMCTS Common Platform')The client credentials are available against the application as application.uid and application.secret
Use these credentials to generate an access_token by making a call to the OAuth endpoint described in the schema.
Send the access_token provided by the OAuth endpoint as a Bearer Token.
eg:
curl --get \
--url 'https://API_HOST/api/internal/v1/prosecution_cases' \
--data-urlencode 'filter[name]=Boris Lubowitz' \
--data-urlencode 'filter[date_of_birth]=1981-08-22' \
--data-urlencode 'include=defendants' \
--header 'Authorization: Bearer <access_token>'
We use rswag to document with swagger the endpoints that are being exposed.
To view the API documentation, start the rails server locally using rails s and then browse to http://localhost:3000/api-docs/index.html.
To use the 'Try it out' functionality, you need to have first created an oAuth user in your local database. See here for details.
To add a new endpoint, run rails generate rspec:swagger <controller_name> to generate a request spec. Add appropriate tests and content to the spec, then run rake rswag. The new endpoint should now appear in the Swagger UI interface.
The build is triggered in CircleCI upon merging to master but requires manual approval through all environments to deploy to production.
As the Common Platform API does not have a sandbox to independently create test data in, we have also created a Mock of it to use when working in local development, which can be found here
Add the following to .env.development.local
COMMON_PLATFORM_URL=http://localhost:3001
SHARED_SECRET_KEY=super-secret-key
LAA_DEV_API_URL=http://localhost:3000
LAA_DEV_OAUTH_URL=http://localhost:3000/v1/oauth/token
Run the hmcts-common-platform-mock-api in parallel to the Court Data Adaptor on port 3001 to mock the Common Platform API.
Information about other environments can be found on this Confluence page
Kibana logs for production can be found here
Sentry errors for production can be found here
To monitor the worker jobs execution you can access pods by running:
kubectl get pods --namespace laa-court-data-adaptor-[ENV]
kubectl exec --stdin --tty -n laa-court-data-adaptor-[ENV]] [POD-NAME] -- bin/rails c
require 'sidekiq/api'
rs = Sidekiq::RetrySet.new
Further details can be found on this confluence page.
Rubocop can be set up to run pre-commits.
Please see this PR
There is a user interface for monitoring the sidekiq workers each environment. The credentials can be found in the helm values files.
Bug reports and pull requests are welcome.
- Fork the project (https://github.com/ministryofjustice/laa-court-data-adaptor/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit until you are happy with your contribution (
git commit -am 'Add some feature') - Push the branch (
git push origin my-new-feature) - Make sure your changes are covered by tests, so that we don't break it unintentionally in the future.
- Create a new pull request.