1. Purpose

This tool ensures reliable and efficient testing for conformance to the Ozone Connect implementation within the API Hub. It simplifies testing, enforces standards, and enhances quality and interoperability.

This guide provides step-by-step instructions to set up and use the test automation framework, including initializing configurations, running tests, and validating setups. It supports testing on OzoneAPI's mock server or custom servers with ease.

2. Scope

This manual covers the essential aspects of the Testing Tool, including its installation, usage, and testing capabilities. It provides detailed instructions and guidelines to help users effectively utilise the tool within their development and testing environments. The scope includes:

3. Audience

The primary audience for this manual includes developers, QA engineers, and technical implementers who are involved in the integration and testing of the Ozone Connect implementation for the API Hub.

This manual assumes that the audience has a basic understanding of CLI tools, Docker, CBUAE Open Finance Standards and Ozone Connect specifications.

4. Overview

The Testing Tool is a command-line interface (CLI) based testing tool designed to assist implementers in verifying their conformance to the Ozone Connect implementation. Developed specifically for the API Hub, the Testing Tool provides a comprehensive suite of tests that validate various aspects of the implementation against the predefined standard. The tool runs within a Docker container, ensuring a consistent and isolated testing environment. By using the Testing Tool, implementers can efficiently identify and rectify issues, ensuring that their implementations meet the required conformance criteria.

5. Setup Requirements

Before You Start:

• Familiarise yourself with the Ozone Connect specifications.

• Ensure you have https://www.docker.com/ installed locally on your machine to run Docker containers.

6. Usage

The instructions below are based on using the Testing Tool to test against the Ozone Connect v2024.46.00

6.1 Running the Testing Tool on OzoneAPI Mock Server with Default Settings

This command runs the Testing Tool Docker container with the default settings. It executes predefined tests against a cloud-based mock Ozone Connect server. Use it to explore the tool's functionality. The output HTML report will be available in the logs folder.

#Sample command without any client configuration being provided
docker run --user root --rm -it \
-v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \
public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0 \
yarn tr-ozone-connect \
--formatter terse \
--loglevel-runner info \
--config ./config/config.yaml \
--out /usr/o3/tr-ozone-connect/logs/test_logs.json \
-s 'Id:[get-accounts]' -r Id:'[AIS_A001]' 

6.2 Running the Testing Tool on a custom Server

To test the LFI’s implementation of Ozone Connect, execute the following commands. These commands allow you to add a custom configuration file and SSL certificates to connect the tool to the LFI’s server.

The basic command for this testing tool is shown below. Running it without any options will display a list of available options.

6.2.1 Constructing the command for the test tool

6.2.1.1 Base Command

Code Block
docker run --user root --rm -it \ -v "$(pwd)/config:/usr/o3/tr-ozone-connect/config" \ -v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \ public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0

6.2.1.2 Help Command

To view the available Options, run:

docker run --user root --rm -it \
-v "$(pwd)/config:/usr/o3/tr-ozone-connect/config" \
-v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \
public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0 help

6.2.1.3 Available Options

• init-config: Initialize the configuration folder if not already present.

• setup-config: Run the interactive configuration setup.

• validate-config: Validate the configuration file.

• yarn : Run the framework with Yarn and specified arguments.

• help: Show the help message.

The Base Command and the Help Command display the same output.

---

6.2.2 Initializing Configuration

To get started, the framework provides a default configuration setup.
Start by initializing the configuration on your host machine using the init-config command.

docker run --user root --rm -it \
-v "$(pwd)/config:/usr/o3/tr-ozone-connect/config" \
-v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \
public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0 init-config

Initializing Configuration...
Configuration file missing. Copying default config file...
Certificates folder missing. Copying default certs folder...

This command copies the required configuration files and certificates to the config folder inside the container, which is mapped to a newly created config folder in the host's current working directory (pwd). Additionally, a logs folder is created in the host's current working directory to store JSON logs and HTML reports generated after the tests.

6.2.2.1 Running a Sample Test

After initializing the default configuration, you can run the following command. It will execute tests against the same OzoneAPI mock server as described in section 6.1, but now explicitly uses the default configuration as input.
Line number 2 below.

docker run --user root --rm -it \
-v "$(pwd)/config:/usr/o3/tr-ozone-connect/config" \
-v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \
public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0 \
yarn tr-ozone-connect \
--formatter terse \
--loglevel-runner info \
--config ./config/config.yaml \
--out /usr/o3/tr-ozone-connect/logs/test_logs.json \
-s 'Id:[get-accounts]' -r Id:'[AIS_A001]' 

6.2.3 Updating Configuration

6.2.3.1 Editing config.yaml

To run tests on your own server, update the config.yaml file located in the newly created config folder on the host machine. Open the file and edit the necessary fields.

6.2.3.2 Using the Interactive Setup Tool

Alternatively, you can update the configuration using the interactive setup tool:
The setup tool will back up config.yaml as backup-config.yaml in the same folder.

