Installation and setup

Provides instructions for installing and setting up the Testing Tool using Docker, including prerequisites and initial configuration. This tool has been successfully tested on Ubuntu Linux and on MacOS.

Usage instructions

Details the commands and options available in the Testing Tool CLI tool, with examples for effective usage.

Testing

Explains the testing procedures and conformance checks, including how to run tests and interpret the results.3. Audience

-v "$(pwd)/config:/usr/o3/tr-ozone-connect/config"

If the LFI configuration is not provided, the tool will attempt to connect to a the Ozone Connect mock server deployed by Ozone in the cloud. For detailed information on the configuration file format, please refer to the configuration file section: 7.1.2

SSL certificates are necessary for secure mTLS connection between the Testing Tool and LFI’s implementation of Ozone Connect. The method to generate these certificates is documented in the Certificates Generation section: 7.2

After generating the certificates, copy them into a folder named config/certs on the host machine from where the test command will be executed. These copied files are then passed to the Docker container using the configuration options mentioned earlier.

-v "$(pwd)/logs:/usr/o3/tr-ozone-connect/logs"

This option is mandatory and must be provided to access the logs after the program runs. Both the logs and the HTML output report will be available in this folder once the tests are complete.

public.ecr.aws/g5c5c6i0/tr-image/tr-ozone-connect:2025.3.1 \

This is the location of the publicly available Test Tool Docker image.

-h, --help

Show help (boolean)

-c, --config

Input test configuration files in .yaml or .json format
(Format : string, required)

config.yaml, config.json, ./config/config.yaml

-f, --folder

Preconfigured path to the folders with the test files
(Format : string, required)

src/tests, tests, ./src/tests

-o, --out

Output file name
(Format : string, optional)
A log file and an HTML output report are generated with the name specified in this option.

results.json, output.json, ./test_output.json

-e, --formatter

Use a standard formatter for the output
(Format : string, optional)

full, terse, medium, errors

-s, --regex_for_test_suite

Provide the full name of the test suite from the list.
comma separated list if multiple SuiteId needs to be tested. (No leading and trailing whitespace)

(Format : comma separated string, required)

The full list of test suites currently available are :

SuiteIds

Examples:
‘Id:[GET /accounts/{accountId}/customer]’,

‘Id:[GET /accounts/{accountId}/customer,GET /accounts/{accountId}]’

-r, --regex_for_test_case

Provide a regular expression for running selected tests.

(Format : string, required)

The list of the test case names can be found in the Sample Html Report of the Testing Tool

Example regex values are :
‘Id:[AIS_A001]'
'Id:[AIS_A001,AIS_A002]'
'Id:[AIS_A.*]'
'Id:[AIS_A.*,AIS_B.*]'
'Id:[AIS_A009,AIS_A001,AIS_A005]'

Note there is no space after the comma which separates the regex.
Also note that the complete expression is inside single quotes.

-v, --loglevel-runner

Log level for the test runner (Format : string, optional)

debug, info, silent (In the order of precedence)

-l, --loglevel-suite

Log level for the test suite (Format : string, optional)

debug, info, error (In the order of precedence)

--version

Show version number (boolean)

baseUrl

• Description: The base URL for the API endpoints.

• Type: String

• Example Value: https://<Some URL>

psuIdentifier

• userId

• Description: The user identifier (PSU ID) used in the context of AIS.

• Type: String

• Example Value: 10000100000000000000002

aisBasePath

• Description: The base path for the Bank Data Sharing endpoints.

• Type: String

• Example Value: openbanking/v1/ais

pisBasePath

• Description: The base path for the Bank Service Initiation endpoints.

• Type: String

• Example Value: openbanking/v1/pis

authorization_type

• Description: The type of authorization.

• Type: String

• Currently we support only JWT and none.

server

• aud

Identifier for the party receiving the JWT. This must be set to the PROVIDER_ID specified by Ozone during configuration.

server

• request_object_signing_alg

PS256

server

