File: test-pivot_root.py

package info (click to toggle)
apparmor 4.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,096 kB
  • sloc: ansic: 24,943; python: 24,914; cpp: 9,074; sh: 8,166; yacc: 2,061; makefile: 1,923; lex: 1,215; pascal: 1,147; perl: 1,033; ruby: 365; lisp: 282; exp: 250; java: 212; xml: 159
file content (576 lines) | stat: -rw-r--r-- 27,574 bytes parent folder | download
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
#!/usr/bin/python3
# ----------------------------------------------------------------------
#    Copyright (C) 2015 Christian Boltz <apparmor@cboltz.de>
#
#    This program is free software; you can redistribute it and/or
#    modify it under the terms of version 2 of the GNU General Public
#    License as published by the Free Software Foundation.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
# ----------------------------------------------------------------------

import unittest
from collections import namedtuple

from apparmor.common import AppArmorBug, AppArmorException
from apparmor.logparser import ReadLog
from apparmor.aare import AARE
from apparmor.rule.pivot_root import PivotRootRule, PivotRootRuleset
from apparmor.translations import init_translation
from common_test import AATest, setup_all_loops

_ = init_translation()

exp = namedtuple(
    'exp', ('audit', 'allow_keyword', 'deny', 'comment', 'oldroot', 'all_oldroots', 'newroot',
            'all_newroots', 'profile_name', 'all_profile_names'),
)


# # --- tests for single PivotRootRule --- #

class PivotRootTest(AATest):
    def _compare_obj(self, obj, expected):
        self.assertEqual(expected.audit, obj.audit)
        self.assertEqual(expected.allow_keyword, obj.allow_keyword)
        self.assertEqual(expected.deny, obj.deny)
        self.assertEqual(expected.comment, obj.comment)

        if type(obj.oldroot) is AARE:
            self.assertEqual(expected.oldroot, obj.oldroot.regex)
        else:
            self.assertEqual(expected.oldroot, obj.oldroot)

        self.assertEqual(expected.all_oldroots, obj.all_oldroots)

        if type(obj.newroot) is AARE:
            self.assertEqual(expected.newroot, obj.newroot.regex)
        else:
            self.assertEqual(expected.newroot, obj.newroot)

        self.assertEqual(expected.all_newroots, obj.all_newroots)

        if type(obj.profile_name) is AARE:
            self.assertEqual(expected.profile_name, obj.profile_name.regex)
        else:
            self.assertEqual(expected.profile_name, obj.profile_name)

        self.assertEqual(expected.all_profile_names, obj.all_profile_names)


class PivotRootTestParse(PivotRootTest):
    tests = (
        # PivotRootRule object                                              audit  allow  deny   comment   oldroot      all?    newroot         all?    profile_name    all?
        ('pivot_root,',                                                 exp(False, False, False, '',       None,        True,   None,           True,   None,           True)),
        ('pivot_root oldroot=/oldroot,                         # cmt',  exp(False, False, False, ' # cmt', '/oldroot',  False,  None,           True,   None,           True)),
        ('pivot_root oldroot=/oldroot /new/root,               # cmt',  exp(False, False, False, ' # cmt', '/oldroot',  False,  '/new/root',    False,  None,           True)),
        ('pivot_root oldroot=/oldroot /new/root -> targetprof, # cmt',  exp(False, False, False, ' # cmt', '/oldroot',  False,  '/new/root',    False,  'targetprof',   False)),
        ('pivot_root oldroot=/oldroot           -> targetprof, # cmt',  exp(False, False, False, ' # cmt', '/oldroot',  False,  None,           True,   'targetprof',   False)),
        ('pivot_root                  /new/root,               # cmt',  exp(False, False, False, ' # cmt', None,        True,   '/new/root',    False,  None,           True)),
        ('pivot_root                  /new/root -> targetprof, # cmt',  exp(False, False, False, ' # cmt', None,        True,   '/new/root',    False,  'targetprof',   False)),
        ('pivot_root                            -> targetprof, # cmt',  exp(False, False, False, ' # cmt', None,        True,   None,           True,   'targetprof',   False)),
        ('pivot_root oldroot="/oldroot",                       # cmt',  exp(False, False, False, ' # cmt', '/oldroot',  False,  None,           True,   None,           True)),
        ('pivot_root                  "/new/root",             # cmt',  exp(False, False, False, ' # cmt', None,        True,   '/new/root',    False,  None,           True)),
        ('pivot_root                          -> "targetprof", # cmt',  exp(False, False, False, ' # cmt', None,        True,   None,           True,   'targetprof',   False)),
    )

    def _run_test(self, rawrule, expected):
        self.assertTrue(PivotRootRule.match(rawrule))
        obj = PivotRootRule.create_instance(rawrule)
        self.assertEqual(rawrule.strip(), obj.raw_rule)
        self._compare_obj(obj, expected)


