// Copyright 2011 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. // This file is a copy of $GOROOT/src/go/internal/gcimporter/gcimporter_test.go, // adjusted to make it build with code from (std lib) internal/testenv copied. package gcimporter import ( "bytes" "fmt" "go/ast" "go/constant" goimporter "go/importer" goparser "go/parser" "go/token" "go/types" "os" "os/exec" "path" "path/filepath" "runtime" "sort" "strings" "sync" "testing" "time" "golang.org/x/tools/internal/aliases" "golang.org/x/tools/internal/goroot" "golang.org/x/tools/internal/testenv" ) func TestMain(m *testing.M) { testenv.ExitIfSmallMachine() os.Exit(m.Run()) } // ---------------------------------------------------------------------------- func needsCompiler(t *testing.T, compiler string) { if runtime.Compiler == compiler { return } switch compiler { case "gc": t.Skipf("gc-built packages not available (compiler = %s)", runtime.Compiler) } } // compile runs the compiler on filename, with dirname as the working directory, // and writes the output file to outdirname. // compile gives the resulting package a packagepath of p. func compile(t *testing.T, dirname, filename, outdirname string, packagefiles map[string]string) string { return compilePkg(t, dirname, filename, outdirname, packagefiles, "p") } func compilePkg(t *testing.T, dirname, filename, outdirname string, packagefiles map[string]string, pkg string) string { testenv.NeedsGoBuild(t) // filename must end with ".go" basename := strings.TrimSuffix(filepath.Base(filename), ".go") ok := filename != basename if !ok { t.Fatalf("filename doesn't end in .go: %s", filename) } objname := basename + ".o" outname := filepath.Join(outdirname, objname) importcfgfile := os.DevNull if len(packagefiles) > 0 { importcfgfile = filepath.Join(outdirname, basename) + ".importcfg" importcfg := new(bytes.Buffer) fmt.Fprintf(importcfg, "# import config") for k, v := range packagefiles { fmt.Fprintf(importcfg, "\npackagefile %s=%s\n", k, v) } if err := os.WriteFile(importcfgfile, importcfg.Bytes(), 0655); err != nil { t.Fatal(err) } } importreldir := strings.ReplaceAll(outdirname, string(os.PathSeparator), "/") cmd := exec.Command("go", "tool", "compile", "-p", pkg, "-D", importreldir, "-importcfg", importcfgfile, "-o", outname, filename) cmd.Dir = dirname if out, err := cmd.CombinedOutput(); err != nil { t.Logf("%s", out) t.Fatalf("go tool compile %s failed: %s", filename, err) } return outname } func testPath(t *testing.T, path, srcDir string) *types.Package { t0 := time.Now() pkg, err := Import(make(map[string]*types.Package), path, srcDir, nil) if err != nil { t.Errorf("testPath(%s): %s", path, err) return nil } t.Logf("testPath(%s): %v", path, time.Since(t0)) return pkg } func mktmpdir(t *testing.T) string { tmpdir, err := os.MkdirTemp("", "gcimporter_test") if err != nil { t.Fatal("mktmpdir:", err) } if err := os.Mkdir(filepath.Join(tmpdir, "testdata"), 0700); err != nil { os.RemoveAll(tmpdir) t.Fatal("mktmpdir:", err) } return tmpdir } const testfile = "exports.go" func TestImportTestdata(t *testing.T) { needsCompiler(t, "gc") testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache tmpdir := mktmpdir(t) defer os.RemoveAll(tmpdir) packageFiles := map[string]string{} for _, pkg := range []string{"go/ast", "go/token"} { export, _ := FindPkg(pkg, "testdata") if export == "" { t.Fatalf("no export data found for %s", pkg) } packageFiles[pkg] = export } compile(t, "testdata", testfile, filepath.Join(tmpdir, "testdata"), packageFiles) // filename should end with ".go" filename := testfile[:len(testfile)-3] if pkg := testPath(t, "./testdata/"+filename, tmpdir); pkg != nil { // The package's Imports list must include all packages // explicitly imported by testfile, plus all packages // referenced indirectly via exported objects in testfile. // With the textual export format (when run against Go1.6), // the list may also include additional packages that are // not strictly required for import processing alone (they // are exported to err "on the safe side"). // For now, we just test the presence of a few packages // that we know are there for sure. got := fmt.Sprint(pkg.Imports()) wants := []string{"go/ast", "go/token"} if unifiedIR { wants = []string{"go/ast"} } for _, want := range wants { if !strings.Contains(got, want) { t.Errorf(`Package("exports").Imports() = %s, does not contain %s`, got, want) } } } } func TestImportTypeparamTests(t *testing.T) { if testing.Short() { t.Skipf("in short mode, skipping test that requires export data for all of std") } testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache // This package only handles gc export data. if runtime.Compiler != "gc" { t.Skipf("gc-built packages not available (compiler = %s)", runtime.Compiler) } tmpdir := mktmpdir(t) defer os.RemoveAll(tmpdir) // Check go files in test/typeparam, except those that fail for a known // reason. rootDir := filepath.Join(runtime.GOROOT(), "test", "typeparam") list, err := os.ReadDir(rootDir) if err != nil { t.Fatal(err) } var skip map[string]string if !unifiedIR { // The Go 1.18 frontend still fails several cases. skip = map[string]string{ "equal.go": "inconsistent embedded sorting", // TODO(rfindley): investigate this. "nested.go": "fails to compile", // TODO(rfindley): investigate this. "issue47631.go": "can not handle local type declarations", "issue55101.go": "fails to compile", } } for _, entry := range list { if entry.IsDir() || !strings.HasSuffix(entry.Name(), ".go") { // For now, only consider standalone go files. continue } t.Run(entry.Name(), func(t *testing.T) { if reason, ok := skip[entry.Name()]; ok { t.Skip(reason) } filename := filepath.Join(rootDir, entry.Name()) src, err := os.ReadFile(filename) if err != nil { t.Fatal(err) } if !bytes.HasPrefix(src, []byte("// run")) && !bytes.HasPrefix(src, []byte("// compile")) { // We're bypassing the logic of run.go here, so be conservative about // the files we consider in an attempt to make this test more robust to // changes in test/typeparams. t.Skipf("not detected as a run test") } // Compile and import, and compare the resulting package with the package // that was type-checked directly. pkgFiles, err := goroot.PkgfileMap() if err != nil { t.Fatal(err) } compile(t, rootDir, entry.Name(), filepath.Join(tmpdir, "testdata"), pkgFiles) pkgName := strings.TrimSuffix(entry.Name(), ".go") imported := importPkg(t, "./testdata/"+pkgName, tmpdir) checked := checkFile(t, filename, src) seen := make(map[string]bool) for _, name := range imported.Scope().Names() { if !token.IsExported(name) { continue // ignore synthetic names like .inittask and .dict.* } seen[name] = true importedObj := imported.Scope().Lookup(name) got := types.ObjectString(importedObj, types.RelativeTo(imported)) checkedObj := checked.Scope().Lookup(name) if checkedObj == nil { t.Fatalf("imported object %q was not type-checked", name) } want := types.ObjectString(checkedObj, types.RelativeTo(checked)) if got != want { t.Errorf("imported %q as %q, want %q", name, got, want) } } for _, name := range checked.Scope().Names() { if !token.IsExported(name) || seen[name] { continue } t.Errorf("did not import object %q", name) } }) } } func checkFile(t *testing.T, filename string, src []byte) *types.Package { fset := token.NewFileSet() f, err := goparser.ParseFile(fset, filename, src, 0) if err != nil { t.Fatal(err) } config := types.Config{ Importer: goimporter.Default(), } pkg, err := config.Check("", fset, []*ast.File{f}, nil) if err != nil { t.Fatal(err) } return pkg } func TestVersionHandling(t *testing.T) { if debug { t.Skip("TestVersionHandling panics in debug mode") } // This package only handles gc export data. needsCompiler(t, "gc") const dir = "./testdata/versions" list, err := os.ReadDir(dir) if err != nil { t.Fatal(err) } tmpdir := mktmpdir(t) defer os.RemoveAll(tmpdir) corruptdir := filepath.Join(tmpdir, "testdata", "versions") if err := os.Mkdir(corruptdir, 0700); err != nil { t.Fatal(err) } for _, f := range list { name := f.Name() if !strings.HasSuffix(name, ".a") { continue // not a package file } if strings.Contains(name, "corrupted") { continue // don't process a leftover corrupted file } pkgpath := "./" + name[:len(name)-2] if testing.Verbose() { t.Logf("importing %s", name) } // test that export data can be imported _, err := Import(make(map[string]*types.Package), pkgpath, dir, nil) if err != nil { t.Errorf("import %q failed: %v", pkgpath, err) continue } // create file with corrupted export data // 1) read file data, err := os.ReadFile(filepath.Join(dir, name)) if err != nil { t.Fatal(err) } // 2) find export data i := bytes.Index(data, []byte("\n$$B\n")) + 5 j := bytes.Index(data[i:], []byte("\n$$\n")) + i if i < 0 || j < 0 || i > j { t.Fatalf("export data section not found (i = %d, j = %d)", i, j) } // 3) corrupt the data (increment every 7th byte) for k := j - 13; k >= i; k -= 7 { data[k]++ } // 4) write the file pkgpath += "_corrupted" filename := filepath.Join(corruptdir, pkgpath) + ".a" os.WriteFile(filename, data, 0666) // test that importing the corrupted file results in an error _, err = Import(make(map[string]*types.Package), pkgpath, corruptdir, nil) if err == nil { t.Errorf("import corrupted %q succeeded", pkgpath) } else if msg := err.Error(); !strings.Contains(msg, "internal error") { t.Errorf("import %q error incorrect (%s)", pkgpath, msg) } } } func TestImportStdLib(t *testing.T) { if testing.Short() { t.Skip("the imports can be expensive, and this test is especially slow when the build cache is empty") } // This package only handles gc export data. needsCompiler(t, "gc") testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache // Get list of packages in stdlib. Filter out test-only packages with {{if .GoFiles}} check. var stderr bytes.Buffer cmd := exec.Command("go", "list", "-f", "{{if .GoFiles}}{{.ImportPath}}{{end}}", "std") cmd.Stderr = &stderr out, err := cmd.Output() if err != nil { t.Fatalf("failed to run go list to determine stdlib packages: %v\nstderr:\n%v", err, stderr.String()) } pkgs := strings.Fields(string(out)) var nimports int for _, pkg := range pkgs { t.Run(pkg, func(t *testing.T) { if testPath(t, pkg, filepath.Join(testenv.GOROOT(t), "src", path.Dir(pkg))) != nil { nimports++ } }) } const minPkgs = 225 // 'GOOS=plan9 go1.18 list std | wc -l' reports 228; most other platforms have more. if len(pkgs) < minPkgs { t.Fatalf("too few packages (%d) were imported", nimports) } t.Logf("tested %d imports", nimports) } var importedObjectTests = []struct { name string want string }{ // non-interfaces {"crypto.Hash", "type Hash uint"}, {"go/ast.ObjKind", "type ObjKind int"}, {"go/types.Qualifier", "type Qualifier func(*Package) string"}, {"go/types.Comparable", "func Comparable(T Type) bool"}, {"math.Pi", "const Pi untyped float"}, {"math.Sin", "func Sin(x float64) float64"}, {"go/ast.NotNilFilter", "func NotNilFilter(_ string, v reflect.Value) bool"}, // interfaces {"context.Context", "type Context interface{Deadline() (deadline time.Time, ok bool); Done() <-chan struct{}; Err() error; Value(key any) any}"}, {"crypto.Decrypter", "type Decrypter interface{Decrypt(rand io.Reader, msg []byte, opts DecrypterOpts) (plaintext []byte, err error); Public() PublicKey}"}, {"encoding.BinaryMarshaler", "type BinaryMarshaler interface{MarshalBinary() (data []byte, err error)}"}, {"io.Reader", "type Reader interface{Read(p []byte) (n int, err error)}"}, {"io.ReadWriter", "type ReadWriter interface{Reader; Writer}"}, {"go/ast.Node", "type Node interface{End() go/token.Pos; Pos() go/token.Pos}"}, {"go/types.Type", "type Type interface{String() string; Underlying() Type}"}, } func TestImportedTypes(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache for _, test := range importedObjectTests { obj := importObject(t, test.name) if obj == nil { continue // error reported elsewhere } got := types.ObjectString(obj, types.RelativeTo(obj.Pkg())) // TODO(rsc): Delete this block once go.dev/cl/368254 lands. if got != test.want && test.want == strings.ReplaceAll(got, "interface{}", "any") { got = test.want } if got != test.want { t.Errorf("%s: got %q; want %q", test.name, got, test.want) } if named, _ := aliases.Unalias(obj.Type()).(*types.Named); named != nil { verifyInterfaceMethodRecvs(t, named, 0) } } } func TestImportedConsts(t *testing.T) { testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache tests := []struct { name string want constant.Kind }{ {"math.Pi", constant.Float}, {"math.MaxFloat64", constant.Float}, {"math.MaxInt64", constant.Int}, } for _, test := range tests { obj := importObject(t, test.name) if got := obj.(*types.Const).Val().Kind(); got != test.want { t.Errorf("%s: imported as constant.Kind(%v), want constant.Kind(%v)", test.name, got, test.want) } } } // importObject imports the object specified by a name of the form // ., e.g. go/types.Type. // // If any errors occur they are reported via t and the resulting object will // be nil. func importObject(t *testing.T, name string) types.Object { s := strings.Split(name, ".") if len(s) != 2 { t.Fatal("inconsistent test data") } importPath := s[0] objName := s[1] pkg, err := Import(make(map[string]*types.Package), importPath, ".", nil) if err != nil { t.Error(err) return nil } obj := pkg.Scope().Lookup(objName) if obj == nil { t.Errorf("%s: object not found", name) return nil } return obj } // verifyInterfaceMethodRecvs verifies that method receiver types // are named if the methods belong to a named interface type. func verifyInterfaceMethodRecvs(t *testing.T, named *types.Named, level int) { // avoid endless recursion in case of an embedding bug that lead to a cycle if level > 10 { t.Errorf("%s: embeds itself", named) return } iface, _ := named.Underlying().(*types.Interface) if iface == nil { return // not an interface } // check explicitly declared methods for i := 0; i < iface.NumExplicitMethods(); i++ { m := iface.ExplicitMethod(i) recv := m.Type().(*types.Signature).Recv() if recv == nil { t.Errorf("%s: missing receiver type", m) continue } if recv.Type() != named { t.Errorf("%s: got recv type %s; want %s", m, recv.Type(), named) } } // check embedded interfaces (if they are named, too) for i := 0; i < iface.NumEmbeddeds(); i++ { // embedding of interfaces cannot have cycles; recursion will terminate if etype, _ := aliases.Unalias(iface.EmbeddedType(i)).(*types.Named); etype != nil { verifyInterfaceMethodRecvs(t, etype, level+1) } } } func TestIssue5815(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache pkg := importPkg(t, "strings", ".") scope := pkg.Scope() for _, name := range scope.Names() { obj := scope.Lookup(name) if obj.Pkg() == nil { t.Errorf("no pkg for %s", obj) } if tname, _ := obj.(*types.TypeName); tname != nil { named := aliases.Unalias(tname.Type()).(*types.Named) for i := 0; i < named.NumMethods(); i++ { m := named.Method(i) if m.Pkg() == nil { t.Errorf("no pkg for %s", m) } } } } } // Smoke test to ensure that imported methods get the correct package. func TestCorrectMethodPackage(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache imports := make(map[string]*types.Package) _, err := Import(imports, "net/http", ".", nil) if err != nil { t.Fatal(err) } mutex := imports["sync"].Scope().Lookup("Mutex").(*types.TypeName).Type() mset := types.NewMethodSet(types.NewPointer(mutex)) // methods of *sync.Mutex sel := mset.Lookup(nil, "Lock") lock := sel.Obj().(*types.Func) if got, want := lock.Pkg().Path(), "sync"; got != want { t.Errorf("got package path %q; want %q", got, want) } } func TestIssue13566(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache // On windows, we have to set the -D option for the compiler to avoid having a drive // letter and an illegal ':' in the import path - just skip it (see also issue #3483). if runtime.GOOS == "windows" { t.Skip("avoid dealing with relative paths/drive letters on windows") } tmpdir := mktmpdir(t) defer os.RemoveAll(tmpdir) testoutdir := filepath.Join(tmpdir, "testdata") // b.go needs to be compiled from the output directory so that the compiler can // find the compiled package a. We pass the full path to compile() so that we // don't have to copy the file to that directory. bpath, err := filepath.Abs(filepath.Join("testdata", "b.go")) if err != nil { t.Fatal(err) } jsonExport, _ := FindPkg("encoding/json", "testdata") if jsonExport == "" { t.Fatalf("no export data found for encoding/json") } compilePkg(t, "testdata", "a.go", testoutdir, map[string]string{"encoding/json": jsonExport}, apkg(testoutdir)) compile(t, testoutdir, bpath, testoutdir, map[string]string{apkg(testoutdir): filepath.Join(testoutdir, "a.o")}) // import must succeed (test for issue at hand) pkg := importPkg(t, "./testdata/b", tmpdir) // make sure all indirectly imported packages have names for _, imp := range pkg.Imports() { if imp.Name() == "" { t.Errorf("no name for %s package", imp.Path()) } } } func TestIssue13898(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache // import go/internal/gcimporter which imports go/types partially imports := make(map[string]*types.Package) _, err := Import(imports, "go/internal/gcimporter", ".", nil) if err != nil { t.Fatal(err) } // look for go/types package var goTypesPkg *types.Package for path, pkg := range imports { if path == "go/types" { goTypesPkg = pkg break } } if goTypesPkg == nil { t.Fatal("go/types not found") } // look for go/types.Object type obj := lookupObj(t, goTypesPkg.Scope(), "Object") typ, ok := aliases.Unalias(obj.Type()).(*types.Named) if !ok { t.Fatalf("go/types.Object type is %v; wanted named type", typ) } // lookup go/types.Object.Pkg method m, index, indirect := types.LookupFieldOrMethod(typ, false, nil, "Pkg") if m == nil { t.Fatalf("go/types.Object.Pkg not found (index = %v, indirect = %v)", index, indirect) } // the method must belong to go/types if m.Pkg().Path() != "go/types" { t.Fatalf("found %v; want go/types", m.Pkg()) } } func TestIssue15517(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") // On windows, we have to set the -D option for the compiler to avoid having a drive // letter and an illegal ':' in the import path - just skip it (see also issue #3483). if runtime.GOOS == "windows" { t.Skip("avoid dealing with relative paths/drive letters on windows") } tmpdir := mktmpdir(t) defer os.RemoveAll(tmpdir) compile(t, "testdata", "p.go", filepath.Join(tmpdir, "testdata"), nil) // Multiple imports of p must succeed without redeclaration errors. // We use an import path that's not cleaned up so that the eventual // file path for the package is different from the package path; this // will expose the error if it is present. // // (Issue: Both the textual and the binary importer used the file path // of the package to be imported as key into the shared packages map. // However, the binary importer then used the package path to identify // the imported package to mark it as complete; effectively marking the // wrong package as complete. By using an "unclean" package path, the // file and package path are different, exposing the problem if present. // The same issue occurs with vendoring.) imports := make(map[string]*types.Package) for i := 0; i < 3; i++ { if _, err := Import(imports, "./././testdata/p", tmpdir, nil); err != nil { t.Fatal(err) } } } func TestIssue15920(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") // On windows, we have to set the -D option for the compiler to avoid having a drive // letter and an illegal ':' in the import path - just skip it (see also issue #3483). if runtime.GOOS == "windows" { t.Skip("avoid dealing with relative paths/drive letters on windows") } compileAndImportPkg(t, "issue15920") } func TestIssue20046(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") // On windows, we have to set the -D option for the compiler to avoid having a drive // letter and an illegal ':' in the import path - just skip it (see also issue #3483). if runtime.GOOS == "windows" { t.Skip("avoid dealing with relative paths/drive letters on windows") } // "./issue20046".V.M must exist pkg := compileAndImportPkg(t, "issue20046") obj := lookupObj(t, pkg.Scope(), "V") if m, index, indirect := types.LookupFieldOrMethod(obj.Type(), false, nil, "M"); m == nil { t.Fatalf("V.M not found (index = %v, indirect = %v)", index, indirect) } } func TestIssue25301(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") // On windows, we have to set the -D option for the compiler to avoid having a drive // letter and an illegal ':' in the import path - just skip it (see also issue #3483). if runtime.GOOS == "windows" { t.Skip("avoid dealing with relative paths/drive letters on windows") } compileAndImportPkg(t, "issue25301") } func TestIssue51836(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") // On windows, we have to set the -D option for the compiler to avoid having a drive // letter and an illegal ':' in the import path - just skip it (see also issue #3483). if runtime.GOOS == "windows" { t.Skip("avoid dealing with relative paths/drive letters on windows") } tmpdir := mktmpdir(t) defer os.RemoveAll(tmpdir) testoutdir := filepath.Join(tmpdir, "testdata") dir := filepath.Join("testdata", "issue51836") // Following the pattern of TestIssue13898, aa.go needs to be compiled from // the output directory. We pass the full path to compile() so that we don't // have to copy the file to that directory. bpath, err := filepath.Abs(filepath.Join(dir, "aa.go")) if err != nil { t.Fatal(err) } compilePkg(t, dir, "a.go", testoutdir, nil, apkg(testoutdir)) compile(t, testoutdir, bpath, testoutdir, map[string]string{apkg(testoutdir): filepath.Join(testoutdir, "a.o")}) // import must succeed (test for issue at hand) _ = importPkg(t, "./testdata/aa", tmpdir) } func TestIssue61561(t *testing.T) { const src = `package p type I[P any] interface { m(P) n() P } type J = I[int] type StillBad[P any] *interface{b(P)} type K = StillBad[string] ` fset := token.NewFileSet() f, err := goparser.ParseFile(fset, "p.go", src, 0) if f == nil { // Some test cases may have parse errors, but we must always have a // file. t.Fatalf("ParseFile returned nil file. Err: %v", err) } config := &types.Config{} pkg1, err := config.Check("p", fset, []*ast.File{f}, nil) if err != nil { t.Fatal(err) } // Export it. (Shallowness isn't important here.) data, err := IExportShallow(fset, pkg1, nil) if err != nil { t.Fatalf("export: %v", err) // any failure to export is a bug } // Re-import it. imports := make(map[string]*types.Package) pkg2, err := IImportShallow(fset, GetPackagesFromMap(imports), data, "p", nil) if err != nil { t.Fatalf("import: %v", err) // any failure of IExport+IImport is a bug. } insts := []types.Type{ pkg2.Scope().Lookup("J").Type(), // This test is still racy, because the incomplete interface is contained // within a nested type expression. // // Uncomment this once golang/go#61561 is fixed. // pkg2.Scope().Lookup("K").Type().Underlying().(*types.Pointer).Elem(), } // Use the interface instances concurrently. for _, inst := range insts { var wg sync.WaitGroup for i := 0; i < 2; i++ { wg.Add(1) go func() { defer wg.Done() _ = types.NewMethodSet(inst) }() } wg.Wait() } } func TestIssue57015(t *testing.T) { // This package only handles gc export data. needsCompiler(t, "gc") // On windows, we have to set the -D option for the compiler to avoid having a drive // letter and an illegal ':' in the import path - just skip it (see also issue #3483). if runtime.GOOS == "windows" { t.Skip("avoid dealing with relative paths/drive letters on windows") } compileAndImportPkg(t, "issue57015") } // This is a regression test for a failure to export a package // containing type errors. // // Though the issues and tests are specific, they may be representatives of a // class of exporter bugs on ill-typed code that we have yet to flush out. // // TODO(adonovan): systematize our search for similar problems using // fuzz testing. func TestExportInvalid(t *testing.T) { tests := []struct { name string src string objName string }{ // The lack of a receiver causes Recv.Type=Invalid. // (The type checker then treats Foo as a package-level // function, inserting it into the package scope.) // The exporter needs to apply the same treatment. {"issue 57729", `package p; func () Foo() {}`, "Foo"}, // It must be possible to export a constant with unknown kind, even if its // type is known. {"issue 60605", `package p; const EPSILON float64 = 1e-`, "EPSILON"}, // We must not crash when exporting a struct with unknown package. {"issue 60891", `package p; type I[P any] int; const C I[struct{}] = 42`, "C"}, } for _, test := range tests { t.Run(test.name, func(t *testing.T) { // Parse the ill-typed input. fset := token.NewFileSet() f, err := goparser.ParseFile(fset, "p.go", test.src, 0) if f == nil { // Some test cases may have parse errors, but we must always have a // file. t.Fatalf("ParseFile returned nil file. Err: %v", err) } // Type check it, expecting errors. config := &types.Config{ Error: func(err error) { t.Log(err) }, // don't abort at first error } pkg1, _ := config.Check("p", fset, []*ast.File{f}, nil) // Export it. // (Shallowness isn't important here.) data, err := IExportShallow(fset, pkg1, nil) if err != nil { t.Fatalf("export: %v", err) // any failure to export is a bug } // Re-import it. imports := make(map[string]*types.Package) pkg2, err := IImportShallow(fset, GetPackagesFromMap(imports), data, "p", nil) if err != nil { t.Fatalf("import: %v", err) // any failure of IExport+IImport is a bug. } // Check that the expected object is present in both packages. // We can't assert the type hasn't changed: it may have, in some cases. hasObj1 := pkg1.Scope().Lookup(test.objName) != nil hasObj2 := pkg2.Scope().Lookup(test.objName) != nil if hasObj1 != hasObj2 { t.Errorf("export+import changed Lookup(%q)!=nil: was %t, became %t", test.objName, hasObj1, hasObj2) } }) } } func TestIssue58296(t *testing.T) { // Compiles packages c, b, and a where c imports b and b imports a, // then imports c with stub *types.Packages for b and a, and checks that // both a and b are in the Imports() of c. // // This is how go/packages can read the exportdata when NeedDeps is off. // This package only handles gc export data. needsCompiler(t, "gc") testenv.NeedsGoBuild(t) // to find stdlib export data in the build cache // On windows, we have to set the -D option for the compiler to avoid having a drive // letter and an illegal ':' in the import path - just skip it (see also issue #3483). if runtime.GOOS == "windows" { t.Skip("avoid dealing with relative paths/drive letters on windows") } tmpdir := mktmpdir(t) defer os.RemoveAll(tmpdir) testoutdir := filepath.Join(tmpdir, "testdata") apkg := filepath.Join(testoutdir, "a") bpkg := filepath.Join(testoutdir, "b") cpkg := filepath.Join(testoutdir, "c") srcdir := filepath.Join("testdata", "issue58296") compilePkg(t, filepath.Join(srcdir, "a"), "a.go", testoutdir, nil, apkg) compilePkg(t, filepath.Join(srcdir, "b"), "b.go", testoutdir, map[string]string{apkg: filepath.Join(testoutdir, "a.o")}, bpkg) compilePkg(t, filepath.Join(srcdir, "c"), "c.go", testoutdir, map[string]string{bpkg: filepath.Join(testoutdir, "b.o")}, cpkg) // The export data reader for c cannot rely on Package.Imports // being populated for a or b. (For the imports {a,b} it is unset.) imports := map[string]*types.Package{ apkg: types.NewPackage(apkg, "a"), bpkg: types.NewPackage(bpkg, "b"), } // make sure a and b are both imported by c. pkg, err := Import(imports, "./c", testoutdir, nil) if err != nil { t.Fatal(err) } var names []string for _, imp := range pkg.Imports() { names = append(names, imp.Name()) } sort.Strings(names) if got, want := strings.Join(names, ","), "a,b"; got != want { t.Errorf("got imports %v for package c. wanted %v", names, want) } } // apkg returns the package "a" prefixed by (as a package) testoutdir func apkg(testoutdir string) string { apkg := testoutdir + "/a" if os.PathSeparator != '/' { apkg = strings.ReplaceAll(apkg, string(os.PathSeparator), "/") } return apkg } func importPkg(t *testing.T, path, srcDir string) *types.Package { pkg, err := Import(make(map[string]*types.Package), path, srcDir, nil) if err != nil { t.Fatal(err) } return pkg } func compileAndImportPkg(t *testing.T, name string) *types.Package { tmpdir := mktmpdir(t) defer os.RemoveAll(tmpdir) compile(t, "testdata", name+".go", filepath.Join(tmpdir, "testdata"), nil) return importPkg(t, "./testdata/"+name, tmpdir) } func lookupObj(t *testing.T, scope *types.Scope, name string) types.Object { if obj := scope.Lookup(name); obj != nil { return obj } t.Fatalf("%s not found", name) return nil }