b170c0016a
-Added info on max_version field. -Added info about including sample files. -Added warning test for missing lookup key. -Added warning test for missing type field. Change-Id: I1ffa2d3e1d425239641adbdf029647e1af72bca0
69 lines
2.3 KiB
Python
69 lines
2.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# 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 sphinx_testing import with_app
|
|
|
|
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.
|
|
"""
|
|
|
|
@with_app(buildername='html', srcdir=base.example_dir('warnings'),
|
|
copy_srcdir_to_tmpdir=True)
|
|
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()
|
|
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 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."""
|
|
self.assertIn(
|
|
("WARNING: Failure on key: name, values: "
|
|
+ "OrderedDict([('description',"
|
|
+ " 'name_1 is missing type field.\\n'), ('in', 'body'),"
|
|
+ " ('required', True)]). "
|
|
+ "'NoneType' object has no attribute 'split'\n"),
|
|
self.warning)
|