docker run --user root --rm -it \
-v "$(pwd)/config:/usr/o3/tr-ozone-connect/config" \
-v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \
public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0 setup-config

Starting Config Manager: Setup Configuration...
Welcome to the Config Manager!
Note: Pressing enter will keep the current value.
Backup created: /usr/o3/tr-ozone-connect/config/backup-config.yaml

Enter the section to update (e.g., baseUrl, certs, accounts.accountTypes, payments.paymentTypes):

Refer to Section 7.1.2 for a comprehensive list of configurable options. After entering the required details, config.yaml file is updated with the new values.

6.2.4 Validating Configuration

To validate the configuration file, use the validate-config command: This command ensures the configuration file is properly formatted and that all required certificate files are present.

docker run --user root --rm -it \
-v "$(pwd)/config:/usr/o3/tr-ozone-connect/config" \
-v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \
public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0 validate-config

Starting Config Manager: Validate Configuration...
Validating configuration file...
All cert files are present.
Configuration validation passed.

6.2.5 Running the Testing Tool with custom configuration

The command to run the testing tool against the customer server is similar to the command in section 61. above, with the addition of updating the configuration file for the testing tool.
The only difference being the addition of line 3 which is the argument to mount the custom config folder.

#Sample command WITH the client configuration being provided
docker run --user root --rm -it \
-v "$(pwd)/config:/usr/o3/tr-ozone-connect/config" \
-v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \
public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0 \
yarn tr-ozone-connect \
--formatter terse \
--loglevel-runner info \
--config ./config/config.yaml \
--out ./test_logs.json \
-s 'Id:[get-accounts]' -r Id:'[AIS_A001]'

6.2.6 Components of the command

The command provided above docker run --user root --rm -it can has the following 3 parts.

1. Running the Docker Container: The first part runs the Testing Tool Docker container, mounting the necessary directories and setting up the environment:

2. Acquiring the latest docker image:

3. Executing the Ozone Testing Tool: This 3rd part executes the Ozone Testing Tool within the container with a set of specified options:

   Code Block
   yarn tr-ozone-connect \ --formatter terse \ --loglevel-runner info \ --config /usr/o3/tr-ozone-connect/config/config.yaml \ --out /usr/o3/tr-ozone-connect/logs/test_logs.json \ -s 'Id:[get-accounts]' -r Id:'[AIS_A001]'

6.2.7 Options to the tr-ozone-connect command

The available command line options for the yarn tr-ozone-connect command are listed in the table below.

7. Common Config Files Options

In order to run the above docker command against LFI’s implementation of Ozone Connect, the LFI needs to:

1. Create an input configuration file.

2. Provide the certificate files if required.

7.1 Configuration File

The configuration file can be created manually or generated using the init-config command. It should be placed in the ./config folder within the same directory where the docker run command will be executed.

7.1.1 Sample config.yaml file

baseUrl: https://mock.rt-cbuae.rt.dev.ozoneapi.co.uk
accounts-schema-file: der-cbuae-ozone-connect-data-sharing-openapi.json
payments-schema-file: der-cbuae-ozone-connect-service-initiation-openapi.json
event-action-schema-file: der-cbuae-ozone-connect-consent-events-actions-openapi.json
certs:
  transport:
    ca: /usr/o3/tr-ozone-connect/config/certs/ozone2021-ca.pem
    certFileName: /usr/o3/tr-ozone-connect/config/certs/ozone-issued-transport-HQuZPIt3ipkh33Uxytox1E.pem
    keyFileName: /usr/o3/tr-ozone-connect/config/certs/ozone-issued-transport-HQuZPIt3ipkh33Uxytox1E.key
aisBasePath: openbanking/v1/ais
pisBasePath: openbanking/v1/pis
validateBasePath: openbanking/v1
psuIdentifier:
  userId: '10000100000000000000002'
headers:
  o3-provider-id: RTCBUAE
  o3-aspsp-id: RTCBUAE
  o3-caller-org-id: '000015000000000000000001'
  o3-caller-client-id: 65e64982-f080-4785-a887-816f5274ea7e
  o3-caller-software-statement-id: '000016000000000000000004'
  o3-api-uri: open-banking/account-information/v1/accounts
  o3-api-operation: GET
  o3-consent-id: aac-6359d9-ab01458-c45a358cbf3230733
  o3-caller-interaction-id: bf630602-b0a5-467e-abe8-5e350f11f092
  o3-ozone-interaction-id: e2ff21ca-dd11-4c05-98ef-403dcc8e588d
  o3-psu-identifier: eyJ1c2VySWQiOiIxMDAwMDEwMDAwMDAwMDAwMDAwMDAwMDIifQ==
accounts:
  accountTypes:
    SampleAccount:
      accountIds: ['100004000000000000000002']
    Corporate_ChargeCard_Active:
      accountIds:
        - '100004000000000000000008'
      accountType: Corporate
      accountSubType: ChargeCard
      status: Active
    Corporate_Savings_NotActive:
      accountIds:
        - '100004000000000000000002'
      accountType: Corporate
      accountSubType: Savings
      status: NotActive