class PivotRootTestParseInvalid(PivotRootTest):
    tests = (
        ('pivot_root foo,',         AppArmorException),
        ('pivot_root foo bar,',     AppArmorException),
        ('pivot_root oldroot= ,',   AppArmorException),
        ('pivot_root ->  ,',        AppArmorException),
    )

    def _run_test(self, rawrule, expected):
        self.assertTrue(PivotRootRule.match(rawrule))  # the above invalid rules still match the main regex!
        with self.assertRaises(expected):
            PivotRootRule.create_instance(rawrule)

    def test_invalid_rule_name(self):
        self.assertFalse(PivotRootRule.match('pivot_rootbeer,'))
        with self.assertRaises(AppArmorException):
            PivotRootRule.create_instance('pivot_rootbeer,')


class PivotRootTestParseFromLog(PivotRootTest):
    def test_pivot_root_from_log(self):
        parser = ReadLog('', '', '')
        event = 'type=AVC msg=audit(1409700678.384:547594): apparmor="DENIED" operation="pivotroot" profile="/home/ubuntu/bzr/apparmor/tests/regression/apparmor/pivot_root" name="/tmp/sdtest.21082-7446-EeefO6/new_root/" pid=21162 comm="pivot_root" srcname="/tmp/sdtest.21082-7446-EeefO6/new_root/put_old/"'

        parsed_event = parser.parse_event(event)

        self.assertEqual(parsed_event, {
            'request_mask': None,
            'denied_mask': None,
            'error_code': 0,
            'magic_token': 0,
            'parent': 0,
            'profile': '/home/ubuntu/bzr/apparmor/tests/regression/apparmor/pivot_root',
            'operation': 'pivotroot',
            'resource': None,
            'info': None,
            'aamode': 'REJECTING',
            'time': 1409700678,
            'active_hat': None,
            'pid': 21162,
            'task': 0,
            'attr': None,
            'name2': None,
            'src_name': '/tmp/sdtest.21082-7446-EeefO6/new_root/put_old/',
            'name': '/tmp/sdtest.21082-7446-EeefO6/new_root/',
            'family': None,
            'protocol': None,
            'sock_type': None,
            'class': None,
        })

        obj = PivotRootRule(parsed_event['src_name'], parsed_event['name'], PivotRootRule.ALL, log_event=parsed_event)

        #             audit  allow  deny  comment   oldroot                                            all?   newroot                                    all?   target all?
        expected = exp(False, False, False, '',     '/tmp/sdtest.21082-7446-EeefO6/new_root/put_old/', False, '/tmp/sdtest.21082-7446-EeefO6/new_root/', False, None, True)

        self._compare_obj(obj, expected)

        self.assertEqual(
            obj.get_raw(1),
            '  pivot_root oldroot=/tmp/sdtest.21082-7446-EeefO6/new_root/put_old/ /tmp/sdtest.21082-7446-EeefO6/new_root/,')


