This is the API which accesses the TDR consignment database.
The schema of the database is managed in this project
The auth utils and generated slick classes libraries are now stored in a private bucket in S3. This means you will need aws credentials to download the dependencies. You need either a default profile set up or you need to set the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.
Set up the database
docker run --name postgres -p 5432:5432 -e POSTGRES_USER=tdr -e POSTGRES_PASSWORD=password -e POSTGRES_DB=consignmentapi -d postgres:17.2
git clone https://github.com/nationalarchives/tdr-consignment-api-data.git
cd tdr-consignment-api-data.git
sbt flywayMigrate
Run the api:
- From IntelliJ, run the ApiServer app
- Or from the command line, run
sbt run
- The repository and route tests use a docker container for the database. To run the tests locally, you will need to build this database.
docker build -f Dockerfile-tests -t tests .- In order to run the tests run the command
sbt test
- If you would like to run only one test suite, run the command
sbt "testOnly *{File name without .scala}"e.g.sbt "testOnly *ConsignmentRepositorySpec"
Running API tests within IntelliJ requires an additional VM option so that IntelliJ does not confuse the normal run config and test run config. Within your test run configuration, set the VM of:
-Dconfig.file=src/test/resources/application.conf
If this is not set, you may see errors with the message:
Could not resolve substitution to a value: ${DB_PORT}
If an API test is removed because it is no longer needed, you will need to modify the list of required status checks on Github.
These can be found in "Settings > Branches" under the master branch.
The branch status checks are run when a pull request is raised and will get stuck if it tries to run a check on a test that is no longer present. You can remove the test at this point and the checks will carry on to completion.
We are now storing the current Graphql schema in the schema.graphql file in the root of the project. If you make changes to the API which cause a schema change, you will need to update this file with the contents of the newly generated schema, otherwise the test build will fail.
To generate the Graphql schema locally run the following command:
sbt graphqlSchemaGen
The generated schema file will be placed in the following location: target/sbt-graphql/schema.graphql. You can copy the contents of this file into ./schema.graphql and commit the changes to allow the build to pass.
After this file is merged into master, it will only be used by the generated-graphql project when that project is next deployed. In order to manually deploy the generated-graphql, follow these instructions.
The consignment-api makes use of a commercial Akka licence.
The build requires the token in two places:
- lightbend.sbt
- application configuration
Details about how to use the licence can be found here: https://www.lightbend.com/account/lightbend-platform/credentials
The token is stored in a SSM parameter in the TDR management account: /mgmt/akka/licence_token.
The licence token is set as a repository secret AKKA_TOKEN which is then used by the Github actions where needed.
The token is stored in a SSM parameter in the TDR environment accounts (intg / staging / prod): {environment}/akka/licence_token
The token value is passed as an environment secret to the ECS task where is can be picked up in the application configuration file.
Both sets of SSM parameters need to be updated with the new licence token:
The latest version of Akka can still be pulled down for local use.
To ensure when building locally an error is not thrown set the environment variable AKKA_TOKEN with some placeholder value.
For example: AKKA_TOKEN=dummyTokenValue