Issues while testing

[dvzrv]

Hi! 👋

I'm currently rebuilding the package for this project on Arch Linux.

When testing I'm running into the following issue (on 0.1.12 and 0.1.13):

ok      github.com/docker-library/bashbrew/architecture 0.002s
# github.com/docker-library/bashbrew/pkg/tarscrub_test
# [github.com/docker-library/bashbrew/pkg/tarscrub_test]
pkg/tarscrub/git_test.go:15:1: ExampleGitHello refers to unknown identifier: GitHello
pkg/tarscrub/git_test.go:46:1: ExampleGitVarnish refers to unknown identifier: GitVarnish
# github.com/docker-library/bashbrew/pkg/gitfs_test
# [github.com/docker-library/bashbrew/pkg/gitfs_test]
pkg/gitfs/tarscrub_test.go:17:1: ExampleGitVarnish refers to unknown identifier: GitVarnish
pkg/gitfs/tarscrub_test.go:49:1: ExampleGitBash refers to unknown identifier: GitBash
?       github.com/docker-library/bashbrew/cmd/bashbrew [no test files]
ok      github.com/docker-library/bashbrew/manifest     0.976s
ok      github.com/docker-library/bashbrew/pkg/dockerfile       0.001s
ok      github.com/docker-library/bashbrew/pkg/execpipe 0.003s
FAIL    github.com/docker-library/bashbrew/pkg/gitfs [build failed]
ok      github.com/docker-library/bashbrew/pkg/stripper 0.001s
FAIL    github.com/docker-library/bashbrew/pkg/tarscrub [build failed]
ok      github.com/docker-library/bashbrew/pkg/templatelib      0.002s
?       github.com/docker-library/bashbrew/registry     [no test files]
FAIL

bashbrew-0.1.13-1-x86_64-build.log
bashbrew-0.1.13-1-x86_64-check.log

cc @SantiagoTorres (who is the actual maintainer of this package on Arch Linux)

[tianon]

Whew, new reasons to be frustrated at Go, yay! This is breakage caused by Go 1.24, which isn't mentioned explicitly anywhere in the release notes that I can find, just a passing reference in go vet: https://tip.golang.org/doc/go1.24 ("examples that document non-existent identifiers" which I think is probably what it's complaining about here 🙃)

[tianon]

So the shortest answer is to recommend that this project not be built/tested with Go 1.24 for now.
(More exceptions to the "Go compatibility promise" always make me feel so much joy writing code in this language...)

[tianon]

As part of building a test binary, go test runs go vet on the package
and its test source files to identify significant problems. If go vet
finds any problems, go test reports those and does not run the test
binary. Only a high-confidence subset of the default go vet checks are
used. That subset is: atomic, bool, buildtags, directive, errorsas,
ifaceassert, nilfunc, printf, stringintconv, and tests. You can see
the documentation for these and other vet tests via "go doc cmd/vet".
To disable the running of go vet, use the -vet=off flag. To run all
checks, use the -vet=all flag.

That explains it -- the change was limited to go vet, but go test implies go vet automatically unless -vet=off is supplied. 🙃

So, if you can't downgrade to Go 1.23, supplying -vet=off to go test is probably a good workaround.

[tianon]

Reading through https://pkg.go.dev/testing#hdr-Examples again (especially the "naming conventions" section), I think the right long-term fix here is names like Example_gitHello?