subplot 0.14.0

tools for specifying, documenting, and implementing automated acceptance tests for systems and software
Documentation
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
# Bindings for the lib/files step library

# Create, modify, or remove files.

- given: file {embedded_file}
  impl:
    rust:
      function: subplotlib::steplibrary::files::create_from_embedded
    python:
      function: files_create_from_embedded
  types:
    embedded_file: file
  doc: |
    Create a file on disk from an embedded file in the subplot
    document. The created file has the same name as the embedded file.

- given: executable file {embedded_file}
  impl:
    rust:
      function: subplotlib::steplibrary::files::create_executable_from_embedded
    python:
      function: files_create_executable_from_embedded
  types:
    embedded_file: file
  doc: |
    Create a file on disk from an embedded file in the subplot
    document. The created file has the same name as the embedded file
    and is marked as executable.

- given: file {filename_on_disk} from {embedded_file}
  impl:
    rust:
      function: subplotlib::steplibrary::files::create_from_embedded_with_other_name
    python:
      function: files_create_from_embedded_with_other_name
  types:
    filename_on_disk: path
    embedded_file: file
  doc: |
    Create a file on disk from an embedded file in the subplot
    document. Set the name of the created file.

- given: executable file {filename_on_disk} from {embedded_file}
  impl:
    rust:
      function: subplotlib::steplibrary::files::create_executable_from_embedded_with_other_name
    python:
      function: files_create_executable_from_embedded_with_other_name
  types:
    filename_on_disk: path
    embedded_file: file
  doc: |
    Create a file on disk from an embedded file in the subplot
    document. Set the name of the created file. Also the created
    file will be marked as executable.


- when: I write "{text}" to file {filename}
  impl:
    rust:
      function: subplotlib::steplibrary::files::create_from_text
    python:
      function: files_create_from_text
  types:
    filename: path
    text: text
  doc: |
    Create a file on disk with the given content.

- when: "I remove file {filename:path}"
  impl:
    rust:
      function: subplotlib::steplibrary::files::remove_file
    python:
      function: files_remove_file
  doc: |
    Remove a file from disk. It can't be a directory.

# Manage directories (distinct from files).

- given: a directory {path}
  impl:
    rust:
      function: subplotlib::steplibrary::files::make_directory
    python:
      function: files_make_directory
  types:
    path: path
  doc: |
    Create a directory on disk.

- given: directory {path}
  impl:
    rust:
      function: subplotlib::steplibrary::files::make_directory
    python:
      function: files_make_directory
  types:
    path: path
  doc: |
    Create a directory on disk. This is an alias for "given a directory".

- when: I create directory {path}
  impl:
    rust:
      function: subplotlib::steplibrary::files::make_directory
    python:
      function: files_make_directory
  types:
    path: path
  doc: |
    Create a directory on disk.

- when: I remove directory {path}
  impl:
    rust:
      function: subplotlib::steplibrary::files::remove_directory
    python:
      function: files_remove_directory
  types:
    path: path
  doc: |
    Remove a directory on disk.

- when: I remove empty directory {path}
  impl:
    rust:
      function: subplotlib::steplibrary::files::remove_empty_directory
    python:
      function: files_remove_empty_directory
  types:
    path: path
  doc: |
    Remove a directory on disk, but only if it's empty.

- then: directory {path} exists
  impl:
    rust:
      function: subplotlib::steplibrary::files::path_exists
    python:
      function: files_directory_exists
  types:
    path: path
  doc: |
    Check that a directory exists.

- then: directory {path} does not exist
  impl:
    rust:
      function: subplotlib::steplibrary::files::path_does_not_exist
    python:
      function: files_directory_does_not_exist
  types:
    path: path
  doc: |
    Check that a directory does not exist.

- then: directory {path} is empty
  impl:
    rust:
      function: subplotlib::steplibrary::files::path_is_empty
    python:
      function: files_directory_is_empty
  types:
    path: path
  doc: |
    Check that a directory exists and does not contain anything.

- then: directory {path} is not empty
  impl:
    rust:
      function: subplotlib::steplibrary::files::path_is_not_empty
    python:
      function: files_directory_is_not_empty
  types:
    path: path
  doc: |
    Check that a directory exists and contains something.

# File metadata management and testing.

- given: file (?P<filename>\S+) has modification time (?P<mtime>\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})
  regex: true
  impl:
    rust:
      function: subplotlib::steplibrary::files::touch_with_timestamp
    python:
      function: files_touch_with_timestamp
  types:
    filename: path
    mtime: text
  doc: |
    Create a file with specific modification time.

