💯 Coverage for baseline.py initialize.py usage.py

KevinHock · KevinHock · commit 20d19212de53 · 2019-09-20T21:44:52.000-07:00
And normalize main_test.py comments
diff --git a/detect_secrets/core/usage.py b/detect_secrets/core/usage.py
@@ -419,11 +419,7 @@ def consolidate_args(args):
             # Consolidate related args
             related_args = {}
             for related_arg_tuple in plugin.related_args:
-                try:
-                    flag_name, default_value = related_arg_tuple
-                except ValueError:
-                    flag_name = related_arg_tuple
-                    default_value = None
+                flag_name, default_value = related_arg_tuple
 
                 arg_name = PluginOptions._convert_flag_text_to_argument_name(
                     flag_name,
diff --git a/detect_secrets/plugins/common/initialize.py b/detect_secrets/plugins/common/initialize.py
@@ -109,9 +109,9 @@ def _remove_key(d, key):
         ):
             try:
                 plugins_dict[plugin_name][param_name] = param_value
-            except KeyError:
+            except KeyError:  # pragma: no cover
                 log.warning(
-                    'Baseline contain plugin {} which is not in all plugins! Ignoring...',
+                    'Baseline contains plugin {} which is not in all plugins! Ignoring...',
                     plugin_name,
                 )
 
diff --git a/tests/core/baseline_test.py b/tests/core/baseline_test.py
@@ -60,6 +60,29 @@ def test_basic_usage(self, path):
         assert len(results['test_data/files/file_with_secrets.py']) == 1
         assert len(results['test_data/files/tmp/file_with_secrets.py']) == 2
 
+    @pytest.mark.parametrize(
+        'path',
+        [
+            [
+                './test_data/files',
+            ],
+        ],
+    )
+    def test_error_when_getting_git_tracked_files(self, path):
+        with mock_git_calls(
+            'detect_secrets.core.baseline.subprocess.check_output',
+            (
+                SubprocessMock(
+                    expected_input='git -C ./test_data/files ls-files',
+                    should_throw_exception=True,
+                    mocked_output='',
+                ),
+            ),
+        ):
+            results = self.get_results(path=['./test_data/files'])
+
+        assert not results
+
     def test_with_multiple_files(self):
         results = self.get_results(
             path=[
@@ -80,7 +103,13 @@ def test_with_multiple_non_existent_files(self):
         assert not results
 
     def test_with_folders_and_files(self):
-        results = self.get_results(path=['test_data/', 'non-existent-file.B'])
+        results = self.get_results(
+            path=[
+                'non-existent-file.B',
+                'test_data/',
+                'test_data/empty_folder',
+            ],
+        )
 
         assert 'test_data/files/file_with_secrets.py' in results
         assert 'test_data/files/tmp/file_with_secrets.py' in results
diff --git a/tests/main_test.py b/tests/main_test.py
@@ -221,7 +221,7 @@ def test_old_baseline_ignored_with_update_flag(
     @pytest.mark.parametrize(
         'plugins_used, plugins_overwriten, plugins_wrote',
         [
-            (  # remove some plugins from baseline
+            (  # Remove some plugins from baseline
                 [
                     {
                         'base64_limit': 4.5,
@@ -238,7 +238,7 @@ def test_old_baseline_ignored_with_update_flag(
                     },
                 ],
             ),
-            (  # all plugins
+            (  # All plugins
                 [
                     {
                         'base64_limit': 1.5,
@@ -284,7 +284,7 @@ def test_old_baseline_ignored_with_update_flag(
                     },
                 ],
             ),
-            (  # remove some plugins from all plugins
+            (  # Remove some plugins from all plugins
                 [
                     {
                         'base64_limit': 4.5,
@@ -324,7 +324,7 @@ def test_old_baseline_ignored_with_update_flag(
                     },
                 ],
             ),
-            (  # use same plugin list from baseline
+            (  # Use same plugin list from baseline
                 [
                     {
                         'base64_limit': 3.5,
@@ -345,7 +345,7 @@ def test_old_baseline_ignored_with_update_flag(
                     },
                 ],
             ),
-            (  # overwrite base limit from CLI
+            (  # Overwrite base limit from CLI
                 [
                     {
                         'base64_limit': 3.5,
@@ -365,7 +365,7 @@ def test_old_baseline_ignored_with_update_flag(
                     },
                 ],
             ),
-            (  # does not overwrite base limit from CLI if baseline not using the plugin
+            (  # Does not overwrite base limit from CLI if baseline not using the plugin
                 [
                     {
                         'name': 'PrivateKeyDetector',
@@ -378,7 +378,7 @@ def test_old_baseline_ignored_with_update_flag(
                     },
                 ],
             ),
-            (  # use overwriten option from CLI only when using --use-all-plugins
+            (  # Use overwriten option from CLI only when using --use-all-plugins
                 [
                     {
                         'base64_limit': 3.5,
@@ -420,7 +420,7 @@ def test_old_baseline_ignored_with_update_flag(
                     },
                 ],
             ),
-            (  # use plugin limit from baseline when using --use-all-plugins and no input limit
+            (  # Use plugin limit from baseline when using --use-all-plugins and no input limit
                 [
                     {
                         'base64_limit': 2.5,
@@ -492,8 +492,11 @@ def test_plugin_from_old_baseline_respected_with_update_flag(
                 ),
             ) == 0
 
-            assert file_writer.call_args[1]['data']['plugins_used'] == \
+            assert (
+                file_writer.call_args[1]['data']['plugins_used']
+                ==
                 plugins_wrote
+            )
 
     @pytest.mark.parametrize(
         'filename, expected_output',
diff --git a/tests/plugins/common/initialize_test.py b/tests/plugins/common/initialize_test.py
@@ -55,7 +55,7 @@ def setup(self):
     def test_success(self):
         plugin = initialize.from_secret_type(
             'Base64 High Entropy String',
-            self.settings,
+            settings=self.settings,
         )
 
         assert isinstance(plugin, Base64HighEntropyString)
@@ -64,5 +64,11 @@ def test_success(self):
     def test_failure(self):
         assert not initialize.from_secret_type(
             'some random secret_type',
-            self.settings,
+            settings=self.settings,
+        )
+
+    def test_secret_type_not_in_settings(self):
+        assert not initialize.from_secret_type(
+            'Base64 High Entropy String',
+            settings=[],
         )
diff --git a/tox.ini b/tox.ini
@@ -14,8 +14,8 @@ commands =
     coverage run -m pytest tests -v
     coverage report --show-missing --include=tests/* --fail-under 100
     # This is so that we do not regress unintentionally
-    coverage report --show-missing --include=detect_secrets/* --omit=detect_secrets/core/audit.py,detect_secrets/core/baseline.py,detect_secrets/core/secrets_collection.py,detect_secrets/core/usage.py,detect_secrets/main.py,detect_secrets/plugins/common/ini_file_parser.py,detect_secrets/plugins/common/initialize.py --fail-under 100
-    coverage report --show-missing --include=detect_secrets/core/audit.py,detect_secrets/core/baseline.py,detect_secrets/core/secrets_collection.py,detect_secrets/core/usage.py,detect_secrets/main.py,detect_secrets/plugins/common/ini_file_parser.py,detect_secrets/plugins/common/initialize.py --fail-under 96
+    coverage report --show-missing --include=detect_secrets/* --omit=detect_secrets/core/audit.py,detect_secrets/core/secrets_collection.py,detect_secrets/main.py,detect_secrets/plugins/common/ini_file_parser.py --fail-under 100
+    coverage report --show-missing --include=detect_secrets/core/audit.py,detect_secrets/core/secrets_collection.py,detect_secrets/main.py,detect_secrets/plugins/common/ini_file_parser.py --fail-under 96
     pre-commit run --all-files --show-diff-on-failure
 
 [testenv:venv]

Original file line number	Diff line number	Diff line change
`@@ -221,7 +221,7 @@ def test_old_baseline_ignored_with_update_flag(`
`221`	`221`	`@pytest.mark.parametrize(`
`222`	`222`	`'plugins_used, plugins_overwriten, plugins_wrote',`
`223`	`223`	`[`
`224`		`- ( # remove some plugins from baseline`
	`224`	`+ ( # Remove some plugins from baseline`
`225`	`225`	`[`
`226`	`226`	`{`
`227`	`227`	`'base64_limit': 4.5,`
`@@ -238,7 +238,7 @@ def test_old_baseline_ignored_with_update_flag(`
`238`	`238`	`},`
`239`	`239`	`],`
`240`	`240`	`),`
`241`		`- ( # all plugins`
	`241`	`+ ( # All plugins`
`242`	`242`	`[`
`243`	`243`	`{`
`244`	`244`	`'base64_limit': 1.5,`
`@@ -284,7 +284,7 @@ def test_old_baseline_ignored_with_update_flag(`
`284`	`284`	`},`
`285`	`285`	`],`
`286`	`286`	`),`
`287`		`- ( # remove some plugins from all plugins`
	`287`	`+ ( # Remove some plugins from all plugins`
`288`	`288`	`[`
`289`	`289`	`{`
`290`	`290`	`'base64_limit': 4.5,`
`@@ -324,7 +324,7 @@ def test_old_baseline_ignored_with_update_flag(`
`324`	`324`	`},`
`325`	`325`	`],`
`326`	`326`	`),`
`327`		`- ( # use same plugin list from baseline`
	`327`	`+ ( # Use same plugin list from baseline`
`328`	`328`	`[`
`329`	`329`	`{`
`330`	`330`	`'base64_limit': 3.5,`
`@@ -345,7 +345,7 @@ def test_old_baseline_ignored_with_update_flag(`
`345`	`345`	`},`
`346`	`346`	`],`
`347`	`347`	`),`
`348`		`- ( # overwrite base limit from CLI`
	`348`	`+ ( # Overwrite base limit from CLI`
`349`	`349`	`[`
`350`	`350`	`{`
`351`	`351`	`'base64_limit': 3.5,`
`@@ -365,7 +365,7 @@ def test_old_baseline_ignored_with_update_flag(`
`365`	`365`	`},`
`366`	`366`	`],`
`367`	`367`	`),`
`368`		`- ( # does not overwrite base limit from CLI if baseline not using the plugin`
	`368`	`+ ( # Does not overwrite base limit from CLI if baseline not using the plugin`
`369`	`369`	`[`
`370`	`370`	`{`
`371`	`371`	`'name': 'PrivateKeyDetector',`
`@@ -378,7 +378,7 @@ def test_old_baseline_ignored_with_update_flag(`
`378`	`378`	`},`
`379`	`379`	`],`
`380`	`380`	`),`
`381`		`- ( # use overwriten option from CLI only when using --use-all-plugins`
	`381`	`+ ( # Use overwriten option from CLI only when using --use-all-plugins`
`382`	`382`	`[`
`383`	`383`	`{`
`384`	`384`	`'base64_limit': 3.5,`
`@@ -420,7 +420,7 @@ def test_old_baseline_ignored_with_update_flag(`
`420`	`420`	`},`
`421`	`421`	`],`
`422`	`422`	`),`
`423`		`- ( # use plugin limit from baseline when using --use-all-plugins and no input limit`
	`423`	`+ ( # Use plugin limit from baseline when using --use-all-plugins and no input limit`
`424`	`424`	`[`
`425`	`425`	`{`
`426`	`426`	`'base64_limit': 2.5,`
`@@ -492,8 +492,11 @@ def test_plugin_from_old_baseline_respected_with_update_flag(`
`492`	`492`	`),`
`493`	`493`	`) == 0`
`494`	`494`
`495`		`- assert file_writer.call_args[1]['data']['plugins_used'] == \`
	`495`	`+ assert (`
	`496`	`+ file_writer.call_args[1]['data']['plugins_used']`
	`497`	`+ ==`
`496`	`498`	`plugins_wrote`
	`499`	`+ )`
`497`	`500`
`498`	`501`	`@pytest.mark.parametrize(`
`499`	`502`	`'filename, expected_output',`