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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
// Copyright 2024 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 main_test
import (
"cmd/go/internal/base"
"cmd/go/internal/cfg"
"flag"
"go/build"
"internal/diff"
"os"
"slices"
"strings"
"testing"
)
var update = flag.Bool("update", false, "if true update testdata/counternames.txt")
func TestCounterNamesUpToDate(t *testing.T) {
if !*update {
t.Parallel()
}
var counters []string
// -C is a special case because it's handled by handleChdirFlag rather than
// standard flag processing with FlagSets.
// go/subcommand:unknown is also a special case: it's used when the subcommand
// doesn't match any of the known commands.
counters = append(counters, "go/flag:C", "go/subcommand:unknown")
counters = append(counters, flagscounters("go/flag:", *flag.CommandLine)...)
// Add help (without any arguments) as a special case. cmdcounters adds go help <cmd>
// for all subcommands, but it's also valid to invoke go help without any arguments.
counters = append(counters, "go/subcommand:help")
for _, cmd := range base.Go.Commands {
cmdcounters, err := cmdcounters(nil, cmd)
if err != nil {
t.Fatal(err)
}
counters = append(counters, cmdcounters...)
}
counters = append(counters, base.RegisteredCounterNames()...)
for _, c := range counters {
const counterPrefix = "go/"
if !strings.HasPrefix(c, counterPrefix) {
t.Fatalf("registered counter %q does not start with %q", c, counterPrefix)
}
}
cstr := []byte(strings.Join(counters, "\n") + "\n")
const counterNamesFile = "testdata/counters.txt"
old, err := os.ReadFile(counterNamesFile)
if err != nil {
t.Fatalf("error reading %s: %v", counterNamesFile, err)
}
diff := diff.Diff(counterNamesFile, old, "generated counter names", cstr)
if diff == nil {
t.Logf("%s is up to date.", counterNamesFile)
return
}
if *update {
if err := os.WriteFile(counterNamesFile, cstr, 0666); err != nil {
t.Fatal(err)
}
t.Logf("wrote %d bytes to %s", len(cstr), counterNamesFile)
t.Logf("don't forget to file a proposal to update the list of collected counters")
} else {
t.Logf("\n%s", diff)
t.Errorf("%s is stale. To update, run 'go generate cmd/go'.", counterNamesFile)
}
}
func flagscounters(prefix string, flagSet flag.FlagSet) []string {
var counters []string
flagSet.VisitAll(func(f *flag.Flag) {
counters = append(counters, prefix+f.Name)
})
return counters
}
func cmdcounters(previous []string, cmd *base.Command) ([]string, error) {
const subcommandPrefix = "go/subcommand:"
const flagPrefix = "go/flag:"
var counters []string
previousComponent := strings.Join(previous, "-")
if len(previousComponent) > 0 {
previousComponent += "-"
}
if cmd.Runnable() {
if cmd.Name() == "tool" {
// TODO(matloob): Do we expect the same tools to be present on all
// platforms/configurations? Should we only run this on certain
// platforms?
tools, err := toolNames()
if err != nil {
return nil, err
}
for _, t := range tools {
counters = append(counters, subcommandPrefix+previousComponent+cmd.Name()+"-"+t)
}
counters = append(counters, subcommandPrefix+previousComponent+cmd.Name()+"-unknown")
}
counters = append(counters, subcommandPrefix+previousComponent+cmd.Name())
}
counters = append(counters, flagscounters(flagPrefix+previousComponent+cmd.Name()+"-", cmd.Flag)...)
if len(previous) != 0 {
counters = append(counters, subcommandPrefix+previousComponent+"help-"+cmd.Name())
}
counters = append(counters, subcommandPrefix+"help-"+previousComponent+cmd.Name())
for _, subcmd := range cmd.Commands {
subcmdcounters, err := cmdcounters(append(slices.Clone(previous), cmd.Name()), subcmd)
if err != nil {
return nil, err
}
counters = append(counters, subcmdcounters...)
}
return counters, nil
}
// toolNames returns the list of basenames of executables in the tool dir.
func toolNames() ([]string, error) {
entries, err := os.ReadDir(build.ToolDir)
if err != nil {
return nil, err
}
var names []string
for _, e := range entries {
if e.IsDir() {
continue
}
name := strings.TrimSuffix(e.Name(), cfg.ToolExeSuffix())
names = append(names, name)
}
return names, nil
}
|
