Merge branch 'main' into no-docker-action-test

Author: vladopajic

.github/workflows/test.yml

@@ -53,7 +53,7 @@ jobs:
 
       - name: download artifact (main.breakdown)
         id: download-main-breakdown
-        uses: dawidd6/action-download-artifact@v9
+        uses: dawidd6/action-download-artifact@v10
         with:
           branch: main
           workflow_conclusion: success

Dockerfile

@@ -1,5 +1,5 @@
 # GO_VERSION: automatically update to most recent via dependabot
-FROM golang:1.24.2 as builder
+FROM golang:1.24.3 as builder
 WORKDIR /workspace
 
 COPY go.mod go.mod

main.go

@@ -9,7 +9,7 @@ import (
 )
 
 const (
-	Version = "v2.14.1" // VERSION: when changing version update version in other places
+	Version = "v2.14.3" // VERSION: when changing version update version in other places
 	Name    = "go-test-coverage"
 )
 

pkg/testcoverage/badge.go

@@ -19,7 +19,7 @@ func generateAndSaveBadge(w io.Writer, cfg Config, totalCoverage int) error {
 	buffer := &bytes.Buffer{}
 	out := bufio.NewWriter(buffer)
 
-	// `out` writer is used as temporall buffer, which will be finally
+	// `out` writer is used as temporary buffer, which will be finally
 	// written to `w` in this defer call
 	defer func() {
 		out.Flush()

pkg/testcoverage/check.go

@@ -63,8 +63,10 @@ func Check(wout io.Writer, cfg Config) (bool, error) {
 		}
 
 		if cfg.LocalPrefixDeprecated != "" { // coverage-ignore
-			reportGHWarning(w, "Deprecated option",
-				"local-prefix option is deprecated since v2.13.0, you can safely remove setting this option")
+			//nolint:lll // relax
+			msg := "`local-prefix` option is deprecated since v2.13.0, you can safely remove setting this option"
+			logger.L.Warn().Msg(msg)
+			reportGHWarning(w, "Deprecated option", msg)
 		}
 	}
 
@@ -152,7 +154,7 @@ func loadBaseCoverageBreakdown(cfg Config) ([]coverage.Stats, error) {
 
 	stats, err := coverage.StatsDeserialize(data)
 	if err != nil {
-		return nil, fmt.Errorf("parsing file failed: %w", err)
+		return nil, fmt.Errorf("deserializing stats file failed: %w", err)
 	}
 
 	return stats, nil

pkg/testcoverage/coverage/cover.go

@@ -14,6 +14,7 @@ import (
 
 	"golang.org/x/tools/cover"
 
+	"github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/logger"
 	"github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/path"
 )
 
@@ -47,6 +48,7 @@ func GenerateCoverageStats(cfg Config) ([]Stats, error) {
 		}
 
 		if ok := matches(excludeRules, fi.name); ok {
+			logger.L.Debug().Str("file", fi.name).Msg("file excluded")
 			continue // this file is excluded
 		}
 
@@ -189,8 +191,7 @@ func listAllFiles(rootDir string) []fileInfo {
 		return name
 	}
 
-	//nolint:errcheck // error ignored because there is fallback mechanism for finding files
-	filepath.Walk(rootDir, func(file string, info os.FileInfo, err error) error {
+	err := filepath.Walk(rootDir, func(file string, info os.FileInfo, err error) error {
 		if err != nil { // coverage-ignore
 			return err
 		}
@@ -206,6 +207,9 @@ func listAllFiles(rootDir string) []fileInfo {
 
 		return nil
 	})
+	if err != nil { // coverage-ignore
+		logger.L.Error().Err(err).Msg("listing files (.go files search)")
+	}
 
 	return files
 }

pkg/testcoverage/coverage/export_test.go

@@ -6,6 +6,7 @@ var (
 	FindFuncsAndBlocks = findFuncsAndBlocks
 	ParseProfiles      = parseProfiles
 	SumCoverage        = sumCoverage
+	FindGoModFile      = findGoModFile
 )
 
 type Extent = extent

pkg/testcoverage/coverage/module.go

@@ -12,36 +12,79 @@ import (
 func findModuleDirective(rootDir string) string {
 	goModFile := findGoModFile(rootDir)
 	if goModFile == "" {
-		logger.L.Warn().Str("dir", rootDir).Msg("could not find go.mod file in root dir")
+		logger.L.Warn().Str("dir", rootDir).
+			Msg("go.mod file not found in root directory (consider setting up source dir)")
 		return ""
 	}
 
+	logger.L.Debug().Str("file", goModFile).Msg("go.mod file found")
+
 	module := readModuleDirective(goModFile)
 	if module == "" { // coverage-ignore
 		logger.L.Warn().Msg("`module` directive not found")
 	}
 
+	logger.L.Debug().Str("module", module).Msg("using module directive")
+
 	return module
 }
 
 func findGoModFile(rootDir string) string {
-	var goModFile string
+	goModFile := findGoModFromRoot(rootDir)
+	if goModFile != "" {
+		return goModFile
+	}
+
+	// fallback to find first go mod file wherever it may be
+	// not really sure if we really need this ???
+	return findGoModWithWalk(rootDir)
+}
+
+func findGoModWithWalk(rootDir string) string { // coverage-ignore
+	var goModFiles []string
 
-	//nolint:errcheck // error ignored because there is fallback mechanism for finding files
-	filepath.Walk(rootDir, func(file string, info os.FileInfo, err error) error {
+	err := filepath.Walk(rootDir, func(file string, info os.FileInfo, err error) error {
 		if err != nil { // coverage-ignore
 			return err
 		}
 
 		if info.Name() == "go.mod" {
-			goModFile = file
-			return filepath.SkipAll
+			goModFiles = append(goModFiles, file)
 		}
 
 		return nil
 	})
+	if err != nil {
+		logger.L.Error().Err(err).Msg("listing files (go.mod search)")
+	}
+
+	if len(goModFiles) == 0 {
+		logger.L.Warn().Msg("go.mod file not found via walk method")
+		return ""
+	}
+
+	if len(goModFiles) > 1 {
+		logger.L.Warn().Msg("found multiple go.mod files via walk method")
+		return ""
+	}
+
+	return goModFiles[0]
+}
+
+func findGoModFromRoot(rootDir string) string {
+	files, err := os.ReadDir(rootDir)
+	if err != nil { // coverage-ignore
+		logger.L.Error().Err(err).Msg("reading directory")
+		return ""
+	}
+
+	for _, info := range files {
+		if info.Name() == "go.mod" {
+			return filepath.Join(rootDir, info.Name())
+		}
+	}
 
-	return goModFile
+	return ""
 }
 
 func readModuleDirective(filename string) string {

pkg/testcoverage/coverage/module_test.go

@@ -0,0 +1,17 @@
+package coverage_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	. "github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/coverage"
+	"github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/path"
+)
+
+func Test_FindGoModFile(t *testing.T) {
+	t.Parallel()
+
+	assert.Empty(t, FindGoModFile(""))
+	assert.Equal(t, "../../../go.mod", path.NormalizeForTool(FindGoModFile("../../../")))
+}