Using the ODE test harness
The ODE test harness is an automated integration test suite. It requires an active, running ODE and works by uploading data to the ODE and listening to Kafka for output to validate.
The test harness is included in the base ODE repository under the qa/test-harness folder.
Requirements:
- Running ODE
- Python 3
- kafka library installed (
pip install kafka)
- kafka library installed (
-
DOCKER_HOST_IPenvironment variable must be set (see instructions here)
ODE the usdot-jpo-ode organization on GitHub contains the jpo-ode/qa/test-harness which is a python application designed to run a suite of tests in collaboration with a running ODE. The test-harness uses another repository within usdot-jpo-ode that contains a python library consisting of reusable the test cases and the test procedures. this ode-output-validator-library library is also used within a module used by the DataHub program. ode-output-validator-library can also be used by other test routines developed by other ODE data users and deployers. The following diagram illustrates the relationship between these modules.
- Navigate to the
test-harnessdirectory of the ODE using a system shell - Run the command
source ./install.sh - Run the command
source ./full-test.sh
The test harness script includes a series of log statements and assertions. A successful test run will end with a All tests have passed at the end. Unsuccessful test runs will exit with messages indicating the failure.
For more details, please read the ode-output-validator-library library documentation.
Canary Lambda function, a DataHub early warning system also uses ode-output-validator-library library to validate data received from Wyoming into the repository.