fix: handle empty files in --only-allowlisted scan#949
Open
ReGenDevOps wants to merge 1 commit intoYelp:masterfrom
Open
fix: handle empty files in --only-allowlisted scan#949ReGenDevOps wants to merge 1 commit intoYelp:masterfrom
ReGenDevOps wants to merge 1 commit intoYelp:masterfrom
Conversation
_scan_for_allowlisted_secrets_in_lines() calls zip(*lines) which raises ValueError when lines is an empty iterable (e.g. scanning an empty file or an empty diff chunk). Materialize the iterable to a list first and return early if empty. Fixes: ValueError: not enough values to unpack (expected 2, got 0) when running: detect-secrets scan --only-allowlisted
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.
Problem
detect-secrets scan --only-allowlistedcrashes with aValueErrorwhen it encounters an empty file:Traceback:
Root Cause
_scan_for_allowlisted_secrets_in_lines()callszip(*lines)directly. Whenlinesis an empty iterable (from an empty file or an empty diff chunk),zip()returns an empty tuple which cannot be unpacked into two variables.Fix
Materialize the iterable into a list first and return early if empty. This is semantically correct — an empty file cannot contain any allowlisted secrets.
Testing
test_handles_empty_file_for_allowlisted_scantotests/core/scan_test.py.pyfiles and full project scansEnvironment