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
|
# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from botocore.docs.client import (
ClientContextParamsDocumenter,
ClientDocumenter,
ClientExceptionsDocumenter,
)
from tests.unit.docs import BaseDocsTest
class TestClientDocumenter(BaseDocsTest):
def setUp(self):
super().setUp()
exception_shape = {
'SomeException': {
'exception': True,
'type': 'structure',
'members': {'Message': {'shape': 'String'}},
}
}
self.add_shape(exception_shape)
self.add_shape_to_params('Biz', 'String')
self.add_shape_to_errors('SomeException')
self.setup_client()
self.client_documenter = ClientDocumenter(
self.client, self.root_services_path
)
def test_document_client(self):
self.client_documenter.document_client(self.doc_structure)
self.assert_contains_lines_in_order(
[
'======',
'Client',
'======',
'.. py:class:: MyService.Client',
' A low-level client representing AWS MyService',
' AWS MyService Description',
' client = session.create_client(\'myservice\')',
'These are the available methods:',
' myservice/client/can_paginate',
' myservice/client/get_paginator',
' myservice/client/get_waiter',
' myservice/client/sample_operation',
]
)
self.assert_contains_lines_in_order(
['.. py:method:: MyService.Client.can_paginate(operation_name)'],
self.get_nested_service_contents(
'myservice', 'client', 'can_paginate'
),
)
self.assert_contains_lines_in_order(
['.. py:method:: MyService.Client.get_paginator(operation_name)'],
self.get_nested_service_contents(
'myservice', 'client', 'get_paginator'
),
)
self.assert_contains_lines_in_order(
['.. py:method:: MyService.Client.get_waiter(waiter_name)'],
self.get_nested_service_contents(
'myservice', 'client', 'get_waiter'
),
)
self.assert_contains_lines_in_order(
[
'.. py:method:: MyService.Client.sample_operation(**kwargs)',
' **Request Syntax**',
' ::',
' response = client.sample_operation(',
' Biz=\'string\'',
' )',
' :type Biz: string',
' :param Biz:',
' :rtype: dict',
' :returns:',
' **Response Syntax**',
' ::',
' {',
' \'Biz\': \'string\'',
' }',
' **Response Structure**',
' - *(dict) --*',
' - **Biz** *(string) --*',
'**Exceptions**',
'* :py:class:`MyService.Client.exceptions.SomeException`',
],
self.get_nested_service_contents(
'myservice', 'client', 'sample_operation'
),
)
class TestClientExceptionsDocumenter(BaseDocsTest):
def setup_documenter(self):
self.setup_client()
self.exceptions_documenter = ClientExceptionsDocumenter(
self.client, self.root_services_path
)
def test_no_modeled_exceptions(self):
self.setup_documenter()
self.exceptions_documenter.document_exceptions(self.doc_structure)
self.assert_contains_lines_in_order(
[
'=================',
'Client Exceptions',
'=================',
'Client exceptions are available',
'This client has no modeled exception classes.',
]
)
def test_modeled_exceptions(self):
exception_shape = {
'SomeException': {
'exception': True,
'type': 'structure',
'members': {'Message': {'shape': 'String'}},
}
}
self.add_shape(exception_shape)
self.setup_documenter()
self.exceptions_documenter.document_exceptions(self.doc_structure)
self.assert_contains_lines_in_order(
[
'=================',
'Client Exceptions',
'=================',
'Client exceptions are available',
'The available client exceptions are:',
'.. toctree::',
':maxdepth: 1',
':titlesonly:',
' myservice/client/exceptions/SomeException',
]
)
self.assert_contains_lines_in_order(
[
'.. py:class:: MyService.Client.exceptions.SomeException',
'**Example**',
'::',
'except client.exceptions.SomeException as e:',
'.. py:attribute:: response',
'**Syntax**',
'{',
"'Message': 'string',",
"'Error': {",
"'Code': 'string',",
"'Message': 'string'",
'}',
'}',
'**Structure**',
'- *(dict) --*',
'- **Message** *(string) --* ',
'- **Error** *(dict) --* ',
'- **Code** *(string) --* ',
'- **Message** *(string) --* ',
],
self.get_nested_service_contents(
'myservice', 'client/exceptions', 'SomeException'
),
)
class TestClientContextParamsDocumenter(BaseDocsTest):
def setUp(self):
super().setUp()
self.json_model['clientContextParams'] = {
'ClientContextParam1': {
'type': 'string',
'documentation': 'A client context param',
},
'ClientContextParam2': {
'type': 'boolean',
'documentation': 'A second client context param',
},
}
self.setup_client()
service_model = self.client.meta.service_model
self.context_params_documenter = ClientContextParamsDocumenter(
service_model.service_name, service_model.client_context_parameters
)
def test_client_context_params(self):
self.context_params_documenter.document_context_params(
self.doc_structure
)
self.assert_contains_lines_in_order(
[
'========================',
'Client Context Parameters',
'========================',
'Client context parameters are configurable',
'The available ``myservice`` client context params are:',
'* ``client_context_param1`` (string) - A client context param',
'* ``client_context_param2`` (boolean) - A second client context param',
]
)
|
