blob: 49376a4665fc2fc063cff99e66d740089f7dbdc7 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package coverage
// CoverPkgConfig is a bundle of information passed from the Go
// command to the cover command during "go build -cover" runs. The
// Go command creates and fills in a struct as below, then passes
// file containing the encoded JSON for the struct to the "cover"
// tool when instrumenting the source files in a Go package.
type CoverPkgConfig struct {
// File into which cmd/cover should emit summary info
// when instrumentation is complete.
OutConfig string
// Import path for the package being instrumented.
PkgPath string
// Package name.
PkgName string
// Instrumentation granularity: one of "perfunc" or "perblock" (default)
Granularity string
// Module path for this package (empty if no go.mod in use)
ModulePath string
// Local mode indicates we're doing a coverage build or test of a
// package selected via local import path, e.g. "./..." or
// "./foo/bar" as opposed to a non-relative import path. See the
// corresponding field in cmd/go's PackageInternal struct for more
// info.
Local bool
}
// CoverFixupConfig contains annotations/notes generated by the
// cmd/cover tool (during instrumentation) to be passed on to the
// compiler when the instrumented code is compiled. The cmd/cover tool
// creates a struct of this type, JSON-encodes it, and emits the
// result to a file, which the Go command then passes to the compiler
// when the instrumented package is built.
type CoverFixupConfig struct {
// Name of the variable (created by cmd/cover) containing the
// encoded meta-data for the package.
MetaVar string
// Length of the meta-data.
MetaLen int
// Hash computed by cmd/cover of the meta-data.
MetaHash string
// Instrumentation strategy. For now this is always set to
// "normal", but in the future we may add new values (for example,
// if panic paths are instrumented, or if the instrumenter
// eliminates redundant counters).
Strategy string
// Prefix assigned to the names of counter variables generated
// during instrumentation by cmd/cover.
CounterPrefix string
// Name chosen for the package ID variable generated during
// instrumentation.
PkgIdVar string
// Counter mode (e.g. set/count/atomic)
CounterMode string
// Counter granularity (perblock or perfunc).
CounterGranularity string
}
// MetaFilePaths contains information generated by the Go command and
// the read in by coverage test support functions within an executing
// "go test -cover" binary.
type MetaFileCollection struct {
ImportPaths []string
MetaFileFragments []string
}
// Name of file within the "go test -cover" temp coverdir directory
// containing a list of meta-data files for packages being tested
// in a "go test -coverpkg=... ..." run. This constant is shared
// by the Go command and by the coverage runtime.
const MetaFilesFileName = "metafiles.txt"
|