class PivotRootFromInit(PivotRootTest):
    tests = (
        # PivotRootRule object                                                                  audit  allow  deny   comment    oldroot     all?    newroot         all?    profile_name    all?
        (PivotRootRule('/oldroot',        '/new/root',       'some_profile',    deny=True), exp(False, False, True,  '',        '/oldroot', False,  '/new/root',    False,  'some_profile', False)),
        (PivotRootRule('/oldroot',        '/new/root',       PivotRootRule.ALL, deny=True), exp(False, False, True,  '',        '/oldroot', False,  '/new/root',    False,  None,           True)),
        (PivotRootRule('/oldroot',        PivotRootRule.ALL, '/someprofile',    deny=True), exp(False, False, True,  '',        '/oldroot', False,  None,           True,   '/someprofile', False)),
        (PivotRootRule(PivotRootRule.ALL, '/new/root',       '/someprofile',    deny=True), exp(False, False, True,  '',        None,       True,   '/new/root',    False,  '/someprofile', False)),
        (PivotRootRule('/oldroot',        PivotRootRule.ALL, PivotRootRule.ALL, deny=True), exp(False, False, True,  '',        '/oldroot', False,  None,           True,   None,           True)),
        (PivotRootRule(PivotRootRule.ALL, '/new/root',       PivotRootRule.ALL, deny=True), exp(False, False, True,  '',        None,       True,   '/new/root',    False,  None,           True)),
        (PivotRootRule(PivotRootRule.ALL, PivotRootRule.ALL, 'some_profile',    deny=True), exp(False, False, True,  '',        None,       True,   None,           True,   'some_profile', False)),
        (PivotRootRule(PivotRootRule.ALL, PivotRootRule.ALL, PivotRootRule.ALL, deny=True), exp(False, False, True,  '',        None,       True,   None,           True,   None,           True)),
    )

    def _run_test(self, obj, expected):
        self._compare_obj(obj, expected)


class InvalidPivotRootInit(AATest):
    tests = (
        # (init params, expected exception)
        (('',     '/foo', 'bar'), AppArmorBug),        # empty oldroot
        (('/old', '',     'bar'), AppArmorBug),        # empty newroot
        (('/old', '/foo', ''   ), AppArmorBug),        # empty targetprof # noqa: E202

        (('old',  '/foo', 'bar'), AppArmorException),  # oldroot is not a path
        (('/old', 'foo',  'bar'), AppArmorException),  # newroot is not a path


        ((None,   '/foo', 'bar'), AppArmorBug),        # wrong type
        (('/old', None,   'bar'), AppArmorBug),        #
        (('/old', '/foo', None ), AppArmorBug),                           # noqa: E202

        ((dict(), '/foo', 'bar'), AppArmorBug),        # wrong type
        (('/old', dict(), 'bar'), AppArmorBug),        #
        (('/old', '/foo', dict()), AppArmorBug),       #
    )

    def _run_test(self, params, expected):
        with self.assertRaises(expected):
            PivotRootRule(*params)

    def test_missing_params_1(self):
        with self.assertRaises(TypeError):
            PivotRootRule()

    def test_missing_params_2(self):
        with self.assertRaises(TypeError):
            PivotRootRule('/foo')

    def test_missing_params_3(self):
        with self.assertRaises(TypeError):
            PivotRootRule('/foo', '/bar')


class InvalidPivotRootTest(AATest):
    def _check_invalid_rawrule(self, rawrule):
        obj = None
        self.assertFalse(PivotRootRule.match(rawrule))
        with self.assertRaises(AppArmorException):
            obj = PivotRootRule.create_instance(rawrule)

        self.assertIsNone(obj, 'PivotRootRule handed back an object unexpectedly')

    def test_invalid_pivot_root_missing_comma(self):
        self._check_invalid_rawrule('pivot_root')  # missing comma

    def test_invalid_non_PivotRootRule(self):
        self._check_invalid_rawrule('dbus,')  # not a pivot_root rule

    def test_empty_data_1(self):
        obj = PivotRootRule('/foo', '/bar', 'prof')
        obj.oldroot = ''
        # no oldroot set, and ALL not set
        with self.assertRaises(AppArmorBug):
            obj.get_clean(1)

    def test_empty_data_2(self):
        obj = PivotRootRule('/foo', '/bar', 'prof')
        obj.newroot = ''
        # no newroot set, and ALL not set
        with self.assertRaises(AppArmorBug):
            obj.get_clean(1)

    def test_empty_data_3(self):
        obj = PivotRootRule('/foo', '/bar', 'prof')
        obj.profile_name = ''
        # no profile_name set, and ALL not set
        with self.assertRaises(AppArmorBug):
            obj.get_clean(1)


