1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
from __future__ import annotations
import pytest
import pre_commit.constants as C
from pre_commit.clientlib import InvalidConfigError
from pre_commit.commands.migrate_config import migrate_config
def test_migrate_config_normal_format(tmpdir, capsys):
cfg = tmpdir.join(C.CONFIG_FILE)
cfg.write(
'- repo: local\n'
' hooks:\n'
' - id: foo\n'
' name: foo\n'
' entry: ./bin/foo.sh\n'
' language: script\n',
)
with tmpdir.as_cwd():
assert not migrate_config(C.CONFIG_FILE)
out, _ = capsys.readouterr()
assert out == 'Configuration has been migrated.\n'
contents = cfg.read()
assert contents == (
'repos:\n'
'- repo: local\n'
' hooks:\n'
' - id: foo\n'
' name: foo\n'
' entry: ./bin/foo.sh\n'
' language: script\n'
)
def test_migrate_config_document_marker(tmpdir):
cfg = tmpdir.join(C.CONFIG_FILE)
cfg.write(
'# comment\n'
'\n'
'---\n'
'- repo: local\n'
' hooks:\n'
' - id: foo\n'
' name: foo\n'
' entry: ./bin/foo.sh\n'
' language: script\n',
)
with tmpdir.as_cwd():
assert not migrate_config(C.CONFIG_FILE)
contents = cfg.read()
assert contents == (
'# comment\n'
'\n'
'---\n'
'repos:\n'
'- repo: local\n'
' hooks:\n'
' - id: foo\n'
' name: foo\n'
' entry: ./bin/foo.sh\n'
' language: script\n'
)
def test_migrate_config_list_literal(tmpdir):
cfg = tmpdir.join(C.CONFIG_FILE)
cfg.write(
'[{\n'
' repo: local,\n'
' hooks: [{\n'
' id: foo, name: foo, entry: ./bin/foo.sh,\n'
' language: script,\n'
' }]\n'
'}]',
)
with tmpdir.as_cwd():
assert not migrate_config(C.CONFIG_FILE)
contents = cfg.read()
assert contents == (
'repos:\n'
' [{\n'
' repo: local,\n'
' hooks: [{\n'
' id: foo, name: foo, entry: ./bin/foo.sh,\n'
' language: script,\n'
' }]\n'
' }]'
)
def test_already_migrated_configuration_noop(tmpdir, capsys):
contents = (
'repos:\n'
'- repo: local\n'
' hooks:\n'
' - id: foo\n'
' name: foo\n'
' entry: ./bin/foo.sh\n'
' language: script\n'
)
cfg = tmpdir.join(C.CONFIG_FILE)
cfg.write(contents)
with tmpdir.as_cwd():
assert not migrate_config(C.CONFIG_FILE)
out, _ = capsys.readouterr()
assert out == 'Configuration is already migrated.\n'
assert cfg.read() == contents
def test_migrate_config_sha_to_rev(tmpdir):
contents = (
'repos:\n'
'- repo: https://github.com/pre-commit/pre-commit-hooks\n'
' sha: v1.2.0\n'
' hooks: []\n'
'- repo: https://github.com/pre-commit/pre-commit-hooks\n'
' sha: v1.2.0\n'
' hooks: []\n'
)
cfg = tmpdir.join(C.CONFIG_FILE)
cfg.write(contents)
with tmpdir.as_cwd():
assert not migrate_config(C.CONFIG_FILE)
contents = cfg.read()
assert contents == (
'repos:\n'
'- repo: https://github.com/pre-commit/pre-commit-hooks\n'
' rev: v1.2.0\n'
' hooks: []\n'
'- repo: https://github.com/pre-commit/pre-commit-hooks\n'
' rev: v1.2.0\n'
' hooks: []\n'
)
def test_migrate_config_language_python_venv(tmp_path):
src = '''\
repos:
- repo: local
hooks:
- id: example
name: example
entry: example
language: python_venv
- id: example
name: example
entry: example
language: system
'''
expected = '''\
repos:
- repo: local
hooks:
- id: example
name: example
entry: example
language: python
- id: example
name: example
entry: example
language: system
'''
cfg = tmp_path.joinpath('cfg.yaml')
cfg.write_text(src)
assert migrate_config(str(cfg)) == 0
assert cfg.read_text() == expected
def test_migrate_config_invalid_yaml(tmpdir):
contents = '['
cfg = tmpdir.join(C.CONFIG_FILE)
cfg.write(contents)
with tmpdir.as_cwd(), pytest.raises(InvalidConfigError) as excinfo:
migrate_config(C.CONFIG_FILE)
expected = '\n==> File .pre-commit-config.yaml\n=====> '
assert str(excinfo.value).startswith(expected)
|
