forked from anvilco/python-anvil
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_api.py
More file actions
457 lines (400 loc) · 17.8 KB
/
test_api.py
File metadata and controls
457 lines (400 loc) · 17.8 KB
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
# pylint: disable=unused-variable,unused-argument,too-many-statements
import json
import pytest
from typing import Any, MutableMapping
from unittest import mock
from python_anvil.api import Anvil, CreateEtchPacket
from python_anvil.api_resources.payload import (
CreateEtchPacketPayload,
ForgeSubmitPayload,
)
from python_anvil.constants import VALID_HOSTS
from ..api_resources.payload import FillPDFPayload
from . import payloads
DEV_KEY = "MY-SECRET-KEY"
TEST_SCHEMA = """
type GenerateEmbedURLResponse {
eid: String!
url: String!
}
"""
def describe_api():
@pytest.fixture
@mock.patch("builtins.open", new_callable=mock.mock_open, read_data=TEST_SCHEMA)
def anvil(m_open):
return Anvil(api_key=DEV_KEY)
def describe_init():
@mock.patch('python_anvil.api.GQLClient')
@mock.patch('python_anvil.api.HTTPClient')
def test_init_key_default(mock_client, mock_gql):
Anvil(api_key="what")
mock_client.assert_called_once_with(api_key="what", environment="dev")
mock_gql.get_client.assert_called_once_with(
api_key="what", environment="dev", endpoint_url=None
)
@mock.patch('python_anvil.api.GQLClient')
@mock.patch('python_anvil.api.HTTPClient')
def test_init_with_endpoint(mock_client, mock_gql):
Anvil(api_key="what", endpoint_url="http://somewhere.example")
mock_client.assert_called_once_with(api_key="what", environment="dev")
mock_gql.get_client.assert_called_once_with(
api_key="what",
environment="dev",
endpoint_url="http://somewhere.example",
)
@mock.patch('python_anvil.api.GQLClient')
@mock.patch('python_anvil.api.HTTPClient')
def test_init_key_prod(mock_client, mock_gql):
Anvil(api_key="what", environment="prod")
mock_client.assert_called_once_with(api_key="what", environment="prod")
mock_gql.get_client.assert_called_once_with(
api_key="what", environment="prod", endpoint_url=None
)
@mock.patch('python_anvil.api.GQLClient')
@mock.patch('python_anvil.api.HTTPClient')
def test_init_no_key(mock_client, mock_gql):
with pytest.raises(ValueError):
Anvil(environment="prod")
assert mock_client.call_count == 0
assert mock_gql.get_client.call_count == 0
def describe_query():
def test_query():
# TODO: ...
pass
def describe_fill_pdf():
@mock.patch('python_anvil.api.RestRequest.post')
def test_dict_payload(m_request_post, anvil):
payload = {"data": {"this_data": "yes"}}
anvil.fill_pdf("some_template", payload=payload)
m_request_post.assert_called_once_with("fill/some_template.pdf", payload)
@mock.patch('python_anvil.api.RestRequest.post')
def test_json_payload(m_request_post, anvil):
payload = """{ "data": {"jsonData": "is here"} }"""
anvil.fill_pdf("some_template", payload=payload)
m_request_post.assert_called_once_with(
"fill/some_template.pdf",
{'data': {'jsonData': 'is here'}},
)
@mock.patch('python_anvil.api.RestRequest.post')
def test_payload_obj(m_request_post, anvil):
payload = FillPDFPayload(data={"jsonData": "this was a payload instance"})
anvil.fill_pdf("some_template", payload=payload)
m_request_post.assert_called_once_with(
"fill/some_template.pdf",
{'data': {'jsonData': 'this was a payload instance'}},
)
@mock.patch('python_anvil.api.RestRequest.post')
def test_empty_payload(m_request_post, anvil):
with pytest.raises(ValueError):
anvil.fill_pdf("some_template", payload={})
assert m_request_post.call_count == 0
@mock.patch('python_anvil.api.RestRequest.post')
def test_with_kwargs(m_request_post, anvil):
payload = """{ "data": {"jsonData": "is here"} }"""
anvil.fill_pdf("some_template", payload=payload, include_headers=True)
m_request_post.assert_called_once_with(
"fill/some_template.pdf",
{"data": {"jsonData": "is here"}},
include_headers=True,
)
@mock.patch('python_anvil.api.RestRequest.post')
def test_with_version(m_request_post, anvil):
payload = {"data": {"one": "One string"}}
anvil.fill_pdf(
"some_template",
payload=payload,
include_headers=True,
version_number=Anvil.VERSION_LATEST,
)
m_request_post.assert_called_once_with(
"fill/some_template.pdf",
{"data": {"one": "One string"}},
include_headers=True,
params={"versionNumber": Anvil.VERSION_LATEST},
)
@mock.patch('python_anvil.api.RestRequest.post')
def test_with_params(m_request_post, anvil):
payload = {"data": {"one": "One string"}}
params = {"arbitrary": "Param"}
anvil.fill_pdf(
"some_template", payload=payload, include_headers=True, params=params
)
m_request_post.assert_called_once_with(
"fill/some_template.pdf",
{"data": {"one": "One string"}},
include_headers=True,
params=params,
)
def describe_generate_pdf():
@mock.patch('python_anvil.api.RestRequest.post')
def test_dict_payload(m_request_post, anvil):
anvil.generate_pdf({"data": [{"d1": "data"}]})
m_request_post.assert_called_once_with(
# Defaults to 'markdown'
"generate-pdf",
data={'data': [{'d1': 'data'}], 'type': 'markdown'},
)
@mock.patch('python_anvil.api.RestRequest.post')
def test_json_payload(m_request_post, anvil):
payload = """{ "data": [{ "d1": "data" }] }"""
anvil.generate_pdf(payload)
m_request_post.assert_called_once_with(
"generate-pdf", data={"data": [{"d1": "data"}], "type": "markdown"}
)
@mock.patch('python_anvil.api.RestRequest.post')
def test_payload_html_type(m_request_post, anvil):
anvil.generate_pdf({"data": {"html": "<h1>Hello</h1>"}, "type": "html"})
m_request_post.assert_called_once_with(
"generate-pdf",
data={"data": {"html": "<h1>Hello</h1>"}, "type": "html"},
)
@mock.patch('python_anvil.api.RestRequest.post')
def test_invalid_payload_html_payload(m_request_post, anvil):
with pytest.raises(ValueError):
anvil.generate_pdf({"data": {"no_html_here": "Nope"}, "type": "html"})
assert m_request_post.call_count == 0
@mock.patch('python_anvil.api.RestRequest.post')
def test_payload_invalid_type(m_request_post, anvil):
with pytest.raises(ValueError):
anvil.generate_pdf(
{"data": [{"d1": "data"}], "type": "something_invalid"}
)
assert m_request_post.call_count == 0
@mock.patch('python_anvil.api.RestRequest.post')
def test_invalid_data_for_markdown(m_request_post, anvil):
with pytest.raises(ValueError):
anvil.generate_pdf(
{
# This should be a plain dict, not a list
"data": {"d1": "data"},
"type": "markdown",
}
)
assert m_request_post.call_count == 0
def describe_current_user_query():
@mock.patch('gql.Client.execute')
def test_get_current_user(m_request_post, anvil):
anvil.get_current_user()
assert m_request_post.call_count == 1
def describe_get_welds():
@mock.patch('gql.Client.execute')
def test_get_weld(m_request_post, anvil):
anvil.get_welds()
assert m_request_post.call_count == 1
def describe_generate_etch_signing_url():
@mock.patch('gql.Client.execute')
def test_get_url(m_request_post, anvil):
anvil.generate_etch_signing_url(
signer_eid='someId', client_user_id='anotherId'
)
assert m_request_post.call_count == 1
def describe_download_documents():
@mock.patch('python_anvil.api.PlainRequest.get')
def test_get_docs(m_request_post, anvil):
anvil.download_documents('someEid')
assert m_request_post.call_count == 1
def describe_get_cast():
@mock.patch('gql.Client.execute')
def test_get_cast(m_request_post, anvil):
anvil.get_cast('castEid')
assert m_request_post.call_count == 1
def describe_get_casts():
@mock.patch('gql.Client.execute')
def test_get_casts(m_request_post, anvil):
anvil.get_casts()
assert m_request_post.call_count == 1
def describe_create_etch_packet():
expected_data = {
'name': 'Packet name',
'signatureEmailSubject': 'The subject',
'signers': [],
'files': [],
'isDraft': False,
'isTest': True,
'data': {'payloads': {}},
'signaturePageOptions': {},
}
@mock.patch('gql.Client.execute')
def test_create_etch_packet_empty_payload(m_request_post, anvil):
with pytest.raises(TypeError):
anvil.create_etch_packet(payload={})
assert m_request_post.call_count == 0
@mock.patch('gql.Client.execute')
def test_create_etch_packet_invalid_payload(m_request_post, anvil):
with pytest.raises(TypeError):
anvil.create_etch_packet({})
assert m_request_post.call_count == 0
@mock.patch('gql.Client.execute')
def test_create_etch_packet_valid_payload_type(m_request_post, anvil):
payload = CreateEtchPacket(
name="Packet name",
signature_email_subject="The subject",
)
anvil.create_etch_packet(payload=payload)
assert m_request_post.call_count == 1
variables = m_request_post.call_args[1]["variable_values"]
assert expected_data == variables
@mock.patch('gql.Client.execute')
def test_create_etch_packet_passes_options(m_request_post, anvil):
payload = CreateEtchPacket(
is_test=False,
is_draft=True,
name="Packet name",
signature_email_subject="The subject",
)
new_expected = dict(**expected_data)
new_expected["isTest"] = False
new_expected["isDraft"] = True
anvil.create_etch_packet(payload)
assert m_request_post.call_count == 1
variables = m_request_post.call_args[1]["variable_values"]
assert new_expected == variables
@mock.patch('gql.Client.execute')
def test_create_etch_packet_valid_dict_type(m_request_post, anvil):
anvil.create_etch_packet(
dict(name="Packet name", signature_email_subject="The subject")
)
assert m_request_post.call_count == 1
variables = m_request_post.call_args[1]["variable_values"]
assert expected_data == variables
@mock.patch(
'python_anvil.api_resources.mutations.create_etch_packet.create_unique_id'
)
@mock.patch('gql.Client.execute')
def test_create_etch_packet_dict_with_signer(
m_request_post, m_create_unique, anvil
):
m_create_unique.return_value = "signer-mock-generated"
anvil.create_etch_packet(payload=payloads.ETCH_TEST_PAYLOAD)
assert m_request_post.call_count == 1
variables = m_request_post.call_args[1]["variable_values"]
assert payloads.EXPECTED_ETCH_TEST_PAYLOAD == variables
@mock.patch(
'python_anvil.api_resources.mutations.create_etch_packet.create_unique_id'
)
@mock.patch('gql.Client.execute')
def test_create_etch_packet_json(m_request_post, m_create_unique, anvil):
m_create_unique.return_value = "signer-mock-generated"
# We are currently removing `None`s from the payload, so do that here too.
payload = {
k: v
for k, v in payloads.EXPECTED_ETCH_TEST_PAYLOAD_JSON.items()
if v is not None
}
anvil.create_etch_packet(json=json.dumps(payload))
assert m_request_post.call_count == 1
variables = m_request_post.call_args[1]["variable_values"]
assert payload == variables
@mock.patch(
'python_anvil.api_resources.mutations.create_etch_packet.create_unique_id'
)
@mock.patch('gql.Client.execute')
def test_adding_unsupported_fields(m_request_post, m_create_unique, anvil):
m_create_unique.return_value = "signer-mock-generated"
# We are currently removing `None`s from the payload, so do that here too.
payload = {
k: v
for k, v in payloads.EXPECTED_ETCH_TEST_PAYLOAD_JSON.items()
if v is not None
}
cep = CreateEtchPacketPayload.model_validate(payload)
cep.newFeature = True # type: ignore[attr-defined]
anvil.create_etch_packet(payload=cep)
assert m_request_post.call_count == 1
variables = m_request_post.call_args[1]["variable_values"]
assert cep.model_dump(by_alias=True, exclude_none=True) == variables
assert "newFeature" in variables
def describe_forge_submit():
expected_data = {
"forgeEid": "forge1234",
"payload": {"field1": "Some data"},
"isTest": True,
}
@mock.patch('gql.Client.execute')
def test_invalid_payload(m_request_post, anvil):
with pytest.raises(TypeError):
anvil.forge_submit({})
assert m_request_post.call_count == 0
@mock.patch('gql.Client.execute')
def test_minimum_valid_data_forge_eid(m_request_post, anvil):
payload = ForgeSubmitPayload(
forge_eid="forge1234", payload=dict(field1="Some data")
)
anvil.forge_submit(payload=payload)
assert m_request_post.call_count == 1
assert {"variable_values": expected_data} in m_request_post.call_args
@mock.patch('gql.Client.execute')
def test_minimum_valid_data_submission(m_request_post, anvil):
payload = ForgeSubmitPayload(
forge_eid="forge1234",
submission_eid="sub1234",
weld_data_eid="wd1234",
payload=dict(field1="Updated data"),
)
# We copy `expected_data` here as it can cause a race condition
# in other tests that use it.
_expected_data: MutableMapping[str, Any] = {
"variable_values": {
**expected_data,
"submissionEid": "sub1234",
"weldDataEid": "wd1234",
"payload": {"field1": "Updated data"},
}
}
anvil.forge_submit(payload=payload)
assert m_request_post.call_count == 1
assert _expected_data in m_request_post.call_args
def describe_rest_request_absolute_url_behavior():
@pytest.mark.parametrize(
"url, should_raise",
[
("some/relative/path", True),
("https://external.example.com/full/path/file.pdf", True),
*[(host + "/some-endpoint", False) for host in VALID_HOSTS],
],
)
@mock.patch("python_anvil.api_resources.requests.AnvilRequest._request")
def test_get_behavior(mock_request, anvil, url, should_raise):
mock_request.return_value = (b"fake_content", 200, {})
rest_client = anvil.request_fully_qualified()
if should_raise:
with pytest.raises(
ValueError,
match="URL must start with one of: https://app.useanvil.com",
):
rest_client.get(url)
else:
rest_client.get(url)
mock_request.assert_called_once_with(
"GET",
url,
params=None,
retry=True,
)
@pytest.mark.parametrize(
"url, should_raise",
[
("some/relative/path", True),
("https://external.example.com/full/path/file.pdf", True),
*[(host + "/some-endpoint", False) for host in VALID_HOSTS],
],
)
@mock.patch("python_anvil.api_resources.requests.AnvilRequest._request")
def test_post_behavior(mock_request, anvil, url, should_raise):
mock_request.return_value = (b"fake_content", 200, {})
rest_client = anvil.request_fully_qualified()
if should_raise:
with pytest.raises(
ValueError,
match="URL must start with one of: https://app.useanvil.com",
):
rest_client.post(url, data={})
else:
rest_client.post(url, data={})
mock_request.assert_called_once_with(
"POST",
url,
json={},
retry=True,
params=None,
)