Running Goth

Here's what you need to do in order to set up goth and ensure it's running properly on your system.

Clone the repository

Before you begin, clone the goth's repository:

git clone https://github.com/golemfactory/goth.git

Python setup

Python 3.8

The test runner requires Python 3.8+ to be installed on the system. You can check your currently installed Python version by running:

python3 --version

If you don't have Python installed, download the appropriate package and follow instructions from the releases page.

For the sake of compatibility with other projects and/or your local Python 3 installation you can install pyenv to manage and switch between multiple Python versions. The pyenv installer can be found here. You can also use your preferred way of managing Python virtual environments to achieve this.

Project installation

goth is not (yet) available as a standalone package, therefore you will need to set up its development environment in order to use it.

poetry

goth uses poetry to manage its dependencies and provide a runner for common tasks (e.g. running E2E tests). If you don't have poetry available on your system then follow its installation instructions before proceeding or just install it with:

pip install poetry

Verify your installation by running:

poetry --version

project dependencies

To install the project's dependencies run in the directory where you checked-out goth:

poetry install

Docker setup

Docker Engine

The tests are performed on live Yagna nodes running in an isolated network. Currently, this setup is achieved by running a number of Docker containers locally using Docker Compose.

To run the test containers you will need to have both Docker and Docker Compose installed on your system. To install the Docker engine on your system follow these instructions. To verify your installation you can run the hello-world Docker image:

docker run hello-world

Docker Compose

Docker Compose is a separate binary which needs to be available on your system in order to run Yagna integration tests. goth requires docker-compose version 1.27 or higher. There are two ways you can install it:

  1. Download the appropriate executable from the releases page and make sure its present on your system's PATH.

  2. Use the docker-compose installed to your goth Python environment (you will need to activate the environment in the shell from which you run your tests).

Running the test network

Getting a GitHub API token

When first starting the test network, goth uses the GitHub API to fetch metadata and download artifacts and images. Although all of these assets are public, using the GitHub API still requires basic authentication. Therefore, you need to provide goth with a personal access token.

To generate a new token, go to your account's developer settings. You will need to grant your new token the public_repo scope, as well as the read:packages scope. The packages scope is required in order to pull Docker images from GitHub.

Once your token is generated you need to do two things:

  1. Log in to GitHub's Docker registry by calling: docker login docker.pkg.github.com -u {username}, replacing {username} with your GitHub username and pasting in your access token as the password (iow, don't use your regular github password here). You only need to do this once on your development machine.

  2. Export an environment variable named GITHUB_API_TOKEN and use the access token as its value. This environment variable will need to be available in the shell from which you run goth.

Running the integration tests

With project dependencies installed and environment set up you are now ready to launch the end-to-end integration tests which will confirm that your installation of goth and your development environment is correct.

All tests related to yagna can be found under test/yagna with end-to-end tests located in test/yagna/e2e. To run them, issue the below command from the project's root directory:

poetry run poe e2e_test

Every test run consists of the following steps:

  1. docker-compose is used to start the so-called "static" containers (e.g. local blockchain, HTTP proxy) and create a common Docker network for all containers participating in the test.

  2. The test runner creates a number of Yagna containers (as defined in the test's topology) which are connected to the docker-compose network.

  3. For each Yagna container started a so-called "probe" object is created and made available inside the test via the Runner object.

  4. The integration test scenario is executed as defined in the function called by pytest.

  5. Once the test is finished, all previously started Docker containers (both "static" and "dynamic") are removed.

If the test run succeeded, your development environment is now ready to test your own apps using goth's interactive mode.

If anything failed, please refer to the troubleshooting section below or reach out to us on one of our regular support channels.

Other tests

The tool that we're using above to run the tests, is poethepoet, a task runner for poetry. If you'd like see all the tasks configured in goth, run poe with no arguments:

poetry run poe

For more granular control (e.g. running one specific test file) you can also invoke pytest directly to run tests:

pytest -svx test/yagna/e2e/test_e2e_wasm.py

The test runner of choice for goth is pytest, therefore each test is defined as a separate Python function in a given .py file.

Custom test options

Assets path

It's possible to provide a custom assets directory which will be mounted in all Yagna containers used for the test. The assets include files such as the exe script definition (exe-script.json) or payment configuration (accounts.json).

To override the default path, use the --assets-path parameter, passing in the custom path:

poetry run poe e2e_test --assets-path test/custom_assets/some_directory

Log level

By default, the test runner will use INFO log level. To override it and enable more verbose logging, use the --log-cli-level parameter:

poetry run poe e2e_test --log-cli-level DEBUG

Logs path

The destination path for all test logs can be overridden using the option --logs-path:

poetry run poe e2e_test --logs-path your/custom/path

Yagna binary path

By default, a set of yagna binaries is downloaded from GitHub to be used for a given test session. The option --yagna-binary-path allows you to use binaries from the local file system instead. Its value must be a path to either a directory tree containing yagna binaries (e.g. target directory from a local cargo build) or a .zip archive file (e.g. downloaded manually from GitHub Actions):

poetry run poe e2e_test --yagna-binary-path /path/to/binaries

Yagna commit hash

By default, goth uses a yagna binary from the latest GitHub Actions successful build on master branch. This option can be used to override that behaviour. The value here needs to be a git commit hash being the head for one of the build workflow runs:

poetry run poe e2e_test --yagna-commit-hash b0ac62f

Yagna .deb path

Path to a local .deb file or a directory containing a number of such archives. All of these .deb files will be installed in the Docker image used for Yagna nodes in the tests. To specify the path, use the option --yagna-deb-path:

poetry run poe e2e_test --yagna-deb-path path/to/yagna.deb

Troubleshooting integration test runs

All components launched during the integration test run record their logs in a pre-determined location. By default, this location is: $TEMP_DIR/goth-tests, where $TEMP_DIR is the path of the directory used for temporary files. This path will depend either on the shell environment or the operating system on which the tests are being run (see tempfile.gettempdir for more details). This default location can be overridden using the option --logs-path when running tests.

The logs from a test run are recorded in the following directory structure:

  • runner.log - logs recorded by the integration test runner engine.

  • proxy.log - logs recorded by the HTTP 'sniffer' proxy, which monitors network traffic going into the yagna daemons launched for the test.

  • test_* - directory with logs generated by nodes running as part of a single test (as defined in the test's topology). This directory is named after the name of the test scenario itself.

    The logs follow a straightforward naming convention, with daemons and their clients logging into dedicated files, e.g.:

    • provider.log - console output from provider yagna daemon.

    • provider_agent.log - console output of the provider agent, running alongside provider daemon.