fix: paths normalize for windows (#121)

Author: vladopajic

.testcoverage.example.yml

@@ -43,8 +43,4 @@ exclude:
   # Exclude files or packages matching their paths
   paths:
     - \.pb\.go$    # excludes all protobuf generated files
-    - ^pkg/bar     # exclude package `pkg/bar`
- 
-# NOTES:
-# - symbol `/` in all path regexps will be replaced by current OS file path separator
-#   to properly work on Windows.
+    - ^pkg/bar     # exclude package `pkg/bar`

README.md

@@ -125,10 +125,6 @@ exclude:
   paths:
     - \.pb\.go$    # excludes all protobuf generated files
     - ^pkg/bar     # exclude package `pkg/bar`
- 
-# NOTES:
-# - symbol `/` in all path regexps will be replaced by current OS file path separator
-#   to properly work on Windows.
 ```
 
 ### Exclude Code from Coverage

pkg/testcoverage/badgestorer/github_test.go

@@ -2,11 +2,11 @@ package badgestorer_test
 
 import (
 	"context"
+	crand "crypto/rand"
+	"encoding/hex"
 	"fmt"
 	"os"
-	"runtime"
 	"testing"
-	"time"
 
 	"github.com/google/go-github/v56/github"
 	"github.com/stretchr/testify/assert"
@@ -56,7 +56,7 @@ func Test_Github(t *testing.T) {
 		Branch:     "badges-integration-test",
 		// badge name must be unique because two tests running from different platforms
 		// in CI can cause race condition if badge has the same name
-		FileName: fmt.Sprintf("badge_%s_%d.svg", runtime.GOOS, time.Now().UnixNano()),
+		FileName: fmt.Sprintf("badge_%s.svg", randName()),
 	}
 	s := NewGithub(cfg)
 
@@ -110,3 +110,14 @@ func deleteFile(t *testing.T, cfg Git) {
 	)
 	assert.NoError(t, err)
 }
+
+func randName() string {
+	buf := make([]byte, 20)
+
+	_, err := crand.Read(buf)
+	if err != nil {
+		panic(err) //nolint:forbidigo // okay here because it is only used for tests
+	}
+
+	return hex.EncodeToString(buf)
+}

pkg/testcoverage/coverage/cover.go

@@ -10,6 +10,8 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/path"
+
 	"golang.org/x/tools/cover"
 )
 
@@ -88,7 +90,7 @@ func findFile(file, prefix string) (string, string, error) {
 
 	file = filepath.Join(pkg.Dir, file)
 	if _, err := os.Stat(file); err == nil {
-		return file, stripPrefix(file, pkg.Root), nil
+		return file, stripPrefix(path.NormalizeForTool(file), path.NormalizeForTool(pkg.Root)), nil
 	}
 
 	return "", "", fmt.Errorf("can't find file %q", profileFile)

pkg/testcoverage/coverage/cover_test.go

@@ -8,6 +8,7 @@ import (
 	"golang.org/x/tools/cover"
 
 	. "github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/coverage"
+	"github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/path"
 	"github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/testdata"
 )
 
@@ -97,12 +98,12 @@ func Test_findFile(t *testing.T) {
 	file, noPrefixName, err := FindFile(prefix+"/"+filename, "")
 	assert.NoError(t, err)
 	assert.Equal(t, filename, noPrefixName)
-	assert.True(t, strings.HasSuffix(file, filename))
+	assert.True(t, strings.HasSuffix(file, path.NormalizeForOS(filename)))
 
 	file, noPrefixName, err = FindFile(prefix+"/"+filename, prefix)
 	assert.NoError(t, err)
 	assert.Equal(t, filename, noPrefixName)
-	assert.True(t, strings.HasSuffix(file, filename))
+	assert.True(t, strings.HasSuffix(file, path.NormalizeForOS(filename)))
 
 	_, _, err = FindFile(prefix+"/main1.go", "")
 	assert.Error(t, err)

pkg/testcoverage/coverage/types.go

@@ -3,8 +3,6 @@ package coverage
 import (
 	"regexp"
 	"strings"
-
-	"github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/path"
 )
 
 type Stats struct {
@@ -61,7 +59,6 @@ func compileExcludePathRules(excludePaths []string) []*regexp.Regexp {
 	compiled := make([]*regexp.Regexp, len(excludePaths))
 
 	for i, pattern := range excludePaths {
-		pattern = path.NormalizePathInRegex(pattern)
 		compiled[i] = regexp.MustCompile(pattern)
 	}
 

pkg/testcoverage/path/path.go

@@ -8,10 +8,18 @@ import (
 
 const separatorToReplace = string(filepath.Separator)
 
-func NormalizePathInRegex(path string) string {
+func NormalizeForOS(path string) string {
 	if runtime.GOOS != "windows" {
 		return path
 	}
 
 	return strings.ReplaceAll(path, "/", separatorToReplace) // coverage-ignore
 }
+
+func NormalizeForTool(path string) string {
+	if runtime.GOOS != "windows" {
+		return path
+	}
+
+	return strings.ReplaceAll(path, separatorToReplace, "/") // coverage-ignore
+}

pkg/testcoverage/utils.go

@@ -2,8 +2,6 @@ package testcoverage
 
 import (
 	"regexp"
-
-	"github.com/vladopajic/go-test-coverage/v2/pkg/testcoverage/path"
 )
 
 type regRule struct {
@@ -29,9 +27,8 @@ func compileOverridePathRules(cfg Config) []regRule {
 	compiled := make([]regRule, len(cfg.Override))
 
 	for i, o := range cfg.Override {
-		pattern := path.NormalizePathInRegex(o.Path)
 		compiled[i] = regRule{
-			reg:       regexp.MustCompile(pattern),
+			reg:       regexp.MustCompile(o.Path),
 			threshold: o.Threshold,
 		}
 	}