src/go/types/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 error messages expected in the test files.
   8 //
   9 // Expected errors are indicated in the test files by putting a comment
  10 // of the form /* ERROR "rx" */ immediately following an offending token.
  11 // The harness will verify that an error matching the regular expression
  12 // rx is reported at that source position. Consecutive comments may be
  13 // used to indicate multiple errors for the same token position.
  14 //
  15 // For instance, the following test file indicates that a "not declared"
  16 // error should be reported for the undeclared variable x:
  17 //
  18 //      package p
  19 //      func f() {
  20 //              _ = x /* ERROR "not declared" */ + 1
  21 //      }
  22
  23 package types_test
  24
  25 import (
  26         "bytes"
  27         "flag"
  28         "fmt"
  29         "go/ast"
  30         "go/importer"
  31         "go/parser"
  32         "go/scanner"
  33         "go/token"
  34         "internal/testenv"
  35         "os"
  36         "path/filepath"
  37         "reflect"
  38         "regexp"
  39         "strings"
  40         "testing"
  41
  42         . "go/types"
  43 )
  44
  45 var (
  46         haltOnError  = flag.Bool("halt", false, "halt on error")
  47         verifyErrors = flag.Bool("verify", false, "verify errors (rather than list them) in TestManual")
  48 )
  49
  50 var fset = token.NewFileSet()
  51
  52 // Positioned errors are of the form filename:line:column: message .
  53 var posMsgRx = regexp.MustCompile(`^(.*:\d+:\d+): *(?s)(.*)`)
  54
  55 // splitError splits an error's error message into a position string
  56 // and the actual error message. If there's no position information,
  57 // pos is the empty string, and msg is the entire error message.
  58 func splitError(err error) (pos, msg string) {
  59         msg = err.Error()
  60         if m := posMsgRx.FindStringSubmatch(msg); len(m) == 3 {
  61                 pos = m[1]
  62                 msg = m[2]
  63         }
  64         return
  65 }
  66
  67 func parseFiles(t *testing.T, filenames []string, srcs [][]byte, mode parser.Mode) ([]*ast.File, []error) {
  68         var files []*ast.File
  69         var errlist []error
  70         for i, filename := range filenames {
  71                 file, err := parser.ParseFile(fset, filename, srcs[i], mode)
  72                 if file == nil {
  73                         t.Fatalf("%s: %s", filename, err)
  74                 }
  75                 files = append(files, file)
  76                 if err != nil {
  77                         if list, _ := err.(scanner.ErrorList); len(list) > 0 {
  78                                 for _, err := range list {
  79                                         errlist = append(errlist, err)
  80                                 }
  81                         } else {
  82                                 errlist = append(errlist, err)
  83                         }
  84                 }
  85         }
  86         return files, errlist
  87 }
  88
  89 // ERROR comments must start with text `ERROR "rx"` or `ERROR rx` where
  90 // rx is a regular expression that matches the expected error message.
  91 // Space around "rx" or rx is ignored.
  92 var errRx = regexp.MustCompile(`^ *ERROR *"?([^"]*)"?`)
  93
  94 // errMap collects the regular expressions of ERROR comments found
  95 // in files and returns them as a map of error positions to error messages.
  96 //
  97 // srcs must be a slice of the same length as files, containing the original
  98 // source for the parsed AST.
  99 func errMap(t *testing.T, files []*ast.File, srcs [][]byte) map[string][]string {
 100         // map of position strings to lists of error message patterns
 101         errmap := make(map[string][]string)
 102
 103         for i, file := range files {
 104                 tok := fset.File(file.Package)
 105                 src := srcs[i]
 106                 var s scanner.Scanner
 107                 s.Init(tok, src, nil, scanner.ScanComments)
 108                 var prev token.Pos // position of last non-comment, non-semicolon token
 109
 110         scanFile:
 111                 for {
 112                         pos, tok, lit := s.Scan()
 113                         switch tok {
 114                         case token.EOF:
 115                                 break scanFile
 116                         case token.COMMENT:
 117                                 if lit[1] == '*' {
 118                                         lit = lit[:len(lit)-2] // strip trailing */
 119                                 }
 120                                 if s := errRx.FindStringSubmatch(lit[2:]); len(s) == 2 {
 121                                         p := fset.Position(prev).String()
 122                                         errmap[p] = append(errmap[p], strings.TrimSpace(s[1]))
 123                                 }
 124                         case token.SEMICOLON:
 125                                 // ignore automatically inserted semicolon
 126                                 if lit == "\n" {
 127                                         continue scanFile
 128                                 }
 129                                 fallthrough
 130                         default:
 131                                 prev = pos
 132                         }
 133                 }
 134         }
 135
 136         return errmap
 137 }
 138
 139 func eliminate(t *testing.T, errmap map[string][]string, errlist []error) {
 140         for _, err := range errlist {
 141                 pos, gotMsg := splitError(err)
 142                 list := errmap[pos]
 143                 index := -1 // list index of matching message, if any
 144                 // we expect one of the messages in list to match the error at pos
 145                 for i, wantRx := range list {
 146                         rx, err := regexp.Compile(wantRx)
 147                         if err != nil {
 148                                 t.Errorf("%s: %v", pos, err)
 149                                 continue
 150                         }
 151                         if rx.MatchString(gotMsg) {
 152                                 index = i
 153                                 break
 154                         }
 155                 }
 156                 if index >= 0 {
 157                         // eliminate from list
 158                         if n := len(list) - 1; n > 0 {
 159                                 // not the last entry - swap in last element and shorten list by 1
 160                                 list[index] = list[n]
 161                                 errmap[pos] = list[:n]
 162                         } else {
 163                                 // last entry - remove list from map
 164                                 delete(errmap, pos)
 165                         }
 166                 } else {
 167                         t.Errorf("%s: no error expected: %q", pos, gotMsg)
 168                 }
 169         }
 170 }
 171
 172 // parseFlags parses flags from the first line of the given source
 173 // (from src if present, or by reading from the file) if the line
 174 // starts with "//" (line comment) followed by "-" (possibly with
 175 // spaces between). Otherwise the line is ignored.
 176 func parseFlags(filename string, src []byte, flags *flag.FlagSet) error {
 177         // If there is no src, read from the file.
 178         const maxLen = 256
 179         if len(src) == 0 {
 180                 f, err := os.Open(filename)
 181                 if err != nil {
 182                         return err
 183                 }
 184
 185                 var buf [maxLen]byte
 186                 n, err := f.Read(buf[:])
 187                 if err != nil {
 188                         return err
 189                 }
 190                 src = buf[:n]
 191         }
 192
 193         // we must have a line comment that starts with a "-"
 194         const prefix = "//"
 195         if !bytes.HasPrefix(src, []byte(prefix)) {
 196                 return nil // first line is not a line comment
 197         }
 198         src = src[len(prefix):]
 199         if i := bytes.Index(src, []byte("-")); i < 0 || len(bytes.TrimSpace(src[:i])) != 0 {
 200                 return nil // comment doesn't start with a "-"
 201         }
 202         end := bytes.Index(src, []byte("\n"))
 203         if end < 0 || end > maxLen {
 204                 return fmt.Errorf("flags comment line too long")
 205         }
 206
 207         return flags.Parse(strings.Fields(string(src[:end])))
 208 }
 209
 210 func testFiles(t *testing.T, sizes Sizes, filenames []string, srcs [][]byte, manual bool, imp Importer) {
 211         if len(filenames) == 0 {
 212                 t.Fatal("no source files")
 213         }
 214
 215         var conf Config
 216         conf.Sizes = sizes
 217         flags := flag.NewFlagSet("", flag.PanicOnError)
 218         flags.StringVar(&conf.GoVersion, "lang", "", "")
 219         flags.BoolVar(&conf.FakeImportC, "fakeImportC", false, "")
 220         if err := parseFlags(filenames[0], srcs[0], flags); err != nil {
 221                 t.Fatal(err)
 222         }
 223
 224         // TODO(gri) remove this or use flag mechanism to set mode if still needed
 225         if strings.HasSuffix(filenames[0], ".go1") {
 226                 // TODO(rfindley): re-enable this test by using GoVersion.
 227                 t.Skip("type params are enabled")
 228         }
 229
 230         files, errlist := parseFiles(t, filenames, srcs, parser.AllErrors)
 231
 232         pkgName := "<no package>"
 233         if len(files) > 0 {
 234                 pkgName = files[0].Name.Name
 235         }
 236
 237         listErrors := manual && !*verifyErrors
 238         if listErrors && len(errlist) > 0 {
 239                 t.Errorf("--- %s:", pkgName)
 240                 for _, err := range errlist {
 241                         t.Error(err)
 242                 }
 243         }
 244
 245         // typecheck and collect typechecker errors
 246         if imp == nil {
 247                 imp = importer.Default()
 248         }
 249         conf.Importer = imp
 250         conf.Error = func(err error) {
 251                 if *haltOnError {
 252                         defer panic(err)
 253                 }
 254                 if listErrors {
 255                         t.Error(err)
 256                         return
 257                 }
 258                 // Ignore secondary error messages starting with "\t";
 259                 // they are clarifying messages for a primary error.
 260                 if !strings.Contains(err.Error(), ": \t") {
 261                         errlist = append(errlist, err)
 262                 }
 263         }
 264         conf.Check(pkgName, fset, files, nil)
 265
 266         if listErrors {
 267                 return
 268         }
 269
 270         for _, err := range errlist {
 271                 err, ok := err.(Error)
 272                 if !ok {
 273                         continue
 274                 }
 275                 code := readCode(err)
 276                 if code == 0 {
 277                         t.Errorf("missing error code: %v", err)
 278                 }
 279         }
 280
 281         // match and eliminate errors;
 282         // we are expecting the following errors
 283         errmap := errMap(t, files, srcs)
 284         eliminate(t, errmap, errlist)
 285
 286         // there should be no expected errors left
 287         if len(errmap) > 0 {
 288                 t.Errorf("--- %s: %d source positions with expected (but not reported) errors:", pkgName, len(errmap))
 289                 for pos, list := range errmap {
 290                         for _, rx := range list {
 291                                 t.Errorf("%s: %q", pos, rx)
 292                         }
 293                 }
 294         }
 295 }
 296
 297 func readCode(err Error) int {
 298         v := reflect.ValueOf(err)
 299         return int(v.FieldByName("go116code").Int())
 300 }
 301
 302 // TestManual is for manual testing of a package - either provided
 303 // as a list of filenames belonging to the package, or a directory
 304 // name containing the package files - after the test arguments
 305 // (and a separating "--"). For instance, to test the package made
 306 // of the files foo.go and bar.go, use:
 307 //
 308 //      go test -run Manual -- foo.go bar.go
 309 //
 310 // If no source arguments are provided, the file testdata/manual.go
 311 // is used instead.
 312 // Provide the -verify flag to verify errors against ERROR comments
 313 // in the input files rather than having a list of errors reported.
 314 // The accepted Go language version can be controlled with the -lang
 315 // flag.
 316 func TestManual(t *testing.T) {
 317         testenv.MustHaveGoBuild(t)
 318
 319         filenames := flag.Args()
 320         if len(filenames) == 0 {
 321                 filenames = []string{filepath.FromSlash("testdata/manual.go")}
 322         }
 323
 324         info, err := os.Stat(filenames[0])
 325         if err != nil {
 326                 t.Fatalf("TestManual: %v", err)
 327         }
 328
 329         DefPredeclaredTestFuncs()
 330         if info.IsDir() {
 331                 if len(filenames) > 1 {
 332                         t.Fatal("TestManual: must have only one directory argument")
 333                 }
 334                 testDir(t, filenames[0], true)
 335         } else {
 336                 testPkg(t, filenames, true)
 337         }
 338 }
 339
 340 func TestLongConstants(t *testing.T) {
 341         format := "package longconst\n\nconst _ = %s /* ERROR constant overflow */ \nconst _ = %s // ERROR excessively long constant"
 342         src := fmt.Sprintf(format, strings.Repeat("1", 9999), strings.Repeat("1", 10001))
 343         testFiles(t, nil, []string{"longconst.go"}, [][]byte{[]byte(src)}, false, nil)
 344 }
 345
 346 // TestIndexRepresentability tests that constant index operands must
 347 // be representable as int even if they already have a type that can
 348 // represent larger values.
 349 func TestIndexRepresentability(t *testing.T) {
 350         const src = "package index\n\nvar s []byte\nvar _ = s[int64 /* ERROR \"int64\\(1\\) << 40 \\(.*\\) overflows int\" */ (1) << 40]"
 351         testFiles(t, &StdSizes{4, 4}, []string{"index.go"}, [][]byte{[]byte(src)}, false, nil)
 352 }
 353
 354 func TestIssue47243_TypedRHS(t *testing.T) {
 355         // The RHS of the shift expression below overflows uint on 32bit platforms,
 356         // but this is OK as it is explicitly typed.
 357         const src = "package issue47243\n\nvar a uint64; var _ = a << uint64(4294967296)" // uint64(1<<32)
 358         testFiles(t, &StdSizes{4, 4}, []string{"p.go"}, [][]byte{[]byte(src)}, false, nil)
 359 }
 360
 361 func TestCheck(t *testing.T) {
 362         DefPredeclaredTestFuncs()
 363         testDirFiles(t, "../../internal/types/testdata/check", false)
 364 }
 365 func TestSpec(t *testing.T)      { testDirFiles(t, "../../internal/types/testdata/spec", false) }
 366 func TestExamples(t *testing.T)  { testDirFiles(t, "../../internal/types/testdata/examples", false) }
 367 func TestFixedbugs(t *testing.T) { testDirFiles(t, "../../internal/types/testdata/fixedbugs", false) }
 368 func TestLocal(t *testing.T)     { testDirFiles(t, "testdata/local", false) }
 369
 370 func testDirFiles(t *testing.T, dir string, manual bool) {
 371         testenv.MustHaveGoBuild(t)
 372         dir = filepath.FromSlash(dir)
 373
 374         fis, err := os.ReadDir(dir)
 375         if err != nil {
 376                 t.Error(err)
 377                 return
 378         }
 379
 380         for _, fi := range fis {
 381                 path := filepath.Join(dir, fi.Name())
 382
 383                 // If fi is a directory, its files make up a single package.
 384                 if fi.IsDir() {
 385                         testDir(t, path, manual)
 386                 } else {
 387                         t.Run(filepath.Base(path), func(t *testing.T) {
 388                                 testPkg(t, []string{path}, manual)
 389                         })
 390                 }
 391         }
 392 }
 393
 394 func testDir(t *testing.T, dir string, manual bool) {
 395         testenv.MustHaveGoBuild(t)
 396
 397         fis, err := os.ReadDir(dir)
 398         if err != nil {
 399                 t.Error(err)
 400                 return
 401         }
 402
 403         var filenames []string
 404         for _, fi := range fis {
 405                 filenames = append(filenames, filepath.Join(dir, fi.Name()))
 406         }
 407
 408         t.Run(filepath.Base(dir), func(t *testing.T) {
 409                 testPkg(t, filenames, manual)
 410         })
 411 }
 412
 413 // TODO(rFindley) reconcile the different test setup in go/types with types2.
 414 func testPkg(t *testing.T, filenames []string, manual bool) {
 415         srcs := make([][]byte, len(filenames))
 416         for i, filename := range filenames {
 417                 src, err := os.ReadFile(filename)
 418                 if err != nil {
 419                         t.Fatalf("could not read %s: %v", filename, err)
 420                 }
 421                 srcs[i] = src
 422         }
 423         testFiles(t, nil, filenames, srcs, manual, nil)
 424 }