Recognizes closed jira tickets

Author: kalverra

tools/flakeguard/README.md

@@ -1,12 +1,10 @@
-Flakeguard
-==========
+# Flakeguard
 
 **Flakeguard** is a tool designed to help identify flaky tests within a Go project. Flaky tests are tests that intermittently fail without changes to the code, often due to race conditions or other non-deterministic behavior. Flakeguard assists by analyzing the impact of code changes on test packages and by running tests multiple times to determine stability.
 
 In addition to detecting flaky tests, Flakeguard can also integrate with Jira to track known flaky tests. It maintains a local database of tests and their associated Jira tickets, allowing you to create and manage these tickets directly from the command line.
 
-Features
---------
+## Features
 
 *   **Identify Impacted Tests:** Detects test packages that may be affected by changes in your Go project files.
 *   **Run Tests for Flakiness:** Runs tests multiple times to determine their flakiness.
@@ -16,8 +14,7 @@ Features
 *   **Jira Integration (Optional):** Create, review, and manage flaky test tickets in Jira.
 *   **Local Database:** Store known flaky tests and their associated Jira tickets for easy reference.
 
-Prerequisites
--------------
+## Prerequisites
 
 1.  **Go:** Version 1.21 or later recommended.
 2.  **Jira API Access (optional):** Required only if you want to use the Jira-related commands (`create-tickets`, `review-tickets`, `sync-jira`):
@@ -26,23 +23,24 @@ Prerequisites
     *   `JIRA_API_KEY`: Your Jira API token (generate one in your Jira account settings).
     *   `JIRA_PROJECT_KEY`: (Optional) The default Jira project key to use if `--jira-project` is not specified for `create-tickets`.
 
-Installation
-------------
+## Installation
 
 To install the `flakeguard` CLI, ensure you have Go installed. Then run:
 
+```sh
 go install github.com/smartcontractkit/chainlink-testing-framework/tools/flakeguard@latest
+```
 
 You can also clone the repository and build from source:
 
+```sh
 git clone https://github.com/smartcontractkit/chainlink-testing-framework.git
 cd chainlink-testing-framework/tools/flakeguard
 
 go build -o flakeguard main.go
+```
 
-
-Usage (Flaky Test Detection)
-----------------------------------
+## Usage (Flaky Test Detection)
 
 Flakeguard provides two primary commands for local detection of flaky tests without involving Jira: `find` and `run`.
 
@@ -56,8 +54,7 @@ The `find` command scans your Go project to determine which test packages may be
 After identifying packages of interest (via `flakeguard find` or otherwise), use the `run` command to execute tests multiple times to detect flakiness.
 
 
-Configuration Files (for Jira Integration)
-------------------------------------------
+## Configuration Files (for Jira Integration)
 
 When using Flakeguard’s Jira integration and local database features, you may need these configuration files:
 
@@ -83,8 +80,7 @@ When using Flakeguard’s Jira integration and local database features, you may
     *   **Flag:** Use `--user-test-mapping-path` (default: `user_test_mapping.json`) when creating tickets.
 
 
-Usage (Jira Integration)
-------------------------
+## Usage (Jira Integration)
 
 If you only need to identify flaky tests locally (via `find` and `run`) and do not intend to create or manage Jira tickets, you can skip these commands.
 
@@ -113,7 +109,7 @@ Interactively process a CSV file of flaky tests, suggest assignees based on patt
 
 **Example:**
 
-```
+```sh
  go run main.go create-tickets \                      
   --jira-project=DX \
   --test-db-path=flaky_test_db.json \
@@ -147,7 +143,7 @@ Interactively review tickets in the local database. Fetches current status and P
 
 **Examples:**
 
-```
+```sh
 go run main.go review-tickets --test-db-path ".flaky_test_db.json" --dry-run=false --user-mapping-path "user_mapping.json"
 ```
 
@@ -166,6 +162,6 @@ Scans Jira for all tickets matching a specific label and ensures they exist in t
 
 **Example:**
 
-```
+```sh
 go run main.go sync-jira --test-db-path=.flaky_test_db.json
 ```

tools/flakeguard/cmd/create_tickets.go

