Source file src/go/build/deps_test.go

     1  // Copyright 2022 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/dag"
    15  	"internal/testenv"
    16  	"io/fs"
    17  	"os"
    18  	"path/filepath"
    19  	"slices"
    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  // "a < b" means package b can import package a.
    33  //
    34  // See `go doc internal/dag` for the full syntax.
    35  //
    36  // All-caps names are pseudo-names for specific points
    37  // in the dependency lattice.
    38  var depsRules = `
    39  	# No dependencies allowed for any of these packages.
    40  	NONE
    41  	< unsafe
    42  	< cmp,
    43  	  container/list,
    44  	  container/ring,
    45  	  internal/byteorder,
    46  	  internal/cfg,
    47  	  internal/coverage,
    48  	  internal/coverage/rtcov,
    49  	  internal/coverage/uleb128,
    50  	  internal/coverage/calloc,
    51  	  internal/cpu,
    52  	  internal/goarch,
    53  	  internal/godebugs,
    54  	  internal/goexperiment,
    55  	  internal/goos,
    56  	  internal/goversion,
    57  	  internal/nettrace,
    58  	  internal/platform,
    59  	  internal/profilerecord,
    60  	  internal/runtime/pprof/label,
    61  	  internal/simd/variants,
    62  	  internal/syslist,
    63  	  internal/trace/tracev2,
    64  	  internal/trace/traceviewer/format,
    65  	  log/internal,
    66  	  math/bits,
    67  	  structs,
    68  	  unicode,
    69  	  unicode/utf8,
    70  	  unicode/utf16;
    71  
    72  	internal/goarch < internal/abi;
    73  	internal/byteorder, internal/cpu, internal/goarch < internal/chacha8rand;
    74  	internal/goarch, math/bits < internal/strconv;
    75  
    76  	internal/cpu, internal/strconv < simd/archsimd;
    77  
    78  	# RUNTIME is the core runtime group of packages, all of them very light-weight.
    79  	internal/abi,
    80  	internal/chacha8rand,
    81  	internal/coverage/rtcov,
    82  	internal/cpu,
    83  	internal/goarch,
    84  	internal/godebugs,
    85  	internal/goexperiment,
    86  	internal/goos,
    87  	internal/profilerecord,
    88  	internal/runtime/pprof/label,
    89  	internal/strconv,
    90  	internal/trace/tracev2,
    91  	math/bits,
    92  	structs,
    93  	simd/archsimd
    94  	< internal/bytealg
    95  	< internal/stringslite
    96  	< internal/unsafeheader
    97  	< internal/race
    98  	< internal/msan
    99  	< internal/asan
   100  	< internal/runtime/sys
   101  	< internal/runtime/syscall/linux
   102  	< internal/runtime/syscall/windows
   103  	< internal/runtime/atomic
   104  	< internal/runtime/exithook
   105  	< internal/runtime/gc
   106  	< internal/runtime/math
   107  	< internal/runtime/maps
   108  	< internal/runtime/cgroup
   109  	< internal/runtime/gc/scan
   110  	< runtime
   111  	< runtime/secret
   112  	< sync/atomic
   113  	< internal/sync
   114  	< weak
   115  	< internal/synctest
   116  	< sync
   117  	< internal/bisect
   118  	< internal/godebug
   119  	< internal/reflectlite
   120  	< errors
   121  	< internal/oserror;
   122  
   123  	cmp, runtime, math/bits
   124  	< iter
   125  	< maps, slices;
   126  
   127  	internal/oserror, maps, slices
   128  	< RUNTIME;
   129  
   130  	RUNTIME
   131  	< sort
   132  	< container/heap
   133  	< unique;
   134  
   135  	RUNTIME
   136  	< io;
   137  
   138  	RUNTIME
   139  	< arena;
   140  
   141  	syscall !< io;
   142  	reflect !< sort;
   143  
   144  	RUNTIME, unicode/utf8
   145  	< path;
   146  
   147  	unicode !< path;
   148  
   149  	# SYSCALL is RUNTIME plus the packages necessary for basic system calls.
   150  	RUNTIME, unicode/utf8, unicode/utf16, internal/synctest
   151  	< internal/syscall/windows/sysdll, syscall/js
   152  	< syscall
   153  	< internal/syscall/unix, internal/syscall/windows, internal/syscall/windows/registry
   154  	< internal/syscall/execenv
   155  	< SYSCALL;
   156  
   157  	# TIME is SYSCALL plus the core packages about time, including context.
   158  	SYSCALL
   159  	< time/tzdata
   160  	< time
   161  	< context
   162  	< TIME;
   163  
   164  	TIME, io, path, slices
   165  	< io/fs;
   166  
   167  	# MATH is RUNTIME plus the basic math packages.
   168  	RUNTIME
   169  	< math
   170  	< MATH;
   171  
   172  	unicode !< math;
   173  
   174  	MATH
   175  	< math/cmplx;
   176  
   177  	MATH
   178  	< math/rand, math/rand/v2;
   179  
   180  	MATH
   181  	< runtime/metrics;
   182  
   183  	MATH
   184  	< simd/internal/spec
   185  	< simd/internal/simdref;
   186  
   187  	MATH, unicode/utf8
   188  	< strconv;
   189  
   190  	unicode !< strconv;
   191  
   192  	# STR is basic string and buffer manipulation.
   193  	RUNTIME, io, unicode/utf8, unicode/utf16, unicode
   194  	< bytes, strings
   195  	< bufio;
   196  
   197  	bufio, path, strconv
   198  	< STR;
   199  
   200  	# OS is basic OS access, including helpers (path/filepath, os/exec, etc).
   201  	# OS includes string routines, but those must be layered above package os.
   202  	# OS does not include reflection.
   203  	io/fs
   204  	< internal/testlog
   205  	< internal/poll
   206  	< internal/filepathlite
   207  	< os
   208  	< os/signal;
   209  
   210  	io/fs
   211  	< embed;
   212  
   213  	unicode, fmt !< net, os, os/signal;
   214  
   215  	os/signal, internal/filepathlite, STR
   216  	< path/filepath
   217  	< io/ioutil;
   218  
   219  	path/filepath, internal/godebug < os/exec;
   220  
   221  	io/ioutil, os/exec, os/signal
   222  	< OS;
   223  
   224  	reflect !< OS;
   225  
   226  	OS
   227  	< golang.org/x/sys/cpu;
   228  
   229  	# FMT is OS (which includes string routines) plus reflect and fmt.
   230  	# It does not include package log, which should be avoided in core packages.
   231  	arena, strconv, unicode
   232  	< reflect;
   233  
   234  	os, reflect
   235  	< internal/fmtsort
   236  	< fmt;
   237  
   238  	OS, fmt
   239  	< FMT;
   240  
   241  	log !< FMT;
   242  
   243  	# Misc packages needing only FMT.
   244  	FMT
   245  	< html,
   246  	  internal/dag,
   247  	  internal/goroot,
   248  	  internal/types/errors,
   249  	  mime/quotedprintable,
   250  	  net/internal/socktest,
   251  	  runtime/trace,
   252  	  text/scanner,
   253  	  text/tabwriter;
   254  
   255  	io, reflect
   256  	< internal/saferio;
   257  
   258  	# encodings
   259  	# core ones do not use fmt.
   260  	io, strconv, slices
   261  	< encoding, encoding/base32, encoding/base64;
   262  
   263  	encoding, reflect
   264  	< encoding/binary;
   265  
   266  	FMT, encoding < flag;
   267  
   268  	FMT, simd/archsimd < simd/internal/bridge;
   269  
   270  	simd/internal/bridge, internal/simd/variants < simd;
   271  
   272  	fmt !< encoding/base32, encoding/base64;
   273  
   274  	FMT, encoding, encoding/base32, encoding/base64, encoding/binary,
   275  	internal/saferio
   276  	< encoding/ascii85, encoding/csv, encoding/gob, encoding/hex,
   277  	  encoding/pem, encoding/xml, mime;
   278  
   279  	STR, errors
   280  	< encoding/json/internal
   281  	< encoding/json/internal/jsonflags
   282  	< encoding/json/internal/jsonopts
   283  	< encoding/json/internal/jsonwire
   284  	< encoding/json/jsontext;
   285  
   286  	FMT,
   287  	encoding/hex,
   288  	encoding/base32,
   289  	encoding/base64,
   290  	encoding/binary,
   291  	encoding/json/jsontext,
   292  	encoding/json/internal,
   293  	encoding/json/internal/jsonflags,
   294  	encoding/json/internal/jsonopts,
   295  	encoding/json/internal/jsonwire
   296  	< encoding/json/v2
   297  	< encoding/json;
   298  
   299  	# hashes
   300  	io
   301  	< hash
   302  	< hash/adler32, hash/crc32, hash/crc64, hash/fnv, hash/maphash;
   303  
   304  	# math/big
   305  	FMT, math/rand
   306  	< math/big;
   307  
   308  	# compression
   309  	FMT, encoding/binary, hash/adler32, hash/crc32, sort
   310  	< compress/bzip2, compress/flate, compress/lzw, internal/zstd
   311  	< archive/zip, compress/gzip, compress/zlib;
   312  
   313  	# templates
   314  	FMT
   315  	< text/template/parse;
   316  
   317  	internal/bytealg, math/bits, slices, strconv, unique
   318  	< net/netip;
   319  
   320  	FMT, net/netip
   321  	< net/url;
   322  
   323  	net/url, text/template/parse
   324  	< text/template
   325  	< internal/lazytemplate;
   326  
   327  	# regexp
   328  	FMT, sort
   329  	< regexp/syntax
   330  	< regexp
   331  	< internal/lazyregexp;
   332  
   333  	encoding/json, html, text/template, regexp
   334  	< html/template;
   335  
   336  	# suffix array
   337  	encoding/binary, regexp
   338  	< index/suffixarray;
   339  
   340  	# executable parsing
   341  	FMT, encoding/binary, compress/zlib, internal/saferio, internal/zstd, sort
   342  	< runtime/debug
   343  	< debug/dwarf
   344  	< debug/elf, debug/gosym, debug/macho, debug/pe, debug/plan9obj, internal/xcoff
   345  	< debug/buildinfo
   346  	< DEBUG;
   347  
   348  	# go parser and friends.
   349  	FMT, sort
   350  	< internal/gover
   351  	< go/version
   352  	< go/token
   353  	< go/scanner
   354  	< go/ast
   355  	< go/internal/typeparams;
   356  
   357  	FMT
   358  	< go/build/constraint;
   359  
   360  	FMT, sort
   361  	< go/doc/comment;
   362  
   363  	go/internal/typeparams, go/build/constraint
   364  	< go/parser;
   365  
   366  	go/doc/comment, go/parser, text/tabwriter
   367  	< go/printer
   368  	< go/format;
   369  
   370  	math/big, go/token
   371  	< go/constant;
   372  
   373  	FMT, internal/goexperiment
   374  	< internal/buildcfg;
   375  
   376  	# The vast majority of standard library packages should not be resorting to regexp.
   377  	# go/types is a good chokepoint. It shouldn't use regexp, nor should anything
   378  	# that is low-enough level to be used by go/types.
   379  	regexp !< go/types;
   380  
   381  	go/doc/comment, go/parser, internal/lazyregexp, text/template
   382  	< go/doc;
   383  
   384  	go/build/constraint, go/doc, go/parser, internal/buildcfg, internal/goroot, internal/goversion, internal/platform, internal/syslist
   385  	< go/build;
   386  
   387  	# images
   388  	FMT, compress/lzw, compress/zlib
   389  	< image/color
   390  	< image, image/color/palette
   391  	< image/internal/imageutil
   392  	< image/draw
   393  	< image/gif, image/jpeg, image/png;
   394  
   395  	# cgo, delayed as long as possible.
   396  	# If you add a dependency on CGO, you must add the package
   397  	# to cgoPackages in cmd/dist/test.go as well.
   398  	RUNTIME
   399  	< C
   400  	< runtime/cgo
   401  	< CGO
   402  	< runtime/msan, runtime/asan;
   403  
   404  	# runtime/race
   405  	NONE < runtime/race/internal/amd64v1;
   406  	NONE < runtime/race/internal/amd64v3;
   407  	CGO, runtime/race/internal/amd64v1, runtime/race/internal/amd64v3 < runtime/race;
   408  
   409  	# Bulk of the standard library must not use cgo.
   410  	# The prohibition stops at net and os/user.
   411  	C !< fmt, go/types, CRYPTO-MATH, log/slog;
   412  
   413  	CGO, OS
   414  	< plugin;
   415  
   416  	CGO, FMT
   417  	< os/user
   418  	< archive/tar;
   419  
   420  	sync
   421  	< internal/singleflight;
   422  
   423  	os
   424  	< golang.org/x/net/dns/dnsmessage,
   425  	  golang.org/x/net/lif;
   426  
   427  	os, net/netip
   428  	< internal/routebsd;
   429  
   430  	# net is unavoidable when doing any networking,
   431  	# so large dependencies must be kept out.
   432  	# This is a long-looking list but most of these
   433  	# are small with few dependencies.
   434  	CGO,
   435  	golang.org/x/net/dns/dnsmessage,
   436  	golang.org/x/net/lif,
   437  	internal/godebug,
   438  	internal/goversion,
   439  	internal/nettrace,
   440  	internal/poll,
   441  	internal/routebsd,
   442  	internal/singleflight,
   443  	net/netip,
   444  	os,
   445  	sort
   446  	< net;
   447  
   448  	fmt, unicode !< net;
   449  	math/rand !< net; # net uses runtime instead
   450  
   451  	# NET is net plus net-helper packages.
   452  	FMT, net
   453  	< net/textproto;
   454  
   455  	mime, net/textproto, net/url
   456  	< NET;
   457  
   458  	# logging - most packages should not import; http and up is allowed
   459  	FMT, log/internal
   460  	< log;
   461  
   462  	log, log/slog !< crypto/tls, database/sql, go/importer, testing;
   463  
   464  	FMT, log, net
   465  	< log/syslog;
   466  
   467  	RUNTIME
   468  	< log/slog/internal, log/slog/internal/buffer;
   469  
   470  	FMT,
   471  	encoding, encoding/json,
   472  	log, log/internal,
   473  	log/slog/internal, log/slog/internal/buffer,
   474  	slices
   475  	< log/slog
   476  	< log/slog/internal/slogtest, log/slog/internal/benchmarks;
   477  
   478  	NET, log
   479  	< net/mail;
   480  
   481  	# FIPS is the FIPS 140 module.
   482  	# It must not depend on external crypto packages.
   483  	# Package hash is ok as it's only the interface.
   484  	# See also fips140deps.AllowedInternalPackages.
   485  
   486  	io, math/rand/v2 < crypto/internal/randutil;
   487  
   488  	NONE < crypto/internal/constanttime;
   489  
   490  	STR < crypto/internal/impl;
   491  
   492  	OS < crypto/internal/sysrand
   493  	< crypto/internal/entropy;
   494  
   495  	internal/byteorder < crypto/internal/fips140deps/byteorder;
   496  	internal/cpu, internal/goarch < crypto/internal/fips140deps/cpu;
   497  	internal/godebug < crypto/internal/fips140deps/godebug;
   498  	time, internal/syscall/windows < crypto/internal/fips140deps/time;
   499  
   500  	crypto/internal/fips140deps/time, errors, math/bits, sync/atomic, unsafe
   501  	< crypto/internal/entropy/v1.0.0;
   502  
   503  	STR, hash,
   504  	crypto/internal/impl,
   505  	crypto/internal/entropy,
   506  	crypto/internal/randutil,
   507  	crypto/internal/constanttime,
   508  	crypto/internal/entropy/v1.0.0,
   509  	crypto/internal/fips140deps/byteorder,
   510  	crypto/internal/fips140deps/cpu,
   511  	crypto/internal/fips140deps/godebug
   512  	< crypto/internal/fips140
   513  	< crypto/internal/fips140/alias
   514  	< crypto/internal/fips140/subtle
   515  	< crypto/internal/fips140/sha256
   516  	< crypto/internal/fips140/sha512
   517  	< crypto/internal/fips140/sha3
   518  	< crypto/internal/fips140/hmac
   519  	< crypto/internal/fips140/check
   520  	< crypto/internal/fips140/pbkdf2
   521  	< crypto/internal/fips140/aes
   522  	< crypto/internal/fips140/drbg
   523  	< crypto/internal/fips140/aes/gcm
   524  	< crypto/internal/fips140/hkdf
   525  	< crypto/internal/fips140/mlkem
   526  	< crypto/internal/fips140/mldsa
   527  	< crypto/internal/fips140/ssh
   528  	< crypto/internal/fips140/tls12
   529  	< crypto/internal/fips140/tls13
   530  	< crypto/internal/fips140/bigmod
   531  	< crypto/internal/fips140/nistec/fiat
   532  	< crypto/internal/fips140/nistec
   533  	< crypto/internal/fips140/ecdh
   534  	< crypto/internal/fips140/ecdsa
   535  	< crypto/internal/fips140/edwards25519/field
   536  	< crypto/internal/fips140/edwards25519
   537  	< crypto/internal/fips140/ed25519
   538  	< crypto/internal/fips140/rsa
   539  	< crypto/fips140 < FIPS;
   540  
   541  	crypto !< FIPS;
   542  
   543  	# CRYPTO is core crypto algorithms - no cgo, fmt, net.
   544  	# Mostly wrappers around the FIPS module.
   545  
   546  	NONE < crypto/internal/boring/sig, crypto/internal/boring/syso;
   547  	sync/atomic < crypto/internal/boring/bcache;
   548  
   549  	FIPS, internal/godebug, embed,
   550  	crypto/internal/boring/sig,
   551  	crypto/internal/boring/syso,
   552  	crypto/internal/boring/bcache
   553  	< crypto/internal/fips140only
   554  	< crypto
   555  	< crypto/subtle
   556  	< crypto/sha3
   557  	< crypto/internal/fips140hash
   558  	< crypto/cipher
   559  	< crypto/internal/boring
   560  	< crypto/boring
   561  	< crypto/internal/rand
   562  	< crypto/aes,
   563  	  crypto/des,
   564  	  crypto/rc4,
   565  	  crypto/md5,
   566  	  crypto/sha1,
   567  	  crypto/sha256,
   568  	  crypto/sha512,
   569  	  crypto/hmac,
   570  	  crypto/hkdf,
   571  	  crypto/pbkdf2,
   572  	  crypto/ecdh,
   573  	  crypto/mlkem,
   574  	  crypto/mldsa
   575  	< CRYPTO;
   576  
   577  	CRYPTO
   578  	< golang.org/x/crypto/hkdf;
   579  
   580  	CGO, fmt, net !< CRYPTO;
   581  
   582  	# CRYPTO-MATH is crypto that exposes math/big APIs - no cgo, net; fmt now ok.
   583  
   584  	CRYPTO, FMT, math/big, internal/saferio
   585  	< crypto/internal/boring/bbig
   586  	< crypto/internal/fips140cache
   587  	< crypto/rand
   588  	< crypto/ed25519 # depends on crypto/rand.Reader
   589  	< encoding/asn1
   590  	< golang.org/x/crypto/cryptobyte/asn1
   591  	< golang.org/x/crypto/cryptobyte
   592  	< crypto/dsa, crypto/elliptic, crypto/rsa
   593  	< crypto/ecdsa
   594  	< CRYPTO-MATH;
   595  
   596  	CGO, net !< CRYPTO-MATH;
   597  
   598  	# uuids
   599  	crypto/rand, errors, encoding/binary, encoding/hex
   600  	< uuid;
   601  
   602  	# databases
   603  	FMT, uuid
   604  	< database/sql/internal
   605  	< database/sql/driver;
   606  
   607  	database/sql/driver, math/rand/v2 < database/sql;
   608  
   609  	# TLS, Prince of Dependencies.
   610  
   611  	crypto/fips140, sync/atomic < crypto/tls/internal/fips140tls;
   612  
   613  	crypto/internal/boring/sig, crypto/tls/internal/fips140tls < crypto/tls/fipsonly;
   614  
   615  	CRYPTO, golang.org/x/sys/cpu, encoding/binary, reflect
   616  	< golang.org/x/crypto/internal/alias
   617  	< golang.org/x/crypto/internal/subtle
   618  	< golang.org/x/crypto/chacha20
   619  	< golang.org/x/crypto/internal/poly1305
   620  	< golang.org/x/crypto/chacha20poly1305;
   621  
   622  	CRYPTO-MATH, golang.org/x/crypto/chacha20poly1305
   623  	< crypto/hpke;
   624  
   625  	CRYPTO-MATH, NET, container/list, encoding/hex, encoding/pem, crypto/hpke,
   626  	golang.org/x/crypto/chacha20poly1305, crypto/tls/internal/fips140tls
   627  	< crypto/x509/internal/macos
   628  	< crypto/x509/pkix
   629  	< crypto/x509
   630  	< crypto/tls;
   631  
   632  	# crypto-aware packages
   633  
   634  	FMT, hash/maphash
   635  	< container/hash;
   636  
   637  	hash/maphash, container/heap, go/constant, go/parser, internal/buildcfg, internal/goversion, internal/types/errors
   638  	< go/types;
   639  
   640  	DEBUG, go/build, go/types, text/scanner, crypto/sha256
   641  	< internal/pkgbits, internal/exportdata
   642  	< go/internal/gcimporter, go/internal/gccgoimporter, go/internal/srcimporter
   643  	< go/importer;
   644  
   645  	NET, crypto/rand, mime/quotedprintable
   646  	< mime/multipart;
   647  
   648  	crypto/tls
   649  	< net/smtp;
   650  
   651  	# HTTP, King of Dependencies.
   652  
   653  	context
   654  	< internal/gate;
   655  
   656  	FMT, encoding/binary
   657  	< golang.org/x/net/http2/hpack
   658  	< net/http/internal, net/http/internal/ascii, net/http/internal/testcert;
   659  
   660  	FMT, NET, container/list, encoding/binary, log
   661  	< golang.org/x/text/transform
   662  	< golang.org/x/text/unicode/norm
   663  	< golang.org/x/text/unicode/bidi
   664  	< golang.org/x/text/secure/bidirule
   665  	< golang.org/x/net/idna
   666  	< golang.org/x/net/http/httpguts, golang.org/x/net/http/httpproxy;
   667  
   668  	NET, crypto/tls
   669  	< net/http/httptrace;
   670  
   671  	compress/gzip,
   672  	golang.org/x/net/http/httpguts,
   673  	golang.org/x/net/http/httpproxy,
   674  	golang.org/x/net/http2/hpack,
   675  	net/http/internal,
   676  	net/http/internal/ascii,
   677  	net/http/internal/testcert,
   678  	net/http/httptrace,
   679  	mime/multipart,
   680  	log
   681  	< net/http/internal/httpcommon, net/http/internal/httpsfv
   682  	< net/http/internal/http2
   683  	< net/http;
   684  
   685  	net/http, golang.org/x/crypto/hkdf, log/slog
   686  	< golang.org/x/net/internal/quic/quicwire
   687  	< golang.org/x/net/quic, golang.org/x/net/internal/httpcommon
   688  	< golang.org/x/net/internal/http3
   689  	< golang.org/x/net/http3;
   690  
   691  	# HTTP-aware packages
   692  
   693  	encoding/json, net/http
   694  	< expvar;
   695  
   696  	net/http, net/http/internal/ascii
   697  	< net/http/cookiejar, net/http/httputil;
   698  
   699  	net/http, regexp
   700  	< net/http/cgi
   701  	< net/http/fcgi;
   702  
   703  	# Profiling
   704  	internal/runtime/pprof/label, runtime, context < internal/runtime/pprof;
   705  	FMT, compress/gzip, encoding/binary, sort, text/tabwriter, internal/runtime/pprof, internal/runtime/pprof/label
   706  	< runtime/pprof;
   707  
   708  	OS, compress/gzip, internal/lazyregexp
   709  	< internal/profile;
   710  
   711  	html, internal/profile, net/http, runtime/pprof, runtime/trace
   712  	< net/http/pprof;
   713  
   714  	# RPC
   715  	encoding/gob, encoding/json, go/token, html/template, net/http
   716  	< net/rpc
   717  	< net/rpc/jsonrpc;
   718  
   719  	# System Information
   720  	bufio, bytes, internal/cpu, io, os, strings, sync
   721  	< internal/sysinfo;
   722  
   723  	# Test-only
   724  	log
   725  	< testing/iotest
   726  	< testing/fstest;
   727  
   728  	FMT, flag, math/rand
   729  	< testing/quick;
   730  
   731  	FMT, DEBUG, flag, runtime/trace, internal/sysinfo, math/rand
   732  	< testing;
   733  
   734  	testing, math
   735  	< simd/archsimd/internal/test_helpers;
   736  
   737  	log/slog, testing
   738  	< testing/slogtest;
   739  
   740  	testing, crypto/rand
   741  	< testing/cryptotest;
   742  
   743  	NET, internal/gate
   744  	< internal/nettest;
   745  
   746  	net/http, flag, internal/nettest, testing
   747  	< net/http/httptest;
   748  
   749  	FMT, crypto/sha256, encoding/binary, encoding/json,
   750  	go/ast, go/parser, go/token,
   751  	internal/godebug, math/rand, encoding/hex
   752  	< internal/fuzz;
   753  
   754  	OS, flag, testing, internal/cfg, internal/platform, internal/goroot
   755  	< internal/testenv;
   756  
   757  	OS, encoding/base64
   758  	< internal/obscuretestdata;
   759  
   760  	CGO, OS, fmt
   761  	< internal/testpty;
   762  
   763  	NET, testing, math/rand
   764  	< golang.org/x/net/nettest;
   765  
   766  	syscall
   767  	< os/exec/internal/fdtest;
   768  
   769  	FMT, sort
   770  	< internal/diff;
   771  
   772  	FMT
   773  	< internal/txtar;
   774  
   775  	internal/synctest, testing
   776  	< testing/synctest;
   777  
   778  	testing
   779  	< internal/testhash;
   780  
   781  	CRYPTO-MATH
   782  	< crypto/mlkem/mlkemtest;
   783  
   784  	CRYPTO-MATH, testing, internal/testenv, internal/testhash, encoding/json, regexp
   785  	< crypto/internal/cryptotest;
   786  
   787  	crypto/internal/cryptotest, encoding/hex
   788  	< crypto/internal/cryptotest/wycheproof;
   789  
   790  	FMT, encoding/json, time, regexp
   791  	< crypto/internal/cryptotest/x509limbo;
   792  
   793  	CGO, FMT
   794  	< crypto/internal/sysrand/internal/seccomp;
   795  
   796  	FIPS
   797  	< crypto/internal/fips140/check/checktest;
   798  
   799  	# v2 execution trace parser.
   800  	FMT, io, internal/trace/tracev2
   801  	< internal/trace/version;
   802  
   803  	FMT, encoding/binary, internal/trace/version
   804  	< internal/trace/raw;
   805  
   806  	FMT, internal/trace/version, io, sort, encoding/binary
   807  	< internal/trace/internal/tracev1;
   808  
   809  	FMT, encoding/binary, internal/trace/version, internal/trace/internal/tracev1, container/heap, math/rand, regexp
   810  	< internal/trace;
   811  
   812  	# cmd/trace dependencies.
   813  	FMT,
   814  	embed,
   815  	encoding/json,
   816  	html/template,
   817  	internal/profile,
   818  	internal/trace,
   819  	internal/trace/traceviewer/format,
   820  	net/http
   821  	< internal/trace/traceviewer;
   822  
   823  	# Coverage.
   824  	FMT, hash/fnv, encoding/binary, regexp, sort, text/tabwriter,
   825  	internal/coverage, internal/coverage/uleb128
   826  	< internal/coverage/cmerge,
   827  	  internal/coverage/pods,
   828  	  internal/coverage/slicereader,
   829  	  internal/coverage/slicewriter;
   830  
   831  	internal/coverage/slicereader, internal/coverage/slicewriter
   832  	< internal/coverage/stringtab
   833  	< internal/coverage/decodecounter, internal/coverage/decodemeta,
   834  	  internal/coverage/encodecounter, internal/coverage/encodemeta;
   835  
   836  	internal/coverage/cmerge
   837  	< internal/coverage/cformat;
   838  
   839  	internal/coverage, crypto/sha256, FMT
   840  	< cmd/internal/cov/covcmd;
   841  
   842  	encoding/json,
   843  	runtime/debug,
   844  	internal/coverage/calloc,
   845  	internal/coverage/cformat,
   846  	internal/coverage/decodecounter, internal/coverage/decodemeta,
   847  	internal/coverage/encodecounter, internal/coverage/encodemeta,
   848  	internal/coverage/pods
   849  	< internal/coverage/cfile
   850  	< runtime/coverage;
   851  
   852  	internal/coverage/cfile, internal/fuzz, internal/testlog, runtime/pprof, regexp
   853  	< testing/internal/testdeps;
   854  
   855  	# Test-only packages can have anything they want
   856  
   857  	FMT, compress/gzip, embed, encoding/binary
   858  	< encoding/json/internal/jsontest;
   859  
   860  	CGO, internal/syscall/unix
   861  	< net/internal/cgotest;
   862  
   863  	FMT, testing
   864  	< internal/cgrouptest;
   865  
   866  	regexp, internal/testenv, internal/trace, internal/trace/raw, internal/txtar, testing
   867  	< internal/trace/testtrace;
   868  
   869  	C, CGO
   870  	< internal/runtime/cgobench;
   871  
   872  	# Generate-only packages can have anything they want.
   873  
   874  	container/heap,
   875  	encoding/binary,
   876  	fmt,
   877  	hash/maphash,
   878  	io,
   879  	log,
   880  	math/bits,
   881  	os,
   882  	reflect,
   883  	strings,
   884  	sync
   885  	< internal/runtime/gc/internal/gen;
   886  
   887  	regexp, internal/txtar, internal/trace, internal/trace/raw
   888  	< internal/trace/internal/testgen;
   889  
   890  	FMT
   891  	< math/big/internal/asmgen;
   892  `
   893  
   894  // listStdPkgs returns the same list of packages as "go list std".
   895  func listStdPkgs(goroot string) ([]string, error) {
   896  	// Based on cmd/go's matchPackages function.
   897  	var pkgs []string
   898  
   899  	src := filepath.Join(goroot, "src") + string(filepath.Separator)
   900  	walkFn := func(path string, d fs.DirEntry, err error) error {
   901  		if err != nil || !d.IsDir() || path == src {
   902  			return nil
   903  		}
   904  
   905  		base := filepath.Base(path)
   906  		if strings.HasPrefix(base, ".") || strings.HasPrefix(base, "_") || base == "testdata" {
   907  			return filepath.SkipDir
   908  		}
   909  
   910  		name := filepath.ToSlash(path[len(src):])
   911  		if name == "builtin" || name == "cmd" {
   912  			return filepath.SkipDir
   913  		}
   914  
   915  		pkgs = append(pkgs, strings.TrimPrefix(name, "vendor/"))
   916  		return nil
   917  	}
   918  	if err := filepath.WalkDir(src, walkFn); err != nil {
   919  		return nil, err
   920  	}
   921  	return pkgs, nil
   922  }
   923  
   924  func TestDependencies(t *testing.T) {
   925  	testenv.MustHaveSource(t)
   926  
   927  	ctxt := Default
   928  	all, err := listStdPkgs(ctxt.GOROOT)
   929  	if err != nil {
   930  		t.Fatal(err)
   931  	}
   932  	slices.Sort(all)
   933  
   934  	sawImport := map[string]map[string]bool{} // from package => to package => true
   935  	policy := depsPolicy(t)
   936  
   937  	for _, pkg := range all {
   938  		imports, err := findImports(pkg)
   939  		if err != nil {
   940  			t.Error(err)
   941  			continue
   942  		}
   943  		if sawImport[pkg] == nil {
   944  			sawImport[pkg] = map[string]bool{}
   945  		}
   946  		var bad []string
   947  		for _, imp := range imports {
   948  			sawImport[pkg][imp] = true
   949  			if !policy.HasEdge(pkg, imp) {
   950  				bad = append(bad, imp)
   951  			}
   952  		}
   953  		if bad != nil {
   954  			t.Errorf("unexpected dependency: %s imports %v", pkg, bad)
   955  		}
   956  	}
   957  }
   958  
   959  var buildIgnore = []byte("\n//go:build ignore")
   960  
   961  func findImports(pkg string) ([]string, error) {
   962  	vpkg := pkg
   963  	if strings.HasPrefix(pkg, "golang.org") {
   964  		vpkg = "vendor/" + pkg
   965  	}
   966  	dir := filepath.Join(Default.GOROOT, "src", vpkg)
   967  	files, err := os.ReadDir(dir)
   968  	if err != nil {
   969  		return nil, err
   970  	}
   971  	var imports []string
   972  	var haveImport = map[string]bool{}
   973  	if pkg == "crypto/internal/boring" {
   974  		haveImport["C"] = true // kludge: prevent C from appearing in crypto/internal/boring imports
   975  	}
   976  	fset := token.NewFileSet()
   977  	for _, file := range files {
   978  		name := file.Name()
   979  		if name == "slice_go14.go" || name == "slice_go18.go" {
   980  			// These files are for compiler bootstrap with older versions of Go and not built in the standard build.
   981  			continue
   982  		}
   983  		if !strings.HasSuffix(name, ".go") || strings.HasSuffix(name, "_test.go") {
   984  			continue
   985  		}
   986  		info := fileInfo{
   987  			name: filepath.Join(dir, name),
   988  			fset: fset,
   989  		}
   990  		f, err := os.Open(info.name)
   991  		if err != nil {
   992  			return nil, err
   993  		}
   994  		err = readGoInfo(f, &info)
   995  		f.Close()
   996  		if err != nil {
   997  			return nil, fmt.Errorf("reading %v: %v", name, err)
   998  		}
   999  		if info.parsed.Name.Name == "main" {
  1000  			continue
  1001  		}
  1002  		if bytes.Contains(info.header, buildIgnore) {
  1003  			continue
  1004  		}
  1005  		for _, imp := range info.imports {
  1006  			path := imp.path
  1007  			if !haveImport[path] {
  1008  				haveImport[path] = true
  1009  				imports = append(imports, path)
  1010  			}
  1011  		}
  1012  	}
  1013  	slices.Sort(imports)
  1014  	return imports, nil
  1015  }
  1016  
  1017  // depsPolicy returns a map m such that m[p][d] == true when p can import d.
  1018  func depsPolicy(t *testing.T) *dag.Graph {
  1019  	g, err := dag.Parse(depsRules)
  1020  	if err != nil {
  1021  		t.Fatal(err)
  1022  	}
  1023  	return g
  1024  }
  1025  
  1026  // TestStdlibLowercase tests that all standard library package names are
  1027  // lowercase. See Issue 40065.
  1028  func TestStdlibLowercase(t *testing.T) {
  1029  	testenv.MustHaveSource(t)
  1030  
  1031  	ctxt := Default
  1032  	all, err := listStdPkgs(ctxt.GOROOT)
  1033  	if err != nil {
  1034  		t.Fatal(err)
  1035  	}
  1036  
  1037  	for _, pkgname := range all {
  1038  		if strings.ToLower(pkgname) != pkgname {
  1039  			t.Errorf("package %q should not use upper-case path", pkgname)
  1040  		}
  1041  	}
  1042  }
  1043  
  1044  // TestFindImports tests that findImports works.  See #43249.
  1045  func TestFindImports(t *testing.T) {
  1046  	imports, err := findImports("go/build")
  1047  	if err != nil {
  1048  		t.Fatal(err)
  1049  	}
  1050  	t.Logf("go/build imports %q", imports)
  1051  	want := []string{"bytes", "os", "path/filepath", "strings"}
  1052  wantLoop:
  1053  	for _, w := range want {
  1054  		for _, imp := range imports {
  1055  			if imp == w {
  1056  				continue wantLoop
  1057  			}
  1058  		}
  1059  		t.Errorf("expected to find %q in import list", w)
  1060  	}
  1061  }
  1062  

View as plain text