60 lines
2.2 KiB
Python
60 lines
2.2 KiB
Python
# 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.
|
|
import os
|
|
import shutil
|
|
import tempfile
|
|
|
|
import mock
|
|
|
|
from tests.unit.docs import BaseDocsTest
|
|
from botocore.session import get_session
|
|
from botocore.docs import generate_docs
|
|
|
|
|
|
class TestGenerateDocs(BaseDocsTest):
|
|
def setUp(self):
|
|
super(TestGenerateDocs, self).setUp()
|
|
self.docs_root = tempfile.mkdtemp()
|
|
self.loader_patch = mock.patch(
|
|
'botocore.session.create_loader', return_value=self.loader)
|
|
self.available_service_patch = mock.patch(
|
|
'botocore.session.Session.get_available_services',
|
|
return_value=['myservice'])
|
|
self.loader_patch.start()
|
|
self.available_service_patch.start()
|
|
|
|
def tearDown(self):
|
|
super(TestGenerateDocs, self).tearDown()
|
|
shutil.rmtree(self.docs_root)
|
|
self.loader_patch.stop()
|
|
self.available_service_patch.stop()
|
|
|
|
def test_generate_docs(self):
|
|
session = get_session()
|
|
# Have the rst files get written to the temporary directory
|
|
generate_docs(self.docs_root, session)
|
|
|
|
reference_services_path = os.path.join(
|
|
self.docs_root, 'reference', 'services')
|
|
reference_service_path = os.path.join(
|
|
reference_services_path, 'myservice.rst')
|
|
self.assertTrue(os.path.exists(reference_service_path))
|
|
|
|
# Make sure the rst file has some the expected contents.
|
|
with open(reference_service_path, 'r') as f:
|
|
contents = f.read()
|
|
self.assertIn('AWS MyService', contents)
|
|
self.assertIn('Client', contents)
|
|
self.assertIn('Paginators', contents)
|
|
self.assertIn('Waiters', contents)
|