File: bw_items.py

package info (click to toggle)
bundlewrap 5.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 3,260 kB
  • sloc: python: 20,849; makefile: 2
file content (455 lines) | stat: -rw-r--r-- 12,355 bytes parent folder | download | duplicates (2)
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
from bundlewrap.utils.testing import make_repo, run


def test_file_preview(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1"],
            },
        },
        bundles={
            "bundle1": {
                'items': {
                    'files': {
                        "/test": {
                            'content': "föö",
                            'encoding': 'latin-1',
                        },
                    },
                },
            },
        },
    )

    stdout, stderr, rcode = run("bw items -f node1 file:/test", path=str(tmpdir))
    assert stdout == "föö".encode('utf-8')  # our output is always utf-8
    assert rcode == 0


def test_multiple_file_preview(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1"],
            },
        },
        bundles={
            "bundle1": {
                'items': {
                    'files': {
                        "/test": {
                            'content': "föö",
                        },
                        "/testdir/test2": {
                            'content': "bar",
                        },
                    },
                },
            },
        },
    )

    stdout, stderr, rcode = run("bw items -w itemprev node1", path=str(tmpdir))
    assert rcode == 0
    assert tmpdir.join("itemprev/test").exists()
    assert tmpdir.join("itemprev/testdir/test2").exists()


def test_fault_unavailable(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1"],
            },
        },
        bundles={
            "bundle1": {
                'items': {
                    'files': {
                        "/test": {
                            'content': "${repo.vault.password_for('test', key='404')}",
                            'content_type': 'mako',
                        },
                    },
                },
            },
        },
    )

    stdout, stderr, rcode = run("bw items -f node1 file:/test", path=str(tmpdir))
    assert rcode == 1


def test_fault_unavailable_multiple(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1"],
            },
        },
        bundles={
            "bundle1": {
                'items': {
                    'files': {
                        "/test": {
                            'content': "föö",
                        },
                        "/testdir/test3": {
                            'content': "${repo.vault.password_for('test', key='404')}",
                            'content_type': 'mako',
                        },
                    },
                },
            },
        },
    )

    stdout, stderr, rcode = run("bw items -w itemprev node1", path=str(tmpdir))
    assert rcode == 0
    assert tmpdir.join("itemprev/test").exists()
    assert not tmpdir.join("itemprev/testdir/test3").exists()


def test_tag_inheritance(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1"],
            },
        },
        bundles={
            "bundle1": {
                'attrs': {
                    'tags': {
                        "directly": {
                            'tags': {"inherited"},
                        },
                    },
                },
                'items': {
                    'actions': {
                        "test": {
                            'command': "true",
                            'tags': {"directly"},
                        },
                    },
                },
            },
        },
    )
    stdout, stderr, rcode = run("bw items --attrs node1 action:test", path=str(tmpdir))
    assert rcode == 0
    assert "inherited" in stdout.decode()


def test_tag_inheritance_loop(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1"],
            },
        },
        bundles={
            "bundle1": {
                'attrs': {
                    'tags': {
                        "directly": {
                            'tags': {"inherited"},
                        },
                        "inherited": {
                            'tags': {"looped"},
                        },
                        "looped": {
                            'tags': {"inherited"},
                            'needs': {"action:dep"},
                        },
                    },
                },
                'items': {
                    'actions': {
                        "test": {
                            'command': "true",
                            'tags': {"directly"},
                        },
                        "dep": {
                            'command': "true",
                        },
                    },
                },
            },
        },
    )
    stdout, stderr, rcode = run("bw items --attrs node1 action:test", path=str(tmpdir))
    assert rcode == 0
    assert "inherited" in stdout.decode()
    assert "looped" in stdout.decode()
    assert "action:dep" in stdout.decode()


def test_duplicate_items(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1", "bundle2"],
            },
        },
        bundles={
            "bundle1": {
                'items': {
                    'actions': {
                        "dupl": {
                            'command': "true",
                        },
                    },
                },
            },
            "bundle2": {
                'items': {
                    'actions': {
                        "dupl": {
                            'command': "true",
                        },
                    },
                },
            },
        },
    )
    stdout, stderr, rcode = run("bw items node1", path=str(tmpdir))
    assert rcode == 1
    assert "action:dupl" in stderr.decode()
    assert "bundle1" in stderr.decode()
    assert "bundle2" in stderr.decode()


def test_show_auto_needs(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1"],
            },
        },
        bundles={
            "bundle1": {
                'items': {
                    'directories': {
                        "/foo": {},
                        "/foo/bar": {'needs': {"action:"}},
                    },
                },
            },
        },
    )
    stdout, stderr, rcode = run("BW_TABLE_STYLE=grep bw items --attr node1 directory:/foo/bar needs", path=str(tmpdir))
    assert stdout.decode() == """attribute\tvalue
needs\taction:
needs\tdirectory:/foo
"""
    assert stderr.decode() == ""
    assert rcode == 0


