/
test_message_pact.py
267 lines (219 loc) · 9.8 KB
/
test_message_pact.py
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
import os
import json
from mock import patch
from unittest import TestCase
from pact.message_consumer import MessageConsumer, Provider
from pact.message_pact import MessagePact
from pact.constants import MESSAGE_PATH
from pact import message_pact as message_pact
from pact import Term
class MessagePactTestCase(TestCase):
def setUp(self):
self.consumer = MessageConsumer('TestConsumer')
self.provider = Provider('TestProvider')
def test_init_defaults(self):
target = MessagePact(self.consumer, self.provider)
self.assertIs(target.broker_base_url, None)
self.assertIs(target.broker_username, None)
self.assertIs(target.broker_password, None)
self.assertIs(target.consumer, self.consumer)
self.assertEqual(target.pact_dir, os.getcwd())
self.assertIs(target.provider, self.provider)
self.assertIs(target.publish_to_broker, False)
self.assertEqual(target.version, '3.0.0')
self.assertEqual(len(target._messages), 0)
def test_init_custom_mock_service(self):
target = MessagePact(
self.consumer, self.provider, pact_dir='/pacts',
version='3.0.0', file_write_mode='merge')
self.assertIs(target.consumer, self.consumer)
self.assertEqual(target.pact_dir, '/pacts')
self.assertIs(target.provider, self.provider)
self.assertEqual(target.version, '3.0.0')
self.assertEqual(target.file_write_mode, 'merge')
self.assertEqual(len(target._messages), 0)
def test_init_publish_to_broker(self):
target = MessagePact(
self.consumer, self.provider, publish_to_broker=True,
broker_base_url='http://localhost', broker_username='username',
broker_password='password', broker_token='token')
self.assertEqual(target.broker_base_url, 'http://localhost')
self.assertEqual(target.broker_username, 'username')
self.assertEqual(target.broker_password, 'password')
self.assertEqual(target.broker_token, 'token')
self.assertIs(target.publish_to_broker, True)
def test_definition_sparse(self):
target = MessagePact(self.consumer, self.provider)
(
target
.given('there is an alligator named John')
.expects_to_receive('an alligator message')
.with_content({'name': 'John', 'document_name': 'sample_document.doc'})
.with_metadata({'contentType': 'application/json',
'source': 'legacy_api',
'some-header': Term('\\d+-\\d+-\\d+T\\d+:\\d+:\\d+', '2022-02-15T20:16:01')})
)
self.assertEqual(len(target._messages), 1)
self.assertEqual(
target._messages[0]['providerStates'],
[{'name': 'there is an alligator named John'}])
self.assertEqual(
target._messages[0]['description'],
'an alligator message')
self.assertEqual(
target._messages[0]['contents'],
{'name': 'John', 'document_name': 'sample_document.doc'})
self.assertTrue({'contentType': 'application/json', 'source': 'legacy_api'}.items()
<= target._messages[0]['metaData'].items())
self.assertTrue(target._messages[0]['metaData']['some-header'], 'Pact::Term')
def test_definition_multiple_provider_states(self):
target = MessagePact(self.consumer, self.provider)
(
target
.given('there is an alligator named John',
params={'color': 'green', 'weight_kg': 130, 'length_m': 1.95})
.given('there is an spider named Jack',
params={'color': 'mostly black', 'weight_kg': 0.009, 'length_m': 0.05})
.expects_to_receive('an alligator message')
.with_content({'name': 'John', 'document_name': 'sample_document.doc'})
.with_metadata({'contentType': 'application/json',
'source': 'legacy_api',
'some-header': Term('\\d+-\\d+-\\d+T\\d+:\\d+:\\d+', '2022-02-15T20:16:01')})
)
self.assertEqual(len(target._messages), 1)
self.assertEqual(
target._messages[0]['providerStates'],
[
{
'name': 'there is an alligator named John',
'params': {
'color': 'green',
'weight_kg': 130,
'length_m': 1.95
}
},
{
'name': 'there is an spider named Jack',
'params': {
'color': 'mostly black',
'weight_kg': 0.009,
'length_m': 0.05
}
}
]
)
self.assertEqual(
target._messages[0]['description'],
'an alligator message')
self.assertEqual(
target._messages[0]['contents'],
{'name': 'John', 'document_name': 'sample_document.doc'})
self.assertTrue({'contentType': 'application/json', 'source': 'legacy_api'}.items()
<= target._messages[0]['metaData'].items())
self.assertTrue(target._messages[0]['metaData']['some-header'], 'Pact::Term')
def test_insert_new_message_once_required_attributes_provided(self):
target = MessagePact(self.consumer, self.provider)
(
target
.given('there is an alligator named John')
.with_content({'name': 'John', 'document_name': 'sample_document.doc'})
.with_metadata({'contentType': 'application/json'})
)
self.assertEqual(len(target._messages), 1)
(
target.expects_to_receive('an alligator message')
)
self.assertEqual(len(target._messages), 1)
self.assertEqual(target._messages[0]['description'], 'an alligator message')
(
target.expects_to_receive('a new message description')
)
self.assertEqual(len(target._messages), 2)
self.assertEqual(target._messages[0]['description'], 'a new message description')
def test_definition_without_given(self):
target = MessagePact(self.consumer, self.provider)
(
target
.expects_to_receive('an crocodile message')
.with_content({'name': 'Mary'})
.with_metadata({'source': 'legacy_api'})
)
self.assertEqual(len(target._messages), 1)
self.assertIsNone(target._messages[0].get('providerStates'))
self.assertEqual(
target._messages[0]['description'],
'an crocodile message')
self.assertEqual(
target._messages[0]['contents'],
{'name': 'Mary'})
self.assertEqual(
target._messages[0]['metaData'],
{'source': 'legacy_api'})
class MessagePactContextManagerTestCase(MessagePactTestCase):
def setUp(self):
super(MessagePactContextManagerTestCase, self).setUp()
self.addCleanup(patch.stopall)
self.write_to_pact_file = patch.object(
message_pact.MessagePact, 'write_to_pact_file', autospec=True).start()
self.write_to_pact_file.return_value.returncode = 0
self.mock_publish = patch.object(
message_pact.MessagePact, 'publish', autospec=True).start()
self.mock_publish.return_value.returncode = 0
def test_successful(self):
pact = MessagePact(
self.consumer, self.provider, publish_to_broker=True,
broker_base_url='http://localhost', broker_username='username', broker_password='password',
pact_dir='some_dir')
with pact:
pass
self.write_to_pact_file.assert_called_once()
self.mock_publish.assert_called_once_with(
pact,
'TestConsumer',
'0.0.0',
auto_detect_version_properties=False,
branch=None,
build_url=None,
consumer_tags=None,
pact_dir='some_dir',
tag_with_git_branch=False
)
def test_context_raises_error(self):
pact = MessagePact(
self.consumer, self.provider, publish_to_broker=True,
broker_base_url='http://localhost', broker_username='username', broker_password='password')
with self.assertRaises(RuntimeError):
with pact:
raise RuntimeError
self.write_to_pact_file.assert_not_called()
self.mock_publish.assert_not_called()
class PactGeneratePactFileTestCase(TestCase):
def setUp(self):
super(PactGeneratePactFileTestCase, self).setUp()
self.addCleanup(patch.stopall)
self.mock_Popen = patch.object(message_pact, 'Popen', autospec=True).start()
self.mock_Popen.return_value.returncode = 0
self.consumer = MessageConsumer('TestConsumer')
self.provider = Provider('TestProvider')
def test_call_pact_message_to_generate_pact_file(self):
target = MessagePact(
self.consumer, self.provider, pact_dir='/pacts',
version='3.0.0', file_write_mode='merge', publish_to_broker=True)
(target
.given('There is an alligator named John')
.expects_to_receive('an alligator message')
.with_content({
'name': 'John',
'document_name': 'sample_document.doc'
}).with_metadata({
'contentType': 'application/json',
'source': 'legacy_api'}))
target.write_to_pact_file()
self.mock_Popen.assert_called_once_with([
MESSAGE_PATH, 'update',
json.dumps(target._messages[0]),
'--pact-dir', '/pacts',
'--pact-specification-version=3.0.0',
'--consumer', 'TestConsumer',
'--provider', 'TestProvider',
])