Refactor a test function and remove a test helper #2977
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Removing the need to cast the function.
We call this a lot in tests, and we can avoid passing in the registry each time by including it on the struct. The next commit will remove the argument from all the callers.
It now comes from a field on the method receiver.
The caches were removed in a previous commit.
dnephin
requested review from
ssoroka,
BruceMacD,
jmorganca,
pdevine and
kimskimchi
as code owners
BruceMacD
reviewed
Aug 19, 2022
|
|
||
| httpErrorLog := log.New(logging.NewFilteredHTTPLogger(), "", 0) | ||
| metricsServer := &http.Server{ | ||
| ReadHeaderTimeout: 30 * time.Second, | ||
| ReadTimeout: 60 * time.Second, | ||
| Addr: s.options.Addr.Metrics, | ||
| Handler: metrics.NewHandler(promRegistry), | ||
| Handler: metrics.NewHandler(s.metricsRegistry), |
There was a problem hiding this comment.
Seems like we should handle the possibility of this value being nil in the metrics functions. Feels like a likely nil pointer de-reference.
There was a problem hiding this comment.
In what scenario would we expect the metrics registry to be nil?
In production we set this to a value in server.New, so it can't ever be nil. I think for this to be nil it would have to be a programming error, which should panic.
ssoroka
approved these changes
Aug 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Best viewed by individual commit.
This PR:
TestRequireAccessKeytest case to use atestCasestruct, removing the need to cast theinterface{}to a functionprometheus.Registryarg fromServer.GenerateRoutes. We call this in many tests, and it can receive the registry from a field on the serverdata.InvalidateCache, which was used in tests, but we removed the caches in a previous commit, so we no longer need to invalidate them. In the future if we want to cache these references we can use thedata.DBstruct which is different for each test, so we shouldn't need to invalidate the cache.