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
|
# Copyright 2015: Mirantis Inc.
# All Rights Reserved.
#
# 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.
from rally.common.plugin import info
from tests.unit import test
class DocstringTestCasePep257(test.TestCase):
docstring_no_leading_whitespace = """One-line description.
Multi-
line-
description.
:param p1: Param 1 description.
:param p2: Param 2
description.
:returns: Return value
description.
"""
docstring_indented = """One-line description.
Multi-
line-
description.
:param p1: Param 1 description.
:param p2: Param 2
description.
:returns: Return value
description.
"""
docstring_oneline = """Simple oneline description."""
def test_trim_docstring_multi_line_no_extra_whitespace(self):
docstring = self.docstring_no_leading_whitespace
expected = self.docstring_no_leading_whitespace
self.assertEqual(expected, info.trim(docstring))
def test_trim_docstring_trivial(self):
docstring = self.docstring_indented
expected = self.docstring_no_leading_whitespace
self.assertEqual(expected, info.trim(docstring))
def test_trim_docstring_oneline(self):
docstring = self.docstring_oneline
expected = self.docstring_oneline
self.assertEqual(expected, info.trim(docstring))
class DocstringTestCase(test.TestCase):
def test_parse_complete_docstring(self):
docstring = """One-line description.
Multi-
line-
description.
:param p1: Param 1 description.
:param p2: Param 2
description.
:returns: Return value
description.
"""
expected = {
"short_description": "One-line description.",
"long_description": "Multi-\nline-\ndescription.",
"params": [{"name": "p1", "doc": "Param 1 description.\n"},
{"name": "p2", "doc": "Param 2\n"
"description.\n"}],
"returns": "Return value\ndescription."
}
self.assertEqual(expected, info.parse_docstring(docstring))
def test_parse_incomplete_docstring(self):
docstring = """One-line description.
:param p1: Param 1 description.
:param p2: Param 2
description.
"""
expected = {
"short_description": "One-line description.",
"long_description": "",
"params": [{"name": "p1", "doc": "Param 1 description.\n"},
{"name": "p2", "doc": "Param 2\n"
"description.\n"}],
"returns": ""
}
self.assertEqual(expected, info.parse_docstring(docstring))
def test_parse_docstring_with_no_params(self):
docstring = """One-line description.
Multi-
line-
description.
:returns: Return value
description.
"""
expected = {
"short_description": "One-line description.",
"long_description": "Multi-\nline-\ndescription.",
"params": [],
"returns": "Return value\ndescription."
}
self.assertEqual(expected, info.parse_docstring(docstring))
def test_parse_docstring_short_only(self):
docstring = """One-line description."""
expected = {
"short_description": "One-line description.",
"long_description": "",
"params": [],
"returns": ""
}
self.assertEqual(expected, info.parse_docstring(docstring))
|
