chore(ci_visibility): add ITR coverage support to manual API

[romainkomorndatadog]

Adds support for submitting coverage data using the CI Visibility manual API.

The CICoverageData class is used as a container. One of the features it will enable is adding coverage data "a piece at a time" instead of one-shotting the entire coverage data (which is still possible).

This will be useful for cases where tests don't run in-order within suites (which is possible in cases like pytest-xdist).

Two worthwhile mentions compared to existing approach to coverage:

• paths are stored using pathlib.Path rather than strings
• paths are stored as absolute paths (by calling .absolute() on all given Paths objects)

Checklist

• Change(s) are motivated and described in the PR description
• Testing strategy is described if automated tests are not included in the PR
• Risks are described (performance impact, potential for breakage, maintainability)
• Change is maintainable (easy to change, telemetry, documentation)
• Library release note guidelines are followed or label changelog/no-changelog is set
• Documentation is included (in-code, generated user docs, public corp docs)
• Backport labels are set (if applicable)
• If this PR changes the public interface, I've notified @DataDog/apm-tees.
• If change touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from @DataDog/security-design-and-guidance.

Reviewer Checklist

• Title is accurate
• All changes are related to the pull request's stated goal
• Description motivates each change
• Avoids breaking API changes
• Testing strategy adequately addresses listed risks
• Change is maintainable (easy to change, telemetry, documentation)
• Release note makes sense to a user of the library
• Author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
• Backport labels are set in a manner that is consistent with the release branch maintenance policy

[romainkomorndatadog]

Worth noting here, there's a known (by me) issue here where suite-level coverage is not being added.

I'm not addressing this because I'm working on another change on top of this one that refactors that part of the code.

[datadog-dd-trace-py-rkomorn]

Datadog Report

Branch report: romain.komorn/CIVIS-2943/add_coverage_support
Commit report: cb16903
Test service: dd-trace-py

✅ 0 Failed, 36226 Passed, 18 Skipped, 9m 45.37s Wall Time

[pr-commenter]

Benchmarks

Benchmark execution time: 2024-03-26 15:42:46

Comparing candidate commit 3fe1db5 in PR branch romain.komorn/CIVIS-2943/add_coverage_support with baseline commit 7ed8fbc in branch main.

Found 4 performance improvements and 3 performance regressions! Performance is the same for 194 metrics, 9 unstable metrics.

scenario:flasksimple-appsec-get

• 🟥 execution_time [+241.624µs; +300.735µs] or [+3.858%; +4.802%]

scenario:flasksimple-appsec-telemetry

• 🟥 execution_time [+234.096µs; +297.340µs] or [+3.737%; +4.747%]

scenario:flasksimple-tracer

• 🟥 execution_time [+252.137µs; +296.635µs] or [+4.026%; +4.736%]

scenario:httppropagationextract-b3_headers

• 🟩 max_rss_usage [-747.437KB; -671.008KB] or [-3.418%; -3.068%]

scenario:httppropagationextract-large_header_no_matches

• 🟩 max_rss_usage [-777.876KB; -509.906KB] or [-3.561%; -2.335%]

scenario:httppropagationextract-medium_header_no_matches

• 🟩 max_rss_usage [-788.061KB; -636.527KB] or [-3.603%; -2.910%]

scenario:httppropagationextract-wsgi_valid_headers_basic

• 🟩 max_rss_usage [-839.789KB; -645.011KB] or [-3.840%; -2.950%]