tariff-classification-frontend

The frontend for the internal Advance Tariff Rulings Case Manager service for reviewing & answering ATaR applications.

Running

To run this Service you will need:

1. Service Manager 2 installed
2. SBT Version >=1.x installed
3. MongoDB version >=3.6 installed and running on port 27017
4. Localstack installed and running on port 4572
5. Create an S3 bucket in localstack by using awslocal s3 mb s3://digital-tariffs-local within the localstack container

The easiest way to run MongoDB and Localstack for local development is to use Docker.

To run Localstack and create the S3 bucket

> docker run -d --restart unless-stopped --name localstack -e SERVICES=s3 -p4572:4566 -p8080:8080 localstack/localstack
> docker exec -it localstack bash
> awslocal s3 mb s3://digital-tariffs-local
> exit

Starting the application:

1. Launch dependencies using sm2 --start DIGITAL_TARIFFS_DEPS
2. Start the backend service binding-tariff-classification using sm2 --start BINDING_TARIFF_CLASSIFICATION
3. Start the filestore service binding-tariff-filestore using sm2 --start BINDING_TARIFF_FILESTORE
4. Start the ruling frontend binding-tariff-ruling-frontend using sm2 --start BINDING_TARIFF_RULING_FRONTEND
5. Start the trader frontend binding-tariff-trader-frontend using sm2 --start BINDING_TARIFF_TRADER_FRONTEND
6. On Mac OS you must start an older version of the pdf-generator-service:

sm2 --stop PDF_GENERATOR_SERVICE
sm2 --start PDF_GENERATOR_SERVICE:1.20.0

Use sbt run to boot the app or run it with Service Manager 2 using sm2 --start TARIFF_CLASSIFICATION_FRONTEND.

This application runs on port 9581.

Open http://localhost:9581/manage-tariff-classifications.

You can also run the DIGITAL_TARIFFS profile using sm2 --start DIGITAL_TARIFFS and then stop the Service Manager 2 instance of this service using sm2 --stop TARIFF_CLASSIFICATION_FRONTEND before running with sbt.

Authentication

The service uses the HMRC auth-client for authentication with STRIDE as the authentication provider. In non production environments you will be redirected to the stride-idp-stub. You can log in using the following enrolment information:

PID: <any string>

to log in as a classification team officer:

Roles: classification

and as a classification team manager:

Roles: classification-manager

and as a read-only user:

Roles: classification-read-only

PDF Generation

When running the unit tests, some PDFs are generated at /test/resources/fop using Apache FOP. These should be used to check for regressions in the layout of the PDFs generated by the service.

Running the pdf-generator-service locally on Mac OSX (currently) requires running an older version.

Run sm2 --start PDF_GENERATOR_SERVICE:1.20.0

Testing

Run ./run_all_tests.sh. This also runs scalafmt and does coverage testing.

or sbt test to run the tests only.

License

This code is open source software licensed under the Apache 2.0 License.