@@ -117,12 +117,16 @@ Features:
 
 			// Check local DB first for existing ticket
 			if entry, found := db.GetEntry(ft.TestPackage, ft.TestName); found {
-				log.Debug().Str("test", ft.TestName).Str("db_ticket", entry.JiraTicket).Str("db_assignee", entry.AssigneeID).Time("db_skipped_at", entry.SkippedAt).Msg("Found existing entry in local DB")
-
-				if entry.JiraTicket != "" {
-					ft.ExistingJiraKey = entry.JiraTicket
-					ft.ExistingTicketSource = "localdb"
-				}
+				log.Debug().
+					Str("test", ft.TestName).
+					Str("db_ticket", entry.JiraTicket).
+					Str("db_assignee", entry.AssigneeID).
+					Time("db_skipped_at", entry.SkippedAt).
+					Msg("Found existing entry in local DB")
+
+				ft.RelatedJiraTickets = entry.PastJiraTickets
+				ft.ExistingJiraKey = entry.JiraTicket
+				ft.ExistingTicketSource = "localdb"
 				// Always assign SkippedAt and AssigneeID from the DB entry if found
 				ft.SkippedAt = entry.SkippedAt
 				if entry.AssigneeID != "" {
@@ -170,35 +174,6 @@ Features:
 			client = nil
 		}
 
-		if client != nil {
-			processedCount := 0
-			totalToSearch := 0
-			for _, t := range tickets {
-				if t.ExistingJiraKey == "" {
-					totalToSearch++
-				}
-			}
-
-			for i := range tickets {
-				t := &tickets[i]
-				if t.ExistingJiraKey == "" {
-					key, searchErr := findExistingTicket(client, jiraSearchLabel, *t)
-					processedCount++
-					if searchErr != nil {
-						log.Warn().Err(searchErr).Str("summary", t.Summary).Msg("Jira search failed for test")
-					} else if key != "" {
-						log.Info().Str("test", t.TestName).Str("found_key", key).Str("label", jiraSearchLabel).Msg("Found existing ticket in Jira via search")
-						t.ExistingJiraKey = key
-						t.ExistingTicketSource = "jira"
-						errDb := db.UpsertEntry(t.TestPackage, t.TestName, key, t.SkippedAt, t.AssigneeId)
-						if errDb != nil {
-							log.Error().Err(errDb).Str("key", key).Msg("Failed to update local DB after finding ticket in Jira!")
-						}
-					}
-				}
-			}
-		}
-
 		m := initialCreateModel(tickets, userMap)
 		m.DryRun = dryRun
 		m.JiraProject = jiraProject
@@ -763,7 +738,19 @@ func updateConfirm(m createModel) (tea.Model, tea.Cmd) {
 		ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
 		defer cancel()
 
-		issueKey, err := jirautils.CreateTicketInJira(ctx, m.JiraClient, t.Summary, t.Description, m.JiraProject, m.JiraIssueType, assigneeForJira, t.Priority, []string{jiraSearchLabel}, pillarName)
+		issueKey, err := jirautils.CreateTicketInJira(
+			ctx,
+			m.JiraClient,
+			t.Summary,
+			t.Description,
+			m.JiraProject,
+			m.JiraIssueType,
+			assigneeForJira,
+			t.Priority,
+			t.RelatedJiraTickets,
+			[]string{},
+			pillarName,
+		)
 
 		if err != nil {
 			errMsg := fmt.Sprintf("Failed to create Jira ticket for %q", t.Summary)
@@ -1034,6 +1021,11 @@ func viewNormal(m createModel) string {
 	sb.WriteString(descHeaderStyle.Render("Proposed Description:") + "\n")
 	sb.WriteString(descBodyStyle.Render(t.Description) + "\n")
 
+	if len(t.RelatedJiraTickets) > 0 {
+		sb.WriteString(descHeaderStyle.Render("Related Jira Tickets:") + "\n")
+		sb.WriteString(descBodyStyle.Render(strings.Join(t.RelatedJiraTickets, ", ")) + "\n")
+	}
+
 	// Help Line / Actions
 	sb.WriteString(helpStyle.Render(buildHelpLine(m)))
 

tools/flakeguard/cmd/make_pr.go

@@ -0,0 +1,103 @@
+package cmd
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"time"
+
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+	"github.com/google/go-github/v72/github"
+	"github.com/smartcontractkit/chainlink-testing-framework/tools/flakeguard/localdb"
+	"github.com/spf13/cobra"
+	"golang.org/x/oauth2"
+)
+
+var (
+	repoPath    string
+	localDBPath string
+)
+
+var MakePRCmd = &cobra.Command{
+	Use:   "make-pr",
+	Short: "Make a PR to skip identified flaky tests",
+	RunE:  makePR,
+}
+
+func makePR(cmd *cobra.Command, args []string) error {
+	repo, err := git.PlainOpen(repoPath)
+	if err != nil {
+		return err
+	}
+
+	db, err := localdb.LoadDBWithPath(localDBPath)
+	if err != nil {
+		return err
+	}
+
+	entries := db.GetAllEntries()
+
+	branchName := fmt.Sprintf("flakeguard-skip-%s", time.Now().Format("20060102150405"))
+	w, err := repo.Worktree()
+	if err != nil {
+		return err
+	}
+	err = w.Checkout(&git.CheckoutOptions{
+		Branch: plumbing.NewBranchReferenceName(branchName),
+		Create: true,
+	})
+	if err != nil {
+		return err
+	}
+
+	for _, entry := range entries {
+		// Find the test function in the codebase and skip it
+
+		entry.SkippedAt = time.Now()
+		db.UpsertEntry(entry.TestPackage, entry.TestName, entry.JiraTicket, entry.SkippedAt, entry.AssigneeID)
+
+	}
+
+	_, err = w.Add(".")
+	if err != nil {
+		return err
+	}
+	_, err = w.Commit("Skips flaky tests", &git.CommitOptions{})
+	if err != nil {
+		return err
+	}
+
+	err = repo.Push(&git.PushOptions{})
+	if err != nil {
+		return err
+	}
+
+	ctx := context.Background()
+	ts := oauth2.StaticTokenSource(
+		&oauth2.Token{AccessToken: os.Getenv("GITHUB_TOKEN")},
+	)
+	tc := oauth2.NewClient(ctx, ts)
+	client := github.NewClient(tc)
+
+	owner := "your-org"
+	repoName := "your-repo"
+	pr := &github.NewPullRequest{
+		Title:               github.Ptr("Skip flaky tests"),
+		Head:                github.Ptr(branchName),
+		Base:                github.Ptr("main"),
+		Body:                github.Ptr("This PR skips flaky tests."),
+		MaintainerCanModify: github.Ptr(true),
+	}
+	_, _, err = client.PullRequests.Create(ctx, owner, repoName, pr)
+	if err != nil {
+		return err
+	}
+
+	fmt.Println("PR created!")
+	return nil
+}
+
+func init() {
+	MakePRCmd.Flags().StringVarP(&repoPath, "repo", "r", ".", "Path to the repository to make the PR in")
+}