Validate the cluster

In this step, we validate that the Dyff installation is fully operational by running the integration test suite.

Install the Dyff SDK from source

The integration tests currently are not included in the dyff package on pip, so you need to install them from source.

Create a Python venv

python3 -m venv venv
. venv/bin/activate

Clone and install code repos

Clone the repos:

git clone https://gitlab.com/dyff/packages/dyff-schema.git
git clone https://gitlab.com/dyff/packages/dyff-client.git
git clone https://gitlab.com/dyff/packages/dyff-audit.git

Install the repos:

Note

You should install the repositories in order of their dependencies.

Note

Make sure to install the optional dev dependencies for dyff-audit.

(dyff-schema) $ python -m pip install -e .
(dyff-client) $ python -m pip install -e .
(dyff-audit) $ python -m pip install -e .[dev]

Test that it’s installed:

$ pip freeze | grep ^dyff
dyff-audit==...
dyff-client==...
dyff-schema==...

Run integration tests

The integration tests live in dyff-audit/tests. We recommend creating a wrapper script to run them that sets the configuration appropriately for your local installation.

Warning

Don’t commit files containing credentials!

#!/bin/bash
# test-local.sh

export DYFF_API_ENDPOINT="https://api.dyff.local/v0"
export DYFF_API_TOKEN="$(cat $HOME/.dyff/accounts/dev-admin)"

exec pytest -rP --test_remote --api_insecure "$@"

In this script, we assume that you have an Admin token for your local cluster installation stored at ~/.dyff/accounts/dev-admin.

Note

When running integration tests locally, many tests will be skipped. It should take around 20 minutes to complete. One test is likely to fail without issue (test_client_impossible_timeout), and does not indicate an issue with your installation.