fix(ci_visibility): fix adding test.skipped_by_itr tag [backport 1.20] (#7303)

Backport 370f7da from #7275 to 1.20.

Fixes an issue where tests skipped by the Intelligent Test Runner were
not properly getting the `test.skipped_by_itr` tag (due to an invalid
comparison between a Pytest reason object and a string).

No release note because ITR is still in beta.

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.
- [x] Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
- [x] If this PR 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`.
- [x] This PR doesn't touch any of that.

Co-authored-by: Romain Komorn <[email protected]>

Author: github-actions[bot]

ddtrace/contrib/pytest/plugin.py

@@ -759,7 +759,11 @@ def pytest_runtest_makereport(item, call):
         reason = _extract_reason(call)
         if reason is not None:
             span.set_tag_str(test.SKIP_REASON, str(reason))
-            if reason == SKIPPED_BY_ITR_REASON:
+            if str(reason) == SKIPPED_BY_ITR_REASON:
+                if _CIVisibility._instance._suite_skipping_mode:
+                    suite_span = _extract_span(item.parent)
+                    if suite_span is not None:
+                        suite_span.set_tag_str(test.ITR_SKIPPED, "true")
                 span.set_tag_str(test.ITR_SKIPPED, "true")
     elif result.passed:
         _mark_not_skipped(item.parent)

tests/contrib/pytest/test_pytest.py

@@ -1840,6 +1840,16 @@ def test_pytest_skip_suite_by_path(self):
         skipped_spans = [x for x in spans if x.get_tag("test.status") == "skip"]
         assert len(skipped_spans) == 3
 
+        skipped_suite_spans = [x for x in skipped_spans if x.get_tag("type") == "test_suite_end"]
+        assert len(skipped_suite_spans) == 1
+        for skipped_suite_span in skipped_suite_spans:
+            assert skipped_suite_span.get_tag("test.skipped_by_itr") == "true"
+
+        skipped_test_spans = [x for x in skipped_spans if x.get_tag("type") == "test"]
+        assert len(skipped_test_spans) == 1
+        for skipped_test_span in skipped_test_spans:
+            assert skipped_test_span.get_tag("test.skipped_by_itr") == "true"
+
     def test_pytest_skip_tests_by_path(self):
         """
         Test that running pytest on two nested packages with 1 test each. It should generate
@@ -1909,6 +1919,10 @@ def test_pytest_skip_tests_by_path(self):
         skipped_spans = [x for x in spans if x.get_tag("test.status") == "skip"]
         assert len(skipped_spans) == 3
 
+        skipped_test_spans = [x for x in skipped_spans if x.get_tag("type") == "test"]
+        for skipped_test_span in skipped_test_spans:
+            assert skipped_test_span.get_tag("test.skipped_by_itr") == "true"
+
     def test_pytest_skip_none_tests(self):
         """
         Test that running pytest on two nested packages with 1 test each. It should generate
@@ -2016,6 +2030,11 @@ def test_pytest_skip_all_tests(self):
         skipped_spans = [x for x in spans if x.get_tag("test.status") == "skip"]
         assert len(skipped_spans) == 7
 
+        skipped_test_spans = [x for x in skipped_spans if x.get_tag("type") == "test"]
+        assert len(skipped_test_spans) == 2
+        for skipped_test_span in skipped_test_spans:
+            assert skipped_test_span.get_tag("test.skipped_by_itr") == "true"
+
     def test_pytest_skip_all_test_suites(self):
         """
         Test that running pytest on two nested packages with 1 test each. It should generate
@@ -2069,6 +2088,18 @@ def test_pytest_skip_all_test_suites(self):
         skipped_spans = [x for x in spans if x.get_tag("test.status") == "skip"]
         assert len(skipped_spans) == 7
 
+        skipped_suite_spans = [
+            x for x in spans if x.get_tag("test.status") == "skip" and x.get_tag("type") == "test_suite_end"
+        ]
+        assert len(skipped_suite_spans) == 2
+        for skipped_suite_span in skipped_suite_spans:
+            assert skipped_suite_span.get_tag("test.skipped_by_itr") == "true"
+
+        skipped_test_spans = [x for x in spans if x.get_tag("test.status") == "skip" and x.get_tag("type") == "test"]
+        assert len(skipped_test_spans) == 2
+        for skipped_test_span in skipped_test_spans:
+            assert skipped_test_span.get_tag("test.skipped_by_itr") == "true"
+
     def test_pytest_skip_none_test_suites(self):
         """
         Test that running pytest on two nested packages with 1 test each. It should generate