- when: I remember metadata for file {filename}
  impl:
    rust:
      function: subplotlib::steplibrary::files::remember_metadata
    python:
      function: files_remember_metadata
  types:
    filename: path
  doc: |
    Remember the metadata of a file.

- when: I touch file {filename}
  impl:
    rust:
      function: subplotlib::steplibrary::files::touch
    python:
      function: files_touch
  types:
    filename: path
  doc: |
    Update the modification time of a file to be current time.

- then: file {filename} has same metadata as before
  impl:
    rust:
      function: subplotlib::steplibrary::files::has_remembered_metadata
    python:
      function: files_has_remembered_metadata
  types:
    filename: path
  doc: |
    Check that a file has the same metadata as remembered from
    earlier.

- then: file {filename} has different metadata from before
  impl:
    rust:
      function: subplotlib::steplibrary::files::has_different_metadata
    python:
      function: files_has_different_metadata
  types:
    filename: path
  doc: |
    Check that a file metadata has changed from earlier.

- then: file {filename} has changed from before
  impl:
    rust:
      function: subplotlib::steplibrary::files::has_different_metadata
    python:
      function: files_has_different_metadata
  types:
    filename: path
  doc: |
    Check that file metadata has changed from before.

- then: file {filename} has a very recent modification time
  impl:
    rust:
      function: subplotlib::steplibrary::files::mtime_is_recent
    python:
      function: files_mtime_is_recent
  types:
    filename: path
  doc: |
    Check that file modification time is recent.

- then: file {filename} has a very old modification time
  impl:
    rust:
      function: subplotlib::steplibrary::files::mtime_is_ancient
    python:
      function: files_mtime_is_ancient
  types:
    filename: path
  doc: |
    Check that file modification is far in the past.

# Testing file existence.

- then: file {filename} exists
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_exists
    python:
      function: files_file_exists
  types:
    filename: path
  doc: |
    Check that a file exist.

- then: file {filename} does not exist
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_does_not_exist
    python:
      function: files_file_does_not_exist
  types:
    filename: path
  doc: |
    Check that a file does not exist.

- then: only files (?P<filenames>.+) exist
  impl:
    rust:
      function: subplotlib::steplibrary::files::only_these_exist
    python:
      function: files_only_these_exist
  regex: true
  types:
    filenames: text
  doc: |
    Check that the test directory only contains specific files.

# Tests on file content.

- then: file {filename} contains "{data}"
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_contains
    python:
      function: files_file_contains
  types:
    filename: path
    data: escapedtext
  doc: |
    Check that a file contains a string.

- then: file {filename} doesn't contain "{data}"
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_doesnt_contain
    python:
      function: files_file_doesnt_contain
  types:
    filename: path
    data: escapedtext
  doc: |
    Check that a file does not contain a string.

- then: file {filename} matches regex /{regex}/
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_matches_regex
    python:
      function: files_file_matches_regex
  types:
    filename: path
    regex: text
  doc: |
    Check that file content matches a regular expression.

- then: file {filename} matches regex "{regex}"
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_matches_regex
    python:
      function: files_file_matches_regex
  types:
    filename: path
    regex: text
  doc: |
    Check that file content matches a regular expression.

- then: files {filename1} and {filename2} match
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_match
    python:
      function: files_match
  types:
    filename1: path
    filename2: path
  doc: |
    Check that two files have the same content.

- then: files {filename1} and {filename2} on disk are identical
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_match
    python:
      function: files_match
  types:
    filename1: path
    filename2: path
  doc: |
    Check that two files have the same content.

- then: files {filename1} and {filename2} on disk are different
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_do_not_match
    python:
      function: files_do_not_match
  types:
    filename1: path
    filename2: path
  doc: |
    Check that two files do not have the same content.


- then: "file {filename} on disk and embedded file {embedded} are identical"
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_and_embedded_file_match
    python:
      function: file_and_embedded_file_match
  types:
    filename: path
    embedded: file
  doc: |
    Check that a file on disk and an embedded file contain the same data.

- then: "file {filename} on disk and embedded file {embedded} are different"
  impl:
    rust:
      function: subplotlib::steplibrary::files::file_and_embedded_file_do_not_match
    python:
      function: file_and_embedded_file_do_not_match
  types:
    filename: path
    embedded: file
  doc: |
    Check that a file on disk and an embedded file do not contain the
    same data.