proposal: testing: Export Name of Test or Benchmark

[sgerhardt]

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

1.7

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

windows/amd64

What did you do?

Can't get a test name without using reflection or hard-coding name.
Test name is not exported https://github.com/golang/go/blob/master/src/testing/testing.go#L269.

What did you expect to see?

The test name exported.
e.g.

func TestSomething(t *testing.T) {
    t.Log(t.Name())
...
}

What did you see instead?

Non-exported test name.

[minux]

This seems reasonable esp. because we have subtests and subbenchmarks, so getting the test name is very hard (previously it's possible to use callers, but not anymore.)

[adg]

This makes sense, but what's your use case?

[minux]

One case would be creating subtest specific file names so that files from different subtest will have distinctive file name (to ease debugging for, say, finding the test responsible for left over files, which turns out to be a big hassle for builder owners, because it's very hard to see which test left some gotest-XXXX temporary files which gradually fill up the partition.)

[sgerhardt]

My use cases are simple. I want to know what test is running when I pass test functions to utility functions, and/or want to log the name of a test for recording to external services.

[adg]

Ok, sounds good to me. Please write up a brief proposal document.

[seangerhardt-wf]

@adg Did you want a design document? As far as proposals go, it looks like this issue should be enough if I've understood the directions correctly.

The change should be very simple - don't feel like a design document is really necessary, but let me know.

Thanks,
Sean

[adg]

Well, just spec out here what the method looks like.

On 28 September 2016 at 10:35, Sean Gerhardt notifications@github.com
wrote:

@adg https://github.com/adg Did you want a design document? As far as
proposals go, it looks like this issue should be enough if I've understood
the directions correctly.

The change should be very simple - don't feel like a design document is
really necessary, but let me know.

Thanks,
Sean

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#17231 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AIDilSrVkbWga5qAwTbEVShdZc8R-crrks5qubZogaJpZM4KGFsB
.

[sgerhardt]

I was thinking we could export the field. https://github.com/golang/go/blob/master/src/testing/testing.go#L269 change nameto Name

e.g. Name string // Name of test or benchmark.

[adg]

I'd be wary of doing that, lest people change the Name in a test.
Safer would be to add a Name() string method to *testing.T and *testing.B, I think.
Care to send a CL?

[sgerhardt]

That does sound like a safer approach. What's a CL?

[adg]

A "change list" (see the contribution docs). But this is so simple that I'll do it, to save you the trouble of setting up a dev environment.

[gopherbot]

CL https://golang.org/cl/29970 mentions this issue.