Add 'go-project-name' flag to RunTestsCmd and update Runner struct

Author: lukaszcl

tools/flakeguard/cmd/run.go

@@ -27,6 +27,7 @@ var RunTestsCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		// Retrieve flags
 		projectPath, _ := cmd.Flags().GetString("project-path")
+		goProject, _ := cmd.Flags().GetString("go-project-name")
 		testPackagesJson, _ := cmd.Flags().GetString("test-packages-json")
 		testPackagesArg, _ := cmd.Flags().GetStringSlice("test-packages")
 		testCmdStrings, _ := cmd.Flags().GetStringArray("test-cmd")
@@ -80,6 +81,7 @@ var RunTestsCmd = &cobra.Command{
 		// Initialize the runner
 		testRunner := runner.Runner{
 			ProjectPath:          projectPath,
+			GoProject:            goProject,
 			Verbose:              true,
 			RunCount:             runCount,
 			Timeout:              timeout,
@@ -162,6 +164,8 @@ var RunTestsCmd = &cobra.Command{
 
 func init() {
 	RunTestsCmd.Flags().StringP("project-path", "r", ".", "The path to the Go project. Default is the current directory. Useful for subprojects")
+	RunTestsCmd.Flags().String("go-project-name", "", "The name of the Go project. Example: github.com/smartcontractkit/chainlink/v2")
+	_ = RunTestsCmd.MarkFlagRequired("go-project-name")
 	RunTestsCmd.Flags().String("test-packages-json", "", "JSON-encoded string of test packages")
 	RunTestsCmd.Flags().StringSlice("test-packages", nil, "Comma-separated list of test packages to run")
 	RunTestsCmd.Flags().StringArray("test-cmd", nil,

tools/flakeguard/runner/runner.go

@@ -27,7 +27,7 @@ var (
 // Runner describes the test run parameters and raw test outputs
 type Runner struct {
 	ProjectPath          string        // Path to the Go project directory.
-	prettyProjectPath    string        // Go project package path, formatted for pretty printing.
+	GoProject            string        // Go project package name.
 	Verbose              bool          // If true, provides detailed logging.
 	RunCount             int           // Number of times to run the tests.
 	UseRace              bool          // Enable race detector.
@@ -76,7 +76,7 @@ func (r *Runner) RunTestPackages(packages []string) (*reports.TestReport, error)
 		return nil, fmt.Errorf("failed to parse test results: %w", err)
 	}
 	report := &reports.TestReport{
-		GoProject:     r.prettyProjectPath,
+		GoProject:     r.GoProject,
 		RaceDetection: r.UseRace,
 		ExcludedTests: r.SkipTests,
 		SelectedTests: r.SelectTests,
@@ -112,7 +112,7 @@ func (r *Runner) RunTestCmd(testCmd []string) (*reports.TestReport, error) {
 	}
 
 	report := &reports.TestReport{
-		GoProject:     r.prettyProjectPath,
+		GoProject:     r.GoProject,
 		RaceDetection: r.UseRace,
 		ExcludedTests: r.SkipTests,
 		SelectedTests: r.SelectTests,
@@ -173,11 +173,6 @@ func (r *Runner) runTestPackage(packageName string) (string, bool, error) {
 	}
 	defer tmpFile.Close()
 
-	r.prettyProjectPath, err = prettyProjectPath(r.ProjectPath)
-	if err != nil {
-		r.prettyProjectPath = r.ProjectPath
-		log.Warn().Err(err).Str("projectPath", r.ProjectPath).Msg("Failed to get pretty project path")
-	}
 	// Run the command with output directed to the file
 	cmd := exec.Command("go", args...)
 	cmd.Dir = r.ProjectPath
@@ -638,42 +633,3 @@ func parseSubTest(testName string) (parentTestName, subTestName string) {
 	}
 	return parts[0], parts[1]
 }
-
-// prettyProjectPath returns the project path formatted for pretty printing in results.
-func prettyProjectPath(projectPath string) (string, error) {
-	// Walk up the directory structure to find go.mod
-	absPath, err := filepath.Abs(projectPath)
-	if err != nil {
-		return "", fmt.Errorf("failed to resolve absolute path: %w", err)
-	}
-	dir := absPath
-	for {
-		if _, err := os.Stat(filepath.Join(dir, "go.mod")); err == nil {
-			break
-		}
-
-		parent := filepath.Dir(dir)
-		if parent == dir { // Reached the root without finding go.mod
-			return "", fmt.Errorf("go.mod not found in project path, started at %s, ended at %s", projectPath, dir)
-		}
-		dir = parent
-	}
-
-	// Read go.mod to extract the module path
-	goModPath := filepath.Join(dir, "go.mod")
-	goModData, err := os.ReadFile(goModPath)
-	if err != nil {
-		return "", fmt.Errorf("failed to read go.mod: %w", err)
-	}
-
-	for _, line := range strings.Split(string(goModData), "\n") {
-		if strings.HasPrefix(line, "module ") {
-			goProject := strings.TrimSpace(strings.TrimPrefix(line, "module "))
-			relativePath := strings.TrimPrefix(projectPath, dir)
-			relativePath = strings.TrimLeft(relativePath, string(os.PathSeparator))
-			return filepath.Join(goProject, relativePath), nil
-		}
-	}
-
-	return "", fmt.Errorf("module path not found in go.mod")
-}

tools/flakeguard/runner/runner_test.go

@@ -39,14 +39,6 @@ type expectedTestResult struct {
 	seen bool
 }
 
-func TestPrettyProjectPath(t *testing.T) {
-	t.Parallel()
-
-	prettyPath, err := prettyProjectPath("./")
-	require.NoError(t, err)
-	assert.Equal(t, "github.com/smartcontractkit/chainlink-testing-framework/tools/flakeguard", prettyPath)
-}
-
 func TestRun(t *testing.T) {
 	var (
 		zeroRuns        = 0