src/cmd/compile/internal/types2/check_test.go

   1 // Copyright 2011 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 implements a typechecker test harness. The packages specified
   6 // in tests are typechecked. Error messages reported by the typechecker are
   7 // compared against the errors expected in the test files.
   8 //
   9 // Expected errors are indicated in the test files by putting comments
  10 // of the form /* ERROR pattern */ or /* ERRORx pattern */ (or a similar
  11 // //-style line comment) immediately following the tokens where errors
  12 // are reported. There must be exactly one blank before and after the
  13 // ERROR/ERRORx indicator, and the pattern must be a properly quoted Go
  14 // string.
  15 //
  16 // The harness will verify that each ERROR pattern is a substring of the
  17 // error reported at that source position, and that each ERRORx pattern
  18 // is a regular expression matching the respective error.
  19 // Consecutive comments may be used to indicate multiple errors reported
  20 // at the same position.
  21 //
  22 // For instance, the following test source indicates that an "undeclared"
  23 // error should be reported for the undeclared variable x:
  24 //
  25 //      package p
  26 //      func f() {
  27 //              _ = x /* ERROR "undeclared" */ + 1
  28 //      }
  29
  30 package types2_test
  31
  32 import (
  33         "bytes"
  34         "cmd/compile/internal/syntax"
  35         "flag"
  36         "fmt"
  37         "internal/buildcfg"
  38         "internal/testenv"
  39         "os"
  40         "path/filepath"
  41         "reflect"
  42         "regexp"
  43         "runtime"
  44         "strconv"
  45         "strings"
  46         "testing"
  47
  48         . "cmd/compile/internal/types2"
  49 )
  50
  51 var (
  52         haltOnError  = flag.Bool("halt", false, "halt on error")
  53         verifyErrors = flag.Bool("verify", false, "verify errors (rather than list them) in TestManual")
  54         enableAlias  = flag.Bool("alias", false, "set Config._EnableAlias for tests")
  55 )
  56
  57 func parseFiles(t *testing.T, filenames []string, srcs [][]byte, mode syntax.Mode) ([]*syntax.File, []error) {
  58         var files []*syntax.File
  59         var errlist []error
  60         errh := func(err error) { errlist = append(errlist, err) }
  61         for i, filename := range filenames {
  62                 base := syntax.NewFileBase(filename)
  63                 r := bytes.NewReader(srcs[i])
  64                 file, err := syntax.Parse(base, r, errh, nil, mode)
  65                 if file == nil {
  66                         t.Fatalf("%s: %s", filename, err)
  67                 }
  68                 files = append(files, file)
  69         }
  70         return files, errlist
  71 }
  72
  73 func unpackError(err error) (syntax.Pos, string) {
  74         switch err := err.(type) {
  75         case syntax.Error:
  76                 return err.Pos, err.Msg
  77         case Error:
  78                 return err.Pos, err.Msg
  79         default:
  80                 return nopos, err.Error()
  81         }
  82 }
  83
  84 // absDiff returns the absolute difference between x and y.
  85 func absDiff(x, y uint) uint {
  86         if x < y {
  87                 return y - x
  88         }
  89         return x - y
  90 }
  91
  92 // parseFlags parses flags from the first line of the given source if the line
  93 // starts with "//" (line comment) followed by "-" (possibly with spaces
  94 // between). Otherwise the line is ignored.
  95 func parseFlags(src []byte, flags *flag.FlagSet) error {
  96         // we must have a line comment that starts with a "-"
  97         const prefix = "//"
  98         if !bytes.HasPrefix(src, []byte(prefix)) {
  99                 return nil // first line is not a line comment
 100         }
 101         src = src[len(prefix):]
 102         if i := bytes.Index(src, []byte("-")); i < 0 || len(bytes.TrimSpace(src[:i])) != 0 {
 103                 return nil // comment doesn't start with a "-"
 104         }
 105         end := bytes.Index(src, []byte("\n"))
 106         const maxLen = 256
 107         if end < 0 || end > maxLen {
 108                 return fmt.Errorf("flags comment line too long")
 109         }
 110
 111         return flags.Parse(strings.Fields(string(src[:end])))
 112 }
 113
 114 // testFiles type-checks the package consisting of the given files, and
 115 // compares the resulting errors with the ERROR annotations in the source.
 116 //
 117 // The srcs slice contains the file content for the files named in the
 118 // filenames slice. The colDelta parameter specifies the tolerance for position
 119 // mismatch when comparing errors. The manual parameter specifies whether this
 120 // is a 'manual' test.
 121 //
 122 // If provided, opts may be used to mutate the Config before type-checking.
 123 func testFiles(t *testing.T, filenames []string, srcs [][]byte, colDelta uint, manual bool, opts ...func(*Config)) {
 124         if len(filenames) == 0 {
 125                 t.Fatal("no source files")
 126         }
 127
 128         var conf Config
 129         var goexperiment string
 130         flags := flag.NewFlagSet("", flag.PanicOnError)
 131         flags.StringVar(&conf.GoVersion, "lang", "", "")
 132         flags.StringVar(&goexperiment, "goexperiment", "", "")
 133         flags.BoolVar(&conf.FakeImportC, "fakeImportC", false, "")
 134         flags.BoolVar(boolFieldAddr(&conf, "_EnableAlias"), "alias", *enableAlias, "")
 135         if err := parseFlags(srcs[0], flags); err != nil {
 136                 t.Fatal(err)
 137         }
 138         exp, err := buildcfg.ParseGOEXPERIMENT(runtime.GOOS, runtime.GOARCH, goexperiment)
 139         if err != nil {
 140                 t.Fatal(err)
 141         }
 142         old := buildcfg.Experiment
 143         defer func() {
 144                 buildcfg.Experiment = old
 145         }()
 146         buildcfg.Experiment = *exp
 147
 148         files, errlist := parseFiles(t, filenames, srcs, 0)
 149
 150         pkgName := "<no package>"
 151         if len(files) > 0 {
 152                 pkgName = files[0].PkgName.Value
 153         }
 154
 155         listErrors := manual && !*verifyErrors
 156         if listErrors && len(errlist) > 0 {
 157                 t.Errorf("--- %s:", pkgName)
 158                 for _, err := range errlist {
 159                         t.Error(err)
 160                 }
 161         }
 162
 163         // typecheck and collect typechecker errors
 164         conf.Trace = manual && testing.Verbose()
 165         conf.Importer = defaultImporter()
 166         conf.Error = func(err error) {
 167                 if *haltOnError {
 168                         defer panic(err)
 169                 }
 170                 if listErrors {
 171                         t.Error(err)
 172                         return
 173                 }
 174                 errlist = append(errlist, err)
 175         }
 176
 177         for _, opt := range opts {
 178                 opt(&conf)
 179         }
 180
 181         // Provide Config.Info with all maps so that info recording is tested.
 182         info := Info{
 183                 Types:      make(map[syntax.Expr]TypeAndValue),
 184                 Instances:  make(map[*syntax.Name]Instance),
 185                 Defs:       make(map[*syntax.Name]Object),
 186                 Uses:       make(map[*syntax.Name]Object),
 187                 Implicits:  make(map[syntax.Node]Object),
 188                 Selections: make(map[*syntax.SelectorExpr]*Selection),
 189                 Scopes:     make(map[syntax.Node]*Scope),
 190         }
 191         conf.Check(pkgName, files, &info)
 192
 193         if listErrors {
 194                 return
 195         }
 196
 197         // collect expected errors
 198         errmap := make(map[string]map[uint][]syntax.Error)
 199         for i, filename := range filenames {
 200                 if m := syntax.CommentMap(bytes.NewReader(srcs[i]), regexp.MustCompile("^ ERRORx? ")); len(m) > 0 {
 201                         errmap[filename] = m
 202                 }
 203         }
 204
 205         // match against found errors
 206         var indices []int // list indices of matching errors, reused for each error
 207         for _, err := range errlist {
 208                 gotPos, gotMsg := unpackError(err)
 209
 210                 // find list of errors for the respective error line
 211                 filename := gotPos.Base().Filename()
 212                 filemap := errmap[filename]
 213                 line := gotPos.Line()
 214                 var errList []syntax.Error
 215                 if filemap != nil {
 216                         errList = filemap[line]
 217                 }
 218
 219                 // At least one of the errors in errList should match the current error.
 220                 indices = indices[:0]
 221                 for i, want := range errList {
 222                         pattern, substr := strings.CutPrefix(want.Msg, " ERROR ")
 223                         if !substr {
 224                                 var found bool
 225                                 pattern, found = strings.CutPrefix(want.Msg, " ERRORx ")
 226                                 if !found {
 227                                         panic("unreachable")
 228                                 }
 229                         }
 230                         pattern, err := strconv.Unquote(strings.TrimSpace(pattern))
 231                         if err != nil {
 232                                 t.Errorf("%s:%d:%d: %v", filename, line, want.Pos.Col(), err)
 233                                 continue
 234                         }
 235                         if substr {
 236                                 if !strings.Contains(gotMsg, pattern) {
 237                                         continue
 238                                 }
 239                         } else {
 240                                 rx, err := regexp.Compile(pattern)
 241                                 if err != nil {
 242                                         t.Errorf("%s:%d:%d: %v", filename, line, want.Pos.Col(), err)
 243                                         continue
 244                                 }
 245                                 if !rx.MatchString(gotMsg) {
 246                                         continue
 247                                 }
 248                         }
 249                         indices = append(indices, i)
 250                 }
 251                 if len(indices) == 0 {
 252                         t.Errorf("%s: no error expected: %q", gotPos, gotMsg)
 253                         continue
 254                 }
 255                 // len(indices) > 0
 256
 257                 // If there are multiple matching errors, select the one with the closest column position.
 258                 index := -1 // index of matching error
 259                 var delta uint
 260                 for _, i := range indices {
 261                         if d := absDiff(gotPos.Col(), errList[i].Pos.Col()); index < 0 || d < delta {
 262                                 index, delta = i, d
 263                         }
 264                 }
 265
 266                 // The closest column position must be within expected colDelta.
 267                 if delta > colDelta {
 268                         t.Errorf("%s: got col = %d; want %d", gotPos, gotPos.Col(), errList[index].Pos.Col())
 269                 }
 270
 271                 // eliminate from errList
 272                 if n := len(errList) - 1; n > 0 {
 273                         // not the last entry - slide entries down (don't reorder)
 274                         copy(errList[index:], errList[index+1:])
 275                         filemap[line] = errList[:n]
 276                 } else {
 277                         // last entry - remove errList from filemap
 278                         delete(filemap, line)
 279                 }
 280
 281                 // if filemap is empty, eliminate from errmap
 282                 if len(filemap) == 0 {
 283                         delete(errmap, filename)
 284                 }
 285         }
 286
 287         // there should be no expected errors left
 288         if len(errmap) > 0 {
 289                 t.Errorf("--- %s: unreported errors:", pkgName)
 290                 for filename, filemap := range errmap {
 291                         for line, errList := range filemap {
 292                                 for _, err := range errList {
 293                                         t.Errorf("%s:%d:%d: %s", filename, line, err.Pos.Col(), err.Msg)
 294                                 }
 295                         }
 296                 }
 297         }
 298 }
 299
 300 // boolFieldAddr(conf, name) returns the address of the boolean field conf.<name>.
 301 // For accessing unexported fields.
 302 func boolFieldAddr(conf *Config, name string) *bool {
 303         v := reflect.Indirect(reflect.ValueOf(conf))
 304         return (*bool)(v.FieldByName(name).Addr().UnsafePointer())
 305 }
 306
 307 // TestManual is for manual testing of a package - either provided
 308 // as a list of filenames belonging to the package, or a directory
 309 // name containing the package files - after the test arguments
 310 // (and a separating "--"). For instance, to test the package made
 311 // of the files foo.go and bar.go, use:
 312 //
 313 //      go test -run Manual -- foo.go bar.go
 314 //
 315 // If no source arguments are provided, the file testdata/manual.go
 316 // is used instead.
 317 // Provide the -verify flag to verify errors against ERROR comments
 318 // in the input files rather than having a list of errors reported.
 319 // The accepted Go language version can be controlled with the -lang
 320 // flag.
 321 func TestManual(t *testing.T) {
 322         testenv.MustHaveGoBuild(t)
 323
 324         filenames := flag.Args()
 325         if len(filenames) == 0 {
 326                 filenames = []string{filepath.FromSlash("testdata/manual.go")}
 327         }
 328
 329         info, err := os.Stat(filenames[0])
 330         if err != nil {
 331                 t.Fatalf("TestManual: %v", err)
 332         }
 333
 334         DefPredeclaredTestFuncs()
 335         if info.IsDir() {
 336                 if len(filenames) > 1 {
 337                         t.Fatal("TestManual: must have only one directory argument")
 338                 }
 339                 testDir(t, filenames[0], 0, true)
 340         } else {
 341                 testPkg(t, filenames, 0, true)
 342         }
 343 }
 344
 345 func TestLongConstants(t *testing.T) {
 346         format := `package longconst; const _ = %s /* ERROR "constant overflow" */; const _ = %s // ERROR "excessively long constant"`
 347         src := fmt.Sprintf(format, strings.Repeat("1", 9999), strings.Repeat("1", 10001))
 348         testFiles(t, []string{"longconst.go"}, [][]byte{[]byte(src)}, 0, false)
 349 }
 350
 351 func withSizes(sizes Sizes) func(*Config) {
 352         return func(cfg *Config) {
 353                 cfg.Sizes = sizes
 354         }
 355 }
 356
 357 // TestIndexRepresentability tests that constant index operands must
 358 // be representable as int even if they already have a type that can
 359 // represent larger values.
 360 func TestIndexRepresentability(t *testing.T) {
 361         const src = `package index; var s []byte; var _ = s[int64 /* ERRORx "int64\\(1\\) << 40 \\(.*\\) overflows int" */ (1) << 40]`
 362         testFiles(t, []string{"index.go"}, [][]byte{[]byte(src)}, 0, false, withSizes(&StdSizes{4, 4}))
 363 }
 364
 365 func TestIssue47243_TypedRHS(t *testing.T) {
 366         // The RHS of the shift expression below overflows uint on 32bit platforms,
 367         // but this is OK as it is explicitly typed.
 368         const src = `package issue47243; var a uint64; var _ = a << uint64(4294967296)` // uint64(1<<32)
 369         testFiles(t, []string{"p.go"}, [][]byte{[]byte(src)}, 0, false, withSizes(&StdSizes{4, 4}))
 370 }
 371
 372 func TestCheck(t *testing.T) {
 373         old := buildcfg.Experiment.RangeFunc
 374         defer func() {
 375                 buildcfg.Experiment.RangeFunc = old
 376         }()
 377         buildcfg.Experiment.RangeFunc = true
 378
 379         DefPredeclaredTestFuncs()
 380         testDirFiles(t, "../../../../internal/types/testdata/check", 50, false) // TODO(gri) narrow column tolerance
 381 }
 382 func TestSpec(t *testing.T) { testDirFiles(t, "../../../../internal/types/testdata/spec", 0, false) }
 383 func TestExamples(t *testing.T) {
 384         testDirFiles(t, "../../../../internal/types/testdata/examples", 125, false)
 385 } // TODO(gri) narrow column tolerance
 386 func TestFixedbugs(t *testing.T) {
 387         testDirFiles(t, "../../../../internal/types/testdata/fixedbugs", 100, false)
 388 }                            // TODO(gri) narrow column tolerance
 389 func TestLocal(t *testing.T) { testDirFiles(t, "testdata/local", 0, false) }
 390
 391 func testDirFiles(t *testing.T, dir string, colDelta uint, manual bool) {
 392         testenv.MustHaveGoBuild(t)
 393         dir = filepath.FromSlash(dir)
 394
 395         fis, err := os.ReadDir(dir)
 396         if err != nil {
 397                 t.Error(err)
 398                 return
 399         }
 400
 401         for _, fi := range fis {
 402                 path := filepath.Join(dir, fi.Name())
 403
 404                 // If fi is a directory, its files make up a single package.
 405                 if fi.IsDir() {
 406                         testDir(t, path, colDelta, manual)
 407                 } else {
 408                         t.Run(filepath.Base(path), func(t *testing.T) {
 409                                 testPkg(t, []string{path}, colDelta, manual)
 410                         })
 411                 }
 412         }
 413 }
 414
 415 func testDir(t *testing.T, dir string, colDelta uint, manual bool) {
 416         fis, err := os.ReadDir(dir)
 417         if err != nil {
 418                 t.Error(err)
 419                 return
 420         }
 421
 422         var filenames []string
 423         for _, fi := range fis {
 424                 filenames = append(filenames, filepath.Join(dir, fi.Name()))
 425         }
 426
 427         t.Run(filepath.Base(dir), func(t *testing.T) {
 428                 testPkg(t, filenames, colDelta, manual)
 429         })
 430 }
 431
 432 func testPkg(t *testing.T, filenames []string, colDelta uint, manual bool) {
 433         srcs := make([][]byte, len(filenames))
 434         for i, filename := range filenames {
 435                 src, err := os.ReadFile(filename)
 436                 if err != nil {
 437                         t.Fatalf("could not read %s: %v", filename, err)
 438                 }
 439                 srcs[i] = src
 440         }
 441         testFiles(t, filenames, srcs, colDelta, manual)
 442 }