Ejemplo n.º 1
0
    def test_extract_tags_public_only_explicit(self):

        class MyService:
            """ @public
            This is a one-line summary.

            This is public information
            It is multiline
            """

        segments = ServiceInfo(service_name, MyService, sio_config, APISPEC.DEFAULT_TAG).extract_segments(MyService.__doc__)

        # There should be only one tag, the explicitly named 'public' one.
        expected = {
             'tag':         'public',
             'description': 'This is public information\nIt is multiline',
             'full':        'This is a one-line summary.\n\nThis is public information\nIt is multiline\n',
             'summary':     'This is a one-line summary.'
        }

        self.assertEqual(len(segments), 1)
        public = segments[0] # type: _DocstringSegment

        segment_dict = public.to_dict()

        self.assertEqual(segment_dict['tag'], expected['tag'])
        self.assertEqual(segment_dict['description'], expected['description'])
        self.assertEqual(segment_dict['full'], expected['full'])
        self.assertEqual(segment_dict['summary'], expected['summary'])
Ejemplo n.º 2
0
    def test_get_sio_desc_multiline_no_separator(self):

        MyClass = deepcopy(MyService)
        CySimpleIO.attach_sio(self.get_server_config(), MyClass)

        info = ServiceInfo(service_name, MyClass, sio_config, 'public')
        description = info.simple_io['zato'].description # type: SimpleIODescription

        # There are multiple lines and no I/O separator
        # so input and output descriptions will be the same.

        input_user_id      = description.input['input_req_user_id']
        input_user_name    = description.input['input_opt_user_name']
        input_address_id   = description.input['output_req_address_id']
        input_address_name = description.input['output_opt_address_name']

        output_user_id      = description.output['input_req_user_id']
        output_user_name    = description.output['input_opt_user_name']
        output_address_id   = description.output['output_req_address_id']
        output_address_name = description.output['output_opt_address_name']

        self.assertEqual(input_user_id, output_user_id)
        self.assertEqual(input_user_name, output_user_name)
        self.assertEqual(input_address_id, output_address_id)
        self.assertEqual(input_address_name, output_address_name)

        self.assertEqual(input_user_id, 'This is the first line.\nHere is another.\nAnd here are some more lines.')
        self.assertEqual(input_user_name, 'b111')
        self.assertEqual(input_address_id, 'c111 c222 c333 c444')
        self.assertEqual(input_address_name, 'd111\nd222')

        self.assertEqual(output_user_id, 'This is the first line.\nHere is another.\nAnd here are some more lines.')
        self.assertEqual(output_user_name, 'b111')
        self.assertEqual(output_address_id, 'c111 c222 c333 c444')
        self.assertEqual(output_address_name, 'd111\nd222')
Ejemplo n.º 3
0
    def test_extract_tags_multi_1(self):

        class MyService:
            """ This is a one-line summary.

            This is public information
            It is multiline

            @internal

            One-line summary for internal uses.

            This part is internal,
            it will not be visible
            to public users.
            """

        tags = [APISPEC.DEFAULT_TAG, 'internal']
        segments = ServiceInfo(service_name, MyService, sio_config, tags).extract_segments(MyService.__doc__)

        # There should be only one tag, the default, implicit one called 'public'
        expected_public = {
             'tag':         'public',
             'description': 'This is public information\nIt is multiline',
             'full':        'This is a one-line summary.\n\nThis is public information\nIt is multiline\n',
             'summary':     'This is a one-line summary.'
        }

        expected_internal = {
             'tag':         'internal',
             'description': '\n\n\n.. raw:: html\n\n    <span class="zato-tag-name-highlight">@internal</span>\n\nOne-line summary for internal uses.\n\nThis part is internal,\nit will not be visible\nto public users.', # noqa: E501
             'full':        '\n\n.. raw:: html\n\n    <span class="zato-tag-name-highlight">@internal</span>\n\n\nINFORMATION IN THIS SECTION IS NOT PUBLIC.\n\nOne-line summary for internal uses.\n\nThis part is internal,\nit will not be visible\nto public users.\n', # noqa: E501
             'summary':     not_public
        }

        self.assertEqual(len(segments), 2)

        public = segments[0] # type: _DocstringSegment
        segment_dict_public = public.to_dict()

        self.assertEqual(segment_dict_public['tag'], expected_public['tag'])
        self.assertEqual(segment_dict_public['description'], expected_public['description'])
        self.assertEqual(segment_dict_public['full'], expected_public['full'])
        self.assertEqual(segment_dict_public['summary'], expected_public['summary'])

        internal = segments[1] # type: _DocstringSegment
        segment_dict_internal = internal.to_dict()

        self.assertEqual(segment_dict_internal['tag'], expected_internal['tag'])
        self.assertEqual(segment_dict_internal['description'], expected_internal['description'])

        self.assertEqual(segment_dict_internal['full'], expected_internal['full'])
        self.assertEqual(segment_dict_internal['summary'], expected_internal['summary'])
Ejemplo n.º 4
0
    def test_docstring_summary_only(self):

        class MyService:
            """ This is a one-line summary.
            """

        info = ServiceInfo(service_name, MyService, sio_config, 'public')

        # This service's docstring has a summary only so it will constitute
        # all of its summary, decsription and full docstring.

        self.assertEqual(info.docstring.summary, 'This is a one-line summary.')
        self.assertEqual(info.docstring.description, 'This is a one-line summary.')
        self.assertEqual(info.docstring.full, 'This is a one-line summary.')
    def test_docstring_multiline(self):

        class MyService:
            """ This is a one-line summary.

            This is public information
            It is multiline

            ======= ======= =======
            header1 header2 header3
            ======= ======= =======
            column1 column2 column3
            ======= ======= =======

            - This is a list

              - It has a sub-list

                - And another one

                The sub-list has a table

                ======= ======= =======
                header4 header5 header6
                ======= ======= =======
                column4 column5 column6
                ======= ======= =======

            - More bullets in the list

            """


        info = ServiceInfo(service_name, MyService, sio_config, 'public')
        self.assertEqual(info.docstring.summary, 'This is a one-line summary.')

        service_docstring_lines = MyService.__doc__.strip().splitlines()
        docstring_full_lines = info.docstring.full.splitlines()

        for idx, line in enumerate(service_docstring_lines):

            expected_line = line.strip() # type: str
            given_line = docstring_full_lines[idx].strip() # type: str

            self.assertEqual(expected_line, given_line)