From 2482451f76f47707e29b19cafdcaf754badd024b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Mart=C3=AD?= <mvdan@mvdan.cc>
Date: Thu, 16 Aug 2018 14:39:13 +0100
Subject: [PATCH] cmd/vet: don't suggest ... if it breaks a program
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

It is possible to write a function that seems to wrap a print/printf
call, but then doesn't. For example, if the string parameter we thought
was the format is used as another argument.

One option would be to make vet's print analysis smarter, to detect when
format strings are indeed used like we initially suspected.

However, I've opted for a simpler solution - check if the print/printf
call is already using more than one variadic argument, in which case
using an ellipsis in the last one would break the program:

	// too many arguments in call to fmt.Printf
	fmt.Printf(format, arg0, args...)

Fixes #26979.

Change-Id: I39371f1cec8483cfd2770a91670c1e80cbb9efdf
Reviewed-on: https://go-review.googlesource.com/129575
Run-TryBot: Daniel Martí <mvdan@mvdan.cc>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Russ Cox <rsc@golang.org>
---
 src/cmd/vet/print.go          | 14 ++++++++++++++
 src/cmd/vet/testdata/print.go |  4 ++++
 2 files changed, 18 insertions(+)

diff --git a/src/cmd/vet/print.go b/src/cmd/vet/print.go
index 90fd4ed3797..a55da1d3c81 100644
--- a/src/cmd/vet/print.go
+++ b/src/cmd/vet/print.go
@@ -259,6 +259,20 @@ func checkPrintfFwd(pkg *Package, w *printfWrapper, call *ast.CallExpr, kind int
 	}
 
 	if !call.Ellipsis.IsValid() {
+		typ, ok := pkg.types[call.Fun].Type.(*types.Signature)
+		if !ok {
+			return
+		}
+		if len(call.Args) > typ.Params().Len() {
+			// If we're passing more arguments than what the
+			// print/printf function can take, adding an ellipsis
+			// would break the program. For example:
+			//
+			//   func foo(arg1 string, arg2 ...interface{} {
+			//       fmt.Printf("%s %v", arg1, arg2)
+			//   }
+			return
+		}
 		if !vcfg.VetxOnly {
 			desc := "printf"
 			if kind == kindPrint {
diff --git a/src/cmd/vet/testdata/print.go b/src/cmd/vet/testdata/print.go
index 7c0cbcf05ad..ecafed5fa2f 100644
--- a/src/cmd/vet/testdata/print.go
+++ b/src/cmd/vet/testdata/print.go
@@ -446,6 +446,10 @@ func (*ptrStringer) BadWrapf(x int, format string, args ...interface{}) string {
 	return fmt.Sprintf(format, args) // ERROR "missing ... in args forwarded to printf-like function"
 }
 
+func (*ptrStringer) WrapfFalsePositive(x int, arg1 string, arg2 ...interface{}) string {
+	return fmt.Sprintf("%s %v", arg1, arg2)
+}
+
 type embeddedStringer struct {
 	foo string
 	ptrStringer