cmd/cover: use different //line comment for code that does not come from source file

[linzhp]

What version of Go are you using (go version)?

go version go1.10.1 darwin/amd64

Does this issue reproduce with the latest release?

Yes

What operating system and processor architecture are you using (go env)?

GOARCH="amd64"
GOEXE=""
GOHOSTARCH="amd64"
GOHOSTOS="darwin"
GOOS="darwin"
GORACE=""
GOTMPDIR=""
GCCGO="gccgo"
CC="clang"
CXX="clang++"
CGO_ENABLED="1"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/m6/vs051rl54k3_sgxr94ylcz5h0000gn/T/go-build238749509=/tmp/go-build -gno-record-gcc-switches -fno-common"

What did you do?

git clone [email protected]:linzhp/go_examples.git
cd go_examples/hyphen
go tool cover -mode set -var Var_power-driven -o power-driven-gen.go power-driven.go
go run main.go

What did you expect to see?

An error pointing to the right line of power-driven-gen.go

What did you see instead?

power-driven.go:7:14: expected ';', found '-'

However, power-driven.go has less than 7 lines.

[ianlancetaylor]

The go/parser package is working correctly. The error occurs in new code added by the cover tool. The cover tool should add a new //line comment for that code, so that it does not get misattributed to the original file.

In this case the bug is, of course, using a -var option with a name that is not a valid Go identifier. The cover tool could perhaps check for that too.

[nodo]

Hey @ianlancetaylor, I would like to start contributing to Go. I would be interested in working on this if that's OK for you. What do you think?

[ianlancetaylor]

@nodo Sure, thanks.

[linzhp]

Thanks @nodo

[nodo]

@ianlancetaylor I have started to look at the issue and I have a couple of doubts.

In order to check that the string passed using -var is a valid Go identifier I considered using https://golang.org/pkg/go/scanner and check if the output of the scanner is exactly one identifier. If that is the case, then the option is valid.

Another possibility would be to match the string against a regex that matches https://golang.org/ref/spec#Identifiers.

What do you think about these solutions? Are there other options?

[ianlancetaylor]

@nodo A valid Go identifier is defined by the language spec at https://golang.org/ref/spec#Identifiers. It's easy enough to write a function for that, something like:

first := true
for _, c := range ident {
    if !unicode.IsLetter(c) && c != '_' && (first || !unicode.IsDigit(c)) {
        return false // invalid identifier
    }
    first = false
}

[nodo]

Awesome! Thanks @ianlancetaylor , I will continue that way.

[gopherbot]

Change https://golang.org/cl/120316 mentions this issue: cmd/cover: check that the argument of -var is valid

[nodo]

@ianlancetaylor I have added a first CL with the check that the argument of -var is a valid go identifier. WDYT?

[gopherbot]

Change https://golang.org/cl/153500 mentions this issue: cmd/cover: simplify and correct isValidIdentifier