ping author of a failing test's pr

Author: jelly-afk

.chloggen/ping-pr-author-of-failing-test.yaml

@@ -0,0 +1,16 @@
+# 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: issuegenerator now pings the author of a failing test's PR
+
+# One or more tracking issues related to the change
+issues: [1182]
+
+# (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

@@ -69,6 +69,10 @@ Link to latest failed build: ${linkToBuild}
 Commit: ${commit}
 
 ${failedTests}
+`
+	prCommentTemplate = `@${prAuthor} some tests are failing on main after these changes.  
+Details: ${issueLink}  
+Please take a look when you get a chance. Thanks!
 `
 )
 
@@ -227,6 +231,13 @@ 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)
+		}
+	}
+
 	return issueComment
 }
 
@@ -315,6 +326,83 @@ func (c *Client) getCommitMessage(ctx context.Context) string {
 	return ""
 }
 
+// GetPRAuthor fetches the author of a pull request
+func (c *Client) GetPRAuthor(ctx context.Context, prNumber int) string {
+	if prNumber <= 0 {
+		return ""
+	}
+
+	pr, response, err := c.client.PullRequests.Get(
+		ctx,
+		c.envVariables[githubOwner],
+		c.envVariables[githubRepository],
+		prNumber,
+	)
+	if err != nil {
+		c.logger.Warn("Failed to get PR details from GitHub API",
+			zap.Int("pr_number", prNumber),
+			zap.Error(err),
+		)
+		return ""
+	}
+
+	if response.StatusCode != http.StatusOK {
+		c.logger.Warn("Unexpected response when fetching PR",
+			zap.Int("status_code", response.StatusCode),
+			zap.Int("pr_number", prNumber),
+		)
+		return ""
+	}
+
+	if pr.User != nil && pr.User.Login != nil {
+		return *pr.User.Login
+	}
+
+	return ""
+}
+
+// CommentOnPR adds a comment to a pull request to notify the author about failing tests
+func (c *Client) CommentOnPR(ctx context.Context, prNumber int, prAuthor string, issueURL string) *github.IssueComment {
+	if prNumber <= 0 || prAuthor == "" {
+		c.logger.Warn("Cannot comment on PR: missing PR number or author",
+			zap.Int("pr_number", prNumber),
+			zap.String("pr_author", prAuthor),
+		)
+		return nil
+	}
+
+	body := os.Expand(prCommentTemplate, func(param string) string {
+		return prTemplateHelper(param, prAuthor, issueURL)
+	})
+
+	prComment, response, err := c.client.Issues.CreateComment(
+		ctx,
+		c.envVariables[githubOwner],
+		c.envVariables[githubRepository],
+		prNumber,
+		&github.IssueComment{
+			Body: &body,
+		},
+	)
+	if err != nil {
+		c.logger.Warn("Failed to comment on PR",
+			zap.Int("pr_number", prNumber),
+			zap.Error(err),
+		)
+		return nil
+	}
+
+	if response.StatusCode != http.StatusCreated {
+		c.logger.Warn("Unexpected response when commenting on PR",
+			zap.Int("status_code", response.StatusCode),
+			zap.Int("pr_number", prNumber),
+		)
+		return nil
+	}
+
+	return prComment
+}
+
 func (c *Client) extractPRNumberFromCommitMessage(commitMsg string) int {
 	// Only consider the first line of the commit message.
 	firstLine := strings.SplitN(commitMsg, "\n", 2)[0]
@@ -377,9 +465,27 @@ 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)
+		}
+	}
+
 	return issue
 }
 
+func prTemplateHelper(param string, prAuthor string, issueURL string) string {
+	switch param {
+	case "prAuthor":
+		return prAuthor
+	case "issueLink":
+		return issueURL
+	default:
+		return ""
+	}
+}
+
 func (c *Client) handleBadResponses(response *github.Response) {
 	body, _ := io.ReadAll(response.Body)
 	c.logger.Fatal(

issuegenerator/main.go

@@ -66,6 +66,7 @@ func main() {
 		)
 
 		existingIssue := ghClient.GetExistingIssue(ctx, report.Module)
+		// CreateIssue/CommentOnIssue will also comment on the related PR.
 		if existingIssue == nil {
 			// If none exists, create a new GitHub Issue for the failure.
 			logger.Info("No existing Issues found, creating a new one.")
@@ -80,5 +81,6 @@ func main() {
 			createdIssueComment := ghClient.CommentOnIssue(ctx, report, existingIssue)
 			logger.Info("GitHub Issue updated", zap.String("html_url", *createdIssueComment.HTMLURL))
 		}
+
 	}
 }