Repository navigation
fix(secrets): judge test code on a file's path in the project - #255
Merged
Merged
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
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
hardcoded-credentialandconfig-secretsclassified the absolute path. A project under a directory namedtest,tests,testing,fixturesor__tests__had every credential at low confidence, as test code. Its template files were labelledtestinstead ofexample.As proposed in #253 (first direction), the rule keeps the decision and is given the file's path in the project:
findings.context.path_in_projectis the single rule for "the path from the root". The engine uses it for the context of findings: test code is recognised only by hardcoded-credential #244, and so do the plugins.PluginContext.path(source_id)gives that path to module plugins;run_pluginstakes an optional root. This is an additive API change: callers without a root keep their behaviour.SecretDetector.judgetakes the path in the project.hardcoded-credentialreads it fromctx.path, andconfig-secretscomputes it fromctx.root.credential_contextis unchanged.Verdicts change only for projects located under such a directory: that is the fix.
Verification
tests/test_credential_project_path.py, new: 5 tests, 3 of which fail on main. They cover:-j 1and-j 2;.env.example, which keep the lower confidence;No existing test changed.
Full suite green, apart from the local
test_packagingmetadata issue.ruff checkandmypyclean. Regression snapshots unchanged.Closes #253