class WritePivotRootTestAATest(AATest):
    def _run_test(self, rawrule, expected):
        self.assertTrue(PivotRootRule.match(rawrule))
        obj = PivotRootRule.create_instance(rawrule)
        clean = obj.get_clean()
        raw = obj.get_raw()

        self.assertEqual(expected.strip(), clean, 'unexpected clean rule')
        self.assertEqual(rawrule.strip(), raw, 'unexpected raw rule')

    tests = (
        #  raw rule                                           clean rule
        ('pivot_root,',                                           'pivot_root,'),
        ('     pivot_root         ,    # foo        ',            'pivot_root, # foo'),
        ('    audit     pivot_root /foo,',                        'audit pivot_root /foo,'),
        ('   deny pivot_root         /foo      ,# foo bar',       'deny pivot_root /foo, # foo bar'),
        ('   deny pivot_root        "/foo"     ,# foo bar',       'deny pivot_root /foo, # foo bar'),
        ('   allow pivot_root                        ,# foo bar', 'allow pivot_root, # foo bar'),
        ('   pivot_root  oldroot=/old       ,    # foo        ',            'pivot_root oldroot=/old, # foo'),
        ('   pivot_root  oldroot="/old"     ,    # foo        ',            'pivot_root oldroot=/old, # foo'),
        ('   pivot_root  oldroot=/old    ->  some_profile ,   ',            'pivot_root oldroot=/old -> some_profile,'),
        ('   pivot_root  oldroot=/old /new   ->  some_profile ,   ',            'pivot_root oldroot=/old /new -> some_profile,'),
        ('priority=1 pivot_root  oldroot=/old /new   ->  some_profile ,   ',    'priority=1 pivot_root oldroot=/old /new -> some_profile,'),
        ('priority=0 pivot_root  oldroot=/old /new   ->  some_profile ,   ',    'priority=0 pivot_root oldroot=/old /new -> some_profile,'),
        ('priority=-1 pivot_root  oldroot=/old /new   ->  some_profile ,  ',    'priority=-1 pivot_root oldroot=/old /new -> some_profile,'),
        ('priority=+1 pivot_root  oldroot=/old /new   ->  some_profile ,  ',    'priority=1 pivot_root oldroot=/old /new -> some_profile,'),
    )

    def test_write_manually(self):
        obj = PivotRootRule('/old', '/new', 'target', allow_keyword=True)

        expected = '    allow pivot_root oldroot=/old /new -> target,'

        self.assertEqual(expected, obj.get_clean(2), 'unexpected clean rule')
        self.assertEqual(expected, obj.get_raw(2), 'unexpected raw rule')


class PivotRootCoveredTest(AATest):
    def _run_test(self, param, expected):
        obj = PivotRootRule.create_instance(self.rule)
        check_obj = PivotRootRule.create_instance(param)

        self.assertTrue(PivotRootRule.match(param))

        self.assertEqual(obj.is_equal(check_obj), expected[0], 'Mismatch in is_equal, expected {}'.format(expected[0]))
        self.assertEqual(obj.is_equal(check_obj, True), expected[1], 'Mismatch in is_equal/strict, expected {}'.format(expected[1]))

        self.assertEqual(obj.is_covered(check_obj), expected[2], 'Mismatch in is_covered, expected {}'.format(expected[2]))
        self.assertEqual(obj.is_covered(check_obj, True, True), expected[3], 'Mismatch in is_covered/exact, expected {}'.format(expected[3]))


