[Azure] Add A Renderer For Azure DevOps Pipeline #338

weisunOW · 2024-11-25T12:00:04Z

Description

This PR adds a renderer to annotate build logs for Azure DevOps pipelines. The new AzureDevOpsPipelinesRenderer shares most formatting logic with GitHubActionsRenderer.

E.g.

xcodebuild [Flags] 2>&1 | xcbeautify --renderer azure-devops-pipelines

Or

swift test 2>&1 | xcbeautify --renderer azure-devops-pipelines

References

Azure DevOps - Task Commands

weisunOW · 2024-11-25T12:11:44Z

Sources/XcbeautifyLib/Renderers/Microsoft/MicrosoftOutputRendering.swift

    func formatSwiftTestingIssue(group: SwiftTestingIssueCaptureGroup) -> String {
        let message = "Recorded an issue" + (group.issueDetails.map { " (\($0))" } ?? "")
-        return outputGitHubActionsLog(
-            annotationType: .notice,
+        return makeOutputLog(
+            annotation: .error,
            message: message
        )
    }

    func formatSwiftTestingIssueArguments(group: SwiftTestingIssueArgumentCaptureGroup) -> String {
        let message = "Recorded an issue" + (group.numberOfArguments.map { " (\($0)) argument(s)" } ?? "")
-        return outputGitHubActionsLog(
-            annotationType: .notice,
+        return makeOutputLog(
+            annotation: .error,
            message: message
        )
    }


I changed the annotation for these two methods to .error as it reflects what's shown in the Xcode.

Thanks! If it's not too much trouble, can you split this out into its own PR? Happy to do that if you'd like – just let me know if you'd like me to.

Sure, I will raise a separate PR soon.

Done in #340, I will rebase this branch once #340 is merged.

weisunOW · 2024-11-27T05:20:23Z

I will revert the test back to XCTest sometime tonight (UTC+11).

codecov · 2024-11-27T21:40:40Z

Codecov Report

Attention: Patch coverage is 97.85714% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.48%. Comparing base (e81671f) to head (659a8d4).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...Renderers/Microsoft/MicrosoftOutputRendering.swift	95.34%	2 Missing ⚠️
...urces/XcbeautifyLib/Renderers/FileComponents.swift	94.44%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #338      +/-   ##
==========================================
+ Coverage   88.86%   89.48%   +0.62%     
==========================================
  Files          14       17       +3     
  Lines        2291     2312      +21     
==========================================
+ Hits         2036     2069      +33     
+ Misses        255      243      -12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

cpisciotta

Hey @weisunOW! Thanks so much for your patience and contribution! This looks great to me, and I'm glad folks will be able to use this on Azure CI soon.

Quick question: Have you tested these changes in Azure's CI to see that it renders as you expect? If not, can you do that (and possibly link for me to check out)?

Thanks again... Looks good to approve once we address my one comment and question.

cpisciotta · 2024-12-09T04:26:06Z

Sources/XcbeautifyLib/Renderers/Microsoft/MicrosoftOutputRendering.swift

    func formatSwiftTestingIssue(group: SwiftTestingIssueCaptureGroup) -> String {
        let message = "Recorded an issue" + (group.issueDetails.map { " (\($0))" } ?? "")
-        return outputGitHubActionsLog(
-            annotationType: .notice,
+        return makeOutputLog(
+            annotation: .error,
            message: message
        )
    }

    func formatSwiftTestingIssueArguments(group: SwiftTestingIssueArgumentCaptureGroup) -> String {
        let message = "Recorded an issue" + (group.numberOfArguments.map { " (\($0)) argument(s)" } ?? "")
-        return outputGitHubActionsLog(
-            annotationType: .notice,
+        return makeOutputLog(
+            annotation: .error,
            message: message
        )
    }


Thanks! If it's not too much trouble, can you split this out into its own PR? Happy to do that if you'd like – just let me know if you'd like me to.

weisunOW · 2024-12-09T11:30:49Z

Hi @cpisciotta, happy to help.

Quick question: Have you tested these changes in Azure's CI to see that it renders as you expect? If not, can you do that (and possibly link for me to check out)?

I've verified the branch on one of the pipelines of my enterprise project. The update renders fine on Azure Pipelines for the included logs under Tests/ParsingTests. However, when testing on my enterprise project, it failed to annotate a few PhaseScriptExecution logs and some consecutive warning logs for both GitHubActionsRenderer and the new AzureDevopsPipelineRenderer. I couldn't figure out why because the Regex from the CaptureGroup matches fine on these missed logs.

Microsoft temporarily disabled free grants for new organisations on Azure DevOps until the end of this year, so I can't provide a public pipeline for you to check. Unfortunately, I also can't share the logs from the enterprise pipeline due to policy.

## Description This PR updates the annotation type for Swift Testing issue recording (`.notice` -> `.error`), aligning with both Xcode and `swift test` output. ## References See discussion in #338 (comment) Co-authored-by: Wei Sun <[email protected]>

Remove extra `#`

cpisciotta

LGTM! Thanks again for contributing this change 🚀

cpisciotta · 2024-12-10T05:29:14Z

@weisunOW It's late my time, so I will follow up on releasing a new version – likely tomorrow night.

weisunOW · 2024-12-10T05:31:02Z

Thanks @cpisciotta, looking forward to the new release.

cpisciotta · 2024-12-11T00:02:51Z

@weisunOW This is now available via 2.16.0. Homebrew should pick it up shortly. Thanks again!

weisunOW requested a review from cpisciotta as a code owner November 25, 2024 12:00

weisunOW commented Nov 25, 2024

View reviewed changes

cpisciotta reviewed Dec 9, 2024

View reviewed changes

weisunOW mentioned this pull request Dec 9, 2024

Fix GitHubActionsRenderer Annotation Values #340

Merged

weisunOW and others added 7 commits December 10, 2024 14:55

[Azure] Add A Renderer For Azure DevOps Pipeline

11844c2

Fix typo

4dcd250

Remove extra `#`

Update test

79259e5

Update Readme

9df50b4

Fix Test Names

d00f665

Remove Unnecessary Logic

a8baf79

Add missing tests for formatting failing test

659a8d4

weisunOW force-pushed the ws-azure-renderer branch from 8495f9d to 659a8d4 Compare December 10, 2024 04:06

cpisciotta approved these changes Dec 10, 2024

View reviewed changes

cpisciotta merged commit dcda768 into cpisciotta:main Dec 10, 2024
13 checks passed

weisunOW deleted the ws-azure-renderer branch December 10, 2024 05:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Azure] Add A Renderer For Azure DevOps Pipeline #338

[Azure] Add A Renderer For Azure DevOps Pipeline #338

weisunOW commented Nov 25, 2024 •

edited

Loading

weisunOW Nov 25, 2024

cpisciotta Dec 9, 2024

weisunOW Dec 9, 2024

weisunOW Dec 9, 2024

weisunOW commented Nov 27, 2024

codecov bot commented Nov 27, 2024 •

edited

Loading

cpisciotta left a comment

cpisciotta Dec 9, 2024

weisunOW commented Dec 9, 2024

cpisciotta left a comment

cpisciotta commented Dec 10, 2024

weisunOW commented Dec 10, 2024

cpisciotta commented Dec 11, 2024

[Azure] Add A Renderer For Azure DevOps Pipeline #338

[Azure] Add A Renderer For Azure DevOps Pipeline #338

Conversation

weisunOW commented Nov 25, 2024 • edited Loading

Description

References

weisunOW Nov 25, 2024

Choose a reason for hiding this comment

cpisciotta Dec 9, 2024

Choose a reason for hiding this comment

weisunOW Dec 9, 2024

Choose a reason for hiding this comment

weisunOW Dec 9, 2024

Choose a reason for hiding this comment

weisunOW commented Nov 27, 2024

codecov bot commented Nov 27, 2024 • edited Loading

Codecov Report

cpisciotta left a comment

Choose a reason for hiding this comment

cpisciotta Dec 9, 2024

Choose a reason for hiding this comment

weisunOW commented Dec 9, 2024

cpisciotta left a comment

Choose a reason for hiding this comment

cpisciotta commented Dec 10, 2024

weisunOW commented Dec 10, 2024

cpisciotta commented Dec 11, 2024

weisunOW commented Nov 25, 2024 •

edited

Loading

codecov bot commented Nov 27, 2024 •

edited

Loading