ansible/test/units/module_utils/common/warnings/test_warn.py
Sam Doran 3461c682c3
Add mechanism for storing warnings and deprecations outside of AnsibleModule (#58993)
* Move warn() and deprecate() methods out of basic.py
* Use _global_warnings and _global_deprications and create accessor functions
    - This lays the foundation for future functions being moved outside of AnsibleModule
       that need an interface to warnings and deprecations without modifying them.
* Add unit tests for new warn and deprecate functions
2020-01-28 12:12:14 -05:00

61 lines
1.4 KiB
Python

# -*- coding: utf-8 -*-
# (c) 2019 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
import pytest
import ansible.module_utils.common.warnings as warnings
from ansible.module_utils.common.warnings import warn, get_warning_messages
from ansible.module_utils.six import PY3
@pytest.fixture
def warning_messages():
return [
'First warning',
'Second warning',
'Third warning',
]
def test_warn():
warn('Warning message')
assert warnings._global_warnings == ['Warning message']
def test_multiple_warningss(warning_messages):
for w in warning_messages:
warn(w)
assert warning_messages == warnings._global_warnings
def test_get_warning_messages(warning_messages):
for w in warning_messages:
warn(w)
accessor_warnings = get_warning_messages()
assert isinstance(accessor_warnings, tuple)
assert len(accessor_warnings) == 3
@pytest.mark.parametrize(
'test_case',
(
1,
True,
[1],
{'k1': 'v1'},
(1, 2),
6.62607004,
b'bytestr' if PY3 else None,
None,
)
)
def test_warn_failure(test_case):
with pytest.raises(TypeError, match='warn requires a string not a %s' % type(test_case)):
warn(test_case)