Don't run AZ token on planfiles (#248)

Author: tsmithv11

detect_secrets/plugins/azure_storage_key.py

@@ -56,7 +56,7 @@ def analyze_line(
             filename=filename, line=line, line_number=line_number,
             context=context, raw_context=raw_context, **kwargs,
         )
-        output.update(self.analyze_context_keys(results, context, line))
+        output.update(self.analyze_context_keys(results, context, line, filename))
 
         return output
 
@@ -65,9 +65,17 @@ def analyze_context_keys(
             results: Set[PotentialSecret],
             context: Optional[CodeSnippet],
             line: str,
+            filename: str,
     ) -> List[PotentialSecret]:
         context_text = '\n'.join(context.lines).replace('\n\n', '\n') if context else line
-        return [result for result in results if self.context_keys_exists(result, context_text)]
+        return [
+            result for result in results if self.context_keys_exists(result, context_text) and
+                self.should_analyze_file(filename)
+        ]
+
+    def should_analyze_file(self, filename: str) -> bool:
+        excluded_files = {'tfplan.json', 'planfile.json'}
+        return filename.split('/')[-1] not in excluded_files
 
     def context_keys_exists(self, result: PotentialSecret, string: str) -> bool:
         if len(string) > self.max_line_length:

tests/plugins/azure_storage_key_test.py

@@ -220,3 +220,10 @@ class TestAzureStorageKeyDetector:
     def test_analyze(self, payload, should_flag):
         logic = AzureStorageKeyDetector()
         assert bool(logic.analyze_line(filename='mock_filename', line=payload)) == should_flag
+
+    def test_analyze_tfplan_json(self):
+        logic = AzureStorageKeyDetector()
+        payload = 'AccountKey=lJzRc1YdHaAA2KCNJJ1tkYwF/+mKK6Ygw0NGe170Xu592euJv2wYUtBlV8z+qnlcNQSnIYVTkLWntUO1F8j8rQ=='
+        # Flag if not planfile, don't if it is
+        assert logic.analyze_line(filename='mock_filename', line=payload)
+        assert not logic.analyze_line(filename='tfplan.json', line=payload)