How to create an Integration test

How to Integration test¶

In this how to guide you will learn how to create, deploy, and run an Integration test for a Platform service (Web App, User Interface etc) for your team.

Prerequisites¶

Before adding tests for your service, you will need to ensure that:

Overview¶

By completing this guide, you will have completed these actions:

Learned how to add an Integration test for your service.
Learned how to run an Integration test locally.
How to customize your pipeline to run Integration tests for different env.

Guide¶

Note

Every pipeline run includes steps to run varoious tests pre deployment and post deployment. These tests may include unit, integration, acceptance, performance, accessibilty etc as long as they are defined for the service.

The pipeline will check for the existence of the file ./docker-compose.test.yaml to determine if integration tests have been defined.

How to add an Integration test for your service?¶

The Integration Test scripts should be added to the test\integration folder in the GitHub repository of the service. Refer to the ffc-demo-web example. This folder should contain *.test.js files which are required to execute the tests. Tests will be run using PACT BROKER service.

Requirments for local development¶

Docker Desktop 2.2.0.3 (42716) or higher

How to run an Integration test locally?¶

Executre the above commands in bash or PowerShell

# this will execute the docker-compose at the root folder to create an instance of the service and its dependences
docker-compose -f docker-compose.yaml -f docker-compose.test.yaml -p "<<servicename>>-test" up

How to customize your pipeline to run Integration tests?¶

You can customize the environments where you would like to run Integration test (within the pipeline it is referred as integration test)

postDeployTest:
  envToTest: snd4
  testEnvs:
    integrationTests: snd4
  testsToRun: 'integration'

Please refer ffc-demo-web pipeline:

How to disable test?¶

if you want to disable the test for any reason please refer Disable Test