Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

cmd/go: invalidate coverage report cache when coverpkg sources change #74773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryancurrah wants to merge 1 commit into golang:master
base: master
Choose a base branch
Loading
from ryancurrah:fix/coverage-report-when-coverpkg-is-used
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion src/cmd/go/internal/test/test.go
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,10 @@ var (
testTimeout time.Duration // -timeout flag
testV testVFlag // -v flag
testVet = vetFlag{flags: defaultVetFlags} // -vet flag

// Cache for covered packages hash to avoid recomputing for each test package
testCoverPkgsHash cache.ActionID
testCoverPkgsHashOnce sync.Once
)

type testVFlag struct {
Expand Down Expand Up @@ -1927,6 +1931,37 @@ func (c *runCache) tryCacheWithID(b *work.Builder, a *work.Action, id string) bo
var errBadTestInputs = errors.New("error parsing test inputs")
var testlogMagic = []byte("# test log\n") // known to testing/internal/testdeps/deps.go

// hashCoveredPackages writes to h a hash of the source files of the covered packages.
func hashCoveredPackages(h io.Writer, pkgs []*load.Package) {
for _, pkg := range pkgs {
fmt.Fprintf(h, "coverpkg %s", pkg.ImportPath)
// Include source file hashes to detect changes
for _, file := range pkg.GoFiles {
if fh := hashStat(filepath.Join(pkg.Dir, file)); fh != (cache.ActionID{}) {
fmt.Fprintf(h, " %x", fh)
}
}
for _, file := range pkg.CgoFiles {
if fh := hashStat(filepath.Join(pkg.Dir, file)); fh != (cache.ActionID{}) {
fmt.Fprintf(h, " %x", fh)
}
}
fmt.Fprintf(h, "\n")
}
}

// getCoveredPackagesHash returns the cached hash of covered packages, computing it only once.
func getCoveredPackagesHash() cache.ActionID {
testCoverPkgsHashOnce.Do(func() {
if len(testCoverPkgs) > 0 {
h := cache.NewHash("coverpkgs")
hashCoveredPackages(h, testCoverPkgs)
testCoverPkgsHash = h.Sum()
}
})
return testCoverPkgsHash
}

// computeTestInputsID computes the "test inputs ID"
// (see comment in tryCacheWithID above) for the
// test log.
Expand Down Expand Up @@ -2071,7 +2106,14 @@ func testAndInputKey(testID, testInputsID cache.ActionID) cache.ActionID {

// coverProfileAndInputKey returns the "coverprofile" cache key for the pair (testID, testInputsID).
func coverProfileAndInputKey(testID, testInputsID cache.ActionID) cache.ActionID {
return cache.Subkey(testAndInputKey(testID, testInputsID), "coverprofile")
// Include covered packages hash to invalidate coverage reports when covered packages change
h := cache.NewHash("coverprofile")
testAndInputs := testAndInputKey(testID, testInputsID)
h.Write(testAndInputs[:])
// Use cached hash instead of recomputing for each test package
coveredPkgsHash := getCoveredPackagesHash()
h.Write(coveredPkgsHash[:])
return h.Sum()
}

func (c *runCache) saveOutput(a *work.Action) {
Expand Down
137 changes: 137 additions & 0 deletions src/cmd/go/testdata/script/test_cache_coverpkg_bug.txt
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
env GO111MODULE=on

# Test for bug where cached coverage profiles with -coverpkg can contain
# outdated line references when source files are modified.
# This reproduces the issue where coverage data from cache may reference
# lines that no longer exist in the updated source files.

[short] skip
[GODEBUG:gocacheverify=1] skip

# We're testing cache behavior, so start with a clean GOCACHE.
env GOCACHE=$WORK/cache

# Create a project structure with multiple packages
# proj/
# some_func.go
# some_func_test.go
# sub/
# sub.go
# sub_test.go
# sum/
# sum.go

# Switch to the proj directory
cd proj

# Run tests with -coverpkg to collect coverage for all packages
go test -coverpkg=proj/... -coverprofile=cover1.out ./...
stdout 'coverage:'

# Verify the first coverage profile exists and has expected content
exists cover1.out
grep -q 'proj/sub/sub.go:' cover1.out

# Run again to ensure caching works
go test -coverpkg=proj/... -coverprofile=cover1_cached.out ./...
stdout '\(cached\)'
stdout 'coverage:'

# Note: Due to the bug, cached coverage profiles may have duplicate entries
# This is the issue we're trying to fix

# Now modify sub.go to change line structure - this will invalidate
# the cache for sub package but not for proj package
cp ../sub_modified.go sub/sub.go

# The bug manifests as duplicate or invalid line references in the coverage profile
# After modifying sub.go, we should not have both old and new line references
go test -coverpkg=proj/... -coverprofile=cover2.out ./...
stdout 'coverage:'

# With the bug present, we would see duplicate entries for the same lines
# This demonstrates the bug - there should be duplicates in the coverage profile
grep 'proj/sub/sub.go:' cover2.out
# The fix should ensure that only the new line format exists, not the old one
grep 'proj/sub/sub.go:3.24,4.35' cover2.out
# This should fail if the stale coverage line exists (the bug is present)
! grep 'proj/sub/sub.go:3.24,4.22' cover2.out

-- proj/go.mod --
module proj

go 1.21

-- proj/some_func.go --
package proj

import "proj/sum"

func SomeFunc(a, b int) int {
if a == 0 && b == 0 {
return 0
}
return sum.Sum(a, b)
}

-- proj/some_func_test.go --
package proj

import (
"testing"
)

func Test_SomeFunc(t *testing.T) {
t.Run("test1", func(t *testing.T) {
result := SomeFunc(1, 1)
if result != 2 {
t.Errorf("Expected 2, got %d", result)
}
})
}

-- proj/sub/sub.go --
package sub

func Sub(a, b int) int {
if a == 0 && b == 0 {
return 0
}
return a - b
}

-- proj/sub/sub_test.go --
package sub

import (
"testing"
)

func Test_Sub(t *testing.T) {
t.Run("test_sub1", func(t *testing.T) {
result := Sub(1, 1)
if result != 0 {
t.Errorf("Expected 0, got %d", result)
}
})
}

-- proj/sum/sum.go --
package sum

func Sum(a, b int) int {
if a == 0 {
return b
}
return a + b
}

-- sub_modified.go --
package sub

func Sub(a, b int) int {
if a == 0 && b == 0 || a == -100 {
return 0
}
return a - b
}

AltStyle によって変換されたページ (->オリジナル) /