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
|
# 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
#
# https://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.
import botocore.session
import pytest
from botocore import xform_name
from botocore.exceptions import DataNotFoundError
import boto3
from boto3.docs.service import ServiceDocumenter
@pytest.fixture
def botocore_session():
return botocore.session.get_session()
@pytest.fixture
def boto3_session():
return boto3.Session(region_name='us-east-1')
def all_services():
session = boto3.Session(region_name='us-east-1')
yield from session.get_available_services()
@pytest.fixture
def available_resources():
session = boto3.Session(region_name='us-east-1')
return session.get_available_resources()
@pytest.mark.parametrize('service_name', all_services())
def test_documentation(
boto3_session, botocore_session, available_resources, service_name
):
generated_docs = ServiceDocumenter(
service_name, session=boto3_session
).document_service()
generated_docs = generated_docs.decode('utf-8')
client = boto3.client(service_name, 'us-east-1')
# Check that all of the services have the appropriate title
_assert_has_title(generated_docs, client)
# Check that all services have the client documented.
_assert_has_client_documentation(generated_docs, service_name, client)
# If the service has resources, make sure the service resource
# is at least documented.
if service_name in available_resources:
resource = boto3.resource(service_name, 'us-east-1')
_assert_has_resource_documentation(
generated_docs, service_name, resource
)
# If the client can paginate, make sure the paginators are documented.
try:
paginator_model = botocore_session.get_paginator_model(service_name)
_assert_has_paginator_documentation(
generated_docs,
service_name,
client,
sorted(paginator_model._paginator_config),
)
except DataNotFoundError:
pass
# If the client has waiters, make sure the waiters are documented.
if client.waiter_names:
waiter_model = botocore_session.get_waiter_model(service_name)
_assert_has_waiter_documentation(
generated_docs, service_name, client, waiter_model
)
def _assert_contains_lines_in_order(lines, contents):
for line in lines:
assert line in contents
beginning = contents.find(line)
contents = contents[(beginning + len(line)) :]
def _assert_has_title(generated_docs, client):
title = client.__class__.__name__
ref_lines = ['*' * len(title), title, '*' * len(title)]
_assert_contains_lines_in_order(ref_lines, generated_docs)
def _assert_has_client_documentation(generated_docs, service_name, client):
class_name = client.__class__.__name__
ref_lines = [
'======',
'Client',
'======',
'.. py:class:: %s.Client' % class_name,
' A low-level client representing',
' import boto3',
' client = boto3.client(\'%s\')' % service_name,
' These are the available methods:',
' * :py:meth:`~%s.Client.get_paginator`' % class_name,
' * :py:meth:`~%s.Client.get_waiter`' % class_name,
' .. py:method:: get_paginator(operation_name)',
' .. py:method:: get_waiter(waiter_name)',
]
_assert_contains_lines_in_order(ref_lines, generated_docs)
def _assert_has_paginator_documentation(
generated_docs, service_name, client, paginator_names
):
ref_lines = [
'==========',
'Paginators',
'==========',
'The available paginators are:',
]
for paginator_name in paginator_names:
ref_lines.append(
'* :py:class:`{}.Paginator.{}`'.format(
client.__class__.__name__, paginator_name
)
)
for paginator_name in paginator_names:
ref_lines.append(
'.. py:class:: {}.Paginator.{}'.format(
client.__class__.__name__, paginator_name
)
)
ref_lines.append(' .. py:method:: paginate(')
_assert_contains_lines_in_order(ref_lines, generated_docs)
def _assert_has_waiter_documentation(
generated_docs, service_name, client, waiter_model
):
ref_lines = ['=======', 'Waiters', '=======', 'The available waiters are:']
for waiter_name in waiter_model.waiter_names:
ref_lines.append(
'* :py:class:`{}.Waiter.{}`'.format(
client.__class__.__name__, waiter_name
)
)
for waiter_name in waiter_model.waiter_names:
ref_lines.append(
'.. py:class:: {}.Waiter.{}'.format(
client.__class__.__name__, waiter_name
)
)
ref_lines.append(
' waiter = client.get_waiter(\'%s\')' % xform_name(waiter_name)
)
ref_lines.append(' .. py:method:: wait(')
_assert_contains_lines_in_order(ref_lines, generated_docs)
def _assert_has_resource_documentation(generated_docs, service_name, resource):
ref_lines = [
'================',
'Service Resource',
'================',
'.. py:class:: %s.ServiceResource'
% (resource.meta.client.__class__.__name__),
' A resource representing',
' import boto3',
f' {service_name} = boto3.resource(\'{service_name}\')',
]
_assert_contains_lines_in_order(ref_lines, generated_docs)
|
