-
Notifications
You must be signed in to change notification settings - Fork 4
/
check-adr-repo.feature
274 lines (210 loc) · 7.35 KB
/
check-adr-repo.feature
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
Feature: Check ADRs well formed
Background:
Given a new working directory
Scenario: Check all ADR file names are slugs of the ADR title
Given a file named "docs/adr/0002-an-adr.md" with:
"""
# A different ADR Title
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0003-another-adr.md" with:
"""
# Yet another different ADR title
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0004-a-last-adr.md" with:
"""
# A last ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
When I run "pyadr check-adr-repo"
Then it should fail with:
"""
(status to verify against: '<any status with an id>')
ADR(s)'s filename follow the format '[0-9][0-9][0-9][0-9]-<adr-title-in-slug-format>.md', but:
=> 'docs/adr/0002-an-adr.md' does not have the correct title slug ('a-different-adr-title').
=> 'docs/adr/0003-another-adr.md' does not have the correct title slug ('yet-another-different-adr-title').
"""
Scenario: Check all ADR file names have '[0-9][0-9][0-9][0-9]' followed by '-'
Given a file named "docs/adr/XXXX-an-adr.md" with:
"""
# An ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/000X-another-adr.md" with:
"""
# Another ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/000-yet-another-adr.md" with:
"""
# Yet another ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/00023-a-last-adr.md" with:
"""
# A last ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
When I run "pyadr check-adr-repo"
Then it should fail with:
"""
(status to verify against: '<any status with an id>')
ADR(s)'s filename follow the format '[0-9][0-9][0-9][0-9]-<adr-title-in-slug-format>.md', but:
=> 'docs/adr/000-yet-another-adr.md' does not start with '[0-9][0-9][0-9][0-9]-'.
=> 'docs/adr/00023-a-last-adr.md' does not start with '[0-9][0-9][0-9][0-9]-'.
=> 'docs/adr/000X-another-adr.md' does not start with '[0-9][0-9][0-9][0-9]-'.
=> 'docs/adr/XXXX-an-adr.md' does not start with '[0-9][0-9][0-9][0-9]-'.
"""
Scenario: Check all ADR files have a unique number
Given a file named "docs/adr/0002-an-adr.md" with:
"""
# An ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0002-another-adr.md" with:
"""
# Another ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0002-a-last-adr.md" with:
"""
# A last ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0003-more-adr.md" with:
"""
# More ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0003-yet-more-adr.md" with:
"""
# Yet more ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
When I run "pyadr check-adr-repo"
Then it should fail with:
"""
ADRs must have a unique number, but the following files have the same number:
=> ['docs/adr/0002-a-last-adr.md', 'docs/adr/0002-an-adr.md', 'docs/adr/0002-another-adr.md'].
=> ['docs/adr/0003-more-adr.md', 'docs/adr/0003-yet-more-adr.md'].
"""
Scenario: Check all ADR files have a title followed by a status and a date
Given a file named "docs/adr/0002-an-adr.md" with:
"""
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
When I run "pyadr check-adr-repo"
Then it should fail with
"""
ADR must be of format:
>>>>>
# Title
* Status: a_status
[..]
* Date: YYYY-MM-DD
[..]
<<<<<
but the following files where not:
=> 'docs/adr/0002-an-adr.md'.
"""
Scenario: Pass checks when all conditions are filled
Given a file named "docs/adr/0002-an-adr.md" with:
"""
# An ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0003-another-adr.md" with:
"""
# Another ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0004-yet-another-adr.md" with:
"""
# Yet Another ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0005-a-last-adr.md" with:
"""
# A last ADR
* Status: proposed
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
When I run "pyadr check-adr-repo"
Then it should pass with
"""
All checks passed.
"""
Scenario: `no-proposed` option - Check all ADR files have a status other than 'proposed'
Given a file named "docs/adr/0002-an-adr.md" with:
"""
# An ADR
* Status: accepted
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
And a file named "docs/adr/0003-another-adr.md" with:
"""
# Another ADR
* Status: proposed
* Date: 2020-03-26
## Context and Problem Statement
[..]
"""
When I run "pyadr check-adr-repo --no-proposed"
Then it should fail with:
"""
ADR(s) must not have their status set to 'proposed', but:
=> 'docs/adr/0003-another-adr.md' has status 'proposed'.
"""