Skip to content

Commit c0bdc7b

Browse files
rscgopherbot
rsc
authored and
gopherbot
committed
modfile: add API for godebug lines
For golang/go#65573 Change-Id: I5c1be8833f70b0b5a7257bd5216fa6a89bd2665f Reviewed-on: https://go-review.googlesource.com/c/mod/+/584300 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Auto-Submit: Russ Cox <rsc@golang.org> Reviewed-by: Michael Matloob <matloob@golang.org> Reviewed-by: Sam Thanawalla <samthanawalla@google.com>
1 parent 6686f41 commit c0bdc7b

File tree

4 files changed

+339
-4
lines changed

4 files changed

+339
-4
lines changed

‎modfile/rule.go‎

Lines changed: 103 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ type File struct {
3838
Module *Module
3939
Go *Go
4040
Toolchain *Toolchain
41+
Godebug []*Godebug
4142
Require []*Require
4243
Exclude []*Exclude
4344
Replace []*Replace
@@ -65,6 +66,13 @@ type Toolchain struct {
6566
Syntax *Line
6667
}
6768

69+
// A Godebug is a single godebug key=value statement.
70+
type Godebug struct {
71+
Key string
72+
Value string
73+
Syntax *Line
74+
}
75+
6876
// An Exclude is a single exclude statement.
6977
type Exclude struct {
7078
Mod module.Version
@@ -289,7 +297,7 @@ func parseToFile(file string, data []byte, fix VersionFixer, strict bool) (parse
289297
})
290298
}
291299
continue
292-
case "module", "require", "exclude", "replace", "retract":
300+
case "module", "godebug", "require", "exclude", "replace", "retract":
293301
for _, l := range x.Line {
294302
f.add(&errs, x, l, x.Token[0], l.Token, fix, strict)
295303
}
@@ -308,7 +316,9 @@ var laxGoVersionRE = lazyregexp.New(`^v?(([1-9][0-9]*)\.(0|[1-9][0-9]*))([^0-9].
308316

309317
// Toolchains must be named beginning with `go1`,
310318
// like "go1.20.3" or "go1.20.3-gccgo". As a special case, "default" is also permitted.
311-
// TODO(samthanawalla): Replace regex with https://pkg.go.dev/go/version#IsValid in 1.23+
319+
// Note that this regexp is a much looser condition than go/version.IsValid,
320+
// for forward compatibility.
321+
// (This code has to be work to identify new toolchains even if we tweak the syntax in the future.)
312322
var ToolchainRE = lazyregexp.New(`^default$|^go1($|\.)`)
313323

314324
func (f *File) add(errs *ErrorList, block *LineBlock, line *Line, verb string, args []string, fix VersionFixer, strict bool) {
@@ -384,7 +394,7 @@ func (f *File) add(errs *ErrorList, block *LineBlock, line *Line, verb string, a
384394
if len(args) != 1 {
385395
errorf("toolchain directive expects exactly one argument")
386396
return
387-
} else if strict && !ToolchainRE.MatchString(args[0]) {
397+
} else if !ToolchainRE.MatchString(args[0]) {
388398
errorf("invalid toolchain version '%s': must match format go1.23.0 or default", args[0])
389399
return
390400
}
@@ -412,6 +422,22 @@ func (f *File) add(errs *ErrorList, block *LineBlock, line *Line, verb string, a
412422
}
413423
f.Module.Mod = module.Version{Path: s}
414424

425+
case "godebug":
426+
if len(args) != 1 || strings.ContainsAny(args[0], "\"`',") {
427+
errorf("usage: godebug key=value")
428+
return
429+
}
430+
key, value, ok := strings.Cut(args[0], "=")
431+
if !ok {
432+
errorf("usage: godebug key=value")
433+
return
434+
}
435+
f.Godebug = append(f.Godebug, &Godebug{
436+
Key: key,
437+
Value: value,
438+
Syntax: line,
439+
})
440+
415441
case "require", "exclude":
416442
if len(args) != 2 {
417443
errorf("usage: %s module/path v1.2.3", verb)
@@ -654,6 +680,22 @@ func (f *WorkFile) add(errs *ErrorList, line *Line, verb string, args []string,
654680
f.Toolchain = &Toolchain{Syntax: line}
655681
f.Toolchain.Name = args[0]
656682

683+
case "godebug":
684+
if len(args) != 1 || strings.ContainsAny(args[0], "\"`',") {
685+
errorf("usage: godebug key=value")
686+
return
687+
}
688+
key, value, ok := strings.Cut(args[0], "=")
689+
if !ok {
690+
errorf("usage: godebug key=value")
691+
return
692+
}
693+
f.Godebug = append(f.Godebug, &Godebug{
694+
Key: key,
695+
Value: value,
696+
Syntax: line,
697+
})
698+
657699
case "use":
658700
if len(args) != 1 {
659701
errorf("usage: %s local/dir", verb)
@@ -929,6 +971,15 @@ func (f *File) Format() ([]byte, error) {
929971
// Cleanup cleans out all the cleared entries.
930972
func (f *File) Cleanup() {
931973
w := 0
974+
for _, g := range f.Godebug {
975+
if g.Key != "" {
976+
f.Godebug[w] = g
977+
w++
978+
}
979+
}
980+
f.Godebug = f.Godebug[:w]
981+
982+
w = 0
932983
for _, r := range f.Require {
933984
if r.Mod.Path != "" {
934985
f.Require[w] = r
@@ -1027,6 +1078,45 @@ func (f *File) AddToolchainStmt(name string) error {
10271078
return nil
10281079
}
10291080

1081+
// AddGodebug sets the first godebug line for key to value,
1082+
// preserving any existing comments for that line and removing all
1083+
// other godebug lines for key.
1084+
//
1085+
// If no line currently exists for key, AddGodebug adds a new line
1086+
// at the end of the last godebug block.
1087+
func (f *File) AddGodebug(key, value string) error {
1088+
need := true
1089+
for _, g := range f.Godebug {
1090+
if g.Key == key {
1091+
if need {
1092+
g.Value = value
1093+
f.Syntax.updateLine(g.Syntax, "godebug", key+"="+value)
1094+
need = false
1095+
} else {
1096+
g.Syntax.markRemoved()
1097+
*g = Godebug{}
1098+
}
1099+
}
1100+
}
1101+
1102+
if need {
1103+
f.addNewGodebug(key, value)
1104+
}
1105+
return nil
1106+
}
1107+
1108+
// addNewGodebug adds a new godebug key=value line at the end
1109+
// of the last godebug block, regardless of any existing godebug lines for key.
1110+
func (f *File) addNewGodebug(key, value string) {
1111+
line := f.Syntax.addLine(nil, "godebug", key+"="+value)
1112+
g := &Godebug{
1113+
Key: key,
1114+
Value: value,
1115+
Syntax: line,
1116+
}
1117+
f.Godebug = append(f.Godebug, g)
1118+
}
1119+
10301120
// AddRequire sets the first require line for path to version vers,
10311121
// preserving any existing comments for that line and removing all
10321122
// other lines for path.
@@ -1334,6 +1424,16 @@ func (f *File) SetRequireSeparateIndirect(req []*Require) {
13341424
f.SortBlocks()
13351425
}
13361426

1427+
func (f *File) DropGodebug(key string) error {
1428+
for _, g := range f.Godebug {
1429+
if g.Key == key {
1430+
g.Syntax.markRemoved()
1431+
*g = Godebug{}
1432+
}
1433+
}
1434+
return nil
1435+
}
1436+
13371437
func (f *File) DropRequire(path string) error {
13381438
for _, r := range f.Require {
13391439
if r.Mod.Path == path {

‎modfile/rule_test.go‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1581,6 +1581,139 @@ var modifyEmptyFilesTests = []struct {
15811581
},
15821582
}
15831583

1584+
var addGodebugTests = []struct {
1585+
desc string
1586+
in string
1587+
key string
1588+
value string
1589+
out string
1590+
}{
1591+
{
1592+
`existing`,
1593+
`
1594+
module m
1595+
godebug key=old
1596+
`,
1597+
"key", "new",
1598+
`
1599+
module m
1600+
godebug key=new
1601+
`,
1602+
},
1603+
{
1604+
`existing2`,
1605+
`
1606+
module m
1607+
godebug (
1608+
key=first // first
1609+
other=first-a // first-a
1610+
)
1611+
godebug key=second // second
1612+
godebug (
1613+
key=third // third
1614+
other=third-a // third-a
1615+
)
1616+
`,
1617+
"key", "new",
1618+
`
1619+
module m
1620+
1621+
godebug (
1622+
key=new // first
1623+
other=first-a// first-a
1624+
)
1625+
1626+
godebug other=third-a // third-a
1627+
`,
1628+
},
1629+
{
1630+
`new`,
1631+
`
1632+
module m
1633+
godebug other=foo
1634+
`,
1635+
"key", "new",
1636+
`
1637+
module m
1638+
godebug (
1639+
other=foo
1640+
key=new
1641+
)
1642+
`,
1643+
},
1644+
{
1645+
`new2`,
1646+
`
1647+
module m
1648+
godebug first=1
1649+
godebug second=2
1650+
`,
1651+
"third", "3",
1652+
`
1653+
module m
1654+
godebug first=1
1655+
godebug (
1656+
second=2
1657+
third=3
1658+
)
1659+
`,
1660+
},
1661+
}
1662+
1663+
var dropGodebugTests = []struct {
1664+
desc string
1665+
in string
1666+
key string
1667+
out string
1668+
}{
1669+
{
1670+
`existing`,
1671+
`
1672+
module m
1673+
godebug key=old
1674+
`,
1675+
"key",
1676+
`
1677+
module m
1678+
`,
1679+
},
1680+
{
1681+
`existing2`,
1682+
`
1683+
module m
1684+
godebug (
1685+
key=first // first
1686+
other=first-a // first-a
1687+
)
1688+
godebug key=second // second
1689+
godebug (
1690+
key=third // third
1691+
other=third-a // third-a
1692+
)
1693+
`,
1694+
"key",
1695+
`
1696+
module m
1697+
1698+
godebug other=first-a// first-a
1699+
1700+
godebug other=third-a // third-a
1701+
`,
1702+
},
1703+
{
1704+
`new`,
1705+
`
1706+
module m
1707+
godebug other=foo
1708+
`,
1709+
"key",
1710+
`
1711+
module m
1712+
godebug other=foo
1713+
`,
1714+
},
1715+
}
1716+
15841717
func fixV(path, version string) (string, error) {
15851718
if path != "example.com/m" {
15861719
return "", fmt.Errorf("module path must be example.com/m")
@@ -1600,6 +1733,18 @@ func TestAddRequire(t *testing.T) {
16001733
}
16011734
}
16021735

1736+
func TestAddGodebug(t *testing.T) {
1737+
for _, tt := range addGodebugTests {
1738+
t.Run(tt.desc, func(t *testing.T) {
1739+
testEdit(t, tt.in, tt.out, true, func(f *File) error {
1740+
err := f.AddGodebug(tt.key, tt.value)
1741+
f.Cleanup()
1742+
return err
1743+
})
1744+
})
1745+
}
1746+
}
1747+
16031748
func TestSetRequire(t *testing.T) {
16041749
for _, tt := range setRequireTests {
16051750
t.Run(tt.desc, func(t *testing.T) {
@@ -1696,6 +1841,18 @@ func TestDropToolchain(t *testing.T) {
16961841
}
16971842
}
16981843

1844+
func TestDropGodebug(t *testing.T) {
1845+
for _, tt := range dropGodebugTests {
1846+
t.Run(tt.desc, func(t *testing.T) {
1847+
testEdit(t, tt.in, tt.out, true, func(f *File) error {
1848+
f.DropGodebug(tt.key)
1849+
f.Cleanup()
1850+
return nil
1851+
})
1852+
})
1853+
}
1854+
}
1855+
16991856
func TestAddExclude(t *testing.T) {
17001857
for _, tt := range addExcludeTests {
17011858
t.Run(tt.desc, func(t *testing.T) {

0 commit comments

Comments
 (0)