Repository navigation
Expand file tree
/
Copy pathtest_documentation.py
More file actions
125 lines (96 loc) · 4.99 KB
/
Copy pathtest_documentation.py
File metadata and controls
125 lines (96 loc) · 4.99 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
"""tests/test_documentation.py.
Tests the documentation generation capibilities integrated into Hug
Copyright (C) 2016 Timothy Edmund Crosley
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
"""
import json
from falcon import Request
from falcon.testing import StartResponseMock, create_environ
import hug
api = hug.API(__name__)
def test_basic_documentation():
"""Ensure creating and then documenting APIs with Hug works as intuitively as expected"""
@hug.get()
def hello_world():
"""Returns hello world"""
return "Hello World!"
@hug.post()
def echo(text):
"""Returns back whatever data it is given in the text parameter"""
return text
@hug.post('/happy_birthday', examples="name=HUG&age=1")
def birthday(name, age: hug.types.number=1):
"""Says happy birthday to a user"""
return "Happy {age} Birthday {name}!".format(**locals())
@hug.post()
def noop(request, response):
"""Performs no action"""
pass
@hug.get()
def string_docs(data: 'Takes data', ignore_directive: hug.directives.Timer) -> 'Returns data':
"""Annotations defined with strings should be documentation only"""
pass
documentation = api.http.documentation()
assert 'test_documentation' in documentation['overview']
assert '/hello_world' in documentation['handlers']
assert '/echo' in documentation['handlers']
assert '/happy_birthday' in documentation['handlers']
assert not '/birthday' in documentation['handlers']
assert '/noop' in documentation['handlers']
assert '/string_docs' in documentation['handlers']
assert documentation['handlers']['/hello_world']['GET']['usage'] == "Returns hello world"
assert documentation['handlers']['/hello_world']['GET']['examples'] == ["/hello_world"]
assert documentation['handlers']['/hello_world']['GET']['outputs']['content_type'] == "application/json"
assert not 'inputs' in documentation['handlers']['/hello_world']['GET']
assert 'text' in documentation['handlers']['/echo']['POST']['inputs']['text']['type']
assert not 'default' in documentation['handlers']['/echo']['POST']['inputs']['text']
assert 'number' in documentation['handlers']['/happy_birthday']['POST']['inputs']['age']['type']
assert documentation['handlers']['/happy_birthday']['POST']['inputs']['age']['default'] == 1
assert not 'inputs' in documentation['handlers']['/noop']['POST']
assert documentation['handlers']['/string_docs']['GET']['inputs']['data']['type'] == 'Takes data'
assert documentation['handlers']['/string_docs']['GET']['outputs']['type'] == 'Returns data'
assert not 'ignore_directive' in documentation['handlers']['/string_docs']['GET']['inputs']
@hug.post(versions=1) # noqa
def echo(text):
"""V1 Docs"""
return 'V1'
@hug.post(versions=2) # noqa
def echo(text):
"""V1 Docs"""
return 'V2'
@hug.post(versions=2)
def test(text):
"""V1 Docs"""
return True
@hug.get(requires=test)
def unversioned():
return 'Hello'
versioned_doc = api.http.documentation()
assert 'versions' in versioned_doc
assert 1 in versioned_doc['versions']
assert '/unversioned' in versioned_doc['handlers']
assert '/echo' in versioned_doc['handlers']
assert '/test' in versioned_doc['handlers']
specific_version_doc = api.http.documentation(api_version=1)
assert 'versions' in specific_version_doc
assert '/echo' in specific_version_doc['handlers']
assert '/unversioned' in specific_version_doc['handlers']
assert specific_version_doc['handlers']['/unversioned']['GET']['requires'] == ['V1 Docs']
assert '/test' not in specific_version_doc['handlers']
handler = api.http.documentation_404()
response = StartResponseMock()
handler(Request(create_environ(path='v1/doc')), response)
documentation = json.loads(response.data.decode('utf8'))['documentation']
assert 'versions' in documentation
assert '/echo' in documentation['handlers']
assert '/test' not in documentation['handlers']