1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Adds better cli detection for bigip_command (#34975)

The new detection includes things like provider spec. The action
plugin for bigip generally was changed, so this is a required change
This commit is contained in:
Tim Rupp 2018-01-17 09:33:20 -08:00 committed by GitHub
parent a352d43824
commit acb26758ef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 14 deletions

View file

@ -162,12 +162,6 @@ failed_conditions:
import re import re
import time import time
try:
from ansible.module_utils.f5_utils import run_commands
HAS_CLI_TRANSPORT = True
except ImportError:
HAS_CLI_TRANSPORT = False
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.basic import env_fallback from ansible.module_utils.basic import env_fallback
from ansible.module_utils.six import string_types from ansible.module_utils.six import string_types
@ -187,12 +181,18 @@ try:
from library.module_utils.network.f5.common import AnsibleF5Parameters from library.module_utils.network.f5.common import AnsibleF5Parameters
from library.module_utils.network.f5.common import cleanup_tokens from library.module_utils.network.f5.common import cleanup_tokens
from library.module_utils.network.f5.common import fqdn_name from library.module_utils.network.f5.common import fqdn_name
from library.module_utils.network.f5.common import is_cli
from library.module_utils.network.f5.common import f5_argument_spec from library.module_utils.network.f5.common import f5_argument_spec
try: try:
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
except ImportError: except ImportError:
HAS_F5SDK = False HAS_F5SDK = False
HAS_DEVEL_IMPORTS = True HAS_DEVEL_IMPORTS = True
try:
from library.module_utils.network.f5.common import run_commands
HAS_CLI_TRANSPORT = True
except ImportError:
HAS_CLI_TRANSPORT = False
except ImportError: except ImportError:
# Upstream Ansible # Upstream Ansible
from ansible.module_utils.network.f5.bigip import HAS_F5SDK from ansible.module_utils.network.f5.bigip import HAS_F5SDK
@ -201,11 +201,17 @@ except ImportError:
from ansible.module_utils.network.f5.common import AnsibleF5Parameters from ansible.module_utils.network.f5.common import AnsibleF5Parameters
from ansible.module_utils.network.f5.common import cleanup_tokens from ansible.module_utils.network.f5.common import cleanup_tokens
from ansible.module_utils.network.f5.common import fqdn_name from ansible.module_utils.network.f5.common import fqdn_name
from ansible.module_utils.network.f5.common import is_cli
from ansible.module_utils.network.f5.common import f5_argument_spec from ansible.module_utils.network.f5.common import f5_argument_spec
try: try:
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
except ImportError: except ImportError:
HAS_F5SDK = False HAS_F5SDK = False
try:
from ansible.module_utils.network.f5.common import run_commands
HAS_CLI_TRANSPORT = True
except ImportError:
HAS_CLI_TRANSPORT = False
class Parameters(AnsibleF5Parameters): class Parameters(AnsibleF5Parameters):
@ -229,7 +235,7 @@ class Parameters(AnsibleF5Parameters):
def commands(self): def commands(self):
commands = self._listify(self._values['commands']) commands = self._listify(self._values['commands'])
commands = deque(commands) commands = deque(commands)
if self._values['transport'] != 'cli': if not is_cli(self.module):
commands.appendleft( commands.appendleft(
'tmsh modify cli preference pager disabled' 'tmsh modify cli preference pager disabled'
) )
@ -268,12 +274,21 @@ class ModuleManager(object):
'list', 'show', 'list', 'show',
'modify cli preference pager disabled' 'modify cli preference pager disabled'
] ]
if self.module.params['transport'] != 'cli': if not is_cli(self.module):
valid_configs = list(map(self.want._ensure_tmsh_prefix, valid_configs)) valid_configs = list(map(self.want._ensure_tmsh_prefix, valid_configs))
if any(cmd.startswith(x) for x in valid_configs): if any(cmd.startswith(x) for x in valid_configs):
return True return True
return False return False
def is_tmsh(self):
try:
self._run_commands(self.module, 'tmsh help')
except F5ModuleError as ex:
if 'Syntax Error:' in str(ex):
return True
raise
return False
def exec_module(self): def exec_module(self):
result = dict() result = dict()
@ -295,14 +310,16 @@ class ModuleManager(object):
commands = self.parse_commands(warnings) commands = self.parse_commands(warnings)
wait_for = self.want.wait_for or list() wait_for = self.want.wait_for or list()
retries = self.want.retries retries = self.want.retries
conditionals = [Conditional(c) for c in wait_for] conditionals = [Conditional(c) for c in wait_for]
if self.module.check_mode: if self.module.check_mode:
return return
while retries > 0: while retries > 0:
if self.module.params['transport'] == 'cli' and HAS_CLI_TRANSPORT: if is_cli(self.module) and HAS_CLI_TRANSPORT:
if self.is_tmsh():
for command in commands:
command['command'] = command['command'][4:].strip()
responses = self._run_commands(self.module, commands) responses = self._run_commands(self.module, commands)
else: else:
responses = self.execute_on_device(commands) responses = self.execute_on_device(commands)
@ -349,7 +366,7 @@ class ModuleManager(object):
commands = transform(commands) commands = transform(commands)
for index, item in enumerate(commands): for index, item in enumerate(commands):
if not self._is_valid_mode(item['command']) and self.module.params['transport'] != 'cli': if not self._is_valid_mode(item['command']) and is_cli(self.module):
warnings.append( warnings.append(
'Using "write" commands is not idempotent. You should use ' 'Using "write" commands is not idempotent. You should use '
'a module that is specifically made for that. If such a ' 'a module that is specifically made for that. If such a '
@ -432,7 +449,7 @@ def main():
argument_spec=spec.argument_spec, argument_spec=spec.argument_spec,
supports_check_mode=spec.supports_check_mode supports_check_mode=spec.supports_check_mode
) )
if module.params['transport'] != 'cli' and not HAS_F5SDK: if is_cli(module) and not HAS_F5SDK:
module.fail_json(msg="The python f5-sdk module is required to use the rest api") module.fail_json(msg="The python f5-sdk module is required to use the rest api")
try: try:

View file

@ -64,7 +64,7 @@ class TestParameters(unittest.TestCase):
password='password' password='password'
) )
p = Parameters(params=args) p = Parameters(params=args)
assert len(p.commands) == 2 assert len(p.commands) == 1
class TestManager(unittest.TestCase): class TestManager(unittest.TestCase):
@ -143,7 +143,17 @@ class TestManager(unittest.TestCase):
results = mm.exec_module() results = mm.exec_module()
assert results['changed'] is False assert results['changed'] is False
assert mm._run_commands.call_count == 1
# call count is two on CLI transport because we must first
# determine if the remote CLI is in tmsh mode or advanced shell
# (bash) mode.
#
# 1 call for the shell check
# 1 call for the command in the "commands" list above
#
# Can we change this in the future by making the terminal plugin
# find this out ahead of time?
assert mm._run_commands.call_count == 2
assert mm.execute_on_device.call_count == 0 assert mm.execute_on_device.call_count == 0
def test_command_with_commas(self, *args): def test_command_with_commas(self, *args):