This guide provides the necessary information and instructions on setting up an environment to allow for running Mock Data Holder integration tests using both Microsoft Visual Studio's Test Explorer and Docker. It also provides different options for setting up your environment and running tests to cater for different use cases.
Docker Desktop is installed and running.
Microsoft Visual Studio is installed.
Before being able to execute any Mock Data Holder automated tests, the following mock solution docker images are required:
- mock-register
- mock-data-holder
- mock-data-holder-energy
This guide explains how these docker images can be either built from scratch using GitHub repositories, 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.
By default, building a new docker image for a Mock Data Holder is performed by executing any of the integration test compose files as detailed in the Test Execution section below. The following steps are required before any of these compose files can be executed:
- Clone the Mock Data Holder repository using the following command:
git clone https://github.com/ConsumerDataRight/mock-data-holder.git
- The Mock Data Holder image requires the Authorisation Server as a prerequisite before it can be successfully built. The Authorisation Server repository can be cloned using following command:
git clone https://github.com/ConsumerDataRight/authorisation-server.git ./cdr-auth-server
- A PowerShell script is available in the mock-data-holder/Source folder that will copy the required Authorisation Server folders required to build a Mock Data Holder image. This can be executed in PowerShell with the command below.
.\copy-cdr-auth-server.ps1
The Mock Data Holder image is now ready to be built.
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 Mock Data Holder Banking Integration Tests Compose File can be executed using the docker compose command to run the tests within a docker container Banking industry:
docker compose -f "docker-compose.IntegrationTests.Banking.yml" up -d --build
This docker compose command will start the necessary docker containers and automatically run the Mock Data Holder Banking Integration Tests. The following screenshot shows an example of the Banking Mock Data Holder Integration Tests being run:
Similarly, the Mock Data Holder Energy Integration Tests Compose File can be executed using the docker compose command to run the tests within a docker container for the Energy industry:
docker compose -f "docker-compose.IntegrationTests.Energy.yml" up -d --build
Following the execution of the integration tests, a folder named '_temp' will be generated in the 'mock-data-holder/Source/DockerCompose' 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 mock-data-holder
127.0.0.1 mock-data-holder-energy
127.0.0.1 mock-data-holder-integration-tests
127.0.0.1 mock-data-holder-energy-integration-tests
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 execute tests using Microsoft Visual Studio, the Mock Data Holder, Mock Register and Microsoft SQL Server docker containers need to be running. The following docker compose commands will run these containers for a Banking or Energy Mock Data Holder.
To run a multi-container environment for a Banking Mock Data Holder, execute the following docker compose command from the mock-data-holder\Source\DockerCompose folder:
docker compose -f docker-compose.IntegrationTests.Banking.yml up -d --build mssql mock-register mock-data-holder
To run a multi-container environment for an Energy Mock Data Holder, execute the following docker compose command from the mock-data-holder\Source\DockerCompose folder:
docker compose -f docker-compose.IntegrationTests.Energy.yml up -d --build mssql mock-register mock-data-holder
The following screenshot shows an example of the Banking Mock Data Holder, Mock Register and Microsoft SQL Server docker containers running:
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 DataHolder.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 Banking 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 easy debug, step through or ever 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 DataHolder_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.