def _test_bw_items_invocation_succeeds(tmpdir, invocation, expected_output):
    stdout, stderr, rcode = run(f"BW_TABLE_STYLE=grep {invocation}", path=str(tmpdir))
    assert stdout.decode() == expected_output
    assert stderr.decode() == ""
    assert rcode == 0


def _bw_items_invocation_make_repo(tmpdir):
    make_repo(
        tmpdir,
        nodes={
            "node1": {
                'bundles': ["bundle1"],
            },
        },
        bundles={
            "bundle1": {
                'items': {
                    'directories': {
                        "/foo/bar": {'needs': {"action:"}},
                    },
                    'files': {
                        "/foo/bar/moo": {'content': 'bar\n'},
                    },
                    'actions': {
                        "clone_code": {'command': 'git clone'},
                    },
                },
            },
        },
    )


def test_bw_items_invocation_list_of_items(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items node1', """
items
action:clone_code
directory:/foo/bar
file:/foo/bar/moo
""".lstrip())


def test_bw_items_invocation_list_of_items_as_json(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --json node1', """
[
    "action:clone_code",
    "directory:/foo/bar",
    "file:/foo/bar/moo"
]
""".lstrip())


def test_bw_items_invocation_list_of_items_repr(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --repr node1', """
items
<Item action:clone_code>
<Directory path:/foo/bar purge:False owner:root group:root mode:0755>
<File path:/foo/bar/moo content_type:text owner:root group:root mode:0644 delete:False>
""".lstrip())


def test_bw_items_invocation_list_of_items_repr_as_json(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --repr --json node1', """
[
    "<Item action:clone_code>",
    "<Directory path:/foo/bar purge:False owner:root group:root mode:0755>",
    "<File path:/foo/bar/moo content_type:text owner:root group:root mode:0644 delete:False>"
]
""".lstrip())


def test_bw_items_invocation_list_of_items_blame(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --blame node1', """
bundle name\titems
bundle1\taction:clone_code
bundle1\tdirectory:/foo/bar
bundle1\tfile:/foo/bar/moo
""".lstrip())


def test_bw_items_invocation_list_of_items_blame_as_json(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --blame --json node1', """
{
    "bundle1": [
        "action:clone_code",
        "directory:/foo/bar",
        "file:/foo/bar/moo"
    ]
}
""".lstrip())


def test_bw_items_invocation_single_item(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items node1 directory:/foo/bar', """
attribute\tvalue
group\troot
mode\t0755
owner\troot
paths_to_purge\t[]
type\tdirectory
""".lstrip())


def test_bw_items_invocation_single_item_as_json(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --json node1 directory:/foo/bar', """
{
    "group": "root",
    "mode": "0755",
    "owner": "root",
    "paths_to_purge": [],
    "type": "directory"
}
""".lstrip())


def test_bw_items_invocation_single_item_repr(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --repr node1 directory:/foo/bar', """
item
<Directory path:/foo/bar purge:False owner:root group:root mode:0755>
""".lstrip())


def test_bw_items_invocation_single_item_repr_as_json(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --repr --json node1 directory:/foo/bar', """
[
    "<Directory path:/foo/bar purge:False owner:root group:root mode:0755>"
]
""".lstrip())


def test_bw_items_invocation_single_item_attrs(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --attrs node1 directory:/foo/bar', """
attribute\tvalue
after\t[]
before\t[]
canned_actions_inherit_tags	True
cascade_skip\tTrue
comment\tNone
error_on_missing_fault\tFalse
needed_by\t[]
needs\taction:
preceded_by\t[]
precedes\t[]
skip\tFalse
tags\t[]
triggered\tFalse
triggered_by\t[]
triggers\t[]
unless\t
when_creating\t{}
""".lstrip())


def test_bw_items_invocation_single_item_attrs_as_json(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --attrs --json node1 directory:/foo/bar', """
{
    "after": [],
    "before": [],
    "canned_actions_inherit_tags": true,
    "cascade_skip": true,
    "comment": null,
    "error_on_missing_fault": false,
    "needed_by": [],
    "needs": [
        "action:"
    ],
    "preceded_by": [],
    "precedes": [],
    "skip": false,
    "tags": [],
    "triggered": false,
    "triggered_by": [],
    "triggers": [],
    "unless": "",
    "when_creating": {}
}
""".lstrip())


def test_bw_items_invocation_single_item_preview(tmpdir):
    _bw_items_invocation_make_repo(tmpdir)
    _test_bw_items_invocation_succeeds(tmpdir, 'bw items --preview node1 file:/foo/bar/moo', """
bar
""".lstrip())