# 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.waiter import WaiterDocumenter
from botocore.waiter import WaiterModel

from tests.unit.botocore.docs import BaseDocsTest


class TestWaiterDocumenter(BaseDocsTest):
    def setUp(self):
        super().setUp()
        self.add_shape_to_params('Biz', 'String')
        self.setup_client()
        waiter_model = WaiterModel(self.waiter_json_model)
        self.waiter_documenter = WaiterDocumenter(
            client=self.client,
            service_waiter_model=waiter_model,
            root_docs_path=self.root_services_path,
        )

    def test_document_waiters(self):
        self.waiter_documenter.document_waiters(self.doc_structure)
        self.assert_contains_lines_in_order(
            [
                '=======',
                'Waiters',
                '=======',
                'The available waiters are:',
                'waiter/SampleOperationComplete',
            ]
        )
        self.assert_contains_lines_in_order(
            [
                '.. py:class:: MyService.Waiter.SampleOperationComplete',
                '  ::',
                '    waiter = client.get_waiter(\'sample_operation_complete\')',
                '  .. py:method:: wait(**kwargs)',
                (
                    '    Polls :py:meth:`MyService.Client.sample_operation` '
                    'every 15 seconds until a successful state is reached. An error '
                    'is returned after 40 failed checks.'
                ),
                '    **Request Syntax**',
                '    ::',
                '      waiter.wait(',
                '          Biz=\'string\'',
                '      )',
                '    :type Biz: string',
                '    :param Biz:',
                '    :type WaiterConfig: dict',
                '    :param WaiterConfig:',
                (
                    'A dictionary that provides parameters to control waiting '
                    'behavior.'
                ),
                '     - **Delay** *(integer) --*',
                (
                    '        The amount of time in seconds to wait between attempts. '
                    'Default: 15'
                ),
                '      - **MaxAttempts** *(integer) --*',
                '        The maximum number of attempts to be made. Default: 40',
                '    :returns: None',
            ],
            self.get_nested_service_contents(
                'myservice', 'waiter', 'SampleOperationComplete'
            ),
        )
