Add a check and test to the real top level and improve the warning message

yoavcaspi · yoavcaspi · commit 217d31ec1cfe · 2019-05-11T22:57:52.000+03:00
diff --git a/pre_commit/clientlib.py b/pre_commit/clientlib.py
@@ -149,12 +149,10 @@ def _entry(modname):
 
 def warn_on_unknown_keys_at_top_level(extra, orig_keys):
     logger.warning(
-        'Your pre-commit-config contain these extra keys: {}. '
-        'while the only valid keys are: {}.'.format(
-            ', '.join(extra),
-            ', '.join(sorted(orig_keys)),
+        'Unexpected config key(s): {}'.format(
+            ', '.join(sorted(extra)),
         ),
-    ),
+    )
 
 
 _meta = (
@@ -236,7 +234,7 @@ def warn_on_unknown_keys_at_top_level(extra, orig_keys):
 
     MigrateShaToRev(),
     cfgv.WarnAdditionalKeys(
-        {'repo', 'rev', 'hooks'},
+        ('repo', 'rev', 'hooks'),
         warn_on_unknown_keys_at_top_level,
     ),
 )
@@ -264,6 +262,10 @@ def warn_on_unknown_keys_at_top_level(extra, orig_keys):
         cfgv.check_and(cfgv.check_string, check_min_version),
         '0',
     ),
+    cfgv.WarnAdditionalKeys(
+        ('repos',),
+        warn_on_unknown_keys_at_top_level,
+    ),
 )
 
 
diff --git a/tests/clientlib_test.py b/tests/clientlib_test.py
@@ -118,7 +118,7 @@ def test_validate_config_old_list_format_ok(tmpdir):
     assert not validate_config_main((f.strpath,))
 
 
-def test_validate_warn_on_unknown_keys_at_top_level(tmpdir, caplog):
+def test_validate_warn_on_unknown_keys_at_repo_level(tmpdir, caplog):
     f = tmpdir.join('cfg.yaml')
     f.write(
         '-   repo: https://gitlab.com/pycqa/flake8\n'
@@ -133,8 +133,29 @@ def test_validate_warn_on_unknown_keys_at_top_level(tmpdir, caplog):
         (
             'pre_commit',
             logging.WARNING,
-            'Your pre-commit-config contain these extra keys: args. '
-            'while the only valid keys are: hooks, repo, rev.',
+            'Unexpected config key(s): args',
+        ),
+    ]
+
+
+def test_validate_warn_on_unknown_keys_at_top_level(tmpdir, caplog):
+    f = tmpdir.join('cfg.yaml')
+    f.write(
+        'repos:\n'
+        '-   repo: https://gitlab.com/pycqa/flake8\n'
+        '    rev: 3.7.7\n'
+        '    hooks:\n'
+        '    -   id: flake8\n'
+        'foo:\n'
+        '    id: 1.0.0\n',
+    )
+    ret_val = validate_config_main((f.strpath,))
+    assert not ret_val
+    assert caplog.record_tuples == [
+        (
+            'pre_commit',
+            logging.WARNING,
+            'Unexpected config key(s): foo',
         ),
     ]
 
