mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
d088030fa6
The timeout for gathering facts needs to be settable from three places
(highest precedence to lowest):
* programmatically
* ansible.cfg (equivalent to the user specifying it explicitly when
calling setup)
* from the default value
The code was changed in b4bd6c80de to
allow programmatically and the default value to work correctly but
setting via ansible.cfg/parameter was broken.
This change should fix setting via ansible.cfg and adds unittests for
all three cases
Fixes #23753
112 lines
3.7 KiB
Python
112 lines
3.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# (c) 2017, Toshio Kuratomi <tkuratomi@ansible.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)
|
|
__metaclass__ = type
|
|
|
|
import time
|
|
|
|
import pytest
|
|
|
|
from ansible.compat.tests import unittest
|
|
from ansible.compat.tests.mock import patch, MagicMock
|
|
|
|
from ansible.module_utils import facts
|
|
|
|
|
|
@pytest.fixture
|
|
def set_gather_timeout_higher():
|
|
default_timeout = facts.GATHER_TIMEOUT
|
|
facts.GATHER_TIMEOUT = facts.DEFAULT_GATHER_TIMEOUT + 5
|
|
yield
|
|
facts.GATHER_TIMEOUT = default_timeout
|
|
|
|
|
|
@pytest.fixture
|
|
def set_gather_timeout_lower():
|
|
default_timeout = facts.GATHER_TIMEOUT
|
|
facts.GATHER_TIMEOUT = 2
|
|
yield
|
|
facts.GATHER_TIMEOUT = default_timeout
|
|
|
|
|
|
@facts.timeout
|
|
def sleep_amount_implicit(amount):
|
|
# implicit refers to the lack of argument to the decorator
|
|
time.sleep(amount)
|
|
return 'Succeeded after {0} sec'.format(amount)
|
|
|
|
|
|
@facts.timeout(facts.DEFAULT_GATHER_TIMEOUT + 5)
|
|
def sleep_amount_explicit_higher(amount):
|
|
# explicit refers to the argument to the decorator
|
|
time.sleep(amount)
|
|
return 'Succeeded after {0} sec'.format(amount)
|
|
|
|
|
|
@facts.timeout(2)
|
|
def sleep_amount_explicit_lower(amount):
|
|
# explicit refers to the argument to the decorator
|
|
time.sleep(amount)
|
|
return 'Succeeded after {0} sec'.format(amount)
|
|
|
|
|
|
def test_defaults_still_within_bounds():
|
|
# If the default changes outside of these bounds, some of the tests will
|
|
# no longer test the right thing. Need to review and update the timeouts
|
|
# in the other tests if this fails
|
|
assert facts.DEFAULT_GATHER_TIMEOUT >= 4
|
|
|
|
|
|
def test_implicit_file_default_succeeds():
|
|
# amount checked must be less than DEFAULT_GATHER_TIMEOUT
|
|
assert sleep_amount_implicit(1) == 'Succeeded after 1 sec'
|
|
|
|
|
|
def test_implicit_file_default_timesout():
|
|
# sleep_time is greater than the default
|
|
sleep_time = facts.DEFAULT_GATHER_TIMEOUT + 1
|
|
with pytest.raises(facts.TimeoutError):
|
|
assert sleep_amount_implicit(sleep_time) == '(Not expected to succeed)'
|
|
|
|
|
|
def test_implicit_file_overridden_succeeds(set_gather_timeout_higher):
|
|
# Set sleep_time greater than the default timeout and less than our new timeout
|
|
sleep_time = facts.DEFAULT_GATHER_TIMEOUT + 1
|
|
assert sleep_amount_implicit(sleep_time) == 'Succeeded after {0} sec'.format(sleep_time)
|
|
|
|
|
|
def test_implicit_file_overridden_timesout(set_gather_timeout_lower):
|
|
# Set sleep_time greater than our new timeout but less than the default
|
|
sleep_time = 3
|
|
with pytest.raises(facts.TimeoutError):
|
|
assert sleep_amount_implicit(sleep_time) == '(Not expected to Succeed)'
|
|
|
|
|
|
def test_explicit_succeeds():
|
|
# Set sleep_time greater than the default timeout and less than our new timeout
|
|
sleep_time = facts.DEFAULT_GATHER_TIMEOUT + 1
|
|
assert sleep_amount_explicit_higher(sleep_time) == 'Succeeded after {0} sec'.format(sleep_time)
|
|
|
|
|
|
def test_explicit_timeout():
|
|
# Set sleep_time greater than our new timeout but less than the default
|
|
sleep_time = 3
|
|
with pytest.raises(facts.TimeoutError):
|
|
assert sleep_amount_explicit_lower(sleep_time) == '(Not expected to succeed)'
|