Skip to content

feat(junit): include GHA run id and attempt #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 2 commits into from
Feb 6, 2025
Merged

feat(junit): include GHA run id and attempt #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7166f9
feat(junit): include GHA run id and attempt
jd Feb 5, 2025
f9ca635
Merge branch 'main' into devs/jd/add-run-id/I2a2e20331980c59a9f06aea8…
mergify[bot] Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions mergify_cli/ci/detector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,25 @@ async def get_head_sha() -> str | None:
return None


def get_cicd_pipeline_run_id() -> int | None:
if get_ci_provider() == "github_actions" and "GITHUB_RUN_ID" in os.environ:
return int(os.environ["GITHUB_RUN_ID"])

if get_ci_provider() == "circleci" and "CIRCLE_WORKFLOW_ID" in os.environ:
return int(os.environ["CIRCLE_WORKFLOW_ID"])

return None


def get_cicd_pipeline_run_attempt() -> int | None:
if get_ci_provider() == "github_actions" and "GITHUB_RUN_ATTEMPT" in os.environ:
return int(os.environ["GITHUB_RUN_ATTEMPT"])
if get_ci_provider() == "circleci" and "CIRCLE_BUILD_NUM" in os.environ:
return int(os.environ["CIRCLE_BUILD_NUM"])

return None


def get_github_repository() -> str | None:
if get_ci_provider() == "github_actions":
return os.getenv("GITHUB_REPOSITORY")
Expand Down
8 changes: 7 additions & 1 deletion mergify_cli/ci/junit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,17 @@ async def junit_to_spans(
if test_language is not None:
common_attributes["test.language"] = test_language

resource_attributes = {}
resource_attributes: dict[str, typing.Any] = {}

if (job_name := detector.get_job_name()) is not None:
resource_attributes[cicd_attributes.CICD_PIPELINE_NAME] = job_name

if (run_id := detector.get_cicd_pipeline_run_id()) is not None:
resource_attributes[cicd_attributes.CICD_PIPELINE_RUN_ID] = run_id

if (run_attempt := detector.get_cicd_pipeline_run_attempt()) is not None:
resource_attributes["cicd.pipeline.run.attempt"] = run_attempt

if (head_revision := (await detector.get_head_sha())) is not None:
resource_attributes[vcs_attributes.VCS_REF_HEAD_REVISION] = head_revision

Expand Down
145 changes: 28 additions & 117 deletions mergify_cli/tests/ci/test_junit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

@mock.patch.object(detector, "get_ci_provider", return_value="github_actions")
@mock.patch.object(detector, "get_job_name", return_value="JOB")
@mock.patch.object(detector, "get_cicd_pipeline_run_id", return_value=123)
@mock.patch.object(detector, "get_cicd_pipeline_run_attempt", return_value=1)
@mock.patch.object(
detector,
"get_head_sha",
Expand All @@ -20,6 +22,8 @@ async def test_parse(
_get_ci_provider: mock.Mock,
_get_job_name: mock.Mock,
_get_head_sha: mock.Mock,
_get_cicd_pipeline_run_id: mock.Mock,
_get_cicd_pipeline_run_attempt: mock.Mock,
) -> None:
filename = pathlib.Path(__file__).parent / "junit_example.xml"
spans = await junit.junit_to_spans(
Expand All @@ -32,6 +36,17 @@ async def test_parse(
trace_id = "0x" + opentelemetry.trace.span.format_trace_id(
spans[1].context.trace_id,
)
resource_attributes = {
"cicd.pipeline.name": "JOB",
"cicd.pipeline.run.id": 123,
"cicd.pipeline.run.attempt": 1,
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
}
assert dictified_spans == [
{
"attributes": {
Expand All @@ -52,15 +67,7 @@ async def test_parse(
"name": "Tests.Registration",
"parent_id": None,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -88,15 +95,7 @@ async def test_parse(
"name": "Tests.Registration.testCase1",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -124,15 +123,7 @@ async def test_parse(
"name": "Tests.Registration.testCase2",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -163,15 +154,7 @@ async def test_parse(
"name": "Tests.Registration.testCase3",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand All @@ -198,15 +181,7 @@ async def test_parse(
"name": "Tests.Authentication",
"parent_id": None,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -234,15 +209,7 @@ async def test_parse(
"name": "Tests.Authentication.testCase7",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -270,15 +237,7 @@ async def test_parse(
"name": "Tests.Authentication.testCase8",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -309,15 +268,7 @@ async def test_parse(
"name": "Tests.Authentication.testCase9",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -349,15 +300,7 @@ async def test_parse(
"name": "Tests.Permission.testCase10",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand All @@ -384,15 +327,7 @@ async def test_parse(
"name": "Tests.Authentication.Login",
"parent_id": None,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -420,15 +355,7 @@ async def test_parse(
"name": "Tests.Authentication.Login.testCase4",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -459,15 +386,7 @@ async def test_parse(
"name": "Tests.Authentication.Login.testCase5",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down Expand Up @@ -495,15 +414,7 @@ async def test_parse(
"name": "Tests.Authentication.Login.testCase6",
"parent_id": anys.ANY_STR,
"resource": {
"attributes": {
"cicd.pipeline.name": "JOB",
"cicd.provider.name": "github_actions",
"vcs.ref.head.revision": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
"service.name": "unknown_service",
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": anys.ANY_STR,
},
"attributes": resource_attributes,
"schema_url": "",
},
"start_time": anys.ANY_DATETIME_STR,
Expand Down