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

View as plain text