🐛 Fix extra newline from print

By not adding a newline in format_baseline_for_output
And adding the newline in a commonly used write_baseline_to_file function

Author: KevinHock

detect_secrets/core/audit.py

@@ -11,11 +11,11 @@
 from ..plugins.high_entropy_strings import HighEntropyStringsPlugin
 from ..plugins.keyword import determine_file_type
 from ..plugins.keyword import KeywordDetector
-from .baseline import format_baseline_for_output
 from .baseline import merge_results
 from .bidirectional_iterator import BidirectionalIterator
 from .color import AnsiColor
 from .color import colorize
+from .common import write_baseline_to_file
 from .potential_secret import PotentialSecret
 
 
@@ -87,7 +87,10 @@ def audit_baseline(baseline_filename):
         original_baseline['results'],
         dict(results),
     )
-    _save_baseline_to_file(baseline_filename, original_baseline)
+    write_baseline_to_file(
+        baseline_filename,
+        original_baseline,
+    )
 
 
 def compare_baselines(old_baseline_filename, new_baseline_filename):
@@ -420,11 +423,6 @@ def _handle_user_decision(decision, secret):
         del secret['is_secret']
 
 
-def _save_baseline_to_file(filename, data):  # pragma: no cover
-    with open(filename, 'w') as f:
-        f.write(format_baseline_for_output(data))
-
-
 def _get_secret_with_context(
     filename,
     secret,

detect_secrets/core/baseline.py

@@ -231,7 +231,7 @@ def format_baseline_for_output(baseline):
         indent=2,
         sort_keys=True,
         separators=(',', ': '),
-    ) + '\n'
+    )
 
 
 def _get_git_tracked_files(rootdir='.'):

detect_secrets/core/common.py

@@ -0,0 +1,6 @@
+from .baseline import format_baseline_for_output
+
+
+def write_baseline_to_file(filename, data):  # pragma: no cover
+    with open(filename, 'w') as f:
+        f.write(format_baseline_for_output(data) + '\n')

detect_secrets/main.py

@@ -7,6 +7,7 @@
 
 from detect_secrets.core import audit
 from detect_secrets.core import baseline
+from detect_secrets.core.common import write_baseline_to_file
 from detect_secrets.core.log import log
 from detect_secrets.core.usage import ParserBuilder
 from detect_secrets.plugins.core import initialize
@@ -43,7 +44,10 @@ def main(argv=None):
             )
 
             if args.import_filename:
-                _write_to_file(args.import_filename[0], output)
+                write_baseline_to_file(
+                    args.import_filename[0],
+                    output,
+                )
             else:
                 print(output)
 
@@ -139,11 +143,5 @@ def _read_from_file(filename):  # pragma: no cover
         return json.loads(f.read())
 
 
-def _write_to_file(filename, content):
-    """Used for mocking."""
-    with open(filename, 'w') as f:
-        f.write(content)
-
-
 if __name__ == '__main__':
     sys.exit(main())

detect_secrets/pre_commit_hook.py

@@ -5,9 +5,9 @@
 import textwrap
 
 from detect_secrets import VERSION
-from detect_secrets.core.baseline import format_baseline_for_output
 from detect_secrets.core.baseline import get_secrets_not_in_baseline
 from detect_secrets.core.baseline import trim_baseline_of_removed_secrets
+from detect_secrets.core.common import write_baseline_to_file
 from detect_secrets.core.log import get_logger
 from detect_secrets.core.secrets_collection import SecretsCollection
 from detect_secrets.core.usage import ParserBuilder
@@ -64,7 +64,7 @@ def main(argv=None):
         baseline_modified = True
 
     if baseline_modified:
-        _write_to_baseline_file(
+        write_baseline_to_file(
             args.baseline[0],
             baseline_collection.format_for_baseline_output(),
         )
@@ -79,12 +79,6 @@ def main(argv=None):
     return 0
 
 
-def _write_to_baseline_file(filename, payload):  # pragma: no cover
-    """Breaking this function up for mockability."""
-    with open(filename, 'w') as f:
-        f.write(format_baseline_for_output(payload))
-
-
 def get_baseline(baseline_filename):
     """
     :raises: IOError

tests/core/audit_test.py

@@ -207,7 +207,7 @@ def mock_env(self, user_inputs=None, baseline=None):
         ), mock.patch.object(
             # We mock this so we don't need to do any file I/O.
             audit,
-            '_save_baseline_to_file',
+            'write_baseline_to_file',
         ) as m:
             yield m
 

tests/main_test.py

@@ -112,7 +112,7 @@ def test_reads_old_baseline_from_file(self, mock_merge_baseline):
             'detect_secrets.main._read_from_file',
             return_value={'key': 'value'},
         ) as m_read, mock.patch(
-            'detect_secrets.main._write_to_file',
+            'detect_secrets.main.write_baseline_to_file',
         ) as m_write:
             assert main('scan --update old_baseline_file'.split()) == 0
             assert m_read.call_args[0][0] == 'old_baseline_file'
@@ -151,7 +151,7 @@ def test_old_baseline_ignored_with_update_flag(
             return_value={},
         ), mock.patch(
             # We don't want to be creating a file during test
-            'detect_secrets.main._write_to_file',
+            'detect_secrets.main.write_baseline_to_file',
         ) as file_writer:
             assert main(
                 shlex.split(
@@ -221,7 +221,7 @@ def test_audit_short_file(self, filename, expected_output):
             return_value='s',
         ), mock.patch(
             # We don't want to write an actual file
-            'detect_secrets.core.audit._save_baseline_to_file',
+            'detect_secrets.core.audit.write_baseline_to_file',
         ), mock_printer(
             audit_module,
         ) as printer_shim:

tests/pre_commit_hook_test.py

@@ -116,7 +116,7 @@ def test_that_baseline_gets_updated(
                 'detect_secrets.pre_commit_hook._get_baseline_string_from_file',
                 return_value=json.dumps(modified_baseline),
             ), mock.patch(
-                'detect_secrets.pre_commit_hook._write_to_baseline_file',
+                'detect_secrets.pre_commit_hook.write_baseline_to_file',
             ) as m:
                 assert_commit_blocked(
                     '--baseline will_be_mocked test_data/files/file_with_secrets.py',
@@ -162,7 +162,7 @@ def test_writes_new_baseline_if_modified(self):
             'detect_secrets.pre_commit_hook._get_baseline_string_from_file',
             return_value=json.dumps(modified_baseline),
         ), mock.patch(
-            'detect_secrets.pre_commit_hook._write_to_baseline_file',
+            'detect_secrets.pre_commit_hook.write_baseline_to_file',
         ) as m:
             assert_commit_blocked(
                 '--baseline will_be_mocked test_data/files/file_with_secrets.py',