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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import logging
import sys
import os
import json
import pytest
import uuid
from datetime import datetime, timedelta
from msrest.serialization import UTC
import datetime as dt
try:
from urllib.parse import urlparse
except ImportError:
from urlparse import urlparse
from devtools_testutils import AzureRecordedTestCase, recorded_by_proxy
from azure.core.credentials import AzureSasCredential, AzureKeyCredential
from azure.core.messaging import CloudEvent
from azure.core.serialization import NULL
from azure.eventgrid import EventGridPublisherClient, EventGridEvent, generate_sas
from azure.eventgrid._legacy._helpers import _cloud_event_to_generated
from eventgrid_preparer import (
EventGridPreparer,
)
class TestEventGridPublisherClient(AzureRecordedTestCase):
def create_eg_publisher_client(self, endpoint, topic=None):
credential = self.get_credential(EventGridPublisherClient)
client = self.create_client_from_credential(
EventGridPublisherClient, credential=credential, endpoint=endpoint, namespace_topic=topic
)
return client
@EventGridPreparer()
@recorded_by_proxy
def test_send_event_grid_event_data_dict(self, eventgrid_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_topic_endpoint)
eg_event = EventGridEvent(
subject="sample",
data={"sample": "eventgridevent"},
event_type="Sample.EventGrid.Event",
data_version="2.0",
)
client.send(eg_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_event_grid_event_fails_without_full_url(self, eventgrid_topic_endpoint):
credential = self.get_credential(EventGridPublisherClient)
parsed_url = urlparse(eventgrid_topic_endpoint)
client = EventGridPublisherClient(parsed_url.netloc, credential)
eg_event = EventGridEvent(
subject="sample",
data={"sample": "eventgridevent"},
event_type="Sample.EventGrid.Event",
data_version="2.0",
)
with pytest.raises(ValueError):
client.send(eg_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_event_grid_event_data_as_list(self, eventgrid_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_topic_endpoint)
eg_event1 = EventGridEvent(
subject="sample",
data="eventgridevent",
event_type="Sample.EventGrid.Event",
data_version="2.0",
)
eg_event2 = EventGridEvent(
subject="sample2",
data="eventgridevent2",
event_type="Sample.EventGrid.Event",
data_version="2.0",
)
client.send([eg_event1, eg_event2])
@EventGridPreparer()
@recorded_by_proxy
def test_send_event_grid_event_data_str(self, eventgrid_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_topic_endpoint)
eg_event = EventGridEvent(
subject="sample",
data="eventgridevent",
event_type="Sample.EventGrid.Event",
data_version="2.0",
)
client.send(eg_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_event_grid_event_data_bytes(self, eventgrid_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_topic_endpoint)
eg_event = EventGridEvent(
subject="sample",
data=b"eventgridevent",
event_type="Sample.EventGrid.Event",
data_version="2.0",
)
with pytest.raises(TypeError, match="Data in EventGridEvent cannot be bytes*"):
client.send(eg_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_event_grid_event_dict_data_bytes(self, eventgrid_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_topic_endpoint)
eg_event = {
"subject": "sample",
"data": b"eventgridevent",
"eventType": "Sample.EventGrid.Event",
"dataVersion": "2.0",
"id": uuid.uuid4(),
"eventTime": datetime.now(),
}
with pytest.raises(TypeError, match="Data in EventGridEvent cannot be bytes*"):
client.send(eg_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_event_grid_event_dict_data_dict(self, eventgrid_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_topic_endpoint)
eg_event = {
"subject": "sample",
"data": {"key1": "Sample.EventGrid.Event"},
"eventType": "Sample.EventGrid.Event",
"dataVersion": "2.0",
"id": uuid.uuid4(),
"eventTime": datetime.now(),
}
client.send(eg_event)
@pytest.mark.live_test_only
@EventGridPreparer()
def test_send_event_grid_namespace(self, **kwargs):
eventgrid_endpoint = kwargs["eventgrid_endpoint"]
eventgrid_topic_name = kwargs["eventgrid_topic_name"]
client = self.create_eg_publisher_client(eventgrid_endpoint, eventgrid_topic_name)
eg_event = {
"subject": "sample",
"data": {"key1": "Sample.EventGrid.Event"},
"eventType": "Sample.EventGrid.Event",
"dataVersion": "2.0",
"id": uuid.uuid4(),
"eventTime": datetime.now(),
}
with pytest.raises(TypeError):
client.send(eg_event)
### CLOUD EVENT TESTS
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_data_dict(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data={"sample": "cloudevent"},
type="Sample.Cloud.Event",
)
client.send(cloud_event)
@pytest.mark.live_test_only
@EventGridPreparer()
def test_send_cloud_event_data_dict_namespace(self, **kwargs):
eventgrid_endpoint = kwargs["eventgrid_endpoint"]
eventgrid_topic_name = kwargs["eventgrid_topic_name"]
client = self.create_eg_publisher_client(eventgrid_endpoint, eventgrid_topic_name)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data={"sample": "cloudevent"},
type="Sample.Cloud.Event",
)
client.send(cloud_event)
@pytest.mark.live_test_only
@EventGridPreparer()
def test_send_cloud_event_data_channel_name_namespace(self, **kwargs):
eventgrid_endpoint = kwargs["eventgrid_endpoint"]
eventgrid_topic_name = kwargs["eventgrid_topic_name"]
client = self.create_eg_publisher_client(eventgrid_endpoint, eventgrid_topic_name)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data={"sample": "cloudevent"},
type="Sample.Cloud.Event",
)
with pytest.raises(ValueError):
client.send(cloud_event, channel_name="testchannel")
@pytest.mark.skip("https://github.com/Azure/azure-sdk-for-python/issues/16993")
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_data_NULL(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event = CloudEvent(source="http://samplesource.dev", data=NULL, type="Sample.Cloud.Event")
def callback(request):
req = json.loads(request.http_request.body)
assert req[0].get("data") is None
client.send(cloud_event, raw_request_hook=callback)
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_data_base64_using_data(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data=b"cloudevent",
type="Sample.Cloud.Event",
)
def callback(request):
req = json.loads(request.http_request.body)
assert req[0].get("data_base64") is not None
assert req[0].get("data") is None
client.send(cloud_event, raw_response_hook=callback)
def test_send_cloud_event_fails_on_providing_data_and_b64(self):
with pytest.raises(ValueError, match="Unexpected keyword arguments data_base64.*"):
cloud_event = CloudEvent(
source="http://samplesource.dev",
data_base64=b"cloudevent",
data="random data",
type="Sample.Cloud.Event",
)
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_data_none(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event = CloudEvent(source="http://samplesource.dev", data=None, type="Sample.Cloud.Event")
client.send(cloud_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_data_str(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data="cloudevent",
type="Sample.Cloud.Event",
)
client.send(cloud_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_data_bytes(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data=b"cloudevent",
type="Sample.Cloud.Event",
)
client.send(cloud_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_data_as_list(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data="cloudevent",
type="Sample.Cloud.Event",
)
client.send([cloud_event])
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_data_with_extensions(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data="cloudevent",
type="Sample.Cloud.Event",
extensions={"reasoncode": 204, "extension": "hello"},
)
client.send([cloud_event])
internal = _cloud_event_to_generated(cloud_event).serialize()
assert "reasoncode" in internal
assert "extension" in internal
assert internal["reasoncode"] == 204
@EventGridPreparer()
@recorded_by_proxy
def test_send_cloud_event_dict(self, eventgrid_cloud_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_cloud_event_topic_endpoint)
cloud_event1 = {
"id": "1234",
"source": "http://samplesource.dev",
"specversion": "1.0",
"data": "cloudevent",
"type": "Sample.Cloud.Event",
}
client.send(cloud_event1)
@pytest.mark.live_test_only
@EventGridPreparer()
def test_send_signature_credential(self, **kwargs):
eventgrid_topic_endpoint = kwargs.pop("eventgrid_topic_endpoint")
eventgrid_topic_key = kwargs.pop("eventgrid_topic_key")
expiration_date_utc = dt.datetime.now(UTC()) + timedelta(hours=1)
signature = generate_sas(eventgrid_topic_endpoint, eventgrid_topic_key, expiration_date_utc)
credential = AzureSasCredential(signature)
client = EventGridPublisherClient(eventgrid_topic_endpoint, credential)
eg_event = EventGridEvent(
subject="sample",
data={"sample": "eventgridevent"},
event_type="Sample.EventGrid.Event",
data_version="2.0",
)
client.send(eg_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_NONE_credential(self, eventgrid_topic_endpoint):
with pytest.raises(ValueError, match="Parameter 'self._credential' must not be None."):
client = EventGridPublisherClient(eventgrid_topic_endpoint, None)
@EventGridPreparer()
@recorded_by_proxy
def test_send_custom_schema_event(self, eventgrid_custom_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_custom_event_topic_endpoint)
custom_event = {
"customSubject": "sample",
"customEventType": "sample.event",
"customDataVersion": "2.0",
"customId": "1234",
"customEventTime": dt.datetime.now(UTC()).isoformat(),
"customData": "sample data",
}
client.send(custom_event)
@EventGridPreparer()
@recorded_by_proxy
def test_send_custom_schema_event_as_list(self, eventgrid_custom_event_topic_endpoint):
client = self.create_eg_publisher_client(eventgrid_custom_event_topic_endpoint)
custom_event1 = {
"customSubject": "sample",
"customEventType": "sample.event",
"customDataVersion": "2.0",
"customId": "1234",
"customEventTime": dt.datetime.now(UTC()).isoformat(),
"customData": "sample data",
}
custom_event2 = {
"customSubject": "sample2",
"customEventType": "sample.event",
"customDataVersion": "2.0",
"customId": "12345",
"customEventTime": dt.datetime.now(UTC()).isoformat(),
"customData": "sample data 2",
}
client.send([custom_event1, custom_event2])
def test_send_throws_with_bad_credential(self):
bad_credential = "I am a bad credential"
with pytest.raises(
ValueError,
match="The provided credential should be an instance of a TokenCredential, AzureSasCredential or AzureKeyCredential",
):
client = EventGridPublisherClient("eventgrid_endpoint", bad_credential)
@pytest.mark.live_test_only
@EventGridPreparer()
@recorded_by_proxy
def test_send_token_credential(self, eventgrid_topic_endpoint):
credential = self.get_credential(EventGridPublisherClient)
client = EventGridPublisherClient(eventgrid_topic_endpoint, credential)
eg_event = EventGridEvent(
subject="sample",
data={"sample": "eventgridevent"},
event_type="Sample.EventGrid.Event",
data_version="2.0",
)
client.send(eg_event)
@pytest.mark.live_test_only
@EventGridPreparer()
@recorded_by_proxy
def test_send_partner_namespace(self, eventgrid_partner_namespace_topic_endpoint, eventgrid_partner_channel_name):
client = self.create_eg_publisher_client(eventgrid_partner_namespace_topic_endpoint)
cloud_event = CloudEvent(
source="http://samplesource.dev",
data="cloudevent",
type="Sample.Cloud.Event",
)
def callback(request):
req = request.http_request.headers
assert req.get("aeg-channel-name") == eventgrid_partner_channel_name
client.send(cloud_event, channel_name=eventgrid_partner_channel_name, raw_request_hook=callback)
|