class PivotRootCoveredTest_01(PivotRootCoveredTest):
    rule = 'pivot_root /new,'

    tests = (
        #   rule                                         equal  strict equal  covered  covered exact
        ('pivot_root,',                                 (False, False,        False,   False)),
        ('pivot_root              /n*,',                (False, False,        False,   False)),
        ('pivot_root oldroot=/old,',                    (False, False,        False,   False)),
        ('pivot_root              /new,',               (True,  False,        True,    True)),
        ('pivot_root                   -> target,',     (False, False,        False,   False)),
        ('pivot_root oldroot=/old /new,',               (False, False,        True,    True)),
        ('pivot_root              /new -> target,',     (False, False,        True,    True)),
        ('pivot_root oldroot=/old      -> target,',     (False, False,        False,   False)),
        ('pivot_root oldroot=/old /new -> target,',     (False, False,        True,    True)),
    )


class PivotRootCoveredTest_02(PivotRootCoveredTest):
    rule = 'audit pivot_root oldroot=/ol*,'

    tests = (
        #   rule                                               equal  strict equal  covered  covered exact
        ('audit pivot_root,',                                 (False, False,        False,   False)),
        ('audit pivot_root oldroot=/ol*,',                    (True,  True,         True,    True)),
        ('audit pivot_root oldroot=/old,',                    (False, False,        True,    True)),
        ('audit pivot_root              /new,',               (False, False,        False,   False)),
        ('audit pivot_root                   -> target,',     (False, False,        False,   False)),
        ('audit pivot_root oldroot=/old /new,',               (False, False,        True,    True)),
        ('audit pivot_root              /new -> target,',     (False, False,        False,   False)),
        ('audit pivot_root oldroot=/old      -> target,',     (False, False,        True,    True)),  # covered exact - really?
        ('audit pivot_root oldroot=/old /new -> target,',     (False, False,        True,    True)),  # covered exact - really?
    )


class PivotRootCoveredTest_03(PivotRootCoveredTest):
    rule = 'pivot_root -> target,'

    tests = (
        #   rule                                         equal  strict equal  covered  covered exact
        ('pivot_root,',                                 (False, False,        False,   False)),
        ('pivot_root oldroot=/ol*,',                    (False, False,        False,   False)),
        ('pivot_root oldroot=/old,',                    (False, False,        False,   False)),
        ('pivot_root              /new,',               (False, False,        False,   False)),
        ('pivot_root                   -> target,',     (True,  False,        True,    True)),
        ('pivot_root oldroot=/old /new,',               (False, False,        False,   False)),
        ('pivot_root              /new -> target,',     (False, False,        True,    True)),
        ('pivot_root oldroot=/old      -> target,',     (False, False,        True,    True)),
        ('pivot_root oldroot=/old /new -> target,',     (False, False,        True,    True)),
    )


class PivotRootCoveredTest_04(PivotRootCoveredTest):
    rule = 'deny pivot_root /foo,'

    tests = (
        #   rule                         equal  strict equal  covered   covered exact
        ('      deny pivot_root /foo,',     (True,  True,         True,    True)),
        ('audit deny pivot_root /foo,',     (False, False,        False,   False)),
        ('           pivot_root /foo,',     (False, False,        False,   False)),  # XXX should covered be true here?
        ('      deny pivot_root /bar,',     (False, False,        False,   False)),
        ('      deny pivot_root,',          (False, False,        False,   False)),
    )


