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

View as plain text