src/go/build/deps_test.go

   1 // Copyright 2012 The Go Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style
   3 // license that can be found in the LICENSE file.
   4
   5 // This file exercises the import parser but also checks that
   6 // some low-level packages do not have new dependencies added.
   7
   8 package build
   9
  10 import (
  11         "bytes"
  12         "fmt"
  13         "go/token"
  14         "internal/testenv"
  15         "io/fs"
  16         "os"
  17         "path/filepath"
  18         "runtime"
  19         "sort"
  20         "strings"
  21         "testing"
  22 )
  23
  24 // depsRules defines the expected dependencies between packages in
  25 // the Go source tree. It is a statement of policy.
  26 //
  27 // DO NOT CHANGE THIS DATA TO FIX BUILDS.
  28 // Existing packages should not have their constraints relaxed
  29 // without prior discussion.
  30 // Negative assertions should almost never be removed.
  31 //
  32 // The general syntax of a rule is:
  33 //
  34 //              a, b < c, d;
  35 //
  36 // which means c and d come after a and b in the partial order
  37 // (that is, c and d can import a and b),
  38 // but doesn't provide a relative order between a vs b or c vs d.
  39 //
  40 // The rules can chain together, as in:
  41 //
  42 //              e < f, g < h;
  43 //
  44 // which is equivalent to
  45 //
  46 //              e < f, g;
  47 //              f, g < h;
  48 //
  49 // Except for the special bottom element "NONE", each name
  50 // must appear exactly once on the right-hand side of a rule.
  51 // That rule serves as the definition of the allowed dependencies
  52 // for that name. The definition must appear before any uses
  53 // of the name on the left-hand side of a rule. (That is, the
  54 // rules themselves must be ordered according to the partial
  55 // order, for easier reading by people.)
  56 //
  57 // Negative assertions double-check the partial order:
  58 //
  59 //              i !< j
  60 //
  61 // means that it must NOT be the case that i < j.
  62 // Negative assertions may appear anywhere in the rules,
  63 // even before i and j have been defined.
  64 //
  65 // Comments begin with #.
  66 //
  67 // All-caps names are pseudo-names for specific points
  68 // in the dependency lattice.
  69 //
  70 var depsRules = `
  71         # No dependencies allowed for any of these packages.
  72         NONE
  73         < constraints, container/list, container/ring,
  74           internal/cfg, internal/cpu, internal/goarch,
  75           internal/goexperiment, internal/goos,
  76           internal/goversion, internal/nettrace,
  77           unicode/utf8, unicode/utf16, unicode,
  78           unsafe;
  79
  80         # These packages depend only on internal/goarch and unsafe.
  81         internal/goarch, unsafe
  82         < internal/abi;
  83
  84         # RUNTIME is the core runtime group of packages, all of them very light-weight.
  85         internal/abi, internal/cpu, internal/goarch,
  86         internal/goexperiment, internal/goos, unsafe
  87         < internal/bytealg
  88         < internal/itoa
  89         < internal/unsafeheader
  90         < runtime/internal/sys
  91         < runtime/internal/syscall
  92         < runtime/internal/atomic
  93         < runtime/internal/math
  94         < runtime
  95         < sync/atomic
  96         < internal/race
  97         < sync
  98         < internal/reflectlite
  99         < errors
 100         < internal/oserror, math/bits
 101         < RUNTIME;
 102
 103         RUNTIME
 104         < sort
 105         < container/heap;
 106
 107         RUNTIME
 108         < io;
 109
 110         syscall !< io;
 111         reflect !< sort;
 112
 113         RUNTIME, unicode/utf8
 114         < path;
 115
 116         unicode !< path;
 117
 118         # SYSCALL is RUNTIME plus the packages necessary for basic system calls.
 119         RUNTIME, unicode/utf8, unicode/utf16
 120         < internal/syscall/windows/sysdll, syscall/js
 121         < syscall
 122         < internal/syscall/unix, internal/syscall/windows, internal/syscall/windows/registry
 123         < internal/syscall/execenv
 124         < SYSCALL;
 125
 126         # TIME is SYSCALL plus the core packages about time, including context.
 127         SYSCALL
 128         < time/tzdata
 129         < time
 130         < context
 131         < TIME;
 132
 133         TIME, io, path, sort
 134         < io/fs;
 135
 136         # MATH is RUNTIME plus the basic math packages.
 137         RUNTIME
 138         < math
 139         < MATH;
 140
 141         unicode !< math;
 142
 143         MATH
 144         < math/cmplx;
 145
 146         MATH
 147         < math/rand;
 148
 149         MATH
 150         < runtime/metrics;
 151
 152         MATH, unicode/utf8
 153         < strconv;
 154
 155         unicode !< strconv;
 156
 157         # STR is basic string and buffer manipulation.
 158         RUNTIME, io, unicode/utf8, unicode/utf16, unicode
 159         < bytes, strings
 160         < bufio;
 161
 162         bufio, path, strconv
 163         < STR;
 164
 165         # OS is basic OS access, including helpers (path/filepath, os/exec, etc).
 166         # OS includes string routines, but those must be layered above package os.
 167         # OS does not include reflection.
 168         io/fs
 169         < internal/testlog
 170         < internal/poll
 171         < os
 172         < os/signal;
 173
 174         io/fs
 175         < embed;
 176
 177         unicode, fmt !< net, os, os/signal;
 178
 179         os/signal, STR
 180         < path/filepath
 181         < io/ioutil, os/exec;
 182
 183         io/ioutil, os/exec, os/signal
 184         < OS;
 185
 186         reflect !< OS;
 187
 188         OS
 189         < golang.org/x/sys/cpu;
 190
 191         os < internal/godebug;
 192
 193         # FMT is OS (which includes string routines) plus reflect and fmt.
 194         # It does not include package log, which should be avoided in core packages.
 195         strconv, unicode
 196         < reflect;
 197
 198         os, reflect
 199         < internal/fmtsort
 200         < fmt;
 201
 202         OS, fmt
 203         < FMT;
 204
 205         log !< FMT;
 206
 207         OS, FMT
 208         < internal/execabs;
 209
 210         OS, internal/execabs
 211         < internal/goroot;
 212
 213         # Misc packages needing only FMT.
 214         FMT
 215         < html,
 216           mime/quotedprintable,
 217           net/internal/socktest,
 218           net/url,
 219           runtime/trace,
 220           text/scanner,
 221           text/tabwriter;
 222
 223         # encodings
 224         # core ones do not use fmt.
 225         io, strconv
 226         < encoding;
 227
 228         encoding, reflect
 229         < encoding/binary
 230         < encoding/base32, encoding/base64;
 231
 232         FMT, encoding < flag;
 233
 234         fmt !< encoding/base32, encoding/base64;
 235
 236         FMT, encoding/base32, encoding/base64
 237         < encoding/ascii85, encoding/csv, encoding/gob, encoding/hex,
 238           encoding/json, encoding/pem, encoding/xml, mime;
 239
 240         # hashes
 241         io
 242         < hash
 243         < hash/adler32, hash/crc32, hash/crc64, hash/fnv, hash/maphash;
 244
 245         # math/big
 246         FMT, encoding/binary, math/rand
 247         < math/big;
 248
 249         # compression
 250         FMT, encoding/binary, hash/adler32, hash/crc32
 251         < compress/bzip2, compress/flate, compress/lzw
 252         < archive/zip, compress/gzip, compress/zlib;
 253
 254         # templates
 255         FMT
 256         < text/template/parse;
 257
 258         net/url, text/template/parse
 259         < text/template
 260         < internal/lazytemplate;
 261
 262         encoding/json, html, text/template
 263         < html/template;
 264
 265         # regexp
 266         FMT
 267         < regexp/syntax
 268         < regexp
 269         < internal/lazyregexp;
 270
 271         # suffix array
 272         encoding/binary, regexp
 273         < index/suffixarray;
 274
 275         # executable parsing
 276         FMT, encoding/binary, compress/zlib
 277         < runtime/debug
 278         < debug/dwarf
 279         < debug/elf, debug/gosym, debug/macho, debug/pe, debug/plan9obj, internal/xcoff
 280         < debug/buildinfo
 281         < DEBUG;
 282
 283         # go parser and friends.
 284         FMT
 285         < go/token
 286         < go/scanner
 287         < go/ast
 288         < go/internal/typeparams
 289         < go/parser;
 290
 291         FMT
 292         < go/build/constraint;
 293
 294         go/build/constraint, go/parser, text/tabwriter
 295         < go/printer
 296         < go/format;
 297
 298         go/parser, internal/lazyregexp, text/template
 299         < go/doc;
 300
 301         math/big, go/token
 302         < go/constant;
 303
 304         container/heap, go/constant, go/parser, regexp
 305         < go/types;
 306
 307         FMT, internal/goexperiment
 308         < internal/buildcfg;
 309
 310         go/build/constraint, go/doc, go/parser, internal/buildcfg, internal/goroot, internal/goversion
 311         < go/build;
 312
 313         DEBUG, go/build, go/types, text/scanner
 314   < internal/pkgbits
 315         < go/internal/gcimporter, go/internal/gccgoimporter, go/internal/srcimporter
 316         < go/importer;
 317
 318         # databases
 319         FMT
 320         < database/sql/internal
 321         < database/sql/driver
 322         < database/sql;
 323
 324         # images
 325         FMT, compress/lzw, compress/zlib
 326         < image/color
 327         < image, image/color/palette
 328         < image/internal/imageutil
 329         < image/draw
 330         < image/gif, image/jpeg, image/png;
 331
 332         # cgo, delayed as long as possible.
 333         # If you add a dependency on CGO, you must add the package
 334         # to cgoPackages in cmd/dist/test.go as well.
 335         RUNTIME
 336         < C
 337         < runtime/cgo
 338         < CGO
 339         < runtime/race, runtime/msan, runtime/asan;
 340
 341         # Bulk of the standard library must not use cgo.
 342         # The prohibition stops at net and os/user.
 343         C !< fmt, go/types, CRYPTO-MATH;
 344
 345         CGO, OS
 346         < plugin;
 347
 348         CGO, FMT
 349         < os/user
 350         < archive/tar;
 351
 352         sync
 353         < internal/singleflight;
 354
 355         os
 356         < golang.org/x/net/dns/dnsmessage,
 357           golang.org/x/net/lif,
 358           golang.org/x/net/route;
 359
 360         os, runtime, strconv, sync, unsafe,
 361         internal/godebug
 362         < internal/intern;
 363
 364         internal/bytealg, internal/intern, internal/itoa, math/bits, sort, strconv
 365         < net/netip;
 366
 367         # net is unavoidable when doing any networking,
 368         # so large dependencies must be kept out.
 369         # This is a long-looking list but most of these
 370         # are small with few dependencies.
 371         CGO,
 372         golang.org/x/net/dns/dnsmessage,
 373         golang.org/x/net/lif,
 374         golang.org/x/net/route,
 375         internal/godebug,
 376         internal/nettrace,
 377         internal/poll,
 378         internal/singleflight,
 379         internal/race,
 380         net/netip,
 381         os
 382         < net;
 383
 384         fmt, unicode !< net;
 385         math/rand !< net; # net uses runtime instead
 386
 387         # NET is net plus net-helper packages.
 388         FMT, net
 389         < net/textproto;
 390
 391         mime, net/textproto, net/url
 392         < NET;
 393
 394         # logging - most packages should not import; http and up is allowed
 395         FMT
 396         < log;
 397
 398         log !< crypto/tls, database/sql, go/importer, testing;
 399
 400         FMT, log, net
 401         < log/syslog;
 402
 403         NET, log
 404         < net/mail;
 405
 406         # CRYPTO is core crypto algorithms - no cgo, fmt, net.
 407         # Unfortunately, stuck with reflect via encoding/binary.
 408         encoding/binary, golang.org/x/sys/cpu, hash
 409         < crypto
 410         < crypto/subtle
 411         < crypto/internal/subtle
 412         < crypto/elliptic/internal/fiat
 413         < crypto/elliptic/internal/nistec
 414         < crypto/ed25519/internal/edwards25519/field, golang.org/x/crypto/curve25519/internal/field
 415         < crypto/ed25519/internal/edwards25519
 416         < crypto/cipher
 417         < crypto/aes, crypto/des, crypto/hmac, crypto/md5, crypto/rc4,
 418           crypto/sha1, crypto/sha256, crypto/sha512
 419         < CRYPTO;
 420
 421         CGO, fmt, net !< CRYPTO;
 422
 423         # CRYPTO-MATH is core bignum-based crypto - no cgo, net; fmt now ok.
 424         CRYPTO, FMT, math/big, embed
 425         < crypto/rand
 426         < crypto/internal/randutil
 427         < crypto/ed25519
 428         < encoding/asn1
 429         < golang.org/x/crypto/cryptobyte/asn1
 430         < golang.org/x/crypto/cryptobyte
 431         < golang.org/x/crypto/curve25519
 432         < crypto/dsa, crypto/elliptic, crypto/rsa
 433         < crypto/ecdsa
 434         < CRYPTO-MATH;
 435
 436         CGO, net !< CRYPTO-MATH;
 437
 438         # TLS, Prince of Dependencies.
 439         CRYPTO-MATH, NET, container/list, encoding/hex, encoding/pem
 440         < golang.org/x/crypto/internal/subtle
 441         < golang.org/x/crypto/chacha20
 442         < golang.org/x/crypto/internal/poly1305
 443         < golang.org/x/crypto/chacha20poly1305
 444         < golang.org/x/crypto/hkdf
 445         < crypto/x509/internal/macos
 446         < crypto/x509/pkix
 447         < crypto/x509
 448         < crypto/tls;
 449
 450         # crypto-aware packages
 451
 452         NET, crypto/rand, mime/quotedprintable
 453         < mime/multipart;
 454
 455         crypto/tls
 456         < net/smtp;
 457
 458         # HTTP, King of Dependencies.
 459
 460         FMT
 461         < golang.org/x/net/http2/hpack
 462         < net/http/internal, net/http/internal/ascii, net/http/internal/testcert;
 463
 464         FMT, NET, container/list, encoding/binary, log
 465         < golang.org/x/text/transform
 466         < golang.org/x/text/unicode/norm
 467         < golang.org/x/text/unicode/bidi
 468         < golang.org/x/text/secure/bidirule
 469         < golang.org/x/net/idna
 470         < golang.org/x/net/http/httpguts, golang.org/x/net/http/httpproxy;
 471
 472         NET, crypto/tls
 473         < net/http/httptrace;
 474
 475         compress/gzip,
 476         golang.org/x/net/http/httpguts,
 477         golang.org/x/net/http/httpproxy,
 478         golang.org/x/net/http2/hpack,
 479         net/http/internal,
 480         net/http/internal/ascii,
 481         net/http/internal/testcert,
 482         net/http/httptrace,
 483         mime/multipart,
 484         log
 485         < net/http;
 486
 487         # HTTP-aware packages
 488
 489         encoding/json, net/http
 490         < expvar;
 491
 492         net/http, net/http/internal/ascii
 493         < net/http/cookiejar, net/http/httputil;
 494
 495         net/http, flag
 496         < net/http/httptest;
 497
 498         net/http, regexp
 499         < net/http/cgi
 500         < net/http/fcgi;
 501
 502         # Profiling
 503         FMT, compress/gzip, encoding/binary, text/tabwriter
 504         < runtime/pprof;
 505
 506         OS, compress/gzip, regexp
 507         < internal/profile;
 508
 509         html, internal/profile, net/http, runtime/pprof, runtime/trace
 510         < net/http/pprof;
 511
 512         # RPC
 513         encoding/gob, encoding/json, go/token, html/template, net/http
 514         < net/rpc
 515         < net/rpc/jsonrpc;
 516
 517         # System Information
 518         internal/cpu, sync
 519         < internal/sysinfo;
 520
 521         # Test-only
 522         log
 523         < testing/iotest
 524         < testing/fstest;
 525
 526         FMT, flag, math/rand
 527         < testing/quick;
 528
 529         FMT, DEBUG, flag, runtime/trace, internal/sysinfo, math/rand
 530         < testing;
 531
 532         FMT, crypto/sha256, encoding/json, go/ast, go/parser, go/token,
 533         internal/godebug, math/rand, encoding/hex, crypto/sha256
 534         < internal/fuzz;
 535
 536         internal/fuzz, internal/testlog, runtime/pprof, regexp
 537         < testing/internal/testdeps;
 538
 539         OS, flag, testing, internal/cfg
 540         < internal/testenv;
 541
 542         OS, encoding/base64
 543         < internal/obscuretestdata;
 544
 545         CGO, OS, fmt
 546         < os/signal/internal/pty;
 547
 548         NET, testing, math/rand
 549         < golang.org/x/net/nettest;
 550
 551         syscall
 552         < os/exec/internal/fdtest;
 553
 554         FMT, container/heap, math/rand
 555         < internal/trace;
 556
 557         FMT
 558         < internal/diff, internal/txtar;
 559 `
 560
 561 // listStdPkgs returns the same list of packages as "go list std".
 562 func listStdPkgs(goroot string) ([]string, error) {
 563         // Based on cmd/go's matchPackages function.
 564         var pkgs []string
 565
 566         src := filepath.Join(goroot, "src") + string(filepath.Separator)
 567         walkFn := func(path string, d fs.DirEntry, err error) error {
 568                 if err != nil || !d.IsDir() || path == src {
 569                         return nil
 570                 }
 571
 572                 base := filepath.Base(path)
 573                 if strings.HasPrefix(base, ".") || strings.HasPrefix(base, "_") || base == "testdata" {
 574                         return filepath.SkipDir
 575                 }
 576
 577                 name := filepath.ToSlash(path[len(src):])
 578                 if name == "builtin" || name == "cmd" {
 579                         return filepath.SkipDir
 580                 }
 581
 582                 pkgs = append(pkgs, strings.TrimPrefix(name, "vendor/"))
 583                 return nil
 584         }
 585         if err := filepath.WalkDir(src, walkFn); err != nil {
 586                 return nil, err
 587         }
 588         return pkgs, nil
 589 }
 590
 591 func TestDependencies(t *testing.T) {
 592         if !testenv.HasSrc() {
 593                 // Tests run in a limited file system and we do not
 594                 // provide access to every source file.
 595                 t.Skipf("skipping on %s/%s, missing full GOROOT", runtime.GOOS, runtime.GOARCH)
 596         }
 597
 598         ctxt := Default
 599         all, err := listStdPkgs(ctxt.GOROOT)
 600         if err != nil {
 601                 t.Fatal(err)
 602         }
 603         sort.Strings(all)
 604
 605         sawImport := map[string]map[string]bool{} // from package => to package => true
 606         policy := depsPolicy(t)
 607
 608         for _, pkg := range all {
 609                 imports, err := findImports(pkg)
 610                 if err != nil {
 611                         t.Error(err)
 612                         continue
 613                 }
 614                 if sawImport[pkg] == nil {
 615                         sawImport[pkg] = map[string]bool{}
 616                 }
 617                 ok := policy[pkg]
 618                 var bad []string
 619                 for _, imp := range imports {
 620                         sawImport[pkg][imp] = true
 621                         if !ok[imp] {
 622                                 bad = append(bad, imp)
 623                         }
 624                 }
 625                 if bad != nil {
 626                         t.Errorf("unexpected dependency: %s imports %v", pkg, bad)
 627                 }
 628         }
 629
 630         // depPath returns the path between the given from and to packages.
 631         // It returns the empty string if there's no dependency path.
 632         var depPath func(string, string) string
 633         depPath = func(from, to string) string {
 634                 if sawImport[from][to] {
 635                         return from + " => " + to
 636                 }
 637                 for pkg := range sawImport[from] {
 638                         if p := depPath(pkg, to); p != "" {
 639                                 return from + " => " + p
 640                         }
 641                 }
 642                 return ""
 643         }
 644 }
 645
 646 var buildIgnore = []byte("\n//go:build ignore")
 647
 648 func findImports(pkg string) ([]string, error) {
 649         vpkg := pkg
 650         if strings.HasPrefix(pkg, "golang.org") {
 651                 vpkg = "vendor/" + pkg
 652         }
 653         dir := filepath.Join(Default.GOROOT, "src", vpkg)
 654         files, err := os.ReadDir(dir)
 655         if err != nil {
 656                 return nil, err
 657         }
 658         var imports []string
 659         var haveImport = map[string]bool{}
 660         fset := token.NewFileSet()
 661         for _, file := range files {
 662                 name := file.Name()
 663                 if name == "slice_go14.go" || name == "slice_go18.go" {
 664                         // These files are for compiler bootstrap with older versions of Go and not built in the standard build.
 665                         continue
 666                 }
 667                 if !strings.HasSuffix(name, ".go") || strings.HasSuffix(name, "_test.go") {
 668                         continue
 669                 }
 670                 info := fileInfo{
 671                         name: filepath.Join(dir, name),
 672                         fset: fset,
 673                 }
 674                 f, err := os.Open(info.name)
 675                 if err != nil {
 676                         return nil, err
 677                 }
 678                 err = readGoInfo(f, &info)
 679                 f.Close()
 680                 if err != nil {
 681                         return nil, fmt.Errorf("reading %v: %v", name, err)
 682                 }
 683                 if info.parsed.Name.Name == "main" {
 684                         continue
 685                 }
 686                 if bytes.Contains(info.header, buildIgnore) {
 687                         continue
 688                 }
 689                 for _, imp := range info.imports {
 690                         path := imp.path
 691                         if !haveImport[path] {
 692                                 haveImport[path] = true
 693                                 imports = append(imports, path)
 694                         }
 695                 }
 696         }
 697         sort.Strings(imports)
 698         return imports, nil
 699 }
 700
 701 // depsPolicy returns a map m such that m[p][d] == true when p can import d.
 702 func depsPolicy(t *testing.T) map[string]map[string]bool {
 703         allowed := map[string]map[string]bool{"NONE": {}}
 704         disallowed := [][2][]string{}
 705
 706         parseDepsRules(t, func(deps []string, op string, users []string) {
 707                 if op == "!<" {
 708                         disallowed = append(disallowed, [2][]string{deps, users})
 709                         return
 710                 }
 711                 for _, u := range users {
 712                         if allowed[u] != nil {
 713                                 t.Errorf("multiple deps lists for %s", u)
 714                         }
 715                         allowed[u] = make(map[string]bool)
 716                         for _, d := range deps {
 717                                 if allowed[d] == nil {
 718                                         t.Errorf("use of %s before its deps list", d)
 719                                 }
 720                                 allowed[u][d] = true
 721                         }
 722                 }
 723         })
 724
 725         // Check for missing deps info.
 726         for _, deps := range allowed {
 727                 for d := range deps {
 728                         if allowed[d] == nil {
 729                                 t.Errorf("missing deps list for %s", d)
 730                         }
 731                 }
 732         }
 733
 734         // Complete transitive allowed deps.
 735         for k := range allowed {
 736                 for i := range allowed {
 737                         for j := range allowed {
 738                                 if i != k && k != j && allowed[i][k] && allowed[k][j] {
 739                                         if i == j {
 740                                                 // Can only happen along with a "use of X before deps" error above,
 741                                                 // but this error is more specific - it makes clear that reordering the
 742                                                 // rules will not be enough to fix the problem.
 743                                                 t.Errorf("deps policy cycle: %s < %s < %s", j, k, i)
 744                                         }
 745                                         allowed[i][j] = true
 746                                 }
 747                         }
 748                 }
 749         }
 750
 751         // Check negative assertions against completed allowed deps.
 752         for _, bad := range disallowed {
 753                 deps, users := bad[0], bad[1]
 754                 for _, d := range deps {
 755                         for _, u := range users {
 756                                 if allowed[u][d] {
 757                                         t.Errorf("deps policy incorrect: assertion failed: %s !< %s", d, u)
 758                                 }
 759                         }
 760                 }
 761         }
 762
 763         if t.Failed() {
 764                 t.FailNow()
 765         }
 766
 767         return allowed
 768 }
 769
 770 // parseDepsRules parses depsRules, calling save(deps, op, users)
 771 // for each deps < users or deps !< users rule
 772 // (op is "<" or "!<").
 773 func parseDepsRules(t *testing.T, save func(deps []string, op string, users []string)) {
 774         p := &depsParser{t: t, lineno: 1, text: depsRules}
 775
 776         var prev []string
 777         var op string
 778         for {
 779                 list, tok := p.nextList()
 780                 if tok == "" {
 781                         if prev == nil {
 782                                 break
 783                         }
 784                         p.syntaxError("unexpected EOF")
 785                 }
 786                 if prev != nil {
 787                         save(prev, op, list)
 788                 }
 789                 prev = list
 790                 if tok == ";" {
 791                         prev = nil
 792                         op = ""
 793                         continue
 794                 }
 795                 if tok != "<" && tok != "!<" {
 796                         p.syntaxError("missing <")
 797                 }
 798                 op = tok
 799         }
 800 }
 801
 802 // A depsParser parses the depsRules syntax described above.
 803 type depsParser struct {
 804         t        *testing.T
 805         lineno   int
 806         lastWord string
 807         text     string
 808 }
 809
 810 // syntaxError reports a parsing error.
 811 func (p *depsParser) syntaxError(msg string) {
 812         p.t.Fatalf("deps:%d: syntax error: %s near %s", p.lineno, msg, p.lastWord)
 813 }
 814
 815 // nextList parses and returns a comma-separated list of names.
 816 func (p *depsParser) nextList() (list []string, token string) {
 817         for {
 818                 tok := p.nextToken()
 819                 switch tok {
 820                 case "":
 821                         if len(list) == 0 {
 822                                 return nil, ""
 823                         }
 824                         fallthrough
 825                 case ",", "<", "!<", ";":
 826                         p.syntaxError("bad list syntax")
 827                 }
 828                 list = append(list, tok)
 829
 830                 tok = p.nextToken()
 831                 if tok != "," {
 832                         return list, tok
 833                 }
 834         }
 835 }
 836
 837 // nextToken returns the next token in the deps rules,
 838 // one of ";" "," "<" "!<" or a name.
 839 func (p *depsParser) nextToken() string {
 840         for {
 841                 if p.text == "" {
 842                         return ""
 843                 }
 844                 switch p.text[0] {
 845                 case ';', ',', '<':
 846                         t := p.text[:1]
 847                         p.text = p.text[1:]
 848                         return t
 849
 850                 case '!':
 851                         if len(p.text) < 2 || p.text[1] != '<' {
 852                                 p.syntaxError("unexpected token !")
 853                         }
 854                         p.text = p.text[2:]
 855                         return "!<"
 856
 857                 case '#':
 858                         i := strings.Index(p.text, "\n")
 859                         if i < 0 {
 860                                 i = len(p.text)
 861                         }
 862                         p.text = p.text[i:]
 863                         continue
 864
 865                 case '\n':
 866                         p.lineno++
 867                         fallthrough
 868                 case ' ', '\t':
 869                         p.text = p.text[1:]
 870                         continue
 871
 872                 default:
 873                         i := strings.IndexAny(p.text, "!;,<#\n \t")
 874                         if i < 0 {
 875                                 i = len(p.text)
 876                         }
 877                         t := p.text[:i]
 878                         p.text = p.text[i:]
 879                         p.lastWord = t
 880                         return t
 881                 }
 882         }
 883 }
 884
 885 // TestStdlibLowercase tests that all standard library package names are
 886 // lowercase. See Issue 40065.
 887 func TestStdlibLowercase(t *testing.T) {
 888         if !testenv.HasSrc() {
 889                 t.Skipf("skipping on %s/%s, missing full GOROOT", runtime.GOOS, runtime.GOARCH)
 890         }
 891
 892         ctxt := Default
 893         all, err := listStdPkgs(ctxt.GOROOT)
 894         if err != nil {
 895                 t.Fatal(err)
 896         }
 897
 898         for _, pkgname := range all {
 899                 if strings.ToLower(pkgname) != pkgname {
 900                         t.Errorf("package %q should not use upper-case path", pkgname)
 901                 }
 902         }
 903 }
 904
 905 // TestFindImports tests that findImports works.  See #43249.
 906 func TestFindImports(t *testing.T) {
 907         imports, err := findImports("go/build")
 908         if err != nil {
 909                 t.Fatal(err)
 910         }
 911         t.Logf("go/build imports %q", imports)
 912         want := []string{"bytes", "os", "path/filepath", "strings"}
 913 wantLoop:
 914         for _, w := range want {
 915                 for _, imp := range imports {
 916                         if imp == w {
 917                                 continue wantLoop
 918                         }
 919                 }
 920                 t.Errorf("expected to find %q in import list", w)
 921         }
 922 }