-
Notifications
You must be signed in to change notification settings - Fork 10
/
test_v1.py
386 lines (315 loc) · 11.5 KB
/
test_v1.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
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
"""Tests for Shaarli REST API v1 client"""
# pylint: disable=invalid-name,protected-access
from argparse import ArgumentTypeError, Namespace
from unittest import mock
import pytest
from requests.exceptions import InvalidSchema, InvalidURL, MissingSchema
from shaarli_client.client.v1 import (InvalidEndpointParameters,
ShaarliV1Client, check_positive_integer)
SHAARLI_URL = 'http://domain.tld/shaarli'
SHAARLI_SECRET = 's3kr37!'
def test_check_positive_integer():
"""A posivite integer is a positive integer"""
assert check_positive_integer('0') == 0
assert check_positive_integer('2378') == 2378
def test_check_positive_integer_negative():
"""A negative integer is not a positive integer"""
with pytest.raises(ArgumentTypeError) as exc:
check_positive_integer('-123')
assert 'not a positive integer' in str(exc.value)
def test_check_positive_integer_alpha():
"""An alphanumeric string is not a positive integer"""
with pytest.raises(ArgumentTypeError) as exc:
check_positive_integer('abc123')
assert 'not a positive integer' in str(exc.value)
def test_invalid_endpoint_parameters_exception():
"""Custom exception formatting"""
exc = InvalidEndpointParameters('post-dummy', ['param1', 'param2'])
assert str(exc) == \
"Invalid parameters for endpoint 'post-dummy': param1, param2"
def test_constructor():
"""Instantiate a new client"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET)
def test_constructor_no_uri():
"""Missing URI"""
with pytest.raises(TypeError) as exc:
ShaarliV1Client(None, SHAARLI_SECRET)
assert "Missing Shaarli URI" in str(exc.value)
def test_constructor_no_secret():
"""Missing authentication secret"""
with pytest.raises(TypeError) as exc:
ShaarliV1Client(SHAARLI_URL, None)
assert "Missing Shaarli secret" in str(exc.value)
@pytest.mark.parametrize("test_uri", [
SHAARLI_URL,
'%s/' % SHAARLI_URL,
'%s///' % SHAARLI_URL,
])
def test_constructor_strip_uri(test_uri):
"""Ensure trailing / are stripped"""
client = ShaarliV1Client(test_uri, SHAARLI_SECRET)
assert client.uri == SHAARLI_URL
def test_check_endpoint_params_none():
"""Check parameters - none passed"""
ShaarliV1Client._check_endpoint_params('get-info', None)
def test_check_endpoint_params_empty():
"""Check parameters - empty dict passed"""
ShaarliV1Client._check_endpoint_params('get-info', {})
def test_check_endpoint_params_ok():
"""Check parameters - valid params passed"""
ShaarliV1Client._check_endpoint_params(
'get-links',
{'offset': 3, 'limit': 100}
)
def test_check_endpoint_params_nok():
"""Check parameters - invalid params passed"""
with pytest.raises(InvalidEndpointParameters) as exc:
ShaarliV1Client._check_endpoint_params(
'get-links',
{'get': 27, 'forget': 31}
)
assert "'get-links':" in str(exc.value)
assert 'get' in str(exc.value)
assert 'forget' in str(exc.value)
def test_check_endpoint_params_nok_mixed():
"""Check parameters - valid & invalid params passed"""
with pytest.raises(InvalidEndpointParameters) as exc:
ShaarliV1Client._check_endpoint_params(
'get-links',
{'offset': 200, 'preset': 27, 'headset': 31}
)
assert "'get-links':" in str(exc.value)
assert 'headset' in str(exc.value)
assert 'preset' in str(exc.value)
@mock.patch('requests.request')
def test_get_info_uri(request):
"""Ensure the proper endpoint URI is accessed"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET).get_info()
request.assert_called_once_with(
'GET',
'%s/api/v1/info' % SHAARLI_URL,
headers=mock.ANY,
verify=True,
params={}
)
@pytest.mark.parametrize('uri, klass, msg', [
('shaarli', MissingSchema, "No scheme supplied"),
('http:/shaarli', InvalidURL, "No host supplied"),
('htp://shaarli', InvalidSchema, "No connection adapters"),
])
def test_get_info_invalid_uri(uri, klass, msg):
"""Invalid URI format"""
with pytest.raises(ValueError) as exc:
ShaarliV1Client(uri, SHAARLI_SECRET).get_info()
assert isinstance(exc.value, klass)
assert msg in str(exc.value)
@mock.patch('requests.request')
def test_get_links_uri(request):
"""Ensure the proper endpoint URI is accessed"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET).get_links({})
request.assert_called_once_with(
'GET',
'%s/api/v1/links' % SHAARLI_URL,
headers=mock.ANY,
verify=True,
params={}
)
def test_retrieve_http_params_get_info():
"""Retrieve REST parameters from an Argparse Namespace - GET /info"""
args = Namespace(endpoint_name='get-info')
assert ShaarliV1Client._retrieve_http_params(args) == \
('GET', 'info', {})
def test_retrieve_http_params_get_links():
"""Retrieve REST parameters from an Argparse Namespace - GET /links"""
args = Namespace(
endpoint_name='get-links',
offset=42,
limit='all',
visibility='public'
)
assert ShaarliV1Client._retrieve_http_params(args) == \
('GET', 'links', {'offset': 42, 'limit': 'all', 'visibility': 'public'})
def test_retrieve_http_params_get_links_searchterm():
"""Retrieve REST parameters from an Argparse Namespace - GET /links"""
args = Namespace(
endpoint_name='get-links',
searchterm='gimme+some+results'
)
assert ShaarliV1Client._retrieve_http_params(args) == \
('GET', 'links', {'searchterm': 'gimme+some+results'})
@mock.patch('requests.request')
def test_post_links_uri(request):
"""Ensure the proper endpoint URI is accessed"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET).post_link({})
request.assert_called_once_with(
'POST',
'%s/api/v1/links' % SHAARLI_URL,
headers=mock.ANY,
verify=True,
json={}
)
def test_retrieve_http_params_post_link():
"""Retrieve REST parameters from an Argparse Namespace - POST /links"""
args = Namespace(
endpoint_name='post-link',
description="I am not a bookmark about a link.",
private=False,
tags=["nope", "4891"],
title="Ain't Talkin' 'bout Links",
url='https://aint.talkin.bout.lin.ks'
)
assert ShaarliV1Client._retrieve_http_params(args) == \
(
'POST',
'links',
{
'description': "I am not a bookmark about a link.",
'private': False,
'tags': ["nope", "4891"],
'title': "Ain't Talkin' 'bout Links",
'url': 'https://aint.talkin.bout.lin.ks'
}
)
def test_retrieve_http_params_post_empty_link():
"""Retrieve REST parameters from an Argparse Namespace - POST /links"""
args = Namespace(endpoint_name='post-link')
assert ShaarliV1Client._retrieve_http_params(args) == ('POST', 'links', {})
@mock.patch('requests.request')
def test_put_links_uri(request):
"""Ensure the proper endpoint URI is accessed"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET).put_link(12, {})
request.assert_called_once_with(
'PUT',
'%s/api/v1/links/12' % SHAARLI_URL,
headers=mock.ANY,
verify=True,
json={}
)
def test_retrieve_http_params_put_link():
"""Retrieve REST parameters from an Argparse Namespace - PUT /links"""
args = Namespace(
resource=46,
endpoint_name='put-link',
description="I am not a bookmark about a link.",
private=False,
tags=["nope", "4891"],
title="Ain't Talkin' 'bout Links",
url='https://aint.talkin.bout.lin.ks'
)
assert ShaarliV1Client._retrieve_http_params(args) == \
(
'PUT',
'links/46',
{
'description': "I am not a bookmark about a link.",
'private': False,
'tags': ["nope", "4891"],
'title': "Ain't Talkin' 'bout Links",
'url': 'https://aint.talkin.bout.lin.ks'
}
)
def test_retrieve_http_params_put_empty_link():
"""Retrieve REST parameters from an Argparse Namespace - PUT /links"""
args = Namespace(
resource=485,
endpoint_name='put-link'
)
assert ShaarliV1Client._retrieve_http_params(args) == \
('PUT', 'links/485', {})
def test_retrieve_http_params_get_tags():
"""Retrieve REST parameters from an Argparse Namespace - GET /tags"""
args = Namespace(
endpoint_name='get-tags',
offset=42,
limit='all',
visibility='public'
)
assert ShaarliV1Client._retrieve_http_params(args) == \
('GET', 'tags', {'offset': 42, 'limit': 'all', 'visibility': 'public'})
@mock.patch('requests.request')
def test_get_tags_uri(request):
"""Ensure the proper endpoint URI is accessed"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET).get_tags({})
request.assert_called_once_with(
'GET',
'%s/api/v1/tags' % SHAARLI_URL,
headers=mock.ANY,
verify=True,
params={}
)
@mock.patch('requests.request')
def test_put_tags_uri(request):
"""Ensure the proper endpoint URI is accessed"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET).put_tag('some-tag', {})
request.assert_called_once_with(
'PUT',
'%s/api/v1/tags/some-tag' % SHAARLI_URL,
headers=mock.ANY,
verify=True,
json={}
)
def test_retrieve_http_params_put_tag():
"""Retrieve REST parameters from an Argparse Namespace - PUT /tags"""
args = Namespace(
resource='some-tag',
endpoint_name='put-tag',
name='new-tag',
)
assert ShaarliV1Client._retrieve_http_params(args) == \
(
'PUT',
'tags/some-tag',
{
'name': 'new-tag',
}
)
def test_retrieve_http_params_put_empty_tag():
"""Retrieve REST parameters from an Argparse Namespace - PUT /tags"""
args = Namespace(
resource='some-tag',
endpoint_name='put-tag'
)
assert ShaarliV1Client._retrieve_http_params(args) == \
('PUT', 'tags/some-tag', {})
@mock.patch('requests.request')
def test_delete_tags_uri(request):
"""Ensure the proper endpoint URI is accessed"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET).delete_tag('some-tag', {})
request.assert_called_once_with(
'DELETE',
'%s/api/v1/tags/some-tag' % SHAARLI_URL,
headers=mock.ANY,
verify=True,
json={}
)
@mock.patch('requests.request')
def test_delete_link_uri(request):
"""Ensure the proper endpoint URI is accessed"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET).delete_link(1234, {})
request.assert_called_once_with(
'DELETE',
'%s/api/v1/links/1234' % SHAARLI_URL,
headers=mock.ANY,
verify=True,
json={}
)
def test_retrieve_http_params_delete_tag():
"""Retrieve REST parameters from an Argparse Namespace - DELETE /tags"""
args = Namespace(
resource='some-tag',
endpoint_name='delete-tag',
)
assert ShaarliV1Client._retrieve_http_params(args) == \
(
'DELETE',
'tags/some-tag',
{}
)
def test_retrieve_http_params_delete_empty_tag():
"""Retrieve REST parameters from an Argparse Namespace - DELETE /tags"""
args = Namespace(
resource='some-tag',
endpoint_name='delete-tag'
)
assert ShaarliV1Client._retrieve_http_params(args) == \
('DELETE', 'tags/some-tag', {})