a862ff2d43
* Allow to specify collection_name separately for deprecation. * Use new functionality in Ansible. * Use new functionality in tests. * Update tagging/untagging functions. * Update pylint deprecated sanity test. * Update validate-modules. Missing are basic checks for version_added (validate semantic version format for collections). * Improve version validation. Re-add version_added validation. * Make sure collection names are added to return docs before schema validation. * Extra checks to avoid crashes on bad data. * Make C# module utils code work, and update/extend tests. * Add changelog fragment. * Stop extracting collection name from potentially tagged versions/dates. * Simplify C# code. * Update Windows modules docs. * Forgot semicolons.
96 lines
3.3 KiB
Python
96 lines
3.3 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 deprecate, get_deprecation_messages
|
|
from ansible.module_utils.six import PY3
|
|
|
|
|
|
@pytest.fixture
|
|
def deprecation_messages():
|
|
return [
|
|
{'msg': 'First deprecation', 'version': None, 'collection_name': None},
|
|
{'msg': 'Second deprecation', 'version': None, 'collection_name': 'ansible.builtin'},
|
|
{'msg': 'Third deprecation', 'version': '2.14', 'collection_name': None},
|
|
{'msg': 'Fourth deprecation', 'version': '2.9', 'collection_name': None},
|
|
{'msg': 'Fifth deprecation', 'version': '2.9', 'collection_name': 'ansible.builtin'},
|
|
{'msg': 'Sixth deprecation', 'date': '2199-12-31', 'collection_name': None},
|
|
{'msg': 'Seventh deprecation', 'date': '2199-12-31', 'collection_name': 'ansible.builtin'},
|
|
]
|
|
|
|
|
|
def test_deprecate_message_only():
|
|
deprecate('Deprecation message')
|
|
assert warnings._global_deprecations == [
|
|
{'msg': 'Deprecation message', 'version': None, 'collection_name': None}]
|
|
|
|
|
|
def test_deprecate_with_collection():
|
|
deprecate(msg='Deprecation message', collection_name='ansible.builtin')
|
|
assert warnings._global_deprecations == [
|
|
{'msg': 'Deprecation message', 'version': None, 'collection_name': 'ansible.builtin'}]
|
|
|
|
|
|
def test_deprecate_with_version():
|
|
deprecate(msg='Deprecation message', version='2.14')
|
|
assert warnings._global_deprecations == [
|
|
{'msg': 'Deprecation message', 'version': '2.14', 'collection_name': None}]
|
|
|
|
|
|
def test_deprecate_with_version_and_collection():
|
|
deprecate(msg='Deprecation message', version='2.14', collection_name='ansible.builtin')
|
|
assert warnings._global_deprecations == [
|
|
{'msg': 'Deprecation message', 'version': '2.14', 'collection_name': 'ansible.builtin'}]
|
|
|
|
|
|
def test_deprecate_with_date():
|
|
deprecate(msg='Deprecation message', date='2199-12-31')
|
|
assert warnings._global_deprecations == [
|
|
{'msg': 'Deprecation message', 'date': '2199-12-31', 'collection_name': None}]
|
|
|
|
|
|
def test_deprecate_with_date_and_collection():
|
|
deprecate(msg='Deprecation message', date='2199-12-31', collection_name='ansible.builtin')
|
|
assert warnings._global_deprecations == [
|
|
{'msg': 'Deprecation message', 'date': '2199-12-31', 'collection_name': 'ansible.builtin'}]
|
|
|
|
|
|
def test_multiple_deprecations(deprecation_messages):
|
|
for d in deprecation_messages:
|
|
deprecate(**d)
|
|
|
|
assert deprecation_messages == warnings._global_deprecations
|
|
|
|
|
|
def test_get_deprecation_messages(deprecation_messages):
|
|
for d in deprecation_messages:
|
|
deprecate(**d)
|
|
|
|
accessor_deprecations = get_deprecation_messages()
|
|
assert isinstance(accessor_deprecations, tuple)
|
|
assert len(accessor_deprecations) == 7
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
'test_case',
|
|
(
|
|
1,
|
|
True,
|
|
[1],
|
|
{'k1': 'v1'},
|
|
(1, 2),
|
|
6.62607004,
|
|
b'bytestr' if PY3 else None,
|
|
None,
|
|
)
|
|
)
|
|
def test_deprecate_failure(test_case):
|
|
with pytest.raises(TypeError, match='deprecate requires a string not a %s' % type(test_case)):
|
|
deprecate(test_case)
|