This repository was archived by the owner on Dec 12, 2025. It is now read-only.
CLOUDP-302068: Add a linter to forbid env var usage#1690
Merged
m1kola merged 2 commits intomongodb:masterfrom Mar 12, 2025
Merged
CLOUDP-302068: Add a linter to forbid env var usage#1690m1kola merged 2 commits intomongodb:masterfrom
m1kola merged 2 commits intomongodb:masterfrom
Conversation
We want to avoid spreading the practice of accessing environment variables deep in the call hierarchy. We only want to access env vars in the `main` package or very close to it. This commit adds a linter to help us with that. It also adds `nolint:forbidigo` exceptions into places: * Where we allow access (`main` package) * Where we still unfortunately have access. These places ideally need to change with time. To find remaining undesired places, from repo root you can `grep` all files for `nolint:forbidigo` excluding files with `main` package. For example: `grep "nolint:forbidigo" --exclude main.go -r .`
m1kola
added
the
safe-to-test
m1kola
requested review from
Julien-Ben,
MaciejKaras,
fealebenpae,
lsierant,
lucian-tosa,
mircea-cosbuc and
nammn
as code owners
Julien-Ben
approved these changes
Mar 12, 2025
nammn
reviewed
Mar 12, 2025
cmd/manager/main.go
Outdated
| allPresent := true | ||
| for _, envVariable := range envVariables { | ||
| if _, envSpecified := os.LookupEnv(envVariable); !envSpecified { | ||
| if _, envSpecified := os.LookupEnv(envVariable); !envSpecified { // nolint:forbidigo |
Collaborator
There was a problem hiding this comment.
q: I thought we are fine with all files named main.go to keep the env var usage? If yes, could we exclude the whole file instead of single lines? Or is that on purpose here?
Collaborator
Author
There was a problem hiding this comment.
@nammn I considered doing this, but as far as I understand it is only possible to exclude whole linter. It is not an issue right now because we only use forbidigo only for env vars right now. But in the future we decide to use forbidigo for something else main.go will become a blind spot for this linter.
What do you think - still worth adding an exception for main.go?
Collaborator
There was a problem hiding this comment.
I think its better to skip the whole file for now and in case we add more linters we can revisit this decision.
Collaborator
Author
m1kola
added
safe-to-test
m1kola
added
safe-to-test
nammn
approved these changes
Mar 12, 2025
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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:
We want to avoid spreading the practice of accessing environment variables deep in the call hierarchy. We only want to access env vars in the
mainpackage or very close to it.This commit adds a linter to help us with that. It also adds
nolint:forbidigoexceptions into places where we still unfortunately have access. These places ideally need to change with time.To find remaining undesired places, from repo root you can
grepall files fornolint:forbidigo. For example:grep "nolint:forbidigo" -r .All Submissions:
closes #XXXXin your comment to auto-close the issue that your PR fixes (if such).