SSCS - Tribunals Case API

Purpose

Tribunals case api is a spring boot based application to create new appeals for the SSCS Appellants

Prerequisites

For versions and complete list of dependencies see build.gradle

• Java 17
• Spring Boot
• Gradle

Building and deploying the application

Building the application

To build the project execute the following command:

./gradlew build

Running the application

Run the application by executing:

./gradlew bootWithCCD

Cftlib

This repo is now integrated with the rse-cft-library. For more information see the bootWithCCD task in build.gradle. Extra compose files can be provided in src/cftlib/resources/docker.

Running Smoke Test locally

Once the application running locally, please make sure

1. Your local CCD is up and running with subscription id "7S9MxdSBpt"
2. Execute ./gradlew --info smoke

Running tribunals with hearings enabled

If you need to test Tribunals with HMC Hearings you must carry out the following steps:

1. First you need to create a pull request on github for your branch

2. The branch should have the labels: enable_keep_helm, pr-values:hearings

3. Pipeline will generate and upload CCD Definition file to AAT CCD.

4. You can optionally generate the definition file locally using below commands (4120 represents the Pull request number):

   ./bin/create-xlsx.sh benefit dev pr true 4120

5. The callbacks for the CaseEvents must match the service ingress values within your PR's preview chart. Here is an example of a callback URL for a tribunals PR with an id of 4120:

   https://sscs-tribunals-api-pr-4120.preview.platform.hmcts.net/ccdAboutToSubmit
   

6. Once definition is successfully uploaded to AAT by pipeline or manually, you will need to create a service bus subscription for the HMC hearings topic on AAT. In the Azure portal go to hmc-servicebus-aat and create a subscription for the hmc-to-cft-aat topic, name it in this format:

   hmc-to-sscs-subscription-pr-XXXX
   

7. And on that subscription create a Correlation filters with these values:

   hmctsServiceId:BBA3
   hmctsDeploymentId:deployment-sscs-tribunals-api-pr-xxxx
   

Once this is done you should be able to deploy to preview with hearings enabled.

Note: When you are finished with preview testing, remember to delete the uploaded CCD definition from AAT and the subscription created on hmc-to-cft-aat. ccd-def-cleanup should delete the ccd def file you uploaded, given the enable_keep_helm label is not on your PR.

Running in Docker(Work in progress...)

Create the image of the application by executing the following command:

  ./gradlew installDist

Create docker image:

  docker-compose build

Run the distribution by executing the following command:

  docker-compose up

This will start the API container exposing the application's port

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:8008/health

You should get a response similar to this:

  {"status":"UP"}

Unit tests

To run all unit tests execute the following command:

./gradlew test

Mutation tests

To run all mutation tests execute the following command:

./gradlew pitest

Running contract or pact tests:

You can run contract or pact tests as follows:

./gradlew contract

You can then publish your pact tests locally by first running the pact docker-compose:

docker-compose -f docker-pactbroker-compose.yml up

and then using it to publish your tests:

./gradlew pactPublish

or to run the tests and publish in one go you can run the following:

./gradlew runAndPublishConsumerPactTests

In order to run the CCD Provider Tests to determine that the CCD Consumer contract tests published here can be verified you'll need to check out the following github repo:

https://github.com/hmcts/ccd-data-store-api/tree/TA-82_CcdProviderPactTest

And run the following test ensuring that the Pacts created here are published to your local Pact Broker instance and that you have an up to date CCD Docker setup running locally with up to date CCD definition deployed

https://github.com/hmcts/ccd-data-store-api/blob/TA-82_CcdProviderPactTest/src/contractTest/java/uk/gov/hmcts/ccd/v2/external/controller/CasesControllerProviderTest.java

Please change the version tag to point to 'Dev' and ensure the Pact Broker annotations point to your local Pact Broker instance

@PactBroker(scheme = "${PACT_BROKER_SCHEME:http}",
    host = "${PACT_BROKER_URL:localhost}",
    port = "${PACT_BROKER_PORT:80}", consumerVersionSelectors = {
    @VersionSelector(tag = "Dev")})

Also if you require the Provider verification to be published uncomment the following line before running the CasesControllerProviderTest:

  System.getProperties().setProperty("pact.verifier.publishResults", "true");

If you need to run the CCD provider test against the Preview environment for a particular branch of code then please ensure that the Pact Broker annotations are pointing to the central reform Pact Broker with the following credentials ( with the tag in the @VersionSelector pointing to your feature branch name of the PR):

@PactBroker(scheme = "${PACT_BROKER_SCHEME:https}",
    host = "${PACT_BROKER_URL:pact-broker.platform.hmcts.net}",
    port = "${PACT_BROKER_PORT:443}", consumerVersionSelectors = {
    @VersionSelector(tag = "feature_branch_name")})

Running Functional UI tests against Preview env on a Pipeline

By default preview pipelines would just have 1 test as part of sanity check on Preview env, but QA's would need to add label test-suite:preview-regression to their respective ticket PR's to enable running regression UI test pack against preview env.

The format of the label added to run UI tests is always test-suite:<tag-name> so please make sure if above tag name(ie preview-regression) gets updated on tests or new tags added needs github label name to be updated or new label to be created depending on your scenario.

In order to include Bundling & Hearings tests as part of preview pipeline, QA's need to add an additional label test-suite:aat-regression against their PR. As a pre-requisite to add "aat-regression" label please make sure your PR has gone through the config set-up explained in this section Running tribunals with hearings enabled of readme.

Cron tasks

• You can run a cron task locally by setting the TASK_NAME environment variable.

  #Example
  TASK_NAME=MigrateCasesTask ./gradlew bootRun

• You can run a cron task in preview by adding pr-labels:job label on the PR in Github. Configure any additional configuration needed in values.job.preview.template.yaml

• Refer to this sample for setting up cron task in flux.

Gotchas

PRs that start with "Bump" won't have a preview environment. The decision was made after we realised that most the preview environments were created by Depandabot.

Preview cases not listing

Elastic indices may be missing on preview. They can be recreated by login into ccd admin for e.g. - https://admin-web-sscs-tribunals-api-pr-4091.preview.platform.hmcts.net/ and clicking on "Create Elasticsearch Indices" link. This would avoid re-triggering the pipeline build and save time.