fix

Author: lukaszcl

tools/flakeguard/cmd/create_jira_tickets.go

@@ -18,11 +18,12 @@ import (
 )
 
 var (
-	csvPath         string
-	dryRun          bool
-	jiraProject     string
-	jiraIssueType   string
-	jiraSearchLabel string // defaults to "flaky_test" if empty
+	csvPath             string
+	dryRun              bool
+	jiraProject         string
+	jiraIssueType       string
+	jiraSearchLabel     string // defaults to "flaky_test" if empty
+	flakyTestJSONDBPath string
 )
 
 // CreateTicketsCmd is the Cobra command that runs a Bubble Tea TUI for CSV data,
@@ -60,7 +61,7 @@ ticket in a text-based UI. Press 'y' to confirm creation, 'n' to skip,
 		}
 
 		// 2) Load local DB (test -> known Jira ticket)
-		db, err := localdb.LoadDB()
+		db, err := localdb.LoadDBWithPath(flakyTestJSONDBPath)
 		if err != nil {
 			log.Warn().Err(err).Msg("Failed to load local DB; continuing with empty DB.")
 			db = localdb.NewDB()
@@ -149,11 +150,11 @@ ticket in a text-based UI. Press 'y' to confirm creation, 'n' to skip,
 		fm := finalModel.(model)
 
 		// 9) Save local DB with any new knowledge
-		if err := localdb.SaveDB(fm.LocalDB); err != nil {
+		if err := fm.LocalDB.Save(); err != nil {
 			log.Error().Err(err).Msg("Failed to save local DB")
 		} else {
 			// Let the user know we updated it
-			fmt.Printf("Local DB has been updated at: %s\n", localdb.FilePath())
+			fmt.Printf("Local DB has been updated at: %s\n", fm.LocalDB.FilePath())
 		}
 
 		// 10) Write remaining CSV
@@ -174,6 +175,7 @@ func init() {
 	CreateTicketsCmd.Flags().StringVar(&jiraProject, "jira-project", "", "Jira project key (or env JIRA_PROJECT_KEY)")
 	CreateTicketsCmd.Flags().StringVar(&jiraIssueType, "jira-issue-type", "Task", "Type of Jira issue (Task, Bug, etc.)")
 	CreateTicketsCmd.Flags().StringVar(&jiraSearchLabel, "jira-search-label", "", "Jira label to filter existing tickets (default: flaky_test)")
+	CreateTicketsCmd.Flags().StringVar(&flakyTestJSONDBPath, "flaky-test-json-db-path", "", "Path to the flaky test JSON database (default: ~/.flaky_tes_db.json)")
 }
 
 // -------------------------------------------------------------------------------------
@@ -346,34 +348,29 @@ func updateNormalMode(m model, msg tea.KeyMsg) (tea.Model, tea.Cmd) {
 	}
 	t := m.tickets[m.index]
 
+	// Always allow 'q' (quit) and 'e' (enter existing ticket)
 	switch msg.String() {
 	case "q", "esc", "ctrl+c":
 		return updateQuit(m)
+	case "e":
+		m.mode = "promptExisting"
+		m.inputValue = ""
+		return m, nil
 	}
 
-	// If invalid, we cannot create a new ticket, so no 'y' prompt:
-	if !t.Valid {
-		// Let user skip or do other actions
+	// If ticket is valid, allow create ('c') and skip ('n')
+	if t.Valid {
 		switch msg.String() {
-		// user might press anything => skip
-		default:
+		case "c":
+			return updateConfirm(m)
+		case "n":
 			return updateSkip(m)
 		}
-	}
-
-	// If valid, handle normal flow
-	switch msg.String() {
-	case "y":
-		return updateConfirm(m)
-	case "n":
-		return updateSkip(m)
-	case "e":
-		// always prompt to enter or overwrite
-		m.mode = "promptExisting"
-		m.inputValue = ""
 		return m, nil
 	}
-	return m, nil
+
+	// For invalid tickets, default to skipping if any other key is pressed.
+	return updateSkip(m)
 }
 
 func updatePromptExisting(m model, msg tea.KeyMsg) (tea.Model, tea.Cmd) {
@@ -491,8 +488,9 @@ func (m model) View() string {
 	}
 
 	// 2) Summary & Description
-	sum := summaryStyle.Render("Summary:\n") + t.Summary
-	descHeader := descHeaderStyle.Render("\nDescription:\n")
+	sum := summaryStyle.Render("Summary:")
+	sumBody := descBodyStyle.Render(t.Summary)
+	descHeader := descHeaderStyle.Render("\nDescription:")
 	descBody := descBodyStyle.Render(t.Description)
 
 	// 3) Existing ticket line
@@ -527,39 +525,40 @@ func (m model) View() string {
 	helpLine := ""
 	// Cases:
 	// A) If invalid:
-	// B) If valid & there's an existing ticket => [n] to next, [e] to update existing ticket ID, [q] to quit.
-	// C) If valid & no existing => [y] to confirm, [n] to skip, [e] to enter existing ticket, [q] to quit (with DRY RUN text if needed).
+	// B) If valid & there's an existing ticket => [n] to next, [e] to update ticket id, [q] to quit.
+	// C) If valid & no existing => [c] to create ticket, [n] to skip, [e] to enter existing ticket, [q] to quit (with DRY RUN text if needed).
 	if !t.Valid {
 		if t.ExistingJiraKey != "" {
-			helpLine = faintStyle.Render("\n[n] to next, [e] to update existing ticket ID, [q] to quit.")
+			helpLine = faintStyle.Render("\n[n] to next, [e] to update ticket id, [q] to quit.")
 		} else {
 			helpLine = faintStyle.Render("\n[n] to next, [e] to add existing ticket ID, [q] to quit.")
 		}
 	} else {
 		if t.ExistingJiraKey != "" {
-			helpLine = faintStyle.Render("\n[n] to next, [e] to update existing ticket ID, [q] to quit.")
+			helpLine = faintStyle.Render("\n[n] to next, [e] to update ticket id, [q] to quit.")
 		} else {
 			// if no existing ticket, the normal prompt
 			dryRunLabel := ""
 			if m.DryRun || m.JiraClient == nil {
 				dryRunLabel = " (DRY RUN)"
 			}
 			helpLine = faintStyle.Render(
-				fmt.Sprintf("\nPress [y] to confirm%s, [n] to skip, [e] to enter existing ticket, [q] to quit.",
+				fmt.Sprintf("\nPress [c] to create ticket%s, [n] to skip, [e] to enter existing ticket, [q] to quit.",
 					dryRunLabel),
 			)
 		}
 	}
 
 	return fmt.Sprintf(
-		"%s\n\n%s\n%s%s%s%s\n%s\n",
+		"%s\n%s\n%s\n%s%s%s%s\n%s\n",
 		header,
 		sum,
+		sumBody,
 		descHeader,
 		descBody,
 		existingLine, // e.g. "Existing ticket found in jira: https://..."
 		invalidLine,  // e.g. "Cannot create ticket: Missing required..."
-		helpLine,     // e.g. "[n] to next, [e]... or "[y] to confirm..."
+		helpLine,     // e.g. "[n] to next, [e]... or "[c] to create ticket..."
 	)
 }
 

tools/flakeguard/localdb/localdb.go

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+
+	"github.com/rs/zerolog/log"
 )
 
 const defaultDBFileName = ".flaky_test_db.json"
@@ -16,70 +18,91 @@ type Entry struct {
 	JiraTicket  string `json:"jira_ticket"`
 }
 
-// DB is a simple in-memory map keyed by "pkg::testName" => Entry
+// DB is a simple in-memory map keyed by "pkg::testName" => Entry,
+// and it contains the file path used for persistence.
 type DB struct {
 	data map[string]Entry
+	path string
 }
 
-// NewDB returns a new, empty DB.
+// NewDB creates a new, empty DB using the default file path.
 func NewDB() DB {
 	return DB{
 		data: make(map[string]Entry),
+		path: getDefaultDBPath(),
+	}
+}
+
+// NewDBWithPath creates a new, empty DB using the provided path.
+// If the provided path is empty, the default path is used.
+func NewDBWithPath(path string) DB {
+	if path == "" {
+		path = getDefaultDBPath()
+	}
+	return DB{
+		data: make(map[string]Entry),
+		path: path,
 	}
 }
 
-// LoadDB loads the JSON file at ~/.flaky_test_db.json into a DB.
+// LoadDB loads the JSON file from the default path into a DB.
 // If the file does not exist, an empty DB is returned.
 func LoadDB() (DB, error) {
-	path := getDBPath()
+	return LoadDBWithPath("")
+}
+
+// LoadDBWithPath loads the JSON file from the specified path into a DB.
+// If path is empty, the default path is used.
+func LoadDBWithPath(path string) (DB, error) {
+	if path == "" {
+		path = getDefaultDBPath()
+	}
+	db := DB{
+		data: make(map[string]Entry),
+		path: path,
+	}
 	if _, err := os.Stat(path); os.IsNotExist(err) {
-		// File doesn't exist => return empty DB
-		return NewDB(), nil
+		// File doesn't exist => return empty DB.
+		return db, nil
 	}
-
 	f, err := os.Open(path)
 	if err != nil {
-		return DB{}, fmt.Errorf("failed to open local DB file: %w", err)
+		return db, fmt.Errorf("failed to open local DB file: %w", err)
 	}
 	defer f.Close()
 
-	db := NewDB()
 	if err := json.NewDecoder(f).Decode(&db.data); err != nil {
-		return DB{}, fmt.Errorf("failed to decode local DB JSON: %w", err)
+		return db, fmt.Errorf("failed to decode local DB JSON: %w", err)
 	}
 	return db, nil
 }
 
-// SaveDB writes the DB contents to ~/.flaky_test_db.json in JSON format.
-func SaveDB(db DB) error {
-	path := getDBPath()
-	f, err := os.Create(path)
+// Save persists the DB contents to its file path in JSON format.
+func (db *DB) Save() error {
+	f, err := os.Create(db.path)
 	if err != nil {
 		return fmt.Errorf("failed to create local DB file: %w", err)
 	}
 	defer f.Close()
 
 	enc := json.NewEncoder(f)
-	enc.SetIndent("", "  ") // optional prettify
+	enc.SetIndent("", "  ") // Optional: prettify the JSON.
 	if err := enc.Encode(db.data); err != nil {
 		return fmt.Errorf("failed to encode local DB to JSON: %w", err)
 	}
 	return nil
 }
 
-// FilePath returns the path where the local DB is stored (e.g. ~/.flaky_test_db.json).
-func FilePath() string {
-	return getDBPath()
+// FilePath returns the file path where the DB is stored.
+func (db *DB) FilePath() string {
+	return db.path
 }
 
 // Get retrieves the Jira ticket ID for (testPackage, testName), if it exists.
 func (db *DB) Get(testPackage, testName string) (string, bool) {
 	key := makeKey(testPackage, testName)
-	e, ok := db.data[key]
-	if !ok {
-		return "", false
-	}
-	return e.JiraTicket, true
+	entry, exists := db.data[key]
+	return entry.JiraTicket, exists
 }
 
 // Set updates or inserts a record for (testPackage, testName) => jiraTicket.
@@ -92,17 +115,18 @@ func (db *DB) Set(testPackage, testName, jiraTicket string) {
 	}
 }
 
-// getDBPath returns the path to the local DB file in the user's home directory.
-func getDBPath() string {
+// getDefaultDBPath returns the default DB file path in the user's home directory.
+// If the user's home directory cannot be determined, it falls back to the current directory.
+func getDefaultDBPath() string {
 	home, err := os.UserHomeDir()
 	if err != nil {
-		// Fallback to current dir if we cannot get home
+		log.Warn().Msg("Failed to get user home directory; using current directory for local DB.")
 		home = "."
 	}
 	return filepath.Join(home, defaultDBFileName)
 }
 
-// makeKey is a helper to combine package+testName into a single map key.
+// makeKey is a helper to combine the package and test name into a single map key.
 func makeKey(pkg, testName string) string {
 	return pkg + "::" + testName
 }