e2e.md

End to end testing

Note there's likely a more up-to-date version in Confluence. Please check that for more information.

Prerequisites

To run locally, make sure you have valid DD_API_KEY and DD_APPLICATION_KEY in your environment. They must belong to the allow-listed org. Check this site-to-host for easier navigation.

Instructions

Instructions to run the tests

• Make sure you built the appropriate version of the weblog, for example single span sampling at the time of writing is using Go Chi.
  • To build the weblog, run ./build.sh -l golang -w <chi or net-http or etc> from the system-tests directory.
• Run ./run.sh <SCENARIO_NAME> to run the tests, for example ./run.sh APM_TRACING_E2E_SINGLE_SPAN.

Instructions to add new tests or scenarii

If you are writing a new test:

• attached to the DEFAULT scenario (the most common one): you don't need to add anything before the test func.
• attached to a specific scenario: add @scenarios.<scenario name> before your test func.

If you want to create a new scenario, do it in _scenarios.py. Creating a new scenario comes at a cost. It is quite often reasonable to keep the tests in DEFAULT scenario. Checkout .github/workflows/ci.yml if you want to add a test case in CI.