fixing tests

Author: Aaron Loo

detect_secrets/core/audit.py

@@ -154,13 +154,19 @@ def _save_baseline_to_file(filename, data):  # pragma: no cover
 def _secret_generator(baseline):
     """Generates secrets to audit, from the baseline"""
     current_secret_index = 1
-    num_secrets_to_parse = sum(map(
-        lambda filename: len(list(filter(
-            lambda secret: not hasattr(secret, 'is_secret'),
-            baseline['results'][filename],
-        ))),
-        baseline['results'],
-    ))
+    num_secrets_to_parse = sum(
+        map(
+            lambda filename: len(
+                list(
+                    filter(
+                        lambda secret: not hasattr(secret, 'is_secret'),
+                        baseline['results'][filename],
+                    ),
+                ),
+            ),
+            baseline['results'],
+        ),
+    )
 
     for filename, secrets in baseline['results'].items():
         for secret in secrets:
@@ -171,8 +177,6 @@ def _secret_generator(baseline):
 
             current_secret_index += 1
 
-        break
-
 
 def _get_secret_with_context(
     filename,
@@ -271,6 +275,13 @@ def _highlight_secret(secret_line, secret, filename, plugin_settings):
         # We only want to highlight the right one.
         if secret_obj.secret_hash == secret['hashed_secret']:
             break
+    else:
+        raise SecretNotFoundOnSpecifiedLineError(
+            textwrap.dedent("""
+                ERROR: Secret not found on specified line number!
+                Try recreating your baseline to fix this issue.
+            """)[1:-1],
+        )
 
     index_of_secret = secret_line.index(raw_secret)
     return '{}{}{}'.format(
@@ -293,15 +304,6 @@ def _raw_secret_generator(plugin, secret_line):
             for raw_secret in plugin.secret_generator(secret_line):
                 yield raw_secret
 
-    # It hits here if the secret has been moved, from the original
-    # line number listed in the baseline.
-    raise SecretNotFoundOnSpecifiedLineError(
-        textwrap.dedent("""
-            ERROR: Secret not found on specified line number!
-            Try recreating your baseline to fix this issue.
-        """)[1:-1],
-    )
-
 
 def _get_user_decision(prompt_secret_decision=True):
     """

tests/core/audit_test.py

@@ -3,6 +3,7 @@
 import string
 import textwrap
 from contextlib import contextmanager
+from copy import deepcopy
 
 import mock
 import pytest
@@ -33,29 +34,39 @@ def test_quit_before_making_decision(self, mock_printer):
         )
 
     def test_nothing_to_audit(self, mock_printer):
-        modified_baseline = self.baseline.copy()
+        modified_baseline = deepcopy(self.baseline)
         modified_baseline['results']['filenameA'][0]['is_secret'] = True
         modified_baseline['results']['filenameA'][1]['is_secret'] = False
+        modified_baseline['results']['filenameB'][0]['is_secret'] = False
 
         with self.mock_env(baseline=modified_baseline):
             audit.audit_baseline('will_be_mocked')
 
         assert mock_printer.message == 'Nothing to audit!\n'
 
     def test_making_decisions(self, mock_printer):
-        modified_baseline = self.baseline.copy()
-        modified_baseline['results']['filenameA'][0]['is_secret'] = True
-        modified_baseline['results']['filenameA'][1]['is_secret'] = False
+        modified_baseline = deepcopy(self.baseline)
+
+        # Need to do it this way, because dictionaries are not ordered:
+        # meaning, that if we hard-code results to certain filenames, it's
+        # going to be a flakey test.
+        values_to_inject = [True, False, False]
+        for secrets in modified_baseline['results'].values():
+            for secret in secrets:
+                secret['is_secret'] = values_to_inject.pop(0)
 
-        self.run_logic(['y', 'n'], modified_baseline)
+        self.run_logic(['y', 'n', 'n'], modified_baseline)
 
         assert mock_printer.message == (
             'Saving progress...\n'
         )
 
     def test_quit_half_way(self, mock_printer):
-        modified_baseline = self.baseline.copy()
-        modified_baseline['results']['filenameA'][0]['is_secret'] = False
+        modified_baseline = deepcopy(self.baseline)
+
+        for secrets in modified_baseline['results'].values():
+            secrets[0]['is_secret'] = False
+            break
 
         self.run_logic(['n', 'q'], modified_baseline)
 
@@ -65,10 +76,16 @@ def test_quit_half_way(self, mock_printer):
         )
 
     def test_skip_decision(self, mock_printer):
-        modified_baseline = self.baseline.copy()
-        modified_baseline['results']['filenameA'][1]['is_secret'] = True
+        modified_baseline = deepcopy(self.baseline)
+
+        values_to_inject = [None, True, True]
+        for secrets in modified_baseline['results'].values():
+            for secret in secrets:
+                value = values_to_inject.pop(0)
+                if value:
+                    secret['is_secret'] = value
 
-        self.run_logic(['s', 'y'], modified_baseline)
+        self.run_logic(['s', 'y', 'y'], modified_baseline)
 
         assert mock_printer.message == (
             'Saving progress...\n'
@@ -439,17 +456,16 @@ def mock_user_input(inputs):
     :type inputs: list
     :param inputs: list of user choices
     """
-    current_case = {'index': 0}     # needed, because py2 doesn't have nonlocal
-
     class InputShim(object):
         def __init__(self):
             self.message = ''
+            self.index = 0
 
         def get_user_input(self, *args, **kwargs):
             self.message += args[0]
 
-            output = inputs[current_case['index']]
-            current_case['index'] += 1
+            output = inputs[self.index]
+            self.index += 1
 
             return output