class PivotRootCoveredTest_Invalid(AATest):
    # TODO: should this be detected?
    # def test_borked_obj_is_covered_1(self):
    #     obj = PivotRootRule.create_instance('pivot_root oldroot=/old /new -> target,')

    #     testobj = PivotRootRule('/old', '/foo', 'targetprof')
    #     testobj.oldrooot = None

    #     with self.assertRaises(AppArmorBug):
    #         obj.is_covered(testobj)

    def test_borked_obj_is_covered_2(self):
        obj = PivotRootRule.create_instance('pivot_root oldroot=/old /new -> target,')

        testobj = PivotRootRule('/old', '/foo', 'targetprof')
        testobj.newroot = ''

        with self.assertRaises(AppArmorBug):
            obj.is_covered(testobj)

    # def test_borked_obj_is_covered_3(self):
    # TODO: should this be detected?
    #     obj = PivotRootRule.create_instance('pivot_root oldroot=/old /new -> target,')

    #     testobj = PivotRootRule('/old', '/foo', 'targetprof')
    #     testobj.profile_name = ''

    #     with self.assertRaises(AppArmorBug):
    #         obj.is_covered(testobj)

    def test_invalid_is_covered(self):
        raw_rule = 'pivot_root oldroot=/old /new -> target,'

        class SomeOtherClass(PivotRootRule):
            pass

        obj = PivotRootRule.create_instance(raw_rule)
        testobj = SomeOtherClass.create_instance(raw_rule)  # different type
        with self.assertRaises(AppArmorBug):
            obj.is_covered(testobj)

    def test_invalid_is_equal_1(self):
        raw_rule = 'pivot_root oldroot=/old /new -> target,'

        class SomeOtherClass(PivotRootRule):
            pass

        obj = PivotRootRule.create_instance(raw_rule)
        testobj = SomeOtherClass.create_instance(raw_rule)  # different type
        with self.assertRaises(AppArmorBug):
            obj.is_equal(testobj)

#   def test_invalid_is_equal_2(self):
    # TODO: should this be detected?
#       obj = PivotRootRule.create_instance('pivot_root oldroot=/old /new -> target,')

#       testobj = PivotRootRule.create_instance('pivot_root oldroot=/old /new -> target,')
#       testobj.all_oldroots = False  # make testobj invalid (should trigger exception in _is_equal_aare())

#       with self.assertRaises(AppArmorBug):
#           obj.is_equal(testobj)


class PivotRootLogprofHeaderTest(AATest):
    tests = (
        ('pivot_root,',                             [                              _('Old root'), _('ALL'),  _('New root'), _('ALL'),  _('Target profile'), _('ALL')]),  # noqa: E201
        ('pivot_root oldroot=/old,',                [                              _('Old root'), '/old',    _('New root'), _('ALL'),  _('Target profile'), _('ALL')]),  # noqa: E201
        ('deny pivot_root,',                        [_('Qualifier'), 'deny',       _('Old root'), _('ALL'),  _('New root'), _('ALL'),  _('Target profile'), _('ALL')]),
        ('allow pivot_root oldroot=/old,',          [_('Qualifier'), 'allow',      _('Old root'), '/old',    _('New root'), _('ALL'),  _('Target profile'), _('ALL')]),
        ('audit pivot_root /new,',                  [_('Qualifier'), 'audit',      _('Old root'), _('ALL'),  _('New root'), '/new',    _('Target profile'), _('ALL')]),
        ('audit deny pivot_root /new -> target,',   [_('Qualifier'), 'audit deny', _('Old root'), _('ALL'),  _('New root'), '/new',    _('Target profile'), 'target']),
        ('pivot_root oldroot=/old /new -> target,', [                              _('Old root'), '/old',    _('New root'), '/new',    _('Target profile'), 'target']),  # noqa: E201
    )

    def _run_test(self, params, expected):
        obj = PivotRootRule.create_instance(params)
        self.assertEqual(obj.logprof_header(), expected)


class PivotRootEditHeaderTest(AATest):
    def _run_test(self, params, expected):
        rule_obj = PivotRootRule.create_instance(params)
        self.assertEqual(rule_obj.can_edit, True)
        prompt, path_to_edit = rule_obj.edit_header()
        self.assertEqual(path_to_edit, expected)

    tests = (
        ('pivot_root oldroot=/old /foo/bar/baz -> target,',     '/foo/bar/baz'),
        ('pivot_root /foo/**/baz,',                             '/foo/**/baz'),
        ('pivot_root /foo/** -> /bar,',                         '/foo/**'),
    )

    def test_edit_header_bare_pivot_root(self):
        rule_obj = PivotRootRule.create_instance('pivot_root,')
        self.assertEqual(rule_obj.can_edit, False)
        with self.assertRaises(AppArmorBug):
            rule_obj.edit_header()


