Trusted Network Gateway API Tests

General info and requirements

The test suite is based on the Behave framework, a Python implementation of Cucumber. Tests are written in Gherkin, a human-readable, behavior focussed syntax.

❗ It is intended to be used mainly for development and regression testing on the SMART Trustnetwork Gateway.

The environments to test against are configured in teststing_environments and point to the WHO TNG instances.
For using this test suite for your own purposes, the environment has to be changed to your personal needs.

Prerequisites:

• Python 3.9 or later installed
• pip (Python package installer)

Installation instructions:

• Clone this repository
  • on the commandline in the repository:
    optionally create a virtual environemnt, venv

    python -m venv .venv --prompt TNG-Tests 
    source .venv/bin/activate

• install the required packages:

  python -m pip install -r requirements.txt

Depending on whether you run this command within your created virtual environment or not, behave will be available only within the virtual environment or globally on your system. Installing the required packages will take some time, it may be, that some of the packages are already installed on your system, ignore according messages though.

• copy the key material for XXA and XXB in the appropriate folders under certificates/

  The key material is not provided in this repository, as it is confidential.
  For testing purposes you can generate the key material with the scripts that can be found in [the tng-participant-template]((https://github.com/WorldHealthOrganization/tng-participant-template) and run it on your personal copy of TNG. Be sure to provide complete key material (TLS, Upload, SCA) for the 'virtual' test countries **XXA and XXB As TLS certificates need to be whitelisted on the TNG onboarded participants could use the test-suite with the preconfigured environments - but we kindly ask you not to do so.

Usage

A testing environment must be specified with each execution:

behave -D testenv=UAT

The test cases will then look into the corresponding folders for testing certificates. For the countries which are set as country A and country B, these certificates must be onboarded on the respective testing environment.

Testing environments

A testing environment definition currently consists of

• an endpoint
• three roles, representing a country's software client.
  • The countries are aliased A, B and C.
  • A and B are onboarded countries
  • C is not onboarded and used for negative tests

The environments are defined in the file features/testing_environments.json.

Example:

    "UAT": {
        "base_url" : "https://tng-uat.who.int",
        "country_A" : "XXA",
        "country_B" : "XXB",
        "country_C" : "XXC"
    },
    "Scandinavia": {
        "base_url" : "https://virtual.scandinavia.test",
        "country_A" : "FIN",
        "country_B" : "SWE",
        "country_C" : "NOR"
    }

Virtual countries

Some environments do not want to use real country codes. In order for them to function, non-existent (virtual) countries must be defined in features/testing_countries.json.

There, they must be assigned a unique 2-letter and 3-letter country code which must not already be used by an existing country.

Test data (onboarded virtual countries)

The folder certificates should host the key material of the fictional countries that are used for testing.

The directory structure is as follows:

• top level: 3-letter country code
• 2nd level: domain

Example:

certificates
    +--- XXA                 (country XA)
    |     +--- DCC           (domain DCC)
    |     |     +--- TLS.pem
    |     |     +--- TLS.key
    |     |     +--- SCA.pem
    |     |     +--- SCA.key
    |     |     +--- UP.pem
    |     |     +--- UP.key
    |     +--- RACSEL-DDVC     (possible other domain)
    |           +--- TLS.pem
    |           +--- ...
    |
    +--- XXB                 (country XB)
          +--- DCC
                +--- TLS.pem
                +--- ...

Licensing

Copyright (C) 2023 T-Systems International GmbH and all other contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.