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
|
# Copyright 2017 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import textwrap
from oslotest import base
from oslo_policy import policy
from oslo_policy import sphinxext
class IndentTest(base.BaseTestCase):
def test_indent(self):
result = sphinxext._indent("foo\nbar")
self.assertEqual(" foo\n bar", result)
result = sphinxext._indent("")
self.assertEqual("", result)
result = sphinxext._indent("\n")
self.assertEqual("\n", result)
result = sphinxext._indent("test\ntesting\n\nafter blank")
self.assertEqual(" test\n testing\n\n after blank", result)
result = sphinxext._indent("\tfoo\nbar")
self.assertEqual(" \tfoo\n bar", result)
result = sphinxext._indent(" foo\nbar")
self.assertEqual(" foo\n bar", result)
result = sphinxext._indent("foo\n bar")
self.assertEqual(" foo\n bar", result)
result = sphinxext._indent("foo\n\n bar")
self.assertEqual(" foo\n\n bar", result)
self.assertRaises(AttributeError, sphinxext._indent, None)
class FormatPolicyTest(base.BaseTestCase):
def test_minimal(self):
results = '\n'.join(list(sphinxext._format_policy_section(
'foo', [policy.RuleDefault('rule_a', '@')])))
self.assertEqual(textwrap.dedent("""
foo
===
``rule_a``
:Default: ``@``
(no description provided)
""").lstrip(), results)
def test_with_description(self):
results = '\n'.join(list(sphinxext._format_policy_section(
'foo', [policy.RuleDefault('rule_a', '@', 'My sample rule')]
)))
self.assertEqual(textwrap.dedent("""
foo
===
``rule_a``
:Default: ``@``
My sample rule
""").lstrip(), results)
def test_with_operations(self):
results = '\n'.join(list(sphinxext._format_policy_section(
'foo', [policy.DocumentedRuleDefault(
'rule_a', '@', 'My sample rule', [
{'method': 'GET', 'path': '/foo'},
{'method': 'POST', 'path': '/some'}])]
)))
self.assertEqual(textwrap.dedent("""
foo
===
``rule_a``
:Default: ``@``
:Operations:
- **GET** ``/foo``
- **POST** ``/some``
My sample rule
""").lstrip(), results)
def test_with_scope_types(self):
operations = [
{'method': 'GET', 'path': '/foo'},
{'method': 'POST', 'path': '/some'}
]
scope_types = ['bar']
rule = policy.DocumentedRuleDefault(
'rule_a', '@', 'My sample rule', operations,
scope_types=scope_types
)
results = '\n'.join(list(sphinxext._format_policy_section(
'foo', [rule]
)))
self.assertEqual(textwrap.dedent("""
foo
===
``rule_a``
:Default: ``@``
:Operations:
- **GET** ``/foo``
- **POST** ``/some``
:Scope Types:
- **bar**
My sample rule
""").lstrip(), results)
|