payments:
  paymentTypes:
    simple-cbuae-payment:
      paymentType: cbuae-payment
      ConsentId: 1a6d828f-ee97-467f-8626-b5db31f5b887
      Amount: 100
      currency: AED
      PaymentSequenceNumber: 4082668482
      PersonalIdentifiableInformation: eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ....
      PaymentPurposeCode: JEC
      paymentId: b04d4f92e75f4d7f93c0190aa9e4ee71

7.1.2 Configuration Fields

This section provides a detailed explanation of the configuration file fields used in the Testing Tool for Open Banking APIs.

7.2 Generating the SSL certificates

Note
The API Hub uses certificates from the OFTF when calling the LFI Ozone Connect service. The procedures below are included as a reference if developers want to do local testing. It is not recommended to deploy self signed certificates to Preprod or Production environments.

Acquire or generate the SSL certificates to connect to the Ozone Connect server. Put the certificates in a ./config/certs folder.

The certificates in the certs folder are critical for securing communications between the LFI and the OFP using mTLS.

Below you can find a brief explanation of how you can generate test certificates in order to run the testing tool against your implementation.

Please keep in mind that you can also use certificates provided by OFTF. In this case please skip certificate generation step.

7.2.1 Steps to Generate Test Certificates

1. Create a Certificate Authority (CA)

   • A CA is responsible for signing certificates. If you do not have an existing CA, you can create one.

   • Generate the private key for your CA:

     openssl genpkey -algorithm RSA -out dev-ca.key -aes256

   • Create a self-signed root certificate:

     openssl req -x509 -new -nodes -key dev-ca.key -sha256 -days 365 -out dev-ca.pem

2. Generate a Private Key for the Server

   • Generate the private key for your server:

     openssl genpkey -algorithm RSA -out dev-ca-issued-transport.key -aes256

3. Create a Certificate Signing Request (CSR)

   • Generate a CSR using the server's private key:

     openssl req -new -key dev-ca-issued-transport.key -out dev-ca-issued-transport.csr

4. Sign the CSR with Your CA

   • Use your CA to sign the CSR, creating the server certificate:

     openssl x509 -req -in dev-ca-issued-transport.csr -CA dev-ca.pem -CAkey dev-ca.key -CAcreateserial -out dev-ca-issued-transport.pem -days 365 -sha256

5. Verify the Certificate

   • Ensure the certificate is correctly generated and can be verified against the CA:

     openssl verify -CAfile dev-ca.pem dev-ca-issued-transport.pem

7.2.2 Summary of Files

• CA Certificate (dev-ca.pem)

  • The root certificate used to sign other certificates.

• Server Private Key (dev-ca-issued-transport.key)

  • The private key for the server, kept secure and not shared.

• Server Certificate (dev-ca-issued-transport.pem)

  • The public certificate signed by the CA, used for secure communications.

8. Detailed Steps to run the Testing Tool

Follow the instructions below to run the Testing Tool:

Step 1	Create an input test configuration file and set up it in /config folder.	Refer section 6.2.2 and section 6.2.3
Step 2	Acquire/Generate the SSL certificates and put them in a /config/certs folder.	Please follow the Test Certificates section in case you need to generate test certificates: 7.2.1 Otherwise please use OFTF Certificates.
Step 3	Execute the testing tool command.	Code Block #Sample command WITH the client configuration and custom tests being provided : docker run --user root --rm -it \ -v "$(pwd)/config:/usr/o3/tr-ozone-connect/config" \ -v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs" \ public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2024.46.0 \ yarn tr-ozone-connect \ --formatter terse \ --loglevel-runner info \ --config ./config/config.yaml \ --out ./test_logs.json \ -s 'Id:[get-accounts]' -r Id:'[AIS_A001]'
Step 4	The final section of the sample output, after all tests have been run and logs have been printed, will appear as follows.	The output will look similar but the Pass-Fail status might be different in the actual output.
Step 5	Review the Testing Tool output log file for the test case results. The log file's name is defined in the last part of the command from step 1. You can modify this name with each run. If unchanged, subsequent runs will overwrite the same file.	Use any text editor to view the file : $(pwd)/logs/test_logs.json
Step 6	The test run results are also available in an HTML file with a similar name to the test_logs.json file. This file is located in the same folder as the JSON log file.	Use any browser to open the html report file : $(pwd)/logs/test_logs.html

8.1 Sample Output Report

A sample html report file can be found in :

9. Test-Suite and Test-Case Regex Combinations for Running a Subset of Tests

Please note : The -s and the -r both the command line arguments are mandatory.

A wide variety of selection of test cases is possible. An example usage of the regex is listed below.

10. Test Cases

The list of referred tests is available in the following document: Ozone Connect Test Cases

The list of implemented test cases in the current version of the test framework are as follows : Implemented Test Cases

11. Recorded Demonstration of using this tool

The following video demonstration showcases how to customize an existing test case, enabling anyone to run it in their own environment.

12. New Khvafar HTML Report Demo Recording