- Introduction
- Prerequisites
- Getting Started
- Test Execution
- Running Tests Using Docker Containers
This guide provides the necessary information and instructions on setting up an environment to allow for running:
- CDR Authorisation Server integration tests
- CDR Authorisation E2E tests (End-to-end tests that cover user interface testing)
- Get Data Recipient Azure Function integration tests
This guide also provides different options for setting up your environment and running tests by using either Microsoft Visual Studio's Test Explorer or Docker to cater for different use cases.
Docker Desktop is installed and running.
Microsoft Visual Studio is installed.
Before being able to execute any CDR Authorisation Server automated tests, a Mock Register docker image is required.
This guide explains how a Mock Register docker images can be either built from scratch using the Mock Register GitHub repository, or pulled directly from Docker Hub.
The Mock Register image can be either built from the GitHub Mock Register repository, or pulled directly from Docker Hub. This guide describes both options and their respective use cases.
Building your own Mock Register image may be useful if you want to make changes to any source code in the Mock Register solution. Follow the steps below to build a Mock Register image from scratch:
- Clone the Mock Register repository using the following command.
git clone https://github.com/ConsumerDataRight/mock-register.git
- Run the following command to build the Mock Register docker image from the
mock-register\Sourcefolder:
docker build -f Dockerfile -t mock-register .
The Mock Register docker image should now be available for use in Docker. For further and more detailed documentation regarding the Mock Register, refer to the Mock Register GitHub repository.
Pulling the latest Mock Register image from Docker Hub is a quicker and easier alternative to building your own Mock Register image from scratch. It is recommended for most cases where customisation of the Mock Register code base is not required.
This can be done by simply executing the following docker commands:
docker pull consumerdataright/mock-register
docker image tag consumerdataright/mock-register mock-register
The Mock Register image should now be available for use in Docker.
Automated tests can be executed by either using a docker container or by running them directly from Microsoft Visual Studio's Test Explorer. This guide describes both options and their respective use case.
Running tests using a docker container is useful when debugging or stepping through the test's code is not required.
The CDR Authorisation Server Integration Tests Compose File can be executed using the docker compose command to run the tests within a docker container:
docker compose -f "docker-compose.IntegrationTests.Standalone.yml" up -d --build
This docker compose command will start the necessary docker containers and automatically run the CDR Authorisation Server Integration Tests. The following screenshot shows an example of these tests being run:
The CDR Authorisation Server E2E Tests Compose File can be executed using the docker compose command to run the tests within a docker container::
docker compose -f "docker-compose.E2ETests.Standalone.yml" up -d --build
This docker compose command will start the necessary docker containers and automatically run the CDR Authorisation Server E2E Tests. The following screenshot shows an example of these tests being run:
The Get Data Recipients Integration Tests Compose File can be executed using the docker compose command to run the tests within a docker container::
docker compose -f "docker-compose.GetDataRecipients.IntegrationTests.yml" up -d --build
This docker compose command will start the necessary docker containers and automatically run the Get Data Recipients integration tests. The following screenshot shows an example of these tests being run:
Note: The above composed multi-containers must be run independently and cannot co-exist. For example, in order to switch from running E2E tests to running Get Data Recipients integration tests, the E2E Tests multi-container must be deleted before running the compose command for Get Data Recipients integration tests.
Following the execution of tests using Docker, a folder named '_temp' will be generated in the 'cdr-auth-server/Source' folder. This will contain test results in TRX format and any other artifacts created by the test automation execution. The TRX test results file can be opened and viewed in Microsoft Visual Studio as per example screenshot below:
Running tests using Microsoft Visual Studio is required when wanting to debug or step through the test's source code.
The following host names must be registered in the local machine's hosts file (located in C:\Windows\System32\drivers\etc).
127.0.0.1 mock-register
127.0.0.1 cdr-auth-server
127.0.0.1 cdr-auth-server-integration-tests
127.0.0.1 cdr-auth-server-e2e-tests
127.0.0.1 cdr-auth-server-standalone
127.0.0.1 getdatarecipients
127.0.0.1 mssql
A Windows Environment variable for ASPNETCORE_ENVIRONMENT is required to be added and set to Release.
The Mock CDR CA Certificate is required to be installed in the local machine's Trusted Root Certification Authorities store. Consult the Certificate Management documentation for more information about how certificates are used in CDR Mock Solutions.
Before being able to run tests using Microsoft Visual Studio, the required docker containers need to be running in a multi-container docker environment. The following docker compose commands will run the necessary containers:
To setup a multi-container docker environment for CDR Authorisation Server Integration Tests, execute the following docker compose command from the cdr-auth-server\Source folder:
docker compose -f "docker-compose.IntegrationTests.Standalone.yml" up -d --build mssql mock-register cdr-auth-server
To setup a multi-container docker environment for CDR Authorisation Server E2E Tests, execute the following docker compose command from the cdr-auth-server\Source folder:
docker compose -f "docker-compose.E2ETests.Standalone.yml" up -d --build mssql mock-register cdr-auth-server
To setup a multi-container docker environment for Get Data Recipients Integration Tests, execute the following docker compose command from the cdr-auth-server\Source folder:
docker compose -f "docker-compose.GetDataRecipients.IntegrationTests.yml" up -d --build azurite mssql mock-register cdr-auth-server getdatarecipients
The following screenshot shows an example of the Get Data Recipients multi-container environment running in Docker:
Tests can now be run using Microsoft Visual Studio.
The following steps detail the process of running tests using Microsoft Visual Studio's Test Explorer:
-
Open the CdrAuthServer.sln solution file in Microsoft Visual Studio.
-
Build the solution.
-
Open the Test Explorer. If Test Explorer is not visible, choose 'Test' on the Visual Studio menu and then choose 'Test Explorer'.
-
Right click the test, or group of tests to execute and select 'Run' as per screenshot below:
The screenshot below is an example of successfully completed Get Data Recipient integration tests:
The Test Automation projects use the ConsumerDataRight.ParticipantTooling.MockSolution.TestAutomation NuGet package. The source code for this repository is available in the Mock Solution Test Automation repository. Cloning this repository to your local machine will allow you to easily debug, step through or even modify any code that was used to build the NuGet package.
This repository can be cloned using following command:
git clone https://github.com/ConsumerDataRight/mock-solution-test-automation.git
The CdrAuthServer_Shared.sln solution has been created to allow for debugging and stepping through the source code used in Mock Solution Test Automation project.
Select the Shared solution configuration in Visual Studio to switch from using the Mock Solution Test Automation NuGet package to the using the ConsumerDataRight.ParticipantTooling.MockSolution.TestAutomation project instead:
This will allow for debugging, stepping through and modifying the source code that is used to create the NuGet package. Right click the test, or group of tests you'd like to debug and select 'Debug' to begin debugging tests.
For more information on using Microsoft Test Explorer, search for 'Test Explorer' at Microsoft Learn.