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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# The MIT License
#
# Copyright 2012 Sony Mobile Communications. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""Unit tests for the Pygerrit2 helper methods."""
import unittest
from pygerrit2 import GerritReviewMessageFormatter
from pygerrit2.rest import GerritReview, _merge_dict
EXPECTED_TEST_CASE_FIELDS = ['header', 'footer', 'paragraphs', 'result']
TEST_CASES = [
{'header': None,
'footer': None,
'paragraphs': [],
'result': ""},
{'header': "Header",
'footer': "Footer",
'paragraphs': [],
'result': ""},
{'header': None,
'footer': None,
'paragraphs': ["Test"],
'result': "Test"},
{'header': None,
'footer': None,
'paragraphs': ["Test", "Test"],
'result': "Test\n\nTest"},
{'header': "Header",
'footer': None,
'paragraphs': ["Test"],
'result': "Header\n\nTest"},
{'header': "Header",
'footer': None,
'paragraphs': ["Test", "Test"],
'result': "Header\n\nTest\n\nTest"},
{'header': "Header",
'footer': "Footer",
'paragraphs': ["Test", "Test"],
'result': "Header\n\nTest\n\nTest\n\nFooter"},
{'header': "Header",
'footer': "Footer",
'paragraphs': [["One"]],
'result': "Header\n\n* One\n\nFooter"},
{'header': "Header",
'footer': "Footer",
'paragraphs': [["One", "Two"]],
'result': "Header\n\n* One\n* Two\n\nFooter"},
{'header': "Header",
'footer': "Footer",
'paragraphs': ["Test", ["One"], "Test"],
'result': "Header\n\nTest\n\n* One\n\nTest\n\nFooter"},
{'header': "Header",
'footer': "Footer",
'paragraphs': ["Test", ["One", "Two"], "Test"],
'result': "Header\n\nTest\n\n* One\n* Two\n\nTest\n\nFooter"},
{'header': "Header",
'footer': "Footer",
'paragraphs': ["Test", "Test", ["One"]],
'result': "Header\n\nTest\n\nTest\n\n* One\n\nFooter"},
{'header': None,
'footer': None,
'paragraphs': [["* One", "* Two"]],
'result': "* One\n* Two"},
{'header': None,
'footer': None,
'paragraphs': [["* One ", " * Two "]],
'result': "* One\n* Two"},
{'header': None,
'footer': None,
'paragraphs': [["*", "*"]],
'result': ""},
{'header': None,
'footer': None,
'paragraphs': [["", ""]],
'result': ""},
{'header': None,
'footer': None,
'paragraphs': [[" ", " "]],
'result': ""},
{'header': None,
'footer': None,
'paragraphs': [["* One", " ", "* Two"]],
'result': "* One\n* Two"}]
class TestMergeDict(unittest.TestCase):
"""Tests for the `_merge_dict` method."""
def test_merge_into_empty_dict(self):
"""Test merging into an empty dict."""
dct = {}
_merge_dict(dct, {'a': 1, 'b': 2})
self.assertEqual(dct, {'a': 1, 'b': 2})
def test_merge_flat(self):
"""Test merging a flat dict."""
dct = {'c': 3}
_merge_dict(dct, {'a': 1, 'b': 2})
self.assertEqual(dct, {'a': 1, 'b': 2, 'c': 3})
def test_merge_with_override(self):
"""Test merging a dict and overriding values."""
dct = {'a': 1}
_merge_dict(dct, {'a': 0, 'b': 2})
self.assertEqual(dct, {'a': 0, 'b': 2})
def test_merge_two_levels(self):
"""Test merging a dict with two levels."""
dct = {
'a': {
'A': 1,
'AA': 2,
},
'b': {
'B': 1,
'BB': 2,
},
}
overrides = {
'a': {
'AAA': 3,
},
'b': {
'BBB': 3,
},
}
_merge_dict(dct, overrides)
self.assertEqual(
dct,
{
'a': {
'A': 1,
'AA': 2,
'AAA': 3,
},
'b': {
'B': 1,
'BB': 2,
'BBB': 3,
},
}
)
class TestGerritReviewMessageFormatter(unittest.TestCase):
"""Test that the GerritReviewMessageFormatter class behaves properly."""
def _check_test_case_fields(self, test_case, i):
for field in EXPECTED_TEST_CASE_FIELDS:
self.assertTrue(field in test_case,
"field '%s' not present in test case #%d" %
(field, i))
self.assertTrue(
isinstance(test_case['paragraphs'], list),
"'paragraphs' field is not a list in test case #%d" % i)
def test_is_empty(self):
"""Test if message is empty for missing header and footer."""
fmt = GerritReviewMessageFormatter(header=None, footer=None)
self.assertTrue(fmt.is_empty())
fmt.append(['test'])
self.assertFalse(fmt.is_empty())
def test_message_formatting(self):
"""Test message formatter for different test cases."""
for i, test_case in enumerate(TEST_CASES):
self._check_test_case_fields(test_case, i)
fmt = GerritReviewMessageFormatter(header=test_case['header'],
footer=test_case['footer'])
for paragraph in test_case['paragraphs']:
fmt.append(paragraph)
msg = fmt.format()
self.assertEqual(msg, test_case['result'],
"Formatted message does not match expected "
"result in test case #%d:\n[%s]" % (i, msg))
class TestGerritReview(unittest.TestCase):
"""Test that the GerritReview class behaves properly."""
def test_str(self):
"""Test for str function."""
obj = GerritReview()
self.assertEqual(str(obj), '{}')
obj2 = GerritReview(labels={'Verified': 1, 'Code-Review': -1})
self.assertEqual(
str(obj2),
'{"labels": {"Code-Review": -1, "Verified": 1}}')
obj3 = GerritReview(comments=[{'filename': 'Makefile',
'line': 10, 'message': 'test'}])
self.assertEqual(
str(obj3),
'{"comments": {"Makefile": [{"line": 10, "message": "test"}]}}')
obj4 = GerritReview(labels={'Verified': 1, 'Code-Review': -1},
comments=[{'filename': 'Makefile', 'line': 10,
'message': 'test'}])
self.assertEqual(
str(obj4),
'{"comments": {"Makefile": [{"line": 10, "message": "test"}]},'
' "labels": {"Code-Review": -1, "Verified": 1}}')
obj5 = GerritReview(comments=[
{'filename': 'Makefile', 'line': 15, 'message': 'test'},
{'filename': 'Make', 'line': 10, 'message': 'test1'}
])
self.assertEqual(
str(obj5),
'{"comments": {"Make": [{"line": 10, "message": "test1"}],'
' "Makefile": [{"line": 15, "message": "test"}]}}')
if __name__ == '__main__':
unittest.main()
|
