mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
3.4 KiB
Python
100 lines
3.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 annotations
|
|
|
|
import pytest
|
|
|
|
from ansible.module_utils.common import warnings
|
|
|
|
from ansible.module_utils.common.warnings import deprecate, get_deprecation_messages
|
|
|
|
|
|
@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'},
|
|
]
|
|
|
|
|
|
@pytest.fixture
|
|
def reset(monkeypatch):
|
|
monkeypatch.setattr(warnings, '_global_deprecations', [])
|
|
|
|
|
|
def test_deprecate_message_only(reset):
|
|
deprecate('Deprecation message')
|
|
assert warnings._global_deprecations == [
|
|
{'msg': 'Deprecation message', 'version': None, 'collection_name': None}]
|
|
|
|
|
|
def test_deprecate_with_collection(reset):
|
|
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(reset):
|
|
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(reset):
|
|
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(reset):
|
|
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(reset):
|
|
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, reset):
|
|
for d in deprecation_messages:
|
|
deprecate(**d)
|
|
|
|
assert deprecation_messages == warnings._global_deprecations
|
|
|
|
|
|
def test_get_deprecation_messages(deprecation_messages, reset):
|
|
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',
|
|
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)
|