Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

testing: document that TestMain always runs before any benchmarks #45764

Closed
ghost opened this issue Apr 26, 2021 · 2 comments
Closed

testing: document that TestMain always runs before any benchmarks #45764

ghost opened this issue Apr 26, 2021 · 2 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Backlog

Comments

@ghost
Copy link

ghost commented Apr 26, 2021

The docs for TestMain say:

It is sometimes necessary for a test program to do extra setup
or teardown before or after testing.

https://golang.org/pkg/testing/#hdr-Main

But what if one needs to do extra setup before benchmarking? It appears that TestMain would also always run before benchmarks, but neither TestMain doc nor M.Run doc say anything about benchmarks.
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Apr 26, 2021
@cherrymui cherrymui changed the title doc: document that TestMain always runs before any benchmarks testing: document that TestMain always runs before any benchmarks Apr 26, 2021
@cherrymui cherrymui added the NeedsFix The path to resolution is known, but the work has not been done. label Apr 26, 2021
@cherrymui cherrymui added this to the Backlog milestone Apr 26, 2021
@cherrymui
Copy link
Member

cc @mpvl @bcmills

JulienTant added a commit to JulienTant/go-1 that referenced this issue Apr 27, 2021
@JulienTant
document that TestMain can be used with benchmarks, fixes golang#45764
04b1551
JulienTant added a commit to JulienTant/go-1 that referenced this issue Apr 27, 2021
@JulienTant
document that TestMain can be used with benchmarks, fixes golang#45764
0941a0c
JulienTant added a commit to JulienTant/go-1 that referenced this issue Apr 27, 2021
@JulienTant
testing: document that TestMain can be used with benchmarks
8b6f838 
fixes golang#45764
@JulienTant JulienTant mentioned this issue Apr 27, 2021
Closed
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/314349 mentions this issue: testing: document that TestMain can be used with benchmarks

@golang golang locked and limited conversation to collaborators Apr 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

testing: document that TestMain can be used with benchmarks JulienTant/go-1
3 participants
@ianlancetaylor @gopherbot @cherrymui