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
|
"""Paperless basic tests."""
import re
from typing import Any
import aiohttp
import pytest
from aioresponses import CallbackResult, aioresponses
from pypaperless import Paperless
from pypaperless.const import API_PATH
from pypaperless.exceptions import DraftFieldRequiredError
from pypaperless.models import Page
from pypaperless.models.common import PermissionTableType
from . import (
CORRESPONDENT_MAP,
CUSTOM_FIELD_MAP,
DOCUMENT_MAP,
DOCUMENT_TYPE_MAP,
GROUP_MAP,
MAIL_ACCOUNT_MAP,
MAIL_RULE_MAP,
PROCESSED_MAIL_MAP,
SAVED_VIEW_MAP,
SHARE_LINK_MAP,
STORAGE_PATH_MAP,
TAG_MAP,
USER_MAP,
WORKFLOW_MAP,
ResourceTestMapping,
)
from .const import PAPERLESS_TEST_URL
from .data import DATA_OBJECT_PERMISSIONS
# mypy: ignore-errors
@pytest.mark.parametrize(
"mapping",
[
DOCUMENT_MAP,
DOCUMENT_TYPE_MAP,
CORRESPONDENT_MAP,
CUSTOM_FIELD_MAP,
GROUP_MAP,
MAIL_ACCOUNT_MAP,
MAIL_RULE_MAP,
PROCESSED_MAIL_MAP,
SAVED_VIEW_MAP,
SHARE_LINK_MAP,
STORAGE_PATH_MAP,
TAG_MAP,
USER_MAP,
WORKFLOW_MAP,
],
scope="class",
)
# test models/classifiers.py
# test models/custom_fields.py
# test models/mails.py
# test models/permissions.py
# test models/saved_views.py
# test models/share_links.py
class TestReadOnly:
"""Read only resources test cases."""
async def test_pages(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test pages."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
page = await anext(aiter(getattr(paperless, mapping.resource).pages(1)))
assert isinstance(page, Page)
assert isinstance(page.items, list)
for item in page.items:
assert isinstance(item, mapping.model_cls)
async def test_as_dict(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test as_dict."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
items = await getattr(paperless, mapping.resource).as_dict()
for pk, obj in items.items():
assert isinstance(pk, int)
assert isinstance(obj, mapping.model_cls)
async def test_as_list(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test as_dict."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
items = await getattr(paperless, mapping.resource).as_list()
for obj in items:
assert isinstance(obj, mapping.model_cls)
async def test_iter(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test iter."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
async for item in getattr(paperless, mapping.resource):
assert isinstance(item, mapping.model_cls)
async def test_all(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test all."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
items = await getattr(paperless, mapping.resource).all()
assert isinstance(items, list)
for item in items:
assert isinstance(item, int)
async def test_call(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test call."""
resp.get(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1),
status=200,
payload=mapping.data["results"][0],
)
item = await getattr(paperless, mapping.resource)(1)
assert item
assert isinstance(item, mapping.model_cls)
# must raise as 1337 doesn't exist
resp.get(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1337),
status=404,
)
with pytest.raises(aiohttp.ClientResponseError):
await getattr(paperless, mapping.resource)(1337)
@pytest.mark.parametrize(
"mapping",
[
CORRESPONDENT_MAP,
CUSTOM_FIELD_MAP,
DOCUMENT_TYPE_MAP,
SHARE_LINK_MAP,
STORAGE_PATH_MAP,
TAG_MAP,
],
scope="class",
)
# test models/classifiers.py
# test models/custom_fields.py
# test models/share_links.py
class TestReadWrite:
"""R/W models test cases."""
async def test_pages(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test pages."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
page = await anext(aiter(getattr(paperless, mapping.resource).pages(1)))
assert isinstance(page, Page)
assert isinstance(page.items, list)
for item in page.items:
assert isinstance(item, mapping.model_cls)
async def test_iter(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test iter."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
async for item in getattr(paperless, mapping.resource):
assert isinstance(item, mapping.model_cls)
async def test_all(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test all."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
items = await getattr(paperless, mapping.resource).all()
assert isinstance(items, list)
for item in items:
assert isinstance(item, int)
async def test_reduce(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test iter with reduce."""
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload=mapping.data,
)
async with getattr(paperless, mapping.resource).reduce(
any_filter_param="1",
any_filter_list__in=["1", "2"],
any_filter_no_list__in="1",
) as q:
async for item in q:
assert isinstance(item, mapping.model_cls)
async def test_call(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test call."""
resp.get(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1),
status=200,
payload=mapping.data["results"][0],
)
item = await getattr(paperless, mapping.resource)(1)
assert item
assert isinstance(item, mapping.model_cls)
# must raise as 1337 doesn't exist
resp.get(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1337),
status=404,
)
with pytest.raises(aiohttp.ClientResponseError):
await getattr(paperless, mapping.resource)(1337)
async def test_create(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test create."""
draft = getattr(paperless, mapping.resource).draft(**mapping.draft_defaults)
assert isinstance(draft, mapping.draft_cls)
# test empty draft fields
if mapping.model_cls not in (
SHARE_LINK_MAP.model_cls,
CUSTOM_FIELD_MAP.model_cls,
):
backup = draft.name
draft.name = None
with pytest.raises(DraftFieldRequiredError):
await draft.save()
draft.name = backup
# actually call the create endpoint
resp.post(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}",
status=200,
payload={
"id": len(mapping.data["results"]),
**draft._serialize(), # pylint: disable=protected-access
},
)
new_pk = await draft.save()
assert new_pk >= 1
async def test_udpate(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test update."""
update_field = "name"
update_value = "Name Updated"
if mapping.model_cls is SHARE_LINK_MAP.model_cls:
update_field = "document"
update_value = 2
# go on
resp.get(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1),
status=200,
payload=mapping.data["results"][0],
)
to_update = await getattr(paperless, mapping.resource)(1)
setattr(to_update, update_field, update_value)
# actually call the update endpoint
resp.patch(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1),
status=200,
payload={
**to_update._data, # pylint: disable=protected-access
update_field: update_value,
},
)
await to_update.update()
assert getattr(to_update, update_field) == update_value
# no updates
assert not await to_update.update()
# force update
setattr(to_update, update_field, update_value)
resp.put(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1),
status=200,
payload={
**to_update._data, # pylint: disable=protected-access
update_field: update_value,
},
)
await to_update.update(only_changed=False)
assert getattr(to_update, update_field) == update_value
async def test_delete(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test delete."""
resp.get(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1),
status=200,
payload=mapping.data["results"][0],
)
to_delete = await getattr(paperless, mapping.resource)(1)
resp.delete(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1),
status=204, # Paperless-ngx responds with 204 on deletion
)
assert await to_delete.delete()
# test deletion failed
resp.delete(
f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1),
status=404, # we send another status code
)
assert not await to_delete.delete()
@pytest.mark.parametrize(
"mapping",
[
CORRESPONDENT_MAP,
DOCUMENT_MAP,
DOCUMENT_TYPE_MAP,
STORAGE_PATH_MAP,
TAG_MAP,
],
scope="class",
)
# test models/classifiers.py
class TestSecurableMixin:
"""SecurableMixin test cases."""
async def test_permissions(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test permissions."""
getattr(paperless, mapping.resource).request_permissions = True
assert getattr(paperless, mapping.resource).request_permissions
# request single object
resp.get(
re.compile(
r"^"
+ f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1)
+ r"\?.*$"
),
status=200,
payload={
**mapping.data["results"][0],
"permissions": DATA_OBJECT_PERMISSIONS,
},
)
item = await getattr(paperless, mapping.resource)(1)
assert item.has_permissions
assert isinstance(item.permissions, PermissionTableType)
# request by iterator
resp.get(
re.compile(r"^" + f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource]}" + r"\?.*$"),
status=200,
payload={
**mapping.data,
"results": [
{**item, "permissions": DATA_OBJECT_PERMISSIONS}
for item in mapping.data["results"]
],
},
)
async for item in getattr(paperless, mapping.resource):
assert isinstance(item, mapping.model_cls)
assert item.has_permissions
assert isinstance(item.permissions, PermissionTableType)
async def test_permission_change(
self, resp: aioresponses, paperless: Paperless, mapping: ResourceTestMapping
) -> None:
"""Test permission changes."""
getattr(paperless, mapping.resource).request_permissions = True
assert getattr(paperless, mapping.resource).request_permissions
resp.get(
re.compile(
r"^"
+ f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1)
+ r"\?.*$"
),
status=200,
payload={
**mapping.data["results"][0],
"permissions": DATA_OBJECT_PERMISSIONS,
},
)
item = await getattr(paperless, mapping.resource)(1)
item.permissions.view.users.append(23)
def _lookup_set_permissions( # pylint: disable=unused-argument
url: str,
json: dict[str, Any],
**kwargs: Any, # noqa: ARG001
) -> CallbackResult:
assert url
assert "set_permissions" in json
return CallbackResult(
status=200,
payload=item._data, # pylint: disable=protected-access
)
resp.patch(
re.compile(
r"^"
+ f"{PAPERLESS_TEST_URL}{API_PATH[mapping.resource + '_single']}".format(pk=1)
+ r"\?.*$"
),
callback=_lookup_set_permissions,
)
await item.update()
|
