Skip to content

Commit

Permalink
Migrate to go1.20 coverage redesign
Browse files Browse the repository at this point in the history 
Summary:
Coverage redesign: golang/go#51430
Documentation: https://go.dev/doc/build-cover

#build_rule_type[go_library,go_binary,go_unittest,go_test]

Reviewed By: podtserkovskiy

Differential Revision: D68475818

fbshipit-source-id: ddbbe50589d942ee849ad07ca2cd32b10063171d
  • Loading branch information
@echistyakov @facebook-github-bot
echistyakov authored and facebook-github-bot committed Jan 28, 2025
1 parent 3b4eb2a commit a79f5e4
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 82 deletions.
2 changes: 1 addition & 1 deletion prelude/go/go_test.bzl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def go_test_impl(ctx: AnalysisContext) -> list[Provider]:
race = ctx.attrs._race,
asan = ctx.attrs._asan,
embedcfg = ctx.attrs.embedcfg,
tests = True,
with_tests = True,
cgo_enabled = evaluate_cgo_enabled(go_toolchain, ctx.attrs.cgo_enabled),
)

Expand Down
85 changes: 59 additions & 26 deletions prelude/go/package_builder.bzl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def build_package(
cgo_enabled: bool = False,
coverage_mode: GoCoverageMode | None = None,
embedcfg: Artifact | None = None,
tests: bool = False,
with_tests: bool = False,
cgo_gen_dir_name: str = "cgo_gen") -> (GoPkg, GoPackageInfo):
if race and coverage_mode not in [None, GoCoverageMode("atomic")]:
fail("`coverage_mode` must be `atomic` when `race=True`")
Expand All @@ -47,7 +47,7 @@ def build_package(

package_root = package_root if package_root != None else infer_package_root(srcs)

go_list_out = go_list(ctx, pkg_name, srcs, package_root, build_tags, cgo_enabled, with_tests = tests, asan = asan)
go_list_out = go_list(ctx, pkg_name, srcs, package_root, build_tags, cgo_enabled, with_tests = with_tests, asan = asan)

test_go_files_argsfile = ctx.actions.declare_output(paths.basename(pkg_name) + "_test_go_files.go_package_argsfile")
coverage_vars_argsfile = ctx.actions.declare_output(paths.basename(pkg_name) + "_coverage_vars.go_package_argsfile")
Expand All @@ -67,10 +67,19 @@ def build_package(

all_test_go_files = go_list.test_go_files + go_list.x_test_go_files

ctx.actions.write(outputs[test_go_files_argsfile], cmd_args((all_test_go_files if tests else []), ""))
is_x_test_pkg = len(go_list.x_test_go_files) > 0
go_list_pkg_name = go_list.name

go_files_to_cover = go_list.go_files + cgo_go_files + (all_test_go_files if tests else [])
covered_go_files, coverage_vars_out = _cover(ctx, pkg_name, go_files_to_cover, coverage_mode)
# For external test packages, 'go list' will report the name of the package
# being tested, but not the external test package: https://fburl.com/qorledne
# So for XTest packages - we must use Buck pkg_name override.
if is_x_test_pkg:
go_list_pkg_name = pkg_name

ctx.actions.write(outputs[test_go_files_argsfile], cmd_args((all_test_go_files if with_tests else []), ""))

go_files_to_cover = go_list.go_files + cgo_go_files + (all_test_go_files if with_tests else [])
covered_go_files, coverage_vars_out, coveragecfg = _cover(ctx, go_list_pkg_name, pkg_name, go_files_to_cover, coverage_mode)
ctx.actions.write(outputs[coverage_vars_argsfile], coverage_vars_out)

symabis = _symabis(ctx, pkg_name, main, go_list.s_files, go_list.h_files, assembler_flags)
Expand All @@ -94,6 +103,7 @@ def build_package(
asan = asan,
suffix = suffix,
complete = complete_flag,
coveragecfg = coveragecfg,
embedcfg = embedcfg,
embed_files = go_list.embed_files,
symabis = symabis,
Expand Down Expand Up @@ -134,6 +144,7 @@ def _compile(
asan: bool,
suffix: str,
complete: bool,
coveragecfg: Artifact | None = None,
embedcfg: Artifact | None = None,
embed_files: list[Artifact] = [],
symabis: Artifact | None = None,
Expand Down Expand Up @@ -168,6 +179,7 @@ def _compile(
["-race"] if race else [],
["-asan"] if asan else [],
["-shared"] if shared else [],
["-coveragecfg", coveragecfg] if coveragecfg else [],
["-embedcfg", embedcfg] if embedcfg else [],
["-symabis", symabis] if symabis else [],
["-asmhdr", asmhdr.as_output()] if asmhdr else [],
Expand Down Expand Up @@ -287,35 +299,56 @@ def _asm_args(ctx: AnalysisContext, pkg_name: str, main: bool, shared: bool):
["-shared"] if shared else [],
]

def _cover(ctx: AnalysisContext, pkg_name: str, go_files: list[Artifact], coverage_mode: GoCoverageMode | None) -> (list[Artifact], str | cmd_args):
def _cover(ctx: AnalysisContext, pkg_name: str, pkg_import_path: str, go_files: list[Artifact], coverage_mode: GoCoverageMode | None) -> (list[Artifact], str | cmd_args, Artifact | None):
if coverage_mode == None:
return go_files, ""
return go_files, "", None

go_toolchain = ctx.attrs._go_toolchain[GoToolchainInfo]
env = get_toolchain_env_vars(go_toolchain)
covered_files = []
file_to_var = {}
for go_file in go_files:
covered_file = ctx.actions.declare_output("with_coverage", go_file.short_path)
covered_files.append(covered_file)

var = "Var_" + sha256(pkg_name + "::" + go_file.short_path)
file_to_var[go_file.short_path] = var

cover_cmd = [
go_toolchain.cover,
["-mode", coverage_mode.value],
["-var", var],
["-o", covered_file.as_output()],
go_file,
]

ctx.actions.run(cover_cmd, env = env, category = "go_cover", identifier = paths.basename(pkg_name) + "/" + go_file.short_path)
cover_meta_file = ctx.actions.declare_output("cover_meta.json")
out_config_file = ctx.actions.declare_output("out_config.json")

# Based on https://pkg.go.dev/cmd/internal/cov/covcmd#CoverPkgConfig
pkgcfg = {
"EmitMetaFile": cover_meta_file,
"Granularity": "perblock",
"Local": False,
"ModulePath": "",
"OutConfig": out_config_file,
"PkgName": pkg_name,
"PkgPath": pkg_import_path,
}
pkgcfg_file = ctx.actions.write_json("pkg.cfg", pkgcfg)

var = "Var_" + sha256(pkg_import_path)
instrum_vars_file = ctx.actions.declare_output("with_instrumentation", "instrum_vars.go")
instrum_go_files = [
ctx.actions.declare_output("with_instrumentation", go_file.short_path)
for go_file in go_files
]
instrum_all_files = [instrum_vars_file] + instrum_go_files
file_to_var = {
go_file.short_path: var
for go_file in go_files
}
outfilelist = ctx.actions.write("outfilelist.txt", cmd_args(instrum_all_files, ""))

cover_cmd = [
go_toolchain.cover,
["-mode", coverage_mode.value],
["-var", var],
cmd_args(["-outfilelist", outfilelist], hidden = [f.as_output() for f in instrum_all_files]),
cmd_args(["-pkgcfg", pkgcfg_file], hidden = [cover_meta_file.as_output(), out_config_file.as_output()]),
go_files,
]

ctx.actions.run(cover_cmd, env = env, category = "go_cover", identifier = pkg_import_path)

coverage_vars_out = ""
if len(file_to_var) > 0:
# convert file_to_var to argsfile for compatibility with python implementation
cover_pkg = "{}:{}".format(pkg_name, ",".join(["{}={}".format(name, var) for name, var in file_to_var.items()]))
cover_pkg = "{}:{}".format(pkg_import_path, ",".join(["{}={}".format(name, var) for name, var in file_to_var.items()]))
coverage_vars_out = cmd_args("--cover-pkgs", cover_pkg)

return covered_files, coverage_vars_out
return instrum_all_files, coverage_vars_out, out_config_file
3 changes: 1 addition & 2 deletions prelude/go/toolchain.bzl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ GoToolchainInfo = provider(
def get_toolchain_env_vars(toolchain: GoToolchainInfo) -> dict[str, str | cmd_args]:
env = {
"GOARCH": toolchain.env_go_arch,
# opt-out from Go1.20 coverage redesign
"GOEXPERIMENT": "nocoverageredesign",
"GOEXPERIMENT": "",
"GOOS": toolchain.env_go_os,
}

Expand Down
66 changes: 13 additions & 53 deletions prelude/go_bootstrap/tools/go/testmaingen.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ func main() {
}
}

if err := testmainTmpl.Execute(out, testFuncs); err != nil {
if err := testmainTmplNewCoverage.Execute(out, testFuncs); err != nil {
log.Fatalln("Failed to generate main file:", err)
}
}
Expand Down Expand Up @@ -412,7 +412,7 @@ func checkTestFunc(fn *ast.FuncDecl, arg string) error {
return nil
}

var testmainTmpl = template.Must(template.New("main").Parse(`
var testmainTmplNewCoverage = template.Must(template.New("main").Parse(`
// Code generated by 'go test'. DO NOT EDIT.
package main
Expand All @@ -426,18 +426,16 @@ import (
{{end}}
"testing"
"testing/internal/testdeps"
{{if .Cover}}
"internal/coverage/cfile"
{{end}}
{{if .ImportTest}}
{{if .NeedTest}}_test{{else}}_{{end}} {{.Package.ImportPath | printf "%q"}}
{{end}}
{{if .ImportXtest}}
{{if .NeedXtest}}_xtest{{else}}_{{end}} {{.Package.ImportPath | printf "%s_test" | printf "%q"}}
{{end}}
{{if .Cover}}
{{range $i, $p := .Cover.Vars}}
_cover{{$i}} {{$p.Package.ImportPath | printf "%q"}}
{{end}}
{{end}}
)
var tests = []testing.InternalTest{
Expand Down Expand Up @@ -465,47 +463,17 @@ var examples = []testing.InternalExample{
}
func init() {
testdeps.ImportPath = {{.ImportPath | printf "%q"}}
}
{{if .Cover}}
testdeps.CoverMode = {{printf "%q" .Cover.Mode}}
testdeps.Covered = {{printf "%q" .Covered}}
testdeps.CoverSelectedPackages = {{printf "%s" .CoverSelectedPackages}}
testdeps.CoverSnapshotFunc = cfile.Snapshot
testdeps.CoverProcessTestDirFunc = cfile.ProcessCoverTestDir
testdeps.CoverMarkProfileEmittedFunc = cfile.MarkProfileEmitted
// Only updated by init functions, so no need for atomicity.
var (
coverCounters = make(map[string][]uint32)
coverBlocks = make(map[string][]testing.CoverBlock)
)
func init() {
{{range $i, $p := .Cover.Vars}}
{{range $file, $cover := $p.Vars}}
coverRegisterFile({{printf "%q" $cover.File}}, _cover{{$i}}.{{$cover.Var}}.Count[:], _cover{{$i}}.{{$cover.Var}}.Pos[:], _cover{{$i}}.{{$cover.Var}}.NumStmt[:])
{{end}}
{{end}}
}
func coverRegisterFile(fileName string, counter []uint32, pos []uint32, numStmts []uint16) {
if 3*len(counter) != len(pos) || len(counter) != len(numStmts) {
panic("coverage: mismatched sizes")
}
if coverCounters[fileName] != nil {
// Already registered.
return
}
coverCounters[fileName] = counter
block := make([]testing.CoverBlock, len(counter))
for i := range counter {
block[i] = testing.CoverBlock{
Line0: pos[3*i+0],
Col0: uint16(pos[3*i+2]),
Line1: pos[3*i+1],
Col1: uint16(pos[3*i+2]>>16),
Stmts: numStmts[i],
}
}
coverBlocks[fileName] = block
}
{{end}}
testdeps.ImportPath = {{.ImportPath | printf "%q"}}
}
func main() {
// Buck ensures that resources defined on the test targets live in the same
Expand All @@ -524,14 +492,6 @@ func main() {
fmt.Fprintf(os.Stderr, "Failed to change directory to %s.", execDir)
os.Exit(1)
}
{{if .Cover}}
testing.RegisterCover(testing.Cover{
Mode: {{printf "%q" .Cover.Mode}},
Counters: coverCounters,
Blocks: coverBlocks,
CoveredPackages: {{printf "%q" .Covered}},
})
{{end}}
m := testing.MainStart(testdeps.TestDeps{}, tests, benchmarks, fuzzTargets, examples)
{{with .TestMain}}
{{.Package}}.{{.Name}}(m)
Expand Down

0 comments on commit a79f5e4

Please sign in to comment.