https://github.com/ministryofjustice/hmcts-common-platform-mock-api
Mock for HMCTS Common Platform API
https://github.com/ministryofjustice/hmcts-common-platform-mock-api
common-platform laa-access-court-data laa-crime-apps
Last synced: 7 months ago
JSON representation
Mock for HMCTS Common Platform API
- Host: GitHub
- URL: https://github.com/ministryofjustice/hmcts-common-platform-mock-api
- Owner: ministryofjustice
- Created: 2019-10-08T11:22:09.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T17:49:23.000Z (7 months ago)
- Last Synced: 2024-11-18T18:51:44.566Z (7 months ago)
- Topics: common-platform, laa-access-court-data, laa-crime-apps
- Language: Ruby
- Homepage:
- Size: 3.26 MB
- Stars: 2
- Watchers: 11
- Forks: 2
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# HMCTS Common Platform Mock API
## Set up
This is a standard 6 Rails API application which requires:
Clone the repo, then:
### Database setup
Running the tests and the application server locally with require a local Postgres database running. This can be done using docker
with the following command. This runs the same database image that is used in the CircleCI tests.
```shell
docker run -d --name hmcts-mock-db -p 5432:5432 cimg/postgres:14.11
```
### Populate .env file
There is a template .env file included in the repository which will need to be updated with the required values.
As this file is tracked in the repository it is best to avoid populating it with secrets incase it is committed pushed to GitHub.
Therefore the recommendation is to create new files e.g. `.env.development.local` and `.env.test.local` which are in the gitignore file.
The settings in these env files can be used by prefacing all rails and rspec commands with the `RAILS_ENV` environment variable e.g.
```shell
RAILS_ENV=test rails s
```
The rails environment should be set to `test` for running the test suite or `development` for running/debugging the application server locally
The DEV client id and secret refer to the Court Data Adaptor (DEV) OAuth2.0 credentials. These can be found in the encrypted helm values file.
```shell
LAA_DEV_CLIENT_ID=
LAA_DEV_CLIENT_SECRET=
```
The database url should be setup to point to your local Postgres database e.g.
```shell
DATABASE_URL=postgres://postgres:@localhost:5432/hmcts_common_platform_api_test
```
### Setup the app
Clone this repo, then run:
```shell
bundle install
```
```shell
RAILS_ENV=development rails db:setup
```
You can then start the application server by running:
```shell
RAILS_ENV=development rails s
```
By default, the application will listen on port 3000 as defined in `puma.rb`.
You can verify your setup by sending a request to an endpoint and checking for a HTTP response code of 2xx/Success. The credentials for the HTTP Basic Authentication are defined in `.env`.
```shell
curl -u admin:password --head http://localhost:3000/admin/prosecution_cases
```
### Running the App using docker compose
The application and associated database can be started up using the following docker compose command. By default the base `.env` file will be used however
you can set the `.env.test.local` or `.env.development.local` files using the `--env-file` argument.
```shell
docker-compose --env-file .env.development.local up --build
```
### Running the tests
The RSpec test can be run using the following command:
```shell
RAILS_ENV=test bundle exec rspec
```
### Generate demonstration data
Tasks have been created to facilitate generation of a small specific, rememberable set of demonstration data. This data reflects current understanding of a bare minimum needed to effectively demonstrate the workings of this adaptor and its user interface [View court data](https://github.com/ministryofjustice/laa-court-data-ui).
To generate demo data:
```
rake mock:demodata:load
```
To destroy demo data:
```
rake mock:demodata:unload
```
## Publish HearingResulted to LAA
Run the rake task by passing in the hearing id as an argument
```
bundle exec rails 'publish:hearing[HEARING_ID]'
```
This will trigger a publish to the LAA Adaptor service defined by the environment variable `LAA_DEV_API_URL`
### Decrypting secrets for deployment
**NOTE:** **git-crypt** is required to store secrets needed for all environments.
To be able to modify those secrets, **git-crypt** needs to be set up according to the following
[guide](https://user-guide.cloud-platform.service.justice.gov.uk/documentation/other-topics/git-crypt-setup.html#git-crypt).
This requires your gpg key to have been added to git-crypt. Liaise with another developer to action the steps in [git-crypt.md](docs/git-crypt.md)
Once the pull request has been merged, pull master and run
```
git-crypt unlock
```