class PivotRootValidateAndStoreEditTest(AATest):
    def _run_test(self, params, expected):
        rule_obj = PivotRootRule('/old/', '/foo/bar/baz', 'target', log_event=True)

        self.assertEqual(rule_obj.validate_edit(params), expected)

        rule_obj.store_edit(params)
        self.assertEqual(rule_obj.get_raw(), 'pivot_root oldroot=/old/ ' + params + ' -> target,')

    tests = (
        # edited path     match
        ('/foo/bar/baz',  True),
        ('/foo/bar/*',    True),
        ('/foo/bar/???',  True),
        ('/foo/xy**',     False),
        ('/foo/bar/baz/', False),
    )

    def test_validate_not_a_path(self):
        rule_obj = PivotRootRule.create_instance('pivot_root /foo/bar/baz,')

        with self.assertRaises(AppArmorException):
            rule_obj.validate_edit('foo/bar/baz')

        with self.assertRaises(AppArmorException):
            rule_obj.store_edit('foo/bar/baz')

    def test_validate_edit_bare_pivot_root(self):
        rule_obj = PivotRootRule.create_instance('pivot_root,')
        self.assertEqual(rule_obj.can_edit, False)

        with self.assertRaises(AppArmorBug):
            rule_obj.validate_edit('/foo/bar')

        with self.assertRaises(AppArmorBug):
            rule_obj.store_edit('/foo/bar')


# --- tests for PivotRootRuleset --- #

class PivotRootRulesTest(AATest):
    def test_empty_ruleset(self):
        ruleset = PivotRootRuleset()
        ruleset_2 = PivotRootRuleset()
        self.assertEqual([], ruleset.get_raw(2))
        self.assertEqual([], ruleset.get_clean(2))
        self.assertEqual([], ruleset_2.get_raw(2))
        self.assertEqual([], ruleset_2.get_clean(2))

        # test __repr__() for empty ruleset
        self.assertEqual(str(ruleset), '<PivotRootRuleset (empty) />')

    def test_ruleset_1(self):
        ruleset = PivotRootRuleset()
        rules = (
            'pivot_root oldroot=/foo,',
            'pivot_root /new,',
        )

        expected_raw = [
            'pivot_root oldroot=/foo,',
            'pivot_root /new,',
            '',
        ]

        expected_clean = [
            'pivot_root /new,',
            'pivot_root oldroot=/foo,',
            '',
        ]

        for rule in rules:
            ruleset.add(PivotRootRule.create_instance(rule))

        self.assertEqual(expected_raw, ruleset.get_raw())
        self.assertEqual(expected_clean, ruleset.get_clean())

        # test __repr__() for non-empty ruleset
        self.assertEqual(
            str(ruleset), '<PivotRootRuleset>\n  pivot_root oldroot=/foo,\n  pivot_root /new,\n</PivotRootRuleset>')


class PivotRootGlobTestAATest(AATest):
    def test_glob(self):
        glob_list = [(
            'pivot_root /foo/bar,',
            'pivot_root /foo/*,',
            'pivot_root /**,',
        )]
        for globs in glob_list:
            for i in range(len(globs) - 1):
                rule = PivotRootRule.create_instance(globs[i])
                rule.glob()
                self.assertEqual(rule.get_clean(), globs[i + 1])

    def test_glob_all(self):
        glob_list = [(
            'pivot_root,',
            'pivot_root,',
        )]
        for globs in glob_list:
            for i in range(len(globs) - 1):
                rule = PivotRootRule.create_instance(globs[i])
                rule.glob()
                self.assertEqual(rule.get_clean(), globs[i + 1])


#   def test_glob_ext(self):
#       # rule = PivotRootRule.create_instance('pivot_root /foo/bar,')
#       with self.assertRaises(NotImplementedError):
#           # get_glob_ext is not available for pivot_root rules
#           self.ruleset.get_glob_ext('pivot_root /foo,')


# class PivotRootDeleteTestAATest(AATest):
#     pass


setup_all_loops(__name__)
if __name__ == '__main__':
    unittest.main(verbosity=1)