[issuegenerator] Ping pr author of failing test (#1267)

* add pr section in issue body

* ping author of a failing test's pr

---------

Co-authored-by: Antoine Toulme <[email protected]>

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

@@ -23,6 +23,8 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"regexp"
+	"strconv"
 	"strings"
 
 	"github.com/google/go-github/v75/github"
@@ -52,6 +54,7 @@ Auto-generated report for ${jobName} job build.
 
 Link to failed build: ${linkToBuild}
 Commit: ${commit}
+PR: ${prNumber}
 
 ### Component(s)
 ${component}
@@ -66,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!
 `
 )
 
@@ -201,7 +208,11 @@ 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 {
-	body := os.Expand(issueCommentTemplate, templateHelper(c.envVariables, r))
+	// Get commit message and extract PR number
+	commitMessage := c.getCommitMessage(ctx)
+	prNumber := c.extractPRNumberFromCommitMessage(commitMessage)
+
+	body := os.Expand(issueCommentTemplate, templateHelper(c.envVariables, r, prNumber))
 
 	issueComment, response, err := c.client.Issues.CreateComment(
 		ctx,
@@ -220,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
 }
 
@@ -243,7 +261,7 @@ func getComponent(module string) string {
 	return module
 }
 
-func templateHelper(env map[string]string, r report.Report) func(string) string {
+func templateHelper(env map[string]string, r report.Report, prNumber int) func(string) string {
 	return func(param string) string {
 		switch param {
 		case "jobName":
@@ -257,6 +275,11 @@ func templateHelper(env map[string]string, r report.Report) func(string) string
 			return getComponent(trimmedModule)
 		case "commit":
 			return shortSha(env[githubSHAKey])
+		case "prNumber":
+			if prNumber > 0 {
+				return fmt.Sprintf("#%d", prNumber)
+			}
+			return "N/A"
 		default:
 			return ""
 		}
@@ -271,11 +294,155 @@ func shortSha(sha string) string {
 	return sha
 }
 
+// getCommitMessage fetches the commit message
+func (c *Client) getCommitMessage(ctx context.Context) string {
+	commit, response, err := c.client.Repositories.GetCommit(
+		ctx,
+		c.envVariables[githubOwner],
+		c.envVariables[githubRepository],
+		c.envVariables[githubSHAKey],
+		&github.ListOptions{},
+	)
+	if err != nil {
+		c.logger.Warn("Failed to get commit message from GitHub API",
+			zap.String("sha", c.envVariables[githubSHAKey]),
+			zap.Error(err),
+		)
+		return ""
+	}
+
+	if response.StatusCode != http.StatusOK {
+		c.logger.Warn("Unexpected response when fetching commit",
+			zap.Int("status_code", response.StatusCode),
+			zap.String("sha", c.envVariables[githubSHAKey]),
+		)
+		return ""
+	}
+
+	if commit.Commit != nil {
+		return *commit.Commit.Message
+	}
+
+	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]
+
+	// cases matched :
+	// - (#123)
+	// - Merge pull request #123
+	// - (#123): some description
+	// - pull request #123
+	prRegex := regexp.MustCompile(`(?i)(?:merge pull request #|pull request #|\(#)(\d+)\)?`)
+	matches := prRegex.FindStringSubmatch(firstLine)
+
+	if len(matches) >= 2 {
+		prNumber, err := strconv.Atoi(matches[1])
+		if err != nil {
+			c.logger.Warn("Failed to convert PR number to integer",
+				zap.String("pr_string", matches[1]),
+				zap.Error(err),
+			)
+			return 0
+		}
+		return prNumber
+	}
+
+	c.logger.Warn("No PR number found in commit message",
+		zap.String("first_line", firstLine),
+	)
+	return 0
+}
+
 // CreateIssue creates a new GitHub Issue corresponding to a build failure.
 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)
-	body := os.Expand(issueBodyTemplate, templateHelper(c.envVariables, r))
+
+	// Get commit message and extract PR number
+	commitMessage := c.getCommitMessage(ctx)
+	prNumber := c.extractPRNumberFromCommitMessage(commitMessage)
+
+	body := os.Expand(issueBodyTemplate, templateHelper(c.envVariables, r, prNumber))
 	componentName := getComponent(trimmedModule)
 
 	issueLabels := c.cfg.labelsCopy()
@@ -298,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/internal/github/client_test.go

@@ -118,6 +118,7 @@ Auto-generated report for ` + "`test-ci`" + ` job build.
 
 Link to failed build: https://github.com/test-org/test-repo/actions/runs/555555
 Commit: abcde12
+PR: N/A
 
 ### Component(s)
 ` + "package1" + `
@@ -157,7 +158,7 @@ Commit: abcde12
 	require.GreaterOrEqual(t, len(reports), len(tests))
 	for i, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			result := os.Expand(tt.template, templateHelper(envVariables, reports[i]))
+			result := os.Expand(tt.template, templateHelper(envVariables, reports[i], 0))
 			assert.Equal(t, tt.expected, result)
 		})
 	}
@@ -345,3 +346,48 @@ func TestNewClient(t *testing.T) {
 		})
 	}
 }
+
+func TestExtractPRNumberFromMessage(t *testing.T) {
+	type testCase struct {
+		name       string
+		commitMsg  string
+		expectedPR int
+	}
+	tests := []testCase{
+		{
+			name:       "Standard PR format (#123)",
+			commitMsg:  "Fix bug in receiver (#123)",
+			expectedPR: 123,
+		},
+		{
+			name:       "Merge pull request #456",
+			commitMsg:  "Merge pull request #456 from branch/feature",
+			expectedPR: 456,
+		},
+		{
+			name:       "pull request #321",
+			commitMsg:  "Some change pull request #321",
+			expectedPR: 321,
+		},
+		{
+			name:       "No PR number",
+			commitMsg:  "Regular commit message",
+			expectedPR: 0,
+		},
+		{
+			name:       "example otel commit message",
+			commitMsg:  "[chore] Skip test on Windows ARM (#42921)",
+			expectedPR: 42921,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			client := &Client{
+				logger: zaptest.NewLogger(t),
+			}
+			prNum := client.extractPRNumberFromCommitMessage(tt.commitMsg)
+			assert.Equal(t, tt.expectedPR, prNum)
+		})
+	}
+}

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))
 		}
+
 	}
 }