Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
#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:cbuae \
yarn tr-ozone-connect \
--formatter terse \
--loglevel-runner debug \
--config /usr/o3/tr-ozone-connect/config/test-input.yaml \
--out /usr/o3/tr-ozone-connect/logs/<custom_log_file_name>

...

Option

Description

-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: https://ozoneapiopenfinanceuae.atlassian.net/wiki/spaces/OTAPIHubDocsv3/pages/1963950120151126094/Testing+Tool+Manual#6User+Guide#6.2-Configuration-File

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: https://ozoneapiopenfinanceuae.atlassian.net/wiki/spaces/OTAPIHubDocsv3/pages/1963950120151126094/Testing+Tool+Manual#6User+Guide#6.3-Test-Certificates

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 needs to be passed to check the logs after the program has run. The logs will be available in this folder after the tests are run.

...

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: https://ozoneapiopenfinanceuae.atlassian.net/wiki/spaces/OTAPIHubDocsv3/pages/1963950120151126094/Testing+Tool+User+Manual#6Guide#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: https://ozoneapiopenfinanceuae.atlassian.net/wiki/spaces/OTAPIHubDocsv3/pages/1963950120151126094/Testing+Tool+Manual#6User+Guide#6.3-Test-Certificates

Otherwise please use OFTF Certificates.

Step 3

Execute the testing tool command.

Code Block
#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:cbuae \
yarn tr-ozone-connect \
--formatter terse \
--loglevel-runner debug \
--config /usr/o3/tr-ozone-connect/config/test-input.yaml \
--out /usr/o3/tr-ozone-connect/logs/logs_5Aug.json

Step 4

The final section of the sample output, after all tests have been run and logs have been printed, will appear as follows.

Screenshot 2024-08-05 at 15.19.50.png

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/logs_5Aug.json

...

The list of supported test cases is available in the following document: https://ozoneapi.atlassian.net/wiki/spaces/OT/pages/1975419042 Ozone Connect Test Cases