e75570ba83
If a YAML file fails to load due to a syntax error in a file, or there is an error in the last line of a
file, PyYAML reports the last line number of the file as the index where the error occurred.
When reading the file lines, we use that index to the get the relevant line. If the index value is out
of range, the relevant line is lost for error reporting.
Subtract one from the index value to avoid the IndexError in this specific scenario. It is possible
to still get an IndexError, which will be handled as it is currently.
* Update existing tests and add new tests
(cherry picked from commit e8d4b62b41)
Co-authored-by: Sam Doran <sdoran@redhat.com>
151 lines
6.8 KiB
Python
151 lines
6.8 KiB
Python
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
from units.compat import unittest
|
|
from units.compat.builtins import BUILTINS
|
|
from units.compat.mock import mock_open, patch
|
|
from ansible.errors import AnsibleError
|
|
from ansible.parsing.yaml.objects import AnsibleBaseYAMLObject
|
|
|
|
|
|
class TestErrors(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
self.message = 'This is the error message'
|
|
self.unicode_message = 'This is an error with \xf0\x9f\x98\xa8 in it'
|
|
|
|
self.obj = AnsibleBaseYAMLObject()
|
|
|
|
def test_basic_error(self):
|
|
e = AnsibleError(self.message)
|
|
self.assertEqual(e.message, self.message)
|
|
self.assertEqual(e.__repr__(), self.message)
|
|
|
|
def test_basic_unicode_error(self):
|
|
e = AnsibleError(self.unicode_message)
|
|
self.assertEqual(e.message, self.unicode_message)
|
|
self.assertEqual(e.__repr__(), self.unicode_message)
|
|
|
|
@patch.object(AnsibleError, '_get_error_lines_from_file')
|
|
def test_error_with_kv(self, mock_method):
|
|
''' This tests a task with both YAML and k=v syntax
|
|
|
|
- lineinfile: line=foo path=bar
|
|
line: foo
|
|
|
|
An accurate error message and position indicator are expected.
|
|
|
|
_get_error_lines_from_file() returns (target_line, prev_line)
|
|
'''
|
|
|
|
self.obj.ansible_pos = ('foo.yml', 2, 1)
|
|
|
|
mock_method.return_value = [' line: foo\n', '- lineinfile: line=foo path=bar\n']
|
|
|
|
e = AnsibleError(self.message, self.obj)
|
|
self.assertEqual(
|
|
e.message,
|
|
("This is the error message\n\nThe error appears to be in 'foo.yml': line 1, column 19, but may\nbe elsewhere in the "
|
|
"file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n- lineinfile: line=foo path=bar\n"
|
|
" ^ here\n\n"
|
|
"There appears to be both 'k=v' shorthand syntax and YAML in this task. Only one syntax may be used.\n")
|
|
)
|
|
|
|
@patch.object(AnsibleError, '_get_error_lines_from_file')
|
|
def test_error_with_object(self, mock_method):
|
|
self.obj.ansible_pos = ('foo.yml', 1, 1)
|
|
|
|
mock_method.return_value = ('this is line 1\n', '')
|
|
e = AnsibleError(self.message, self.obj)
|
|
|
|
self.assertEqual(
|
|
e.message,
|
|
("This is the error message\n\nThe error appears to be in 'foo.yml': line 1, column 1, but may\nbe elsewhere in the file depending on the "
|
|
"exact syntax problem.\n\nThe offending line appears to be:\n\n\nthis is line 1\n^ here\n")
|
|
)
|
|
|
|
def test_get_error_lines_from_file(self):
|
|
m = mock_open()
|
|
m.return_value.readlines.return_value = ['this is line 1\n']
|
|
|
|
with patch('{0}.open'.format(BUILTINS), m):
|
|
# this line will be found in the file
|
|
self.obj.ansible_pos = ('foo.yml', 1, 1)
|
|
e = AnsibleError(self.message, self.obj)
|
|
self.assertEqual(
|
|
e.message,
|
|
("This is the error message\n\nThe error appears to be in 'foo.yml': line 1, column 1, but may\nbe elsewhere in the file depending on "
|
|
"the exact syntax problem.\n\nThe offending line appears to be:\n\n\nthis is line 1\n^ here\n")
|
|
)
|
|
|
|
with patch('ansible.errors.to_text', side_effect=IndexError('Raised intentionally')):
|
|
# raise an IndexError
|
|
self.obj.ansible_pos = ('foo.yml', 2, 1)
|
|
e = AnsibleError(self.message, self.obj)
|
|
self.assertEqual(
|
|
e.message,
|
|
("This is the error message\n\nThe error appears to be in 'foo.yml': line 2, column 1, but may\nbe elsewhere in the file depending on "
|
|
"the exact syntax problem.\n\n(specified line no longer in file, maybe it changed?)")
|
|
)
|
|
|
|
m = mock_open()
|
|
m.return_value.readlines.return_value = ['this line has unicode \xf0\x9f\x98\xa8 in it!\n']
|
|
|
|
with patch('{0}.open'.format(BUILTINS), m):
|
|
# this line will be found in the file
|
|
self.obj.ansible_pos = ('foo.yml', 1, 1)
|
|
e = AnsibleError(self.unicode_message, self.obj)
|
|
self.assertEqual(
|
|
e.message,
|
|
("This is an error with \xf0\x9f\x98\xa8 in it\n\nThe error appears to be in 'foo.yml': line 1, column 1, but may\nbe elsewhere in the "
|
|
"file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n\nthis line has unicode \xf0\x9f\x98\xa8 in it!\n^ "
|
|
"here\n")
|
|
)
|
|
|
|
def test_get_error_lines_error_in_last_line(self):
|
|
m = mock_open()
|
|
m.return_value.readlines.return_value = ['this is line 1\n', 'this is line 2\n', 'this is line 3\n']
|
|
|
|
with patch('{0}.open'.format(BUILTINS), m):
|
|
# If the error occurs in the last line of the file, use the correct index to get the line
|
|
# and avoid the IndexError
|
|
self.obj.ansible_pos = ('foo.yml', 4, 1)
|
|
e = AnsibleError(self.message, self.obj)
|
|
self.assertEqual(
|
|
e.message,
|
|
("This is the error message\n\nThe error appears to be in 'foo.yml': line 4, column 1, but may\nbe elsewhere in the file depending on "
|
|
"the exact syntax problem.\n\nThe offending line appears to be:\n\nthis is line 2\nthis is line 3\n^ here\n")
|
|
)
|
|
|
|
def test_get_error_lines_error_empty_lines_around_error(self):
|
|
"""Test that trailing whitespace after the error is removed"""
|
|
m = mock_open()
|
|
m.return_value.readlines.return_value = ['this is line 1\n', 'this is line 2\n', 'this is line 3\n', ' \n', ' \n', ' ']
|
|
|
|
with patch('{0}.open'.format(BUILTINS), m):
|
|
self.obj.ansible_pos = ('foo.yml', 5, 1)
|
|
e = AnsibleError(self.message, self.obj)
|
|
self.assertEqual(
|
|
e.message,
|
|
("This is the error message\n\nThe error appears to be in 'foo.yml': line 5, column 1, but may\nbe elsewhere in the file depending on "
|
|
"the exact syntax problem.\n\nThe offending line appears to be:\n\nthis is line 2\nthis is line 3\n^ here\n")
|
|
)
|