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
107 lines
3.7 KiB
Python
107 lines
3.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 collections import OrderedDict
|
|
|
|
from bs4 import BeautifulSoup
|
|
|
|
from os_api_ref.tests import base
|
|
|
|
|
|
class TestWarnings(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('warnings'))
|
|
def setUp(self, app, status, warning):
|
|
super(TestWarnings, self).setUp()
|
|
self.app = app
|
|
self.app.build()
|
|
self.status = status.getvalue()
|
|
self.warning = warning.getvalue()
|
|
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_out_of_order(self):
|
|
"""Do we get an out of order naming warning."""
|
|
self.assertIn(
|
|
("WARNING: Parameters out of order ``name2`` "
|
|
"should be after ``name``"),
|
|
self.warning)
|
|
|
|
def test_missing_lookup_name(self):
|
|
"""Warning when missing a lookup key in parameter file."""
|
|
self.assertIn(
|
|
("WARNING: No field definition for ``lookup_key_name`` found in "),
|
|
self.warning)
|
|
|
|
def test_missing_field(self):
|
|
"""Warning when missing type field in parameter file."""
|
|
# py312 changes string interpretation of OrderedDict.
|
|
# Prevent such failures by using OrderedDict directly
|
|
cmp_data = OrderedDict({
|
|
"description": "name_1 is missing type field.\n",
|
|
"in": "body",
|
|
"required": True
|
|
})
|
|
self.assertIn(
|
|
("WARNING: Failure on key: name, values: " +
|
|
f"{cmp_data}. " +
|
|
"'NoneType' object has no attribute 'split'"),
|
|
self.warning)
|
|
|
|
def test_invalid_parameter_definition(self):
|
|
"""Warning when parameter definition is invalid."""
|
|
self.assertIn(
|
|
("WARNING: Invalid parameter definition ``invalid_name``. " +
|
|
"Expected format: ``name: reference``. "),
|
|
self.warning)
|
|
|
|
def test_empty_parameter_file(self):
|
|
"""Warning when parameter file exists but is empty."""
|
|
self.assertIn(
|
|
("WARNING: Parameters file is empty"),
|
|
self.warning)
|
|
|
|
def test_no_parameters_set(self):
|
|
"""Error when parameters are not set in rest_parameters stanza."""
|
|
self.assertIn(
|
|
("No parameters defined\n\n.." +
|
|
" rest_parameters:: parameters.yaml"),
|
|
self.warning)
|
|
|
|
def test_parameter_file_not_exist(self):
|
|
"""Error when parameter file does not exist"""
|
|
self.assertIn(
|
|
("No parameters defined\n\n.." +
|
|
" rest_parameters:: no_parameters.yaml"),
|
|
self.warning)
|
|
|
|
def test_missing_path_parameter_in_stanza(self):
|
|
"""Warning when path param not found in rest_parameter stanza."""
|
|
|
|
self.assertIn(
|
|
("WARNING: No path parameter ``b_id`` found in" +
|
|
" rest_parameter stanza.\n"),
|
|
self.warning)
|