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 json
import sys
from typing import Callable
import pytest
from stripe.billing._meter import Meter
from tests.http_client_mock import HTTPClientMock
from stripe import DEFAULT_API_BASE
from stripe._error import SignatureVerificationError
from stripe._stripe_client import StripeClient
from stripe.events._v1_billing_meter_error_report_triggered_event import (
V1BillingMeterErrorReportTriggeredEventNotification,
V1BillingMeterErrorReportTriggeredEvent,
)
from stripe.v2.core._event import UnknownEventNotification
from stripe.events._event_classes import ALL_EVENT_NOTIFICATIONS
from tests.test_webhook import DUMMY_WEBHOOK_SECRET, generate_header
EventParser = Callable[[str], ALL_EVENT_NOTIFICATIONS]
class TestV2Event(object):
@pytest.fixture(scope="function")
def v2_payload_no_data(self):
return json.dumps(
{
"id": "evt_234",
"object": "v2.core.event",
"type": "v1.billing.meter.error_report_triggered",
"livemode": True,
"context": "acct_123",
"created": "2022-02-15T00:27:45.330Z",
"related_object": {
"id": "mtr_123",
"type": "billing.meter",
"url": "/v1/billing/meters/mtr_123",
},
"reason": {
"type": "request",
"request": {"id": "foo", "idempotency_key": "bar"},
},
}
)
@pytest.fixture(scope="function")
def v2_payload_with_data(self):
return json.dumps(
{
"id": "evt_234",
"object": "v2.core.event",
"type": "v1.billing.meter.error_report_triggered",
"livemode": False,
"created": "2022-02-15T00:27:45.330Z",
"context": "acct_123",
"related_object": {
"id": "mtr_123",
"type": "billing.meter",
"url": "/v1/billing/meters/mtr_123",
},
"data": {
"reason": {
"error_count": 1,
}
},
}
)
@pytest.fixture(scope="function")
def stripe_client(self, http_client_mock):
return StripeClient(
api_key="sk_test_1234",
http_client=http_client_mock.get_mock_http_client(),
)
@pytest.fixture(scope="function")
def parse_event_notif(self, stripe_client: StripeClient) -> EventParser:
"""
helper to simplify parsing and validating events given a payload
returns a function that has the client pre-bound
"""
def _parse_event_notif(payload: str):
return stripe_client.parse_event_notification(
payload, generate_header(payload=payload), DUMMY_WEBHOOK_SECRET
)
return _parse_event_notif
def test_parses_event_notif(
self, parse_event_notif: EventParser, v2_payload_no_data: str
):
notif = parse_event_notif(v2_payload_no_data)
assert isinstance(
notif, V1BillingMeterErrorReportTriggeredEventNotification
)
assert notif.id == "evt_234"
assert notif.related_object
assert notif.related_object.id == "mtr_123"
assert notif.reason
assert notif.reason.type == "request"
assert notif.reason.request
assert notif.reason.request.id == "foo"
assert notif.reason.request.idempotency_key == "bar"
def test_parses_event_notif_with_data(
self, parse_event_notif: EventParser, v2_payload_with_data: str
):
notif = parse_event_notif(v2_payload_with_data)
assert isinstance(
notif, V1BillingMeterErrorReportTriggeredEventNotification
)
# this isn't for constructing events, it's for parsing thin ones
assert not hasattr(notif, "data")
assert notif.reason is None
def test_parses_unknown_event_notif(self, parse_event_notif: EventParser):
event = parse_event_notif(
json.dumps(
{
"id": "evt_234",
"object": "v2.core.event",
"type": "uknown.event.type",
"livemode": True,
"created": "2022-02-15T00:27:45.330Z",
"context": "acct_456",
"related_object": {
"id": "mtr_123",
"type": "billing.meter",
"url": "/v1/billing/meters/mtr_123",
},
}
)
)
assert type(event) is UnknownEventNotification
assert event.related_object
def test_validates_signature(
self, stripe_client: StripeClient, v2_payload_no_data
):
with pytest.raises(SignatureVerificationError):
stripe_client.parse_event_notification(
v2_payload_no_data, "bad header", DUMMY_WEBHOOK_SECRET
)
def test_v2_events_data_type(self, http_client_mock, v2_payload_with_data):
method = "get"
path = "/v2/core/events/evt_123"
http_client_mock.stub_request(
method,
path=path,
rbody=v2_payload_with_data,
rcode=200,
rheaders={},
)
client = StripeClient(
api_key="sk_test_1234",
stripe_context="org_456",
http_client=http_client_mock.get_mock_http_client(),
)
event = client.v2.core.events.retrieve("evt_123")
http_client_mock.assert_requested(
method,
api_base=DEFAULT_API_BASE,
path=path,
api_key="sk_test_1234",
stripe_context="org_456",
)
assert event.id is not None
assert isinstance(event, V1BillingMeterErrorReportTriggeredEvent)
assert event.data is not None
assert isinstance(
event.data,
V1BillingMeterErrorReportTriggeredEvent.V1BillingMeterErrorReportTriggeredEventData,
)
assert event.data.reason.error_count == 1
# an "integration" shaped test with all the bells and whistles
def test_v2_events_integration(
self,
http_client_mock: HTTPClientMock,
v2_payload_no_data,
v2_payload_with_data,
# use the real client so we get the real types
stripe_client: StripeClient,
):
method = "get"
path = "/v2/core/events/evt_234"
meter_path = "/v1/billing/meters/mtr_123"
http_client_mock.stub_request(
method,
path=path,
rbody=v2_payload_with_data,
rcode=200,
rheaders={},
)
http_client_mock.stub_request(
method,
path=meter_path,
rbody=json.dumps(
{
"id": "mtr_123",
"object": "billing.meter",
"event_name": "cool event",
}
),
rcode=200,
rheaders={},
)
event_notif = stripe_client.parse_event_notification(
v2_payload_no_data,
generate_header(payload=v2_payload_no_data),
DUMMY_WEBHOOK_SECRET,
)
assert event_notif.type == "v1.billing.meter.error_report_triggered"
event = event_notif.fetch_event()
meter = event_notif.fetch_related_object()
if sys.version_info >= (3, 7):
from typing_extensions import assert_type # noqa: SPY103 - this is only available on 3.6 pythons because of typing_extensions version restrictions
# these are purely type-level checks to ensure our narrowing works for users
assert_type(
event_notif,
V1BillingMeterErrorReportTriggeredEventNotification,
)
assert_type(event, V1BillingMeterErrorReportTriggeredEvent)
assert_type(meter, Meter)
assert isinstance(event, V1BillingMeterErrorReportTriggeredEvent)
http_client_mock.assert_requested(
method,
api_base=DEFAULT_API_BASE,
path=path,
api_key="sk_test_1234",
# context read from event
stripe_context="acct_123",
)
http_client_mock.assert_requested(
method,
api_base=DEFAULT_API_BASE,
path=meter_path,
api_key="sk_test_1234",
# context read from event
stripe_context="acct_123",
)
assert isinstance(
event.data,
V1BillingMeterErrorReportTriggeredEvent.V1BillingMeterErrorReportTriggeredEventData,
)
assert event.data.reason.error_count == 1
assert isinstance(meter, Meter)
assert meter.event_name == "cool event"
|
