1. Purpose

The purpose of the tool is to provide implementers with a reliable and efficient test tool for ensuring conformance to the Ozone Connect implementation within the API Hub. This tool aims to simplify the testing process, ensure adherence to standards, and enhance the overall quality and interoperability of implementations.

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 Docker: Accelerated Container Application Development 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.34.00

Below is the command which runs the Testing Tool Docker container with the specified configuration and logging options for running some pre-defined tests against the mock Ozone Connect Server hosted in the cloud:

In order to run the tests against the LFI’s implementation of Ozone Connect the next command should be executed:

Line number 3 is newly added below.

 In order to run tests with modified test data we can add a test configuration file and mount it to the appropriate place in the container :

Line numbers 4,5 and 6 are newly added below.

The command provided above can be broken down into three main 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:

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

1. Create a common configuration file.

2. Create one or more test input configuration file/s.

6.1 Common Config Files Options

1. Create an input configuration file and put it in a ./config folder.

2. Acquire or generate the SSL certificates to connect to the Ozone Connect server.

3. Put the certificates in a ./config/certs folder.

4. Execute the command from the parent folder of ./config to run the tests.

For more details about the options in the configuration file, please review section the tablebelow.

6.1.1 Configuration File

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

A sample configuration file (config.yaml) is as follows :

6.1.2 Test Certificates

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.

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 ozone2021-ca.key -aes256

   • Create a self-signed root certificate:

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

2. Generate a Private Key for the Server

   • Generate the private key for your server:

     openssl genpkey -algorithm RSA -out ozone-issued-transport.key -aes256

3. Create a Certificate Signing Request (CSR)

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

     openssl req -new -key ozone-issued-transport.key -out ozone-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 ozone-issued-transport.csr -CA ozone2021-ca.pem -CAkey ozone2021-ca.key -CAcreateserial -out ozone-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 ozone2021-ca.pem ozone-issued-transport.pem

Summary of Files

• CA Certificate (ozone2021-ca.pem)

  • The root certificate used to sign other certificates.

• Server Private Key (ozone-issued-transport.key)

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

• Server Certificate (ozone-issued-transport.pem)

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

6.2 Test Input Configurations

In order to run the command with custom test data, the LFI needs to :

1. Create new test input configuration file/s with a name similar to the test suite and suffixed by .test.yaml
   For example the test suite is : get-accounts, then the name of the test input configuration file will get-accounts.test.yaml
   The name of the test suite can be found when we run the command and in the output we observe :
   + Running suite: get-accounts - AIS Endpoints
   OR
   get-accounts - 9/11 - AIS Endpoints 

2. Currently there are 3 test suites added in the test tool.

   1. get-accounts

   2. get-transactions

   3. get-payments
      So the LFI can create 3 such files and mount them to appropriate files inside the container.
      These files are already present inside the container. Mounting files from outside will override the files inside the container.
      So we can run the tests with either the default test data or with mount new test data.

3. The mount points for all the 3 files inside the container are as follows :

   1. The mount point for get-accounts.test.yaml inside the container is /usr/o3/tr-ozone-connect/tests/data-sharing/get-accounts.test.yaml

   2. The mount point for get-transactions.test.yaml inside the container is /usr/o3/tr-ozone-connect/tests/data-sharing/get-transactions.test.yaml

   3. The mount point for get-payments.test.yaml inside the container is /usr/o3/tr-ozone-connect/tests/service-initiaiton/get-payments.test.yaml

4. We mount these files inside the container using the command line argument “-v”
   Example : -v "$(pwd)/get-accounts.test.yaml:/usr/o3/tr-ozone-connect/tests/data-sharing/get-accounts.test.yaml" \

6.2.1 Sample Test Input Configuration Files

6.2.1.a get-accounts.test.yaml

6.2.1.b get-transactions.test.yaml

6.2.1.c get-payments.test.yaml

6.3 Configuration Description

7. Running 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.	Please follow the Configuration File section in order to generate the required file: Testing Tool User Guide | 6.2 Configuration File
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: Testing Tool User Guide | 6.3 Test Certificates Otherwise please use OFTF Certificates.
Step 3	Execute the testing tool command.
Step 4	The final section of the sample output, after all tests have been run and logs have been printed, will appear as follows.	Open
Step 5 (optional)	Review the Testing Tool output log file containing the test case results. The log file's name is specified in the last part of the command in step 1 above. You can change this name each time you run the command. If not changed, successive runs will overwrite the same file.	Use any text editor to view the file : vim $(pwd)/logs/test_logs.json

8. Test Cases

The list of supported test cases is available in the following document: Ozone Connect Test

9. Recorded Demonstration of using this tool

Open