• expiry_in_sec

We recommend an expiry time of 10-30s.

When validating the JWT, allow for a 10s clock skew.

server

certs

• transport

  • ca

• Description: Path to the CA certificate for transport layer security.

• Type: String

• Example Value: /usr/o3/tr-ozone-connect/config/dev-ca.pem

server

certs

• transport

  • certFileName

• Description: Path to the transport layer certificate file.

• Type: String

• Example Value: /usr/o3/tr-ozone-connect/config/dev-ca-issued-transport.pem

server

certs

• transport

  • keyFileName

• Description: Path to the private key file for the transport layer certificate.

• Type: String

• Example Value: /usr/o3/tr-ozone-connect/config/dev-ca-issued-transport.key

server

certs

• signing

  • kid

The key ID of key-pair used to sign the message as published on the JWKS. The specification does not support the use of other means of identifying the key as they are not considered to be secure enough (e.g. x5c and x5u are not supported).

server

certs

• signing

  • certFileName

Path to the public certificate file containing the X.509 certificate used for JWT signature verification

server

certs

• signing

  • keyFileName

Path to the private key file used for signing JWTs with PS256 algorithm

headers

• o3-ozone-interaction-id

• Description: A unique identifier for tracking interactions. Each request should have a new uuid

• Type: String

• Example Value: 1c7ee40a-3fa4-406f-a7d5-d935e3910742

headers

• o3-api-operation

• Description: The HTTP method used for the API operation.

• Type: String

• Example Value: GET

headers

• o3-aspsp-id

• Description: The identifier of the LFI.

• Type: String

• Example Value: RTCBUAE

headers

• o3-api-uri

• Description: The URI for the specific API endpoint.

• Type: String

• Example Value: open-banking/account-information/v1/accounts

headers

• o3-caller-org-id

• Description: The organization ID of the API caller.

• Type: String

• Example Value: 000015000000000000000001

headers

• o3-caller-client-id

• Description: The client ID of the API caller.

• Type: String

• Example Value: 0b196be9-d515-4052-88ac-69585d073030

headers

• o3-caller-software-statement-id

• Description: The software statement ID of the API caller.

• Type: String

• Example Value: 000016000000000000000004

headers

• o3-consent-id

• Description: The consent ID provided by the PSU.

• Type: String

• Example Value: 17ac7372-2b42-4856-8724-664c256dbba0

headers

• o3-psu-identifier

• Description: The identifier for the PSU, typically a base64-encoded JSON object.

• Type: String

• Example Value: YmFzZTY0IGVuY29kZWQgSnNvbiBzdHJpbmc=

headers

• o3-provider-id

• Description: The identifier for the service provider.

• Type: String

• Example Value: RTCBUAE

headers

• o3-caller-interaction-id

• Description: A unique identifier for tracking caller interactions.

• Type: String

• Example Value: e4180e49-e895-4d6f-80d0-7f5c8f01ee4d

accounts-schema-file

• Description: Path to the dereferenced swagger file for the data-sharing apis

• Type: String

• Default and only value : der-cbuae-ozone-connect-data-sharing-openapi.json

• This field is required for validating the response with the schemas.

payments-schema-file

• Description: Path to the dereferenced swagger file for the service-initiation apis

• Type: String

• Default and only value : der-cbuae-ozone-connect-service-initiation-openapi.json

• This field is required for validating the response with the schemas.

event-action-schema-file

• Description: Path to the dereferenced swagger file for the consent event action apis

• Type: String

• Default and only value : der-cbuae-ozone-connect-consent-events-actions-openapi.json

• This field is required for validating the response with the schemas.

insurance-schema-file

• Description: Path to the dereferenced swagger file for the insurance apis

• Type: String

• Default and only value : cbuae-ozone-connect-insurance-data-sharing-openapi.json

• This field is required for validating the response with the schemas.

accounts

• accountTypes

• Description: A list of accountToTest key-value pairs which are internally used in the tests.

• Type: Array

• Example :

  • Retail_CurrentAccount_Active

  • AccountIdWithInValidBalanceType

  • AccountIdWithCreditIndicatorRetail_CustomerType

  • Corporate_CustomerType

  • SME_CustomerType

• All the accountToTest are a crucial part of the test framework. To modify the parameters of any data-sharing related test we should know the accountToTest value of that test.

• Then add that accountToTest in the config.yaml file.

A list of all the accountToTest values can be found in the document : Customizable Fields for Ozone Connect Testing Tool

payments

• paymentTypes

• Description : A list of paymentToTest key-value pairs which are internally used in the tests.

• Type : Array

• Example :

  • single-instant-payment-for-SME

  • AcceptedSettlementCompleted

  • simple-cbuae-payment

  • single-instant-payment-for-retail

• All the paymentToTest are a crucial part of the test framework. To modify the parameters of any service-initiation related tests we should know the paymentToTest value of the test.

• Then add that paymentToTestin the config.yaml file.

• A list of all the paymentToTest values can be found in from line number 350 onwards in the document : Customizable Fields for Ozone Connect Testing Tool

Step 1

Create an input test configuration file and set up it in /config folder.

Refer section 6.1.2 and section 6.1.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.

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.

Open

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

1

-s 'Id:[GET /accounts]' -r Id:'[.*]'

Execute all test cases from the GET /accounts test suite only.
Test cases from other suites will not be attempted for execution.

2

-s 'Id:[GET /accounts]' -r Id:'[AIS_A001]'

Execute only the test case AIS_A001 from the GET /accounts test suite.
All other test cases from the GET /accounts test suite will be skipped.
Test cases from other suites will not be attempted for execution.

3

-s 'Id:[GET /accounts]' -r Id:'[00.]'

Execute all the tests from the GET /accounts test suite which have the testId among one of 000, 001, 002, 003, 004, 005, 006, 007, 008, 009.

Test cases from other suites will not be attempted for execution.

4

-s 'Id:[GET /accounts,GET /accounts/{accountId}/direct-debits,GET /customers]' -r Id:'[.*]'

Execute all the test case from the 3 test-suites.

• GET /accounts

• GET /accounts/{accountId}/direct-debits

• GET /customers

Test cases from other suites will not be attempted for execution.
Also note that do not place spaces after and before the commas

5

-s 'Id:[GET /accounts/{accountId}/customer,GET /accounts/{accountId},GET /accounts,GET /accounts/{accountId}/balances,GET /accounts/{accountId}/beneficiaries,GET /customer,GET /accounts/{accountId}/direct-debits,GET /accounts/{accountId}/products,GET /accounts/{accountId}/scheduled-payments,GET /accounts/{accountId}/standing-orders,GET /accounts/{accountId}/transactions,POST /customers/action/cop-query,Combined Future Dated Payment with Fixed Defined Schedule,Combined Future Dated Payments with Fixed On Demand,Combined Future Dated Payments with Fixed Periodic Schedule,Combined Future Dated Payment with Variable Defined Schedule,Combined Future Dated Payments with Variable On Demand,Combined Future Dated Payments with Variable Periodic Schedule,Combined Single Instant Payments with Fixed Defined Schedule,Combined Single Instant Payments with Fixed On Demand,Combined Single Instant Payments with Fixed Periodic Schedule,Combined Single Instant Payments with Variable Defined Schedule,Combined Single Instant Payments with Variable On Demand,Combined Single Instant Payments with Variable Periodic Schedule,Payment consent and file payments,Fixed Defined Schedule,Fixed On Demand,Fixed Periodic Schedule,future-dated-payments,get-report-file-payments,header-validations-tests,International Payments,Payment Consent Refund,single-instant-payments,Variable Defined Schedule,Variable On Demand,Variable Periodic Schedule,Consent/action/augment post request,Consent/action/validate post request,Insurance]' -r Id:'[.*]'

Run all the test cases in all the test suites.