From 3e76cdaf2567d3c6c657f9b0009056a2e1cc3a1e Mon Sep 17 00:00:00 2001 From: Anthony Sottile Date: Tue, 5 Sep 2017 14:04:08 -0700 Subject: [PATCH] Enable map configurations (config v2). --- .pre-commit-config.yaml | 1 + pre_commit/clientlib.py | 18 +++++++++-- pre_commit/commands/autoupdate.py | 2 +- pre_commit/commands/sample_config.py | 3 +- pre_commit/runner.py | 10 +++--- pre_commit/schema.py | 8 +++-- testing/fixtures.py | 9 +++--- tests/clientlib_test.py | 46 +++++++++++++--------------- tests/commands/autoupdate_test.py | 6 ++-- tests/commands/run_test.py | 16 +++++----- tests/commands/sample_config_test.py | 3 +- 11 files changed, 70 insertions(+), 52 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1e529a7f..36340642 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,3 +1,4 @@ +repos: - repo: https://github.com/pre-commit/pre-commit-hooks.git sha: v0.9.1 hooks: diff --git a/pre_commit/clientlib.py b/pre_commit/clientlib.py index 6da6db25..e69359b0 100644 --- a/pre_commit/clientlib.py +++ b/pre_commit/clientlib.py @@ -2,6 +2,7 @@ from __future__ import absolute_import from __future__ import unicode_literals import argparse +import collections import functools from aspy.yaml import ordered_load @@ -125,7 +126,11 @@ CONFIG_REPO_DICT = schema.Map( ensure_absent=True, ), ) -CONFIG_SCHEMA = schema.Array(CONFIG_REPO_DICT) +CONFIG_SCHEMA = schema.Map( + 'Config', None, + + schema.RequiredRecurse('repos', schema.Array(CONFIG_REPO_DICT)), +) def is_local_repo(repo_entry): @@ -136,10 +141,19 @@ class InvalidConfigError(FatalError): pass +def ordered_load_normalize_legacy_config(contents): + data = ordered_load(contents) + if isinstance(data, list): + # TODO: Once happy, issue a deprecation warning and instructions + return collections.OrderedDict([('repos', data)]) + else: + return data + + load_config = functools.partial( schema.load_from_filename, schema=CONFIG_SCHEMA, - load_strategy=ordered_load, + load_strategy=ordered_load_normalize_legacy_config, exc_tp=InvalidConfigError, ) diff --git a/pre_commit/commands/autoupdate.py b/pre_commit/commands/autoupdate.py index 1c79500d..810e53f6 100644 --- a/pre_commit/commands/autoupdate.py +++ b/pre_commit/commands/autoupdate.py @@ -109,7 +109,7 @@ def autoupdate(runner, tags_only): input_configs = load_config(runner.config_file_path) - for repo_config in input_configs: + for repo_config in input_configs['repos']: if is_local_repo(repo_config): output_configs.append(repo_config) continue diff --git a/pre_commit/commands/sample_config.py b/pre_commit/commands/sample_config.py index b74e4271..c8c3bf10 100644 --- a/pre_commit/commands/sample_config.py +++ b/pre_commit/commands/sample_config.py @@ -10,8 +10,9 @@ from __future__ import unicode_literals SAMPLE_CONFIG = '''\ # See http://pre-commit.com for more information # See http://pre-commit.com/hooks.html for more hooks +repos: - repo: https://github.com/pre-commit/pre-commit-hooks - sha: v0.9.1 + sha: v0.9.2 hooks: - id: trailing-whitespace - id: end-of-file-fixer diff --git a/pre_commit/runner.py b/pre_commit/runner.py index 21707cb4..346d6021 100644 --- a/pre_commit/runner.py +++ b/pre_commit/runner.py @@ -40,11 +40,11 @@ class Runner(object): @cached_property def repositories(self): """Returns a tuple of the configured repositories.""" - config = load_config(self.config_file_path) - repositories = tuple(Repository.create(x, self.store) for x in config) - for repository in repositories: - repository.require_installed() - return repositories + repos = load_config(self.config_file_path)['repos'] + repos = tuple(Repository.create(x, self.store) for x in repos) + for repo in repos: + repo.require_installed() + return repos def get_hook_path(self, hook_type): return os.path.join(self.git_dir, 'hooks', hook_type) diff --git a/pre_commit/schema.py b/pre_commit/schema.py index a911bb43..f033071f 100644 --- a/pre_commit/schema.py +++ b/pre_commit/schema.py @@ -142,9 +142,13 @@ class Map(collections.namedtuple('Map', ('object_name', 'id_key', 'items'))): raise ValidationError('Expected a {} map but got a {}'.format( self.object_name, type(v).__name__, )) - with validate_context('At {}({}={!r})'.format( + if self.id_key is None: + context = 'At {}()'.format(self.object_name) + else: + context = 'At {}({}={!r})'.format( self.object_name, self.id_key, v.get(self.id_key, MISSING), - )): + ) + with validate_context(context): for item in self.items: item.check(v) diff --git a/testing/fixtures.py b/testing/fixtures.py index ac7950f1..1c61b2b1 100644 --- a/testing/fixtures.py +++ b/testing/fixtures.py @@ -92,8 +92,9 @@ def make_config_from_repo(repo_path, sha=None, hooks=None, check=True): )) if check: - wrapped = validate([config], CONFIG_SCHEMA) - config, = apply_defaults(wrapped, CONFIG_SCHEMA) + wrapped = validate({'repos': [config]}, CONFIG_SCHEMA) + wrapped = apply_defaults(wrapped, CONFIG_SCHEMA) + config, = wrapped['repos'] return config else: return config @@ -106,9 +107,9 @@ def read_config(directory, config_file=C.CONFIG_FILE): def write_config(directory, config, config_file=C.CONFIG_FILE): - if type(config) is not list: + if type(config) is not list and 'repos' not in config: assert type(config) is OrderedDict - config = [config] + config = {'repos': [config]} with io.open(os.path.join(directory, config_file), 'w') as outfile: outfile.write(ordered_dump(config, **C.YAML_DUMP_KWARGS)) diff --git a/tests/clientlib_test.py b/tests/clientlib_test.py index 6c04648c..8e85e6c4 100644 --- a/tests/clientlib_test.py +++ b/tests/clientlib_test.py @@ -60,15 +60,15 @@ def test_validate_config_main(args, expected_output): ('config_obj', 'expected'), ( ([], False), ( - [{ + {'repos': [{ 'repo': 'git@github.com:pre-commit/pre-commit-hooks', 'sha': 'cd74dc150c142c3be70b24eaf0b02cae9d235f37', 'hooks': [{'id': 'pyflakes', 'files': '\\.py$'}], - }], + }]}, True, ), ( - [{ + {'repos': [{ 'repo': 'git@github.com:pre-commit/pre-commit-hooks', 'sha': 'cd74dc150c142c3be70b24eaf0b02cae9d235f37', 'hooks': [ @@ -78,11 +78,11 @@ def test_validate_config_main(args, expected_output): 'args': ['foo', 'bar', 'baz'], }, ], - }], + }]}, True, ), ( - [{ + {'repos': [{ 'repo': 'git@github.com:pre-commit/pre-commit-hooks', 'sha': 'cd74dc150c142c3be70b24eaf0b02cae9d235f37', 'hooks': [ @@ -94,7 +94,7 @@ def test_validate_config_main(args, expected_output): 'args': ['foo', 'bar', 'baz'], }, ], - }], + }]}, False, ), ), @@ -104,29 +104,25 @@ def test_config_valid(config_obj, expected): assert ret is expected -@pytest.mark.parametrize( - 'config_obj', ( - [{ - 'repo': 'local', - 'sha': 'foo', - 'hooks': [{ - 'id': 'do_not_commit', - 'name': 'Block if "DO NOT COMMIT" is found', - 'entry': 'DO NOT COMMIT', - 'language': 'pcre', - 'files': '^(.*)$', - }], +def test_config_with_local_hooks_definition_fails(): + config_obj = {'repos': [{ + 'repo': 'local', + 'sha': 'foo', + 'hooks': [{ + 'id': 'do_not_commit', + 'name': 'Block if "DO NOT COMMIT" is found', + 'entry': 'DO NOT COMMIT', + 'language': 'pcre', + 'files': '^(.*)$', }], - ), -) -def test_config_with_local_hooks_definition_fails(config_obj): + }]} with pytest.raises(schema.ValidationError): schema.validate(config_obj, CONFIG_SCHEMA) @pytest.mark.parametrize( 'config_obj', ( - [{ + {'repos': [{ 'repo': 'local', 'hooks': [{ 'id': 'arg-per-line', @@ -136,8 +132,8 @@ def test_config_with_local_hooks_definition_fails(config_obj): 'files': '', 'args': ['hello', 'world'], }], - }], - [{ + }]}, + {'repos': [{ 'repo': 'local', 'hooks': [{ 'id': 'arg-per-line', @@ -147,7 +143,7 @@ def test_config_with_local_hooks_definition_fails(config_obj): 'files': '', 'args': ['hello', 'world'], }], - }], + }]}, ), ) def test_config_with_local_hooks_definition_passes(config_obj): diff --git a/tests/commands/autoupdate_test.py b/tests/commands/autoupdate_test.py index 1920610a..2d353000 100644 --- a/tests/commands/autoupdate_test.py +++ b/tests/commands/autoupdate_test.py @@ -274,7 +274,7 @@ def test_autoupdate_local_hooks(tempdir_factory): assert autoupdate(runner, tags_only=False) == 0 new_config_writen = load_config(runner.config_file_path) assert len(new_config_writen) == 1 - assert new_config_writen[0] == config + assert new_config_writen['repos'][0] == config def test_autoupdate_local_hooks_with_out_of_date_repo( @@ -289,5 +289,5 @@ def test_autoupdate_local_hooks_with_out_of_date_repo( runner = Runner('.', C.CONFIG_FILE) assert autoupdate(runner, tags_only=False) == 0 new_config_writen = load_config(runner.config_file_path) - assert len(new_config_writen) == 2 - assert new_config_writen[0] == local_config + assert len(new_config_writen['repos']) == 2 + assert new_config_writen['repos'][0] == local_config diff --git a/tests/commands/run_test.py b/tests/commands/run_test.py index b544eb75..39d3ac0b 100644 --- a/tests/commands/run_test.py +++ b/tests/commands/run_test.py @@ -272,7 +272,7 @@ def test_always_run( cap_out, repo_with_passing_hook, mock_out_store_directory, ): with modify_config() as config: - config[0]['hooks'][0]['always_run'] = True + config['repos'][0]['hooks'][0]['always_run'] = True _test_run( cap_out, repo_with_passing_hook, @@ -288,7 +288,7 @@ def test_always_run_alt_config( ): repo_root = '.' config = read_config(repo_root) - config[0]['hooks'][0]['always_run'] = True + config['repos'][0]['hooks'][0]['always_run'] = True alt_config_file = 'alternate_config.yaml' add_config_to_repo(repo_root, config, config_file=alt_config_file) @@ -428,7 +428,7 @@ def test_multiple_hooks_same_id( with cwd(repo_with_passing_hook): # Add bash hook on there again with modify_config() as config: - config[0]['hooks'].append({'id': 'bash_hook'}) + config['repos'][0]['hooks'].append({'id': 'bash_hook'}) stage_a_file() ret, output = _do_run(cap_out, repo_with_passing_hook, _get_opts()) @@ -455,7 +455,7 @@ def test_stdout_write_bug_py26( ): with cwd(repo_with_failing_hook): with modify_config() as config: - config[0]['hooks'][0]['args'] = ['☃'] + config['repos'][0]['hooks'][0]['args'] = ['☃'] stage_a_file() install(Runner(repo_with_failing_hook, C.CONFIG_FILE)) @@ -505,7 +505,7 @@ def test_lots_of_files(mock_out_store_directory, tempdir_factory): with cwd(git_path): # Override files so we run against them with modify_config() as config: - config[0]['hooks'][0]['files'] = '' + config['repos'][0]['hooks'][0]['files'] = '' # Write a crap ton of files for i in range(400): @@ -660,7 +660,7 @@ def test_local_hook_fails( def modified_config_repo(repo_with_passing_hook): with modify_config(repo_with_passing_hook, commit=False) as config: # Some minor modification - config[0]['hooks'][0]['files'] = '' + config['repos'][0]['hooks'][0]['files'] = '' yield repo_with_passing_hook @@ -721,8 +721,8 @@ def test_pass_filenames( expected_out, ): with modify_config() as config: - config[0]['hooks'][0]['pass_filenames'] = pass_filenames - config[0]['hooks'][0]['args'] = hook_args + config['repos'][0]['hooks'][0]['pass_filenames'] = pass_filenames + config['repos'][0]['hooks'][0]['args'] = hook_args stage_a_file() ret, printed = _do_run( cap_out, repo_with_passing_hook, _get_opts(verbose=True), diff --git a/tests/commands/sample_config_test.py b/tests/commands/sample_config_test.py index 122d7bfc..9d74a011 100644 --- a/tests/commands/sample_config_test.py +++ b/tests/commands/sample_config_test.py @@ -11,8 +11,9 @@ def test_sample_config(capsys): assert out == '''\ # See http://pre-commit.com for more information # See http://pre-commit.com/hooks.html for more hooks +repos: - repo: https://github.com/pre-commit/pre-commit-hooks - sha: v0.9.1 + sha: v0.9.2 hooks: - id: trailing-whitespace - id: end-of-file-fixer