v0.13.0 Testing Checklist

[jorgeepc]

Testing Tracetest

This is the entire checklist on what we should do to assert that Tracetest is working fine on each version release. On each version release, we can copy the contents of this template checklist and open a Github Discussion to start each test.

On Tracetest, we work in two ways to test the entire system and guarantee that everything is working fine. One is through automatic tests, where we run unit, integration and end-to-end tests on Tracetest CLI, Web UI and Server.

Another source of tests is the manual tests that we execute on each release, simulating users, and checking if everything is ok on these tests.

Manual Tests

On our manual tests, we aim to do some sanity checks to see if the main features are working as expected. Usually, we run it on each Tracetest release.

Tests to validate on Release Candidate

• Test server installation via CLI

  • Docker Compose and no demo API
  • Docker Compose and demo API
  • Kubernetes and no demo API
  • Kubernetes and demo API
  • Verify that Tracetest is not sending analytics if you have the TRACETEST_DEV env for docker install
  • Verify that Tracetest is not sending analytics if you have the TRACETEST_DEV env for k8s install

• Test DataStore provisioning and basic test

  • Open WebUI and go to /settings page. The provisioned Data Store should be selected
  • Create a test on WebUI that calls a demo API (like Pokeshop or Open Telemetry Store). This test should fetch traces correctly and run without errors

• Test Tracetest examples

  • Jaeger example
  • Tempo example
  • New Relic example
  • Lightstep example
  • OpenSearch example
  • Elastic APM example
  • SignalFX example
  • Datadog example
  • Amazon X-Ray example
  • Honeycomb
  • Azure Application Insights

• Test CLI commands (detailed list here)

  • Resources: config
  • Resources: datastore
  • Resources: demo
  • Resources: environment
  • Resources: pollingprofile
  • Resources: analyzer
  • Resources: test
  • Resources: transaction
  • Test Runner

• Testing benchmark

  • Run OpenTelemetry Demo tests with the current version and guarantee that the CLI and Server responded correctly

• Test specific features added/changed on this release:

  • CLI run command for tests (by file, by ID) feat(cli): Add run verb #2885
  • CLI run command for transactions (by file, by ID) feat(cli): Add run verb #2885
  • Web automate page CLI for tests fix(frontend): fix automate page to match new run cli command #2928
  • Web automate page CLI for transactions feat(frontend): add transaction automate page #2939
  • Docker host URL warning feature(frontend): Adding Docker Host Url Prompt #2934
  • CLI TestRunner resource feat(cli): TestRunner cli client #2951
  • Web TestRunner resource feature: Required Gates #2922
  • CLI test run with required gates feat(cli): add required-gates flag #2944
  • Web test run with required gates feature: Required Gates #2922
  • Signoz as a Datastore feat: Add Signoz as a Datastore #2935
  • Validate environment search fix(server): fix environments search query #2956
  • Validate test search fix(server): fix test search query #2957
  • Span Events with assertions for Jaeger feat: support span events #2911
  • Span Events with assertions for Tempo feat: support span events #2911
  • Span Events with assertions for OTLP feat: support span events #2911
  • Span Events with assertions for App Insights feat: support span events #2911

Tests to validate on Final Release

• Pipeline

  • Check if our release pipeline on Release Tracetest workflow on Github Actions worked correctly

• Test CLI updates

  • MacOS via homebrew
  • MacOS via curl script
  • Windows via chocolatey
  • Windows via manual download

• Docs

  • Double check Detailed installation docs and see if everything is documented correctly

• Add Major Changes

  • Add a summary with major changes to the release page

• Test specific features added/changed on this release:

  • Add list of features here

[xoscar]

Bugs:

• [Backend] Jaeger events are missing the name
• [Backend] Azure App Insights Pokeshop integration has missing events
• [Frontend] Performance issue when rendering large responses #2963