Refactor the common package and integration_test tags
#768
Conversation
This file contains hidden or 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
The pattern of having a `common` package with a bunch of random functions thrown in is largely undesirable from a code quality standpoint. All the code presently in `common` however was related to metadata, so I renamed the package to `metadata` so no one will be tempted to throw unrelated code in there. While I was at it, I also removed the requirement for the integration_test build tag, since it wasn't really necessary for this code.
It also was unnecessary for the integration_test tag to be applied to this package. It really is only important for the tag to be on the test files.
The init function was being called erroneously, which would fail when the environment does not contain Cloud Monitoring credentials. Instead of an init, refactor it into a function that does the same thing and is called at the beginning of the program.
martijnvans
approved these changes
Jul 29, 2022
martijnvans
reviewed
Jul 29, 2022
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| //go:build integration_test |
There was a problem hiding this comment.
probably want to put this back because it's causing unit tests to fail (more init() stuff)
There was a problem hiding this comment.
Yep, I'll do that. I wish we could refactor the package to not use the init() but it's way too big to do in this PR
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.
The
commonpackage with a bunch of unrelated code is an undesirable pattern long term. Since all the code incommonis currently related to metadata, I have changed the package fromcommontometadata. While I was there, I also removed the requirement forintegration_testbuild tags from everything other than the actual files that contain integration tests.