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
|
# 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.
from boto3.docs.subresource import SubResourceDocumenter
from tests.unit.docs import BaseDocsTest
class TestSubResourceDocumenter(BaseDocsTest):
def test_document_sub_resources(self):
sub_resource_documentor = SubResourceDocumenter(
self.resource, self.root_services_path
)
sub_resource_documentor.document_sub_resources(self.doc_structure)
self.assert_contains_lines_in_order(
[
'-------------\nSub-resources\n-------------',
'Sub-resources are methods that create a new instance of a',
' child resource. This resource\'s identifiers get passed',
' along to the child.',
'For more information about sub-resources refer to the ',
]
)
self.assert_contains_lines_in_order(
[
'Sample',
'.. py:method:: MyService.ServiceResource.Sample(name)',
' Creates a Sample resource.::',
" sample = myservice.Sample('name')",
' :type name: string',
" :param name: The Sample's name identifier.",
' :rtype: :py:class:`MyService.Sample`',
' :returns: A Sample resource',
],
self.get_nested_service_contents(
'myservice', 'service-resource', 'Sample'
),
)
|
