122 lines
4.1 KiB
Python
122 lines
4.1 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.
|
|
|
|
import logging
|
|
import textwrap
|
|
from unittest import mock
|
|
|
|
import fixtures
|
|
import yaml
|
|
|
|
from reno import config
|
|
from reno import loader
|
|
from reno.tests import base
|
|
|
|
|
|
class TestValidate(base.TestCase):
|
|
|
|
scanner_output = {
|
|
'0.0.0': [('note', 'shaA')],
|
|
}
|
|
|
|
versions = ['0.0.0']
|
|
|
|
def setUp(self):
|
|
super(TestValidate, self).setUp()
|
|
self.logger = self.useFixture(
|
|
fixtures.FakeLogger(
|
|
format='%(message)s',
|
|
level=logging.WARNING,
|
|
)
|
|
)
|
|
self.c = config.Config('reporoot')
|
|
|
|
def _make_loader(self, note_bodies):
|
|
def _load(ldr):
|
|
ldr._scanner_output = self.scanner_output
|
|
ldr._cache = {
|
|
'file-contents': {'note1': note_bodies},
|
|
}
|
|
|
|
with mock.patch('reno.loader.Loader._load_data', _load):
|
|
return loader.Loader(
|
|
self.c,
|
|
ignore_cache=False,
|
|
)
|
|
|
|
def test_note_with_non_prelude_string_converted_to_list(self):
|
|
"""Test behavior when a non-prelude note is not structured as a list.
|
|
|
|
We should silently convert it to list.
|
|
"""
|
|
note_bodies = yaml.safe_load(textwrap.dedent("""
|
|
issues: |
|
|
This is a single string. It should be converted to a list.
|
|
"""))
|
|
self.assertIsInstance(note_bodies['issues'], str)
|
|
ldr = self._make_loader(note_bodies)
|
|
parse_results = ldr.parse_note_file('note1', None)
|
|
self.assertIsInstance(parse_results['issues'], list)
|
|
|
|
def test_invalid_note_with_prelude_as_list(self):
|
|
note_bodies = yaml.safe_load(textwrap.dedent('''
|
|
prelude:
|
|
- The prelude should not be a list.
|
|
'''))
|
|
self.assertIsInstance(note_bodies['prelude'], list)
|
|
ldr = self._make_loader(note_bodies)
|
|
ldr.parse_note_file('note1', None)
|
|
self.assertIn('does not parse as a single string', self.logger.output)
|
|
|
|
def test_invalid_note_with_colon_as_dict(self):
|
|
note_bodies = yaml.safe_load(textwrap.dedent('''
|
|
issues:
|
|
- This line is fine.
|
|
- dict: But this is parsed as a mapping (dictionary), which is bad.
|
|
'''))
|
|
self.assertIsInstance(note_bodies['issues'][-1], dict)
|
|
ldr = self._make_loader(note_bodies)
|
|
ldr.parse_note_file('note1', None)
|
|
self.assertIn('instead of a string', self.logger.output)
|
|
|
|
def test_invalid_note_with_unrecognized_key(self):
|
|
"""Test behavior when note contains an unrecognized section."""
|
|
note_bodies = yaml.safe_load(textwrap.dedent('''
|
|
foobar:
|
|
- |
|
|
This is an issue but we're using an unrecognized section key.
|
|
'''))
|
|
self.assertIsInstance(note_bodies, dict)
|
|
ldr = self._make_loader(note_bodies)
|
|
ldr.parse_note_file('note1', None)
|
|
self.assertIn(
|
|
'The foobar section of note1 is not a recognized section.',
|
|
self.logger.output)
|
|
|
|
def test_invalid_note_with_missing_key(self):
|
|
"""Test behavior when note is not structured as a mapping.
|
|
|
|
This one should be an error since we can't correct the input.
|
|
"""
|
|
note_bodies = yaml.safe_load(textwrap.dedent('''
|
|
- |
|
|
This is an issue but we're missing the top-level 'issues' key.
|
|
'''))
|
|
self.assertIsInstance(note_bodies, list)
|
|
ldr = self._make_loader(note_bodies)
|
|
self.assertRaises(ValueError, ldr.parse_note_file, 'note1', None)
|
|
self.assertIn(
|
|
'does not appear to be structured as a YAML mapping',
|
|
self.logger.output)
|