feat(issuegenerator): filter job reports and expand templates

Refine failure detection to exclude timed-out jobs and support multiple failed job links in reports. Added tests for multi-job expansion and conclusion filtering.

Author: vyagh

.chloggen/feat_issuegenerator-failed-job-link.yaml

@@ -1,16 +1,5 @@
-# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
 change_type: enhancement
-
-# The name of the component, or a single word describing the area of concern, (e.g. crosslink)
 component: issuegenerator
-
-# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
 note: "Link to all failing jobs in GitHub Actions instead of general workflow run."
-
-# One or more tracking issues related to the change
 issues: [1183]
-
-# (Optional) One or more lines of additional information to render under the primary note.
-# These lines will be padded with 2 spaces and then inserted directly into the document.
-# Use pipe (|) for multiline entries.
 subtext:

issuegenerator/internal/github/client.go

@@ -211,7 +211,6 @@ func (c *Client) GetExistingIssue(ctx context.Context, module string) *github.Is
 // information about the latest failure. This method is expected to be
 // called only if there's an existing open Issue for the current job.
 func (c *Client) CommentOnIssue(ctx context.Context, r report.Report, issue *github.Issue) *github.IssueComment {
-	// Get commit message and extract PR number
 	commitMessage := c.getCommitMessage(ctx)
 	prNumber := c.extractPRNumberFromCommitMessage(commitMessage)
 
@@ -234,7 +233,6 @@ func (c *Client) CommentOnIssue(ctx context.Context, r report.Report, issue *git
 		c.handleBadResponses(response)
 	}
 
-	// Also comment on the PR with a link to this comment
 	if prNumber > 0 && issueComment != nil && issueComment.HTMLURL != nil {
 		if prAuthor := c.GetPRAuthor(ctx, prNumber); prAuthor != "" {
 			_ = c.CommentOnPR(ctx, prNumber, prAuthor, *issueComment.HTMLURL)
@@ -472,10 +470,9 @@ func (c *Client) CommentOnPR(ctx context.Context, prNumber int, prAuthor string,
 }
 
 func (c *Client) extractPRNumberFromCommitMessage(commitMsg string) int {
-	// Only consider the first line of the commit message.
 	firstLine := strings.SplitN(commitMsg, "\n", 2)[0]
 
-	// cases matched :
+	// Cases matched:
 	// - (#123)
 	// - Merge pull request #123
 	// - (#123): some description
@@ -506,7 +503,6 @@ func (c *Client) CreateIssue(ctx context.Context, r report.Report) *github.Issue
 	trimmedModule := trimModule(c.envVariables[githubOwner], c.envVariables[githubRepository], r.Module)
 	title := strings.Replace(issueTitleTemplate, "${module}", trimmedModule, 1)
 
-	// Get commit message and extract PR number
 	commitMessage := c.getCommitMessage(ctx)
 	prNumber := c.extractPRNumberFromCommitMessage(commitMessage)
 
@@ -533,7 +529,6 @@ func (c *Client) CreateIssue(ctx context.Context, r report.Report) *github.Issue
 		c.handleBadResponses(response)
 	}
 
-	// After creating the issue, also comment on the PR with a link to the created issue
 	if prNumber > 0 && issue != nil && issue.HTMLURL != nil {
 		if prAuthor := c.GetPRAuthor(ctx, prNumber); prAuthor != "" {
 			_ = c.CommentOnPR(ctx, prNumber, prAuthor, *issue.HTMLURL)

issuegenerator/internal/github/client_test.go

@@ -438,6 +438,15 @@ func TestGetFailedJobURLs(t *testing.T) {
 			]}`,
 			expected: map[string]string{},
 		},
+		{
+			name:  "timed_out jobs are excluded",
+			runID: 123,
+			mockResponse: `{"jobs": [
+				{"id": 1, "name": "Failed Job", "conclusion": "failure", "html_url": "http://job/1"},
+				{"id": 2, "name": "Timed out Job", "conclusion": "timed_out", "html_url": "http://job/2"}
+			]}`,
+			expected: map[string]string{"Failed Job": "http://job/1"},
+		},
 	}
 
 	for _, tt := range tests {
@@ -458,7 +467,6 @@ func TestGetFailedJobURLs(t *testing.T) {
 				},
 			}
 
-			// Override client base URL to point to mock server
 			c, _ := github.NewClient(nil).WithEnterpriseURLs(server.URL, server.URL)
 			client.client = c
 
@@ -472,3 +480,45 @@ func TestGetFailedJobURLs(t *testing.T) {
 		})
 	}
 }
+
+func TestMultiJobTemplateExpansion(t *testing.T) {
+	envVariables := map[string]string{
+		githubWorkflow:   "test-ci",
+		githubServerURL:  "https://github.com",
+		githubOwner:      "test-org",
+		githubRepository: "test-repo",
+		githubRunID:      "555555",
+		githubSHAKey:     "abcde12345",
+	}
+
+	report := report.Report{
+		Module: "test-module",
+	}
+
+	t.Run("single failed job link", func(t *testing.T) {
+		mockResponse := &github.Jobs{Jobs: []*github.WorkflowJob{
+			{Name: github.Ptr("Job A"), Conclusion: github.Ptr("failure"), HTMLURL: github.Ptr("http://job/a")},
+		}}
+		mockedHTTPClient := newMockHTTPClient(t, mock.GetReposActionsRunsJobsByOwnerByRepoByRunId, mockResponse, 0)
+		client := newTestClient(t, mockedHTTPClient)
+		client.envVariables = envVariables
+
+		expand := templateHelper(context.Background(), client, envVariables, report, 0)
+		result := expand("linkToBuild")
+
+		assert.Equal(t, "http://job/a", result)
+	})
+
+	t.Run("multiple failed jobs list", func(t *testing.T) {
+		mockResponse := &github.Jobs{Jobs: []*github.WorkflowJob{
+			{Name: github.Ptr("Job A"), Conclusion: github.Ptr("failure"), HTMLURL: github.Ptr("http://job/a")},
+			{Name: github.Ptr("Job B"), Conclusion: github.Ptr("failure"), HTMLURL: github.Ptr("http://job/b")},
+		}}
+		mockedHTTPClient := newMockHTTPClient(t, mock.GetReposActionsRunsJobsByOwnerByRepoByRunId, mockResponse, 0)
+		client := newTestClient(t, mockedHTTPClient)
+		client.envVariables = envVariables
+
+		expand := templateHelper(context.Background(), client, envVariables, report, 0)
+		assert.Equal(t, "\n- [`Job A`](http://job/a)\n- [`Job B`](http://job/b)", expand("linkToBuild"))
+	})
+}