[issuegenerator] use labels to search for existing issues (#1222)

* use labels to search for existing issues

* add label flag and warning log if multiple issues found

---------

Co-authored-by: Pablo Baeyens <[email protected]>

Author: jelly-afk

.chloggen/use-labels-for-issue-search.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: issue generator
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Use labels to search for existing issues in issue generator
+
+# One or more tracking issues related to the change
+issues: [1181]
+
+# (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/main.go

@@ -24,7 +24,6 @@ import (
 	"os"
 	"path"
 	"strings"
-	"time"
 
 	"github.com/google/go-github/github"
 	"github.com/joshdk/go-junit"
@@ -45,6 +44,8 @@ const (
 	githubServerURL = "GITHUB_SERVER_URL"
 	githubRunID     = "GITHUB_RUN_ID"
 
+	autoGeneratedLabel = "generated-by-issuegenerator"
+
 	issueTitleTemplate = `[${module}]: Report for failed tests on main`
 	issueBodyTemplate  = `
 Auto-generated report for ${jobName} job build.
@@ -74,6 +75,7 @@ type reportGenerator struct {
 
 	reports        []report
 	reportIterator int
+	issueLabels    []string
 }
 
 type report struct {
@@ -89,9 +91,10 @@ func newReportGenerator() *reportGenerator {
 	}
 
 	return &reportGenerator{
-		logger:     logger,
-		testSuites: make(map[string]junit.Suite),
-		reports:    make([]report, 0),
+		logger:      logger,
+		testSuites:  make(map[string]junit.Suite),
+		reports:     make([]report, 0),
+		issueLabels: []string{autoGeneratedLabel},
 	}
 }
 
@@ -109,6 +112,7 @@ func getComponent(module string) string {
 
 func main() {
 	pathToArtifacts := flag.String("path", "", "Path to the directory with test results")
+	labelFlag := flag.String("labels", "", "Comma-separated list of labels to add to the created issues")
 	flag.Parse()
 	if *pathToArtifacts == "" {
 		fmt.Println("Path to the directory with test results is required")
@@ -121,7 +125,13 @@ func main() {
 	rg.ingestArtifacts(*pathToArtifacts)
 	rg.processTestResults()
 	rg.initializeGHClient(ctx)
-
+	if *labelFlag != "" {
+		labels := strings.Split(*labelFlag, ",")
+		for i := range labels {
+			labels[i] = strings.TrimSpace(labels[i])
+		}
+		rg.issueLabels = append(rg.issueLabels, labels...)
+	}
 	// Look for existing open GitHub Issue that resulted from previous
 	// failures of this job.
 	rg.logger.Info("Searching GitHub for existing Issues")
@@ -262,13 +272,15 @@ func (rg *reportGenerator) templateHelper(param string) string {
 // getExistingIssues gathers an existing GitHub Issue related to previous failures
 // of the same module.
 func (rg *reportGenerator) getExistingIssue(ctx context.Context, module string) *github.Issue {
+
+	componentName := getComponent(trimModule(rg.envVariables[githubOwner], rg.envVariables[githubRepository], module))
 	issues, response, err := rg.client.Issues.ListByRepo(
 		ctx,
 		rg.envVariables[githubOwner],
 		rg.envVariables[githubRepository],
 		&github.IssueListByRepoOptions{
-			State: "open",
-			Since: time.Now().Add(-time.Hour * 24 * 30 * 6), // Search for at least 6 months of issues
+			State:  "open",
+			Labels: []string{autoGeneratedLabel, componentName},
 		},
 	)
 	if err != nil {
@@ -279,14 +291,21 @@ func (rg *reportGenerator) getExistingIssue(ctx context.Context, module string)
 		rg.handleBadResponses(response)
 	}
 
-	module = trimModule(rg.envVariables[githubOwner], rg.envVariables[githubRepository], module)
-	requiredTitle := strings.Replace(issueTitleTemplate, "${module}", module, 1)
-	for _, issue := range issues {
-		if *issue.Title == requiredTitle {
-			return issue
+	if len(issues) > 0 {
+		if len(issues) > 1 {
+			issueLinks := make([]string, len(issues))
+			for i, issue := range issues {
+				if issue.HTMLURL != nil {
+					issueLinks[i] = *issue.HTMLURL
+				}
+				rg.logger.Warn(
+					"Multiple existing Issues found for the same component",
+					zap.Strings("issue_links", issueLinks),
+				)
+			}
 		}
+		return issues[0]
 	}
-
 	return nil
 }
 
@@ -321,15 +340,18 @@ func (rg *reportGenerator) createIssue(ctx context.Context, r report) *github.Is
 	trimmedModule := trimModule(rg.envVariables[githubOwner], rg.envVariables[githubRepository], r.module)
 	title := strings.Replace(issueTitleTemplate, "${module}", trimmedModule, 1)
 	body := os.Expand(issueBodyTemplate, rg.templateHelper)
+	componentName := getComponent(trimmedModule)
+
+	rg.issueLabels = append(rg.issueLabels, componentName)
 
 	issue, response, err := rg.client.Issues.Create(
 		ctx,
 		rg.envVariables[githubOwner],
 		rg.envVariables[githubRepository],
 		&github.IssueRequest{
-			Title: &title,
-			Body:  &body,
-			// TODO: Set Assignees and labels
+			Title:  &title,
+			Body:   &body,
+			Labels: &rg.issueLabels,
 		})
 	if err != nil {
 		rg.logger.Fatal("Failed to create GitHub Issue", zap.Error(err))