Changeset View
Changeset View
Standalone View
Standalone View
swh/web/tests/api/test_apidoc.py
| # Copyright (C) 2015-2019 The Software Heritage developers | # Copyright (C) 2015-2019 The Software Heritage developers | ||||
| # See the AUTHORS file at the top-level directory of this distribution | # See the AUTHORS file at the top-level directory of this distribution | ||||
| # License: GNU Affero General Public License version 3, or any later version | # License: GNU Affero General Public License version 3, or any later version | ||||
| # See top-level LICENSE file for more information | # See top-level LICENSE file for more information | ||||
| import pytest | import pytest | ||||
| from rest_framework.response import Response | from rest_framework.response import Response | ||||
| from swh.storage.exc import StorageDBError, StorageAPIError | from swh.storage.exc import StorageDBError, StorageAPIError | ||||
| from swh.web.api.apidoc import api_doc, _parse_httpdomain_doc | from swh.web.api.apidoc import api_doc, _parse_httpdomain_doc | ||||
| from swh.web.api.apiurls import api_route | from swh.web.api.apiurls import api_route | ||||
| from swh.web.common.exc import BadInputExc, ForbiddenExc, NotFoundExc | from swh.web.common.exc import BadInputExc, ForbiddenExc, NotFoundExc | ||||
| from swh.web.common.utils import reverse | |||||
| from swh.web.tests.django_asserts import assert_template_used | from swh.web.tests.django_asserts import assert_template_used | ||||
| httpdomain_doc = """ | httpdomain_doc = """ | ||||
| .. http:get:: /api/1/revision/(sha1_git)/ | .. http:get:: /api/1/revision/(sha1_git)/ | ||||
| Get information about a revision in the archive. | Get information about a revision in the archive. | ||||
| Revisions are identified by **sha1** checksums, compatible with Git commit | Revisions are identified by **sha1** checksums, compatible with Git commit | ||||
| ▲ Show 20 Lines • Show All 56 Lines • ▼ Show 20 Lines | |||||
| def test_apidoc_nodoc_failure(): | def test_apidoc_nodoc_failure(): | ||||
| with pytest.raises(Exception): | with pytest.raises(Exception): | ||||
| @api_doc('/my/nodoc/url/') | @api_doc('/my/nodoc/url/') | ||||
| def apidoc_nodoc_tester(request, arga=0, argb=0): | def apidoc_nodoc_tester(request, arga=0, argb=0): | ||||
| return Response(arga + argb) | return Response(arga + argb) | ||||
| @api_route(r'/some/(?P<myarg>[0-9]+)/(?P<myotherarg>[0-9]+)/', | @api_route(r'/some/(?P<myarg>[0-9]+)/(?P<myotherarg>[0-9]+)/', | ||||
| 'some-doc-route') | 'api-1-some-doc-route') | ||||
| @api_doc('/some/doc/route/') | @api_doc('/some/doc/route/') | ||||
| def apidoc_route(request, myarg, myotherarg, akw=0): | def apidoc_route(request, myarg, myotherarg, akw=0): | ||||
| """ | """ | ||||
| Sample doc | Sample doc | ||||
| """ | """ | ||||
| return {'result': int(myarg) + int(myotherarg) + akw} | return {'result': int(myarg) + int(myotherarg) + akw} | ||||
| # remove deprecation warnings related to docutils | |||||
| @pytest.mark.filterwarnings( | |||||
| 'ignore:.*U.*mode is deprecated:DeprecationWarning') | |||||
| def test_apidoc_route_doc(client): | def test_apidoc_route_doc(client): | ||||
| rv = client.get('/api/1/some/doc/route/', HTTP_ACCEPT='text/html') | url = reverse('api-1-some-doc-route') | ||||
| rv = client.get(url, HTTP_ACCEPT='text/html') | |||||
| assert rv.status_code == 200, rv.content | assert rv.status_code == 200, rv.content | ||||
| assert_template_used(rv, 'api/apidoc.html') | assert_template_used(rv, 'api/apidoc.html') | ||||
| def test_apidoc_route_fn(api_client): | def test_apidoc_route_fn(api_client): | ||||
| rv = api_client.get('/api/1/some/1/1/') | url = reverse('api-1-some-doc-route', | ||||
| url_args={'myarg': 1, 'myotherarg': 1}) | |||||
| rv = api_client.get(url) | |||||
| assert rv.status_code == 200, rv.data | assert rv.status_code == 200, rv.data | ||||
| @api_route(r'/test/error/(?P<exc_name>.+)/', 'test-error') | @api_route(r'/test/error/(?P<exc_name>.+)/', 'api-1-test-error') | ||||
| @api_doc('/test/error/') | @api_doc('/test/error/') | ||||
| def apidoc_test_error_route(request, exc_name): | def apidoc_test_error_route(request, exc_name): | ||||
| """ | """ | ||||
| Sample doc | Sample doc | ||||
| """ | """ | ||||
| for e in exception_http_code.keys(): | for e in exception_http_code.keys(): | ||||
| if e.__name__ == exc_name: | if e.__name__ == exc_name: | ||||
| raise e('Error') | raise e('Error') | ||||
| def test_apidoc_error(api_client): | def test_apidoc_error(api_client): | ||||
| for exc, code in exception_http_code.items(): | for exc, code in exception_http_code.items(): | ||||
| rv = api_client.get('/api/1/test/error/%s/' % exc.__name__) | url = reverse('api-1-test-error', | ||||
| url_args={'exc_name': exc.__name__}) | |||||
| rv = api_client.get(url) | |||||
| assert rv.status_code == code, rv.data | assert rv.status_code == code, rv.data | ||||
| @api_route(r'/some/full/(?P<myarg>[0-9]+)/(?P<myotherarg>[0-9]+)/', | @api_route(r'/some/full/(?P<myarg>[0-9]+)/(?P<myotherarg>[0-9]+)/', | ||||
| 'some-complete-doc-route') | 'api-1-some-complete-doc-route') | ||||
| @api_doc('/some/complete/doc/route/') | @api_doc('/some/complete/doc/route/') | ||||
| def apidoc_full_stack(request, myarg, myotherarg, akw=0): | def apidoc_full_stack(request, myarg, myotherarg, akw=0): | ||||
| """ | """ | ||||
| Sample doc | Sample doc | ||||
| """ | """ | ||||
| return {'result': int(myarg) + int(myotherarg) + akw} | return {'result': int(myarg) + int(myotherarg) + akw} | ||||
| # remove deprecation warnings related to docutils | |||||
| @pytest.mark.filterwarnings( | |||||
| 'ignore:.*U.*mode is deprecated:DeprecationWarning') | |||||
| def test_apidoc_full_stack_doc(client): | def test_apidoc_full_stack_doc(client): | ||||
| rv = client.get('/api/1/some/complete/doc/route/', HTTP_ACCEPT='text/html') | url = reverse('api-1-some-complete-doc-route') | ||||
| rv = client.get(url, HTTP_ACCEPT='text/html') | |||||
| assert rv.status_code == 200, rv.content | assert rv.status_code == 200, rv.content | ||||
| assert_template_used(rv, 'api/apidoc.html') | assert_template_used(rv, 'api/apidoc.html') | ||||
| def test_apidoc_full_stack_fn(api_client): | def test_apidoc_full_stack_fn(api_client): | ||||
| rv = api_client.get('/api/1/some/full/1/1/') | url = reverse('api-1-some-complete-doc-route', | ||||
| url_args={'myarg': 1, 'myotherarg': 1}) | |||||
| rv = api_client.get(url) | |||||
| assert rv.status_code == 200, rv.data | assert rv.status_code == 200, rv.data | ||||
| @api_route(r'/test/post/only/', 'api-1-test-post-only', | |||||
| methods=['POST']) | |||||
| @api_doc('/test/post/only/', post_only=True) | |||||
| def apidoc_test_post_only(request, exc_name): | |||||
| """ | |||||
| Sample doc | |||||
| """ | |||||
| return {'result': 'some data'} | |||||
| def test_apidoc_noargs_post_only(client): | |||||
| # a dedicated view accepting GET requests should have | |||||
| # been created to display the HTML documentation | |||||
| url = reverse('api-1-test-post-only-doc') | |||||
| rv = client.get(url, HTTP_ACCEPT='text/html') | |||||
| assert rv.status_code == 200, rv.content | |||||
| assert_template_used(rv, 'api/apidoc.html') | |||||
| def test_api_doc_parse_httpdomain(): | def test_api_doc_parse_httpdomain(): | ||||
| doc_data = { | doc_data = { | ||||
| 'description': '', | 'description': '', | ||||
| 'urls': [], | 'urls': [], | ||||
| 'args': [], | 'args': [], | ||||
| 'params': [], | 'params': [], | ||||
| 'resheaders': [], | 'resheaders': [], | ||||
| 'reqheaders': [], | 'reqheaders': [], | ||||
| ▲ Show 20 Lines • Show All 152 Lines • Show Last 20 Lines | |||||