561ed1cb5f
The time passes and things stop to work which worked before. Unfortunately now we landed in the situation that we can't fix issues independently due to their collision so we need to address few things in one change: - Replace deprecated sphinx.testing.path The sphinx.testing.path moudle was deprecated in sphinx v7.2.0[1]. Also remove the colgroup section causing the assertion failures. The changes made in unit tests require Sphinx v7.2.0 or later, but Sphinx is capped to 7.1.2 in Python 3.8. So unit tests may no longer pass in Python 3.8 once this change is merged. [1] https://github.com/sphinx-doc/sphinx/pull/11526 - Since we stop testing py38 update classifiers - py312 dropped assertRegexpMatches (replace with AssertRegex) - py312 changed how OrderedDict is serialized and as such test asserting certain serialization form is now failing. Address this by using OrderedDict directly in the comparison rather then hardcoding the form since onlt that would work in different python versions. Change-Id: I01a89777e18fb6f21f92a297f605099c5971583c
144 lines
4.7 KiB
Python
144 lines
4.7 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License 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.
|
|
|
|
"""
|
|
test_os_api_ref
|
|
----------------------------------
|
|
|
|
Tests for `os_api_ref` module.
|
|
"""
|
|
|
|
from bs4 import BeautifulSoup
|
|
|
|
from os_api_ref.tests import base
|
|
|
|
|
|
class TestBasicExample(base.TestCase):
|
|
"""Test basic rendering.
|
|
|
|
This can be used to test that basic rendering works for these
|
|
examples, so if someone breaks something we know.
|
|
"""
|
|
|
|
@base.with_app(buildername='html', srcdir=base.example_dir('basic'))
|
|
def setUp(self, app, status, warning):
|
|
super(TestBasicExample, self).setUp()
|
|
self.app = app
|
|
self.status = status
|
|
self.warning = warning
|
|
self.app.build()
|
|
self.html = (app.outdir / 'index.html').read_text(encoding='utf-8')
|
|
self.soup = BeautifulSoup(self.html, 'html.parser')
|
|
self.content = str(self.soup)
|
|
|
|
def test_expand_all(self):
|
|
"""Do we get an expand all button like we expect."""
|
|
content = str(self.soup.find(id='expand-all'))
|
|
example_button = ('<button class="btn btn-info btn-sm btn-expand-all" '
|
|
'data-toggle="collapse" id="expand-all">'
|
|
'Show All</button>')
|
|
self.assertEqual(
|
|
example_button,
|
|
content)
|
|
|
|
def test_rest_method(self):
|
|
"""Do we get a REST method call block"""
|
|
|
|
# TODO(sdague): it probably would make sense to do this as a
|
|
# whole template instead of parts.
|
|
content = str(self.soup.find_all(class_='operation-grp'))
|
|
self.assertIn(
|
|
'<span class="glyphicon glyphicon-link"></span>',
|
|
str(content))
|
|
self.assertIn(
|
|
'<span class="label label-GET">GET</span>',
|
|
str(content))
|
|
self.assertIn(
|
|
'<div class="row col-md-12">/servers</div>',
|
|
str(content))
|
|
self.assertIn(
|
|
('<button class="btn btn-info btn-sm btn-detail" '
|
|
'data-target="#list-servers-detail" data-toggle="collapse" '
|
|
'id="list-servers-detail-btn">detail</button>'),
|
|
str(content))
|
|
|
|
def test_parameters(self):
|
|
"""Do we get some parameters table"""
|
|
table = """<table class="docutils align-default">
|
|
<thead>
|
|
<tr class="row-odd"><th class="head"><p>Name</p></th>
|
|
<th class="head"><p>In</p></th>
|
|
<th class="head"><p>Type</p></th>
|
|
<th class="head"><p>Description</p></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="row-even"><td><p>name</p></td>
|
|
<td><p>body</p></td>
|
|
<td><p>string</p></td>
|
|
<td><p>The name of things</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>"""
|
|
self.assertIn(table, self.content)
|
|
|
|
def test_rest_response(self):
|
|
success_table = """<table class="docutils align-default">
|
|
<thead>
|
|
<tr class="row-odd"><th class="head"><p>Code</p></th>
|
|
<th class="head"><p>Reason</p></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="row-even"><td><code>200 - OK</code></td>
|
|
<td><p>Request was successful.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><code>100 - Continue</code></td>
|
|
<td><p>An unusual code for an API</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><code>201 - Created</code></td>
|
|
<td><p>Resource was created and is ready to use.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>"""
|
|
|
|
error_table = """<table class="docutils align-default">
|
|
<thead>
|
|
<tr class="row-odd"><th class="head"><p>Code</p></th>
|
|
<th class="head"><p>Reason</p></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="row-even"><td><code>405 - Method Not Allowed</code></td>
|
|
<td><p>Method is not valid for this endpoint.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><code>403 - Forbidden</code></td>
|
|
<td><p>Policy does not allow current user to do this operation.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><code>401 - Unauthorized</code></td>
|
|
<td><p>User must authenticate before making a request</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><code>400 - Bad Request</code></td>
|
|
<td><p>Some content in the request was invalid</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><code>500 - Internal Server Error</code></td>
|
|
<td><p>Something went wrong inside the service.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><code>409 - Conflict</code></td>
|
|
<td><p>There is already a zone with this name.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>"""
|
|
|
|
self.assertIn(success_table, self.content)
|
|
self.assertIn(error_table, self.content)
|