Home | History | Annotate | Download | only in testdata 
      1 // Copyright 2010 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 contains tests for the printf checker.
      6 
      7 package testdata
      8 
      9 import (
     10 	"fmt"
     11 	"io"
     12 	"math"
     13 	"os"
     14 	"unsafe" // just for test case printing unsafe.Pointer
     15 
     16 	// For testing printf-like functions from external package.
     17 	"github.com/foobar/externalprintf"
     18 )
     19 
     20 func UnsafePointerPrintfTest() {
     21 	var up unsafe.Pointer
     22 	fmt.Printf("%p, %x %X", up, up, up)
     23 }
     24 
     25 // Error methods that do not satisfy the Error interface and should be checked.
     26 type errorTest1 int
     27 
     28 func (errorTest1) Error(...interface{}) string {
     29 	return "hi"
     30 }
     31 
     32 type errorTest2 int // Analogous to testing's *T type.
     33 func (errorTest2) Error(...interface{}) {
     34 }
     35 
     36 type errorTest3 int
     37 
     38 func (errorTest3) Error() { // No return value.
     39 }
     40 
     41 type errorTest4 int
     42 
     43 func (errorTest4) Error() int { // Different return type.
     44 	return 3
     45 }
     46 
     47 type errorTest5 int
     48 
     49 func (errorTest5) error() { // niladic; don't complain if no args (was bug)
     50 }
     51 
     52 // This function never executes, but it serves as a simple test for the program.
     53 // Test with make test.
     54 func PrintfTests() {
     55 	var b bool
     56 	var i int
     57 	var r rune
     58 	var s string
     59 	var x float64
     60 	var p *int
     61 	var imap map[int]int
     62 	var fslice []float64
     63 	var c complex64
     64 	// Some good format/argtypes
     65 	fmt.Printf("")
     66 	fmt.Printf("%b %b %b", 3, i, x)
     67 	fmt.Printf("%c %c %c %c", 3, i, 'x', r)
     68 	fmt.Printf("%d %d %d", 3, i, imap)
     69 	fmt.Printf("%e %e %e %e", 3e9, x, fslice, c)
     70 	fmt.Printf("%E %E %E %E", 3e9, x, fslice, c)
     71 	fmt.Printf("%f %f %f %f", 3e9, x, fslice, c)
     72 	fmt.Printf("%F %F %F %F", 3e9, x, fslice, c)
     73 	fmt.Printf("%g %g %g %g", 3e9, x, fslice, c)
     74 	fmt.Printf("%G %G %G %G", 3e9, x, fslice, c)
     75 	fmt.Printf("%b %b %b %b", 3e9, x, fslice, c)
     76 	fmt.Printf("%o %o", 3, i)
     77 	fmt.Printf("%p %p", p, nil)
     78 	fmt.Printf("%q %q %q %q", 3, i, 'x', r)
     79 	fmt.Printf("%s %s %s", "hi", s, []byte{65})
     80 	fmt.Printf("%t %t", true, b)
     81 	fmt.Printf("%T %T", 3, i)
     82 	fmt.Printf("%U %U", 3, i)
     83 	fmt.Printf("%v %v", 3, i)
     84 	fmt.Printf("%x %x %x %x", 3, i, "hi", s)
     85 	fmt.Printf("%X %X %X %X", 3, i, "hi", s)
     86 	fmt.Printf("%.*s %d %g", 3, "hi", 23, 2.3)
     87 	fmt.Printf("%s", &stringerv)
     88 	fmt.Printf("%v", &stringerv)
     89 	fmt.Printf("%T", &stringerv)
     90 	fmt.Printf("%v", notstringerv)
     91 	fmt.Printf("%T", notstringerv)
     92 	fmt.Printf("%q", stringerarrayv)
     93 	fmt.Printf("%v", stringerarrayv)
     94 	fmt.Printf("%s", stringerarrayv)
     95 	fmt.Printf("%v", notstringerarrayv)
     96 	fmt.Printf("%T", notstringerarrayv)
     97 	fmt.Printf("%d", new(Formatter))
     98 	fmt.Printf("%*%", 2)               // Ridiculous but allowed.
     99 	fmt.Printf("%s", interface{}(nil)) // Nothing useful we can say.
    100 
    101 	fmt.Printf("%g", 1+2i)
    102 	// Some bad format/argTypes
    103 	fmt.Printf("%b", "hi")                     // ERROR "arg .hi. for printf verb %b of wrong type"
    104 	fmt.Printf("%t", c)                        // ERROR "arg c for printf verb %t of wrong type"
    105 	fmt.Printf("%t", 1+2i)                     // ERROR "arg 1 \+ 2i for printf verb %t of wrong type"
    106 	fmt.Printf("%c", 2.3)                      // ERROR "arg 2.3 for printf verb %c of wrong type"
    107 	fmt.Printf("%d", 2.3)                      // ERROR "arg 2.3 for printf verb %d of wrong type"
    108 	fmt.Printf("%e", "hi")                     // ERROR "arg .hi. for printf verb %e of wrong type"
    109 	fmt.Printf("%E", true)                     // ERROR "arg true for printf verb %E of wrong type"
    110 	fmt.Printf("%f", "hi")                     // ERROR "arg .hi. for printf verb %f of wrong type"
    111 	fmt.Printf("%F", 'x')                      // ERROR "arg 'x' for printf verb %F of wrong type"
    112 	fmt.Printf("%g", "hi")                     // ERROR "arg .hi. for printf verb %g of wrong type"
    113 	fmt.Printf("%g", imap)                     // ERROR "arg imap for printf verb %g of wrong type"
    114 	fmt.Printf("%G", i)                        // ERROR "arg i for printf verb %G of wrong type"
    115 	fmt.Printf("%o", x)                        // ERROR "arg x for printf verb %o of wrong type"
    116 	fmt.Printf("%p", 23)                       // ERROR "arg 23 for printf verb %p of wrong type"
    117 	fmt.Printf("%q", x)                        // ERROR "arg x for printf verb %q of wrong type"
    118 	fmt.Printf("%s", b)                        // ERROR "arg b for printf verb %s of wrong type"
    119 	fmt.Printf("%s", byte(65))                 // ERROR "arg byte\(65\) for printf verb %s of wrong type"
    120 	fmt.Printf("%t", 23)                       // ERROR "arg 23 for printf verb %t of wrong type"
    121 	fmt.Printf("%U", x)                        // ERROR "arg x for printf verb %U of wrong type"
    122 	fmt.Printf("%x", nil)                      // ERROR "arg nil for printf verb %x of wrong type"
    123 	fmt.Printf("%X", 2.3)                      // ERROR "arg 2.3 for printf verb %X of wrong type"
    124 	fmt.Printf("%s", stringerv)                // ERROR "arg stringerv for printf verb %s of wrong type"
    125 	fmt.Printf("%t", stringerv)                // ERROR "arg stringerv for printf verb %t of wrong type"
    126 	fmt.Printf("%q", notstringerv)             // ERROR "arg notstringerv for printf verb %q of wrong type"
    127 	fmt.Printf("%t", notstringerv)             // ERROR "arg notstringerv for printf verb %t of wrong type"
    128 	fmt.Printf("%t", stringerarrayv)           // ERROR "arg stringerarrayv for printf verb %t of wrong type"
    129 	fmt.Printf("%t", notstringerarrayv)        // ERROR "arg notstringerarrayv for printf verb %t of wrong type"
    130 	fmt.Printf("%q", notstringerarrayv)        // ERROR "arg notstringerarrayv for printf verb %q of wrong type"
    131 	fmt.Printf("%d", Formatter(true))          // ERROR "arg Formatter\(true\) for printf verb %d of wrong type: testdata.Formatter"
    132 	fmt.Printf("%z", FormatterVal(true))       // correct (the type is responsible for formatting)
    133 	fmt.Printf("%d", FormatterVal(true))       // correct (the type is responsible for formatting)
    134 	fmt.Printf("%s", nonemptyinterface)        // correct (the type is responsible for formatting)
    135 	fmt.Printf("%.*s %d %g", 3, "hi", 23, 'x') // ERROR "arg 'x' for printf verb %g of wrong type"
    136 	fmt.Println()                              // not an error
    137 	fmt.Println("%s", "hi")                    // ERROR "possible formatting directive in Println call"
    138 	fmt.Println("0.0%")                        // correct (trailing % couldn't be a formatting directive)
    139 	fmt.Printf("%s", "hi", 3)                  // ERROR "wrong number of args for format in Printf call"
    140 	_ = fmt.Sprintf("%"+("s"), "hi", 3)        // ERROR "wrong number of args for format in Sprintf call"
    141 	fmt.Printf("%s%%%d", "hi", 3)              // correct
    142 	fmt.Printf("%08s", "woo")                  // correct
    143 	fmt.Printf("% 8s", "woo")                  // correct
    144 	fmt.Printf("%.*d", 3, 3)                   // correct
    145 	fmt.Printf("%.*d", 3, 3, 3, 3)             // ERROR "wrong number of args for format in Printf call.*4 args"
    146 	fmt.Printf("%.*d", "hi", 3)                // ERROR "arg .hi. for \* in printf format not of type int"
    147 	fmt.Printf("%.*d", i, 3)                   // correct
    148 	fmt.Printf("%.*d", s, 3)                   // ERROR "arg s for \* in printf format not of type int"
    149 	fmt.Printf("%*%", 0.22)                    // ERROR "arg 0.22 for \* in printf format not of type int"
    150 	fmt.Printf("%q %q", multi()...)            // ok
    151 	fmt.Printf("%#q", `blah`)                  // ok
    152 	printf("now is the time", "buddy")         // ERROR "no formatting directive"
    153 	Printf("now is the time", "buddy")         // ERROR "no formatting directive"
    154 	Printf("hi")                               // ok
    155 	const format = "%s %s\n"
    156 	Printf(format, "hi", "there")
    157 	Printf(format, "hi")              // ERROR "missing argument for Printf..%s..: format reads arg 2, have only 1"
    158 	Printf("%s %d %.3v %q", "str", 4) // ERROR "missing argument for Printf..%.3v..: format reads arg 3, have only 2"
    159 	f := new(stringer)
    160 	f.Warn(0, "%s", "hello", 3)  // ERROR "possible formatting directive in Warn call"
    161 	f.Warnf(0, "%s", "hello", 3) // ERROR "wrong number of args for format in Warnf call"
    162 	f.Warnf(0, "%r", "hello")    // ERROR "unrecognized printf verb"
    163 	f.Warnf(0, "%#s", "hello")   // ERROR "unrecognized printf flag"
    164 	Printf("d%", 2)              // ERROR "missing verb at end of format string in Printf call"
    165 	Printf("%d", percentDV)
    166 	Printf("%d", &percentDV)
    167 	Printf("%d", notPercentDV)  // ERROR "arg notPercentDV for printf verb %d of wrong type"
    168 	Printf("%d", &notPercentDV) // ERROR "arg &notPercentDV for printf verb %d of wrong type"
    169 	Printf("%p", &notPercentDV) // Works regardless: we print it as a pointer.
    170 	Printf("%s", percentSV)
    171 	Printf("%s", &percentSV)
    172 	// Good argument reorderings.
    173 	Printf("%[1]d", 3)
    174 	Printf("%[1]*d", 3, 1)
    175 	Printf("%[2]*[1]d", 1, 3)
    176 	Printf("%[2]*.[1]*[3]d", 2, 3, 4)
    177 	fmt.Fprintf(os.Stderr, "%[2]*.[1]*[3]d", 2, 3, 4) // Use Fprintf to make sure we count arguments correctly.
    178 	// Bad argument reorderings.
    179 	Printf("%[xd", 3)                    // ERROR "bad syntax for printf argument index: \[xd\]"
    180 	Printf("%[x]d", 3)                   // ERROR "bad syntax for printf argument index: \[x\]"
    181 	Printf("%[3]*s", "hi", 2)            // ERROR "missing argument for Printf.* reads arg 3, have only 2"
    182 	_ = fmt.Sprintf("%[3]d", 2)          // ERROR "missing argument for Sprintf.* reads arg 3, have only 1"
    183 	Printf("%[2]*.[1]*[3]d", 2, "hi", 4) // ERROR "arg .hi. for \* in printf format not of type int"
    184 	Printf("%[0]s", "arg1")              // ERROR "index value \[0\] for Printf.*; indexes start at 1"
    185 	Printf("%[0]d", 1)                   // ERROR "index value \[0\] for Printf.*; indexes start at 1"
    186 	// Something that satisfies the error interface.
    187 	var e error
    188 	fmt.Println(e.Error()) // ok
    189 	// Something that looks like an error interface but isn't, such as the (*T).Error method
    190 	// in the testing package.
    191 	var et1 errorTest1
    192 	fmt.Println(et1.Error())        // ok
    193 	fmt.Println(et1.Error("hi"))    // ok
    194 	fmt.Println(et1.Error("%d", 3)) // ERROR "possible formatting directive in Error call"
    195 	var et2 errorTest2
    196 	et2.Error()        // ok
    197 	et2.Error("hi")    // ok, not an error method.
    198 	et2.Error("%d", 3) // ERROR "possible formatting directive in Error call"
    199 	var et3 errorTest3
    200 	et3.Error() // ok, not an error method.
    201 	var et4 errorTest4
    202 	et4.Error() // ok, not an error method.
    203 	var et5 errorTest5
    204 	et5.error() // ok, not an error method.
    205 	// Interfaces can be used with any verb.
    206 	var iface interface {
    207 		ToTheMadness() bool // Method ToTheMadness usually returns false
    208 	}
    209 	fmt.Printf("%f", iface) // ok: fmt treats interfaces as transparent and iface may well have a float concrete type
    210 	// Can't print a function.
    211 	Printf("%d", someFunction) // ERROR "arg someFunction in printf call is a function value, not a function call"
    212 	Printf("%v", someFunction) // ERROR "arg someFunction in printf call is a function value, not a function call"
    213 	Println(someFunction)      // ERROR "arg someFunction in Println call is a function value, not a function call"
    214 	Printf("%p", someFunction) // ok: maybe someone wants to see the pointer
    215 	Printf("%T", someFunction) // ok: maybe someone wants to see the type
    216 	// Bug: used to recur forever.
    217 	Printf("%p %x", recursiveStructV, recursiveStructV.next)
    218 	Printf("%p %x", recursiveStruct1V, recursiveStruct1V.next)
    219 	Printf("%p %x", recursiveSliceV, recursiveSliceV)
    220 	Printf("%p %x", recursiveMapV, recursiveMapV)
    221 	// Special handling for Log.
    222 	math.Log(3)  // OK
    223 	Log(3)       // OK
    224 	Log("%d", 3) // ERROR "possible formatting directive in Log call"
    225 	Logf("%d", 3)
    226 	Logf("%d", "hi") // ERROR "arg .hi. for printf verb %d of wrong type: string"
    227 
    228 	Errorf(1, "%d", 3)    // OK
    229 	Errorf(1, "%d", "hi") // ERROR "arg .hi. for printf verb %d of wrong type: string"
    230 
    231 	// Multiple string arguments before variadic args
    232 	errorf("WARNING", "foobar")            // OK
    233 	errorf("INFO", "s=%s, n=%d", "foo", 1) // OK
    234 	errorf("ERROR", "%d")                  // ERROR "format reads arg 1, have only 0 args"
    235 
    236 	// Printf from external package
    237 	externalprintf.Printf("%d", 42) // OK
    238 	externalprintf.Printf("foobar") // OK
    239 	level := 123
    240 	externalprintf.Logf(level, "%d", 42)                        // OK
    241 	externalprintf.Errorf(level, level, "foo %q bar", "foobar") // OK
    242 	externalprintf.Logf(level, "%d")                            // ERROR "format reads arg 1, have only 0 args"
    243 	var formatStr = "%s %s"
    244 	externalprintf.Sprintf(formatStr, "a", "b")     // OK
    245 	externalprintf.Logf(level, formatStr, "a", "b") // OK
    246 
    247 	// user-defined Println-like functions
    248 	ss := &someStruct{}
    249 	ss.Log(someFunction, "foo")          // OK
    250 	ss.Error(someFunction, someFunction) // OK
    251 	ss.Println()                         // OK
    252 	ss.Println(1.234, "foo")             // OK
    253 	ss.Println(1, someFunction)          // ERROR "arg someFunction in Println call is a function value, not a function call"
    254 	ss.log(someFunction)                 // OK
    255 	ss.log(someFunction, "bar", 1.33)    // OK
    256 	ss.log(someFunction, someFunction)   // ERROR "arg someFunction in log call is a function value, not a function call"
    257 
    258 	// indexed arguments
    259 	Printf("%d %[3]d %d %[2]d", 1, 2, 3, 4)             // OK
    260 	Printf("%d %[0]d %d %[2]d", 1, 2, 3, 4)             // ERROR "indexes start at 1"
    261 	Printf("%d %[3]d %d %[-2]d", 1, 2, 3, 4)            // ERROR "bad syntax for printf argument index: \[-2\]"
    262 	Printf("%d %[3]d %d %[2234234234234]d", 1, 2, 3, 4) // ERROR "bad syntax for printf argument index: .+ value out of range"
    263 	Printf("%d %[3]d %d %[2]d", 1, 2, 3)                // ERROR "format reads arg 4, have only 3 args"
    264 	Printf("%d %[3]d %d %[2]d", 1, 2, 3, 4, 5)          // ERROR "wrong number of args for format in Printf call: 4 needed but 5 args"
    265 	Printf("%[1][3]d", 1, 2)                            // ERROR "unrecognized printf verb '\['"
    266 }
    267 
    268 type someStruct struct{}
    269 
    270 // Log is non-variadic user-define Println-like function.
    271 // Calls to this func must be skipped when checking
    272 // for Println-like arguments.
    273 func (ss *someStruct) Log(f func(), s string) {}
    274 
    275 // Error is variadic user-define Println-like function.
    276 // Calls to this func mustn't be checked for Println-like arguments,
    277 // since variadic arguments type isn't interface{}.
    278 func (ss *someStruct) Error(args ...func()) {}
    279 
    280 // Println is variadic user-defined Println-like function.
    281 // Calls to this func must be checked for Println-like arguments.
    282 func (ss *someStruct) Println(args ...interface{}) {}
    283 
    284 // log is variadic user-defined Println-like function.
    285 // Calls to this func must be checked for Println-like arguments.
    286 func (ss *someStruct) log(f func(), args ...interface{}) {}
    287 
    288 // A function we use as a function value; it has no other purpose.
    289 func someFunction() {}
    290 
    291 // Printf is used by the test so we must declare it.
    292 func Printf(format string, args ...interface{}) {
    293 	panic("don't call - testing only")
    294 }
    295 
    296 // Println is used by the test so we must declare it.
    297 func Println(args ...interface{}) {
    298 	panic("don't call - testing only")
    299 }
    300 
    301 // Logf is used by the test so we must declare it.
    302 func Logf(format string, args ...interface{}) {
    303 	panic("don't call - testing only")
    304 }
    305 
    306 // Log is used by the test so we must declare it.
    307 func Log(args ...interface{}) {
    308 	panic("don't call - testing only")
    309 }
    310 
    311 // printf is used by the test so we must declare it.
    312 func printf(format string, args ...interface{}) {
    313 	panic("don't call - testing only")
    314 }
    315 
    316 // Errorf is used by the test for a case in which the first parameter
    317 // is not a format string.
    318 func Errorf(i int, format string, args ...interface{}) {
    319 	panic("don't call - testing only")
    320 }
    321 
    322 // errorf is used by the test for a case in which the function accepts multiple
    323 // string parameters before variadic arguments
    324 func errorf(level, format string, args ...interface{}) {
    325 	panic("don't call - testing only")
    326 }
    327 
    328 // multi is used by the test.
    329 func multi() []interface{} {
    330 	panic("don't call - testing only")
    331 }
    332 
    333 type stringer float64
    334 
    335 var stringerv stringer
    336 
    337 func (*stringer) String() string {
    338 	return "string"
    339 }
    340 
    341 func (*stringer) Warn(int, ...interface{}) string {
    342 	return "warn"
    343 }
    344 
    345 func (*stringer) Warnf(int, string, ...interface{}) string {
    346 	return "warnf"
    347 }
    348 
    349 type notstringer struct {
    350 	f float64
    351 }
    352 
    353 var notstringerv notstringer
    354 
    355 type stringerarray [4]float64
    356 
    357 func (stringerarray) String() string {
    358 	return "string"
    359 }
    360 
    361 var stringerarrayv stringerarray
    362 
    363 type notstringerarray [4]float64
    364 
    365 var notstringerarrayv notstringerarray
    366 
    367 var nonemptyinterface = interface {
    368 	f()
    369 }(nil)
    370 
    371 // A data type we can print with "%d".
    372 type percentDStruct struct {
    373 	a int
    374 	b []byte
    375 	c *float64
    376 }
    377 
    378 var percentDV percentDStruct
    379 
    380 // A data type we cannot print correctly with "%d".
    381 type notPercentDStruct struct {
    382 	a int
    383 	b []byte
    384 	c bool
    385 }
    386 
    387 var notPercentDV notPercentDStruct
    388 
    389 // A data type we can print with "%s".
    390 type percentSStruct struct {
    391 	a string
    392 	b []byte
    393 	c stringerarray
    394 }
    395 
    396 var percentSV percentSStruct
    397 
    398 type recursiveStringer int
    399 
    400 func (s recursiveStringer) String() string {
    401 	_ = fmt.Sprintf("%d", s)
    402 	_ = fmt.Sprintf("%#v", s)
    403 	_ = fmt.Sprintf("%v", s)  // ERROR "arg s for printf causes recursive call to String method"
    404 	_ = fmt.Sprintf("%v", &s) // ERROR "arg &s for printf causes recursive call to String method"
    405 	_ = fmt.Sprintf("%T", s)  // ok; does not recursively call String
    406 	return fmt.Sprintln(s)    // ERROR "arg s in Sprintln call causes recursive call to String method"
    407 }
    408 
    409 type recursivePtrStringer int
    410 
    411 func (p *recursivePtrStringer) String() string {
    412 	_ = fmt.Sprintf("%v", *p)
    413 	return fmt.Sprintln(p) // ERROR "arg p in Sprintln call causes recursive call to String method"
    414 }
    415 
    416 type Formatter bool
    417 
    418 func (*Formatter) Format(fmt.State, rune) {
    419 }
    420 
    421 // Formatter with value receiver
    422 type FormatterVal bool
    423 
    424 func (FormatterVal) Format(fmt.State, rune) {
    425 }
    426 
    427 type RecursiveSlice []RecursiveSlice
    428 
    429 var recursiveSliceV = &RecursiveSlice{}
    430 
    431 type RecursiveMap map[int]RecursiveMap
    432 
    433 var recursiveMapV = make(RecursiveMap)
    434 
    435 type RecursiveStruct struct {
    436 	next *RecursiveStruct
    437 }
    438 
    439 var recursiveStructV = &RecursiveStruct{}
    440 
    441 type RecursiveStruct1 struct {
    442 	next *Recursive2Struct
    443 }
    444 
    445 type RecursiveStruct2 struct {
    446 	next *Recursive1Struct
    447 }
    448 
    449 var recursiveStruct1V = &RecursiveStruct1{}
    450 
    451 // Fix for issue 7149: Missing return type on String method caused fault.
    452 func (int) String() {
    453 	return ""
    454 }
    455 
    456 func (s *unknownStruct) Fprintln(w io.Writer, s string) {}
    457 
    458 func UnknownStructFprintln() {
    459 	s := unknownStruct{}
    460 	s.Fprintln(os.Stdout, "hello, world!") // OK
    461 }
    462