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