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)
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,
json={})
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,
auth=mock.ANY,
json={})
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,
json={})
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,
auth=mock.ANY,
json={})
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,
auth=mock.ANY,
verify=True,
params={})
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'})
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_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_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_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)
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_empty():
"""Check parameters - empty dict passed"""
ShaarliV1Client._check_endpoint_params('get-info', {})
def test_check_endpoint_params_none():
"""Check parameters - none passed"""
ShaarliV1Client._check_endpoint_params('get-info', None)
def test_constructor_strip_uri(test_uri):
"""Ensure trailing / are stripped"""
client = ShaarliV1Client(test_uri, SHAARLI_SECRET)
assert client.uri == SHAARLI_URL
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)
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():
"""Instantiate a new client"""
ShaarliV1Client(SHAARLI_URL, SHAARLI_SECRET)
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_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'})
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_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', {})