Civil CCD Definition and E2E tests

• Building and deploying application
• Testing
• Adding Git Conventions
• UI Test Documentation
• API Test Documentation

The project is dependent on other Civil repositories:

• civil-service
• civil-camunda-bpmn-definition

To set up complete local environment for Civil check civil-sdk

Preview environment will be created when opening new PR. Camunda BPMN definitions will be pulled from the latest GitHub release. Service instance will be running the latest image version deployed to ACR.

To access XUI visit url (make sure that it starts with https, otherwise IDAM won't let you log in):

• https://xui-civil-ccd-pr-PR_NUMBER.service.core-compute-preview.internal

To access Camunda visit url (login and password are both admin):

• https://camunda-civil-ccd-pr-PR_NUMBER.service.core-compute-preview.internal

The below labels are options to get the different services running on the PR

  "enable_keep_helm" label to retain helm release on preview

  "pr-values:enableNotifyEmails" label to be able to send live notifications on the PR

  "pr-values:elasticsearch" label to have elastic search running - needed for scheduler testing

  "pr-values:enableWA" label to verify work allocation task

  "pr-values:enableHmc" label to enable the HMC integration with services running in AAT.

  "civilServicePr:????" label to point this deployment to a specific civil-service image,
  replace ???? with the correspondent civil-service PR number, e.g. civilServicePr:6215 .

Note: enabling HMC, will create a custom CaseType in definitions and import it to AAT. Please delete the same after use by running:

curl -v -k -X DELETE \
  'http://ccd-definition-store-api-aat.service.core-compute-aat.internal/api/testing-support/cleanup-case-type/{PR_NUMBER}/?caseTypeIds=CIVIL'

Running Crossbrowser tests:

Install saucelabs on local machine

$ yarn test:crossbrowser

The repo uses codeceptjs framework for e2e tests.

To install dependencies enter yarn install.

To run e2e tests enter yarn test in the command line.

To run tests with browser window open set SHOW_BROWSER_WINDOW=true. By default, the browser window is hidden.

To run smoke tests enter yarn test:smoke.

To run functional tests enter yarn test:functional.

For running UI tests, set CCD_UI_TESTS=true

Before running API tests, you will need the SENDGRID_API_KEY environment variable setup and to be running the service locally along with all containers.

To run API tests enter yarn test:api. set CCD_UI_TESTS=false

Generating test documentation JSON:

1. yarn test:generate:ui-docs writes e2e/e2e-documentation/results/codeceptjs-ui-tests.json.
2. yarn test:generate:api-docs writes e2e/e2e-documentation/results/codeceptjs-api-tests.json.

Uploading to Confluence:

1. Export CONFLUENCE_PERSONAL_ACCESS_TOKEN, CONFLUENCE_BASE_URL, and CONFLUENCE_PAGE_ID.
2. yarn test:confluence:ui-docs updates the "UI Tests" table on the Confluence page.
3. yarn test:confluence:api-docs updates the "API Tests" table.
4. Optional: pass a custom JSON path as the first argument to either script.

Updating README tables:

1. yarn test:readme:ui-docs refreshes the UI section and yarn test:readme:api-docs refreshes the API section (run both commands to update the entire table set).
2. Optional: pass a custom JSON path as the first argument to either script (e.g. yarn test:readme:ui-docs ../path/to/ui.json).
3. Commit README changes if required.
4. The workflow in .github/workflows/update-readme-docs.yml runs these scripts automatically on master.

1. Running a test_name.js

• Select the .js file containing the tests you want to run and modify its run configuration.

• Set "Node interpreter" to: [...]\node.exe

• Set "Node parameters" to: "[...]\civil-ccd-definition\node_modules\codeceptjs\bin\codecept.js" run --debug --verbose

• Set "Working directory" to: "[...]\civil-ccd-definition"

• Set JavaScript file to: "[...]\test_name.js"

• Set "Environment variables" to:

• S2S_SECRET=[...];ENVIRONMENT=[...];NODE_TLS_REJECT_UNAUTHORIZED=0;SHOW_BROWSER_WINDOW=true

2. Running a test from package.json

• Run > Edit configurations > + > Node.js

• Set "Node interpreter" to: [...]\node.exe

• Set "Node parameters" to: "[...]\civil-ccd-definition\node_modules\codeceptjs\bin\codecept.js" run --grep @[test_name] --debug --verbose

• Set "Working directory" to: "[...]\civil-ccd-definition"

• Set "Environment variables" to:

• S2S_SECRET=[...];ENVIRONMENT=[...];NODE_TLS_REJECT_UNAUTHORIZED=0;SHOW_BROWSER_WINDOW=true

• Make sure your git version is at least 2.9 using the git --version command
• Run the following command:

git config --local core.hooksPath .git-config/hooks

Once the above is done, you will be required to follow specific conventions for your commit messages and branch names.

If you violate a convention, the git error message will report clearly the convention you should follow and provide additional information where necessary.

Optional:

• Install this plugin in Chrome: https://github.com/refined-github/refined-github

  It will automatically set the title for new PRs according to the first commit message, so you won't have to change it manually.

  Note that it will also alter other behaviours in GitHub. Hopefully these will also be improvements to you.

In case of problems

1. Get in touch with your Technical Lead so that they can get you unblocked

2. If the rare eventuality that the above is not possible, you can disable enforcement of conventions using the following command

   git config --local --unset core.hooksPath

   Still, you shouldn't be doing it so make sure you get in touch with a Technical Lead soon afterwards.

As an alternative for a development environment there is a procedure in place where after running the command below the required services for Civil are created in Preview under the developer's name, so these will be exclusively for the named developer use.

While connected to the VPN simply run one of the below commands from your project's (civil-ccd-definition) folder: Note: be sure to have Docker running

echo "CIVIL_SERVICE_IMAGE=latest" >> .env.local && npx @hmcts/dev-env@latest --env .env.local && ./bin/setup-devuser-preview-env.sh

You can optionally specify a branch for CCD definitions and Camunda definitions like below or leave it blank to use master.

echo "CIVIL_SERVICE_IMAGE=latest" >> .env.local && npx @hmcts/dev-env@latest --env .env.local && ./bin/setup-devuser-preview-env.sh camundaBranch dmnBranch waStandaloneBranch

Once the pods are up and running you can connect to them using a plugin called Mirrord on Intellij. https://mirrord.dev

If you want to clean up the environment just run:

npx @hmcts/dev-env@latest --delete

To run the specialised charts, where you can get Work Allocation for instance, run:

npx @hmcts/dev-env@latest --template values.enableWA.preview.template.yaml && ./bin/setup-devuser-preview-env.sh

Note: enabling HMC, will create a custom CaseType in definitions and import it to AAT. Please delete the same after use by running:

./bin/delete-dev-preview-definition-from-aat.sh

For now any Hearings related PRs, i.e. that requires HMC/ILA must undergo some manual setup.

1 - Execute the commands below replacing ${PR_NUMBER} accordingly to create the topic subscription required

    az servicebus topic subscription create --resource-group hmc-shared-aat --namespace-name hmc-servicebus-aat \
      --topic-name hmc-to-cft-aat --subscription DCD-CNP-DEV --name hmc-to-civil-subscription-pr-${PR_NUMBER} \
      --subscription DCD-CNP-DEV && \
    az servicebus topic subscription rule create --resource-group hmc-shared-aat --subscription DCD-CNP-DEV\
      --namespace-name hmc-servicebus-aat --topic-name hmc-to-cft-aat \
      --subscription-name hmc-to-civil-subscription-pr-${PR_NUMBER} \
      --name hmc-servicebus-aat-subscription-rule-civil --subscription DCD-CNP-DEV\
      --filter-sql-expression "hmctsServiceId IN ('AAA7','AAA6')"

(Remember to delete this once finished with the PR using "az servicebus topic subscription delete")

2 - Add the label pr-values:enableHmc on your GitHub PR

3 - When in XUI/CUI the case type will have an extension to your PR number added to it.

This project is licensed under the MIT License - see the LICENSE file for details