›

Run Tests Locally

To run tests locally you can make use of the docker images also used when running the whole test suite with Jenkins. Running the full test suite first does some linting and then runs the actual tests with different versions of Python and different web frameworks. For a full overview of the test matrix and supported versions have a look at Jenkins Configuration.

Pre Commit

edit

We run our git hooks on every commit to automatically point out issues in code. Those issues are also detected within the GitHub actions. Please follow the installation steps stated in https://pre-commit.com/#install.

Code Linter

edit

We run two code linters isort and flake8. You can trigger each single one locally by running:

$ pre-commit run -a isort

$ pre-commit run -a flake8

Code Formatter

edit

We test that the code is formatted using black. You can trigger this check by running:

$ pre-commit run -a black

Test Documentation

edit

We test that the documentation can be generated without errors. You can trigger this check by running:

$ ./tests/scripts/docker/docs.sh

Running Tests

edit

We run the test suite on different combinations of Python versions and web frameworks. For triggering the test suite for a specific combination locally you can run:

$ ./tests/scripts/docker/run_tests.sh python-version framework-version <pip-cache-dir>

The python-version must be of format python-version, e.g. python-3.6 or pypy-2. The framework must be of format framework-version, e.g. django-1.10 or flask-0.12.

You can also run the unit tests outside of docker, by installing the relevant requirements file and then running py.test from the project root.

Integration testing

edit

Check out https://github.com/elastic/apm-integration-testing for resources for setting up full end-to-end testing environments. For example, to spin up an environment with the opbeans Django app, with version 7.3 of the elastic stack and the apm-python-agent from your local checkout, you might do something like this:

$ ./scripts/compose.py start 7.3 \
    --with-agent-python-django --with-opbeans-python \
    --opbeans-python-agent-local-repo=~/elastic/apm-agent-python

« How the Agent works API reference »