# -*- coding: utf-8 -*- # # Copyright 2017 F5 Networks Inc. # # 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 . from __future__ import (absolute_import, division, print_function) __metaclass__ = type import os import json import pytest import sys from nose.plugins.skip import SkipTest if sys.version_info < (2, 7): raise SkipTest("F5 Ansible modules require Python >= 2.7") from ansible.compat.tests import unittest from ansible.compat.tests.mock import patch, Mock from ansible.module_utils import basic from ansible.module_utils._text import to_bytes from ansible.module_utils.f5_utils import AnsibleF5Client from ansible.module_utils.f5_utils import F5ModuleError try: from library.bigip_user import Parameters from library.bigip_user import ModuleManager from library.bigip_user import ArgumentSpec from library.bigip_user import UnparitionedManager from library.bigip_user import PartitionedManager except ImportError: try: from ansible.modules.network.f5.bigip_user import Parameters from ansible.modules.network.f5.bigip_user import ModuleManager from ansible.modules.network.f5.bigip_user import ArgumentSpec from ansible.modules.network.f5.bigip_user import UnparitionedManager from ansible.modules.network.f5.bigip_user import PartitionedManager except ImportError: raise SkipTest("F5 Ansible modules require the f5-sdk Python library") fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures') fixture_data = {} def set_module_args(args): args = json.dumps({'ANSIBLE_MODULE_ARGS': args}) basic._ANSIBLE_ARGS = to_bytes(args) def load_fixture(name): path = os.path.join(fixture_path, name) if path in fixture_data: return fixture_data[path] with open(path) as f: data = f.read() try: data = json.loads(data) except Exception: pass fixture_data[path] = data return data class TestParameters(unittest.TestCase): def test_module_parameters(self): access = [{'name': 'Common', 'role': 'guest'}] args = dict( username_credential='someuser', password_credential='testpass', full_name='Fake Person', partition_access=access, update_password='always' ) p = Parameters(args) assert p.username_credential == 'someuser' assert p.password_credential == 'testpass' assert p.full_name == 'Fake Person' assert p.partition_access == access assert p.update_password == 'always' def test_api_parameters(self): access = [{'name': 'Common', 'role': 'guest'}] args = dict( name='someuser', description='Fake Person', password='testpass', partitionAccess=access, shell='none' ) p = Parameters(args) assert p.name == 'someuser' assert p.password == 'testpass' assert p.full_name == 'Fake Person' assert p.partition_access == access assert p.shell == 'none' @patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root', return_value=True) class TestManager(unittest.TestCase): def setUp(self): self.spec = ArgumentSpec() def test_create_user(self, *args): access = [{'name': 'Common', 'role': 'guest'}] set_module_args(dict( username_credential='someuser', password_credential='testpass', partition_access=access, server='localhost', password='password', user='admin', update_password='on_create' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.create_on_device = Mock(return_value=True) pm.exists = Mock(return_value=False) results = pm.exec_module() assert results['changed'] is True assert results['partition_access'] == access def test_create_user_no_password(self, *args): access = [{'name': 'Common', 'role': 'guest'}] set_module_args(dict( username_credential='someuser', partition_access=access, server='localhost', password='password', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.create_on_device = Mock(return_value=True) pm.exists = Mock(return_value=False) results = pm.exec_module() assert results['changed'] is True assert results['partition_access'] == access def test_create_user_raises(self, *args): access = [{'name': 'Common', 'role': 'guest'}] set_module_args(dict( username_credential='someuser', password_credential='testpass', partition_access=access, password='password', server='localhost', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.create_on_device = Mock(return_value=True) pm.exists = Mock(return_value=False) msg = "The 'update_password' option " \ "needs to be set to 'on_create' when creating " \ "a resource with a password." with pytest.raises(F5ModuleError) as ex: pm.exec_module() assert str(ex.value) == msg def test_create_user_partition_access_raises(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.create_on_device = Mock(return_value=True) pm.exists = Mock(return_value=False) msg = "The 'partition_access' option " \ "is required when creating a resource." with pytest.raises(F5ModuleError) as ex: pm.exec_module() assert str(ex.value) == msg def test_create_user_shell_bash(self, *args): access = [{'name': 'all', 'role': 'admin'}] set_module_args(dict( username_credential='someuser', password_credential='testpass', partition_access=access, password='password', server='localhost', update_password='on_create', user='admin', shell='bash' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.create_on_device = Mock(return_value=True) pm.exists = Mock(return_value=False) results = pm.exec_module() assert results['changed'] is True assert results['partition_access'] == access def test_create_user_shell_not_permitted_raises(self, *args): access = [{'name': 'Common', 'role': 'guest'}] set_module_args(dict( username_credential='someuser', password_credential='testpass', partition_access=access, update_password='on_create', password='password', server='localhost', user='admin', shell='bash' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.create_on_device = Mock(return_value=True) pm.exists = Mock(return_value=False) msg = "Shell access is only available to 'admin' or " \ "'resource-admin' roles" with pytest.raises(F5ModuleError) as ex: pm.exec_module() assert str(ex.value) == msg def test_update_user_password_no_pass(self, *args): set_module_args(dict( username_credential='someuser', password_credential='testpass', password='password', server='localhost', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device current = Parameters(load_fixture('load_auth_user_no_pass.json')) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.exists = Mock(return_value=True) pm.update_on_device = Mock(return_value=True) pm.read_current_from_device = Mock(return_value=current) results = pm.exec_module() assert results['changed'] is True def test_update_user_password_with_pass(self, *args): set_module_args(dict( username_credential='someuser', password_credential='testpass', password='password', server='localhost', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device current = Parameters(load_fixture('load_auth_user_with_pass.json')) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.exists = Mock(return_value=True) pm.update_on_device = Mock(return_value=True) pm.read_current_from_device = Mock(return_value=current) results = pm.exec_module() assert results['changed'] is True def test_update_user_shell_to_none(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin', shell='none' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device current = Parameters( dict( user='admin', shell='tmsh' ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.exists = Mock(return_value=True) pm.update_on_device = Mock(return_value=True) pm.read_current_from_device = Mock(return_value=current) results = pm.exec_module() assert results['changed'] is True assert results['shell'] == 'none' def test_update_user_shell_to_none_shell_attribute_missing(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin', shell='none' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device access = [{'name': 'Common', 'role': 'guest'}] current = Parameters( dict( user='admin', partition_access=access ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=False) pm = PartitionedManager(client) pm.exists = Mock(return_value=True) pm.update_on_device = Mock(return_value=True) pm.read_current_from_device = Mock(return_value=current) results = pm.exec_module() assert results['changed'] is False assert not hasattr(results, 'shell') def test_update_user_shell_to_bash(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin', shell='bash' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device access = [{'name': 'all', 'role': 'admin'}] current = Parameters( dict( user='admin', shell='tmsh', partition_access=access ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.exists = Mock(return_value=True) upm.update_on_device = Mock(return_value=True) upm.read_current_from_device = Mock(return_value=current) results = upm.exec_module() assert results['changed'] is True assert results['shell'] == 'bash' def test_update_user_shell_to_bash_mutliple_roles(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin', shell='bash' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device access = [ {'name': 'Common', 'role': 'operator'}, {'name': 'all', 'role': 'guest'} ] current = Parameters( dict( user='admin', shell='tmsh', partition_access=access ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.exists = Mock(return_value=True) upm.update_on_device = Mock(return_value=True) upm.read_current_from_device = Mock(return_value=current) msg = "Shell access is only available to 'admin' or " \ "'resource-admin' roles" with pytest.raises(F5ModuleError) as ex: upm.exec_module() assert str(ex.value) == msg @patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root', return_value=True) class TestLegacyManager(unittest.TestCase): def setUp(self): self.spec = ArgumentSpec() def test_create_user(self, *args): access = [{'name': 'Common', 'role': 'guest'}] set_module_args(dict( username_credential='someuser', password_credential='testpass', partition_access=access, server='localhost', password='password', user='admin', update_password='on_create' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.create_on_device = Mock(return_value=True) upm.exists = Mock(return_value=False) results = upm.exec_module() assert results['changed'] is True assert results['partition_access'] == access def test_create_user_no_password(self, *args): access = [{'name': 'Common', 'role': 'guest'}] set_module_args(dict( username_credential='someuser', partition_access=access, server='localhost', password='password', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.create_on_device = Mock(return_value=True) upm.exists = Mock(return_value=False) results = upm.exec_module() assert results['changed'] is True assert results['partition_access'] == access def test_create_user_raises(self, *args): access = [{'name': 'Common', 'role': 'guest'}] set_module_args(dict( username_credential='someuser', password_credential='testpass', partition_access=access, password='password', server='localhost', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.create_on_device = Mock(return_value=True) upm.exists = Mock(return_value=False) msg = "The 'update_password' option " \ "needs to be set to 'on_create' when creating " \ "a resource with a password." with pytest.raises(F5ModuleError) as ex: upm.exec_module() assert str(ex.value) == msg def test_create_user_partition_access_raises(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.create_on_device = Mock(return_value=True) upm.exists = Mock(return_value=False) msg = "The 'partition_access' option " \ "is required when creating a resource." with pytest.raises(F5ModuleError) as ex: upm.exec_module() assert str(ex.value) == msg def test_create_user_shell_bash(self, *args): access = [{'name': 'all', 'role': 'admin'}] set_module_args(dict( username_credential='someuser', password_credential='testpass', partition_access=access, password='password', server='localhost', update_password='on_create', user='admin', shell='bash' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.create_on_device = Mock(return_value=True) upm.exists = Mock(return_value=False) results = upm.exec_module() assert results['changed'] is True assert results['partition_access'] == access def test_create_user_shell_not_permitted_raises(self, *args): access = [{'name': 'Common', 'role': 'guest'}] set_module_args(dict( username_credential='someuser', password_credential='testpass', partition_access=access, update_password='on_create', password='password', server='localhost', user='admin', shell='bash' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.create_on_device = Mock(return_value=True) upm.exists = Mock(return_value=False) msg = "Shell access is only available to 'admin' or " \ "'resource-admin' roles" with pytest.raises(F5ModuleError) as ex: upm.exec_module() assert str(ex.value) == msg def test_update_user_password(self, *args): set_module_args(dict( username_credential='someuser', password_credential='testpass', password='password', server='localhost', user='admin' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device access = [{'name': 'Common', 'role': 'guest'}] current = Parameters( dict( shell='tmsh', partition_access=access ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.exists = Mock(return_value=True) upm.update_on_device = Mock(return_value=True) upm.read_current_from_device = Mock(return_value=current) results = upm.exec_module() assert results['changed'] is True def test_update_user_shell_to_none(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin', shell='none' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device current = Parameters( dict( user='admin', shell='tmsh' ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.exists = Mock(return_value=True) upm.update_on_device = Mock(return_value=True) upm.read_current_from_device = Mock(return_value=current) results = upm.exec_module() assert results['changed'] is True assert results['shell'] == 'none' def test_update_user_shell_to_none_shell_attribute_missing(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin', shell='none' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device access = [{'name': 'Common', 'role': 'guest'}] current = Parameters( dict( user='admin', partition_access=access ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.exists = Mock(return_value=True) upm.update_on_device = Mock(return_value=True) upm.read_current_from_device = Mock(return_value=current) results = upm.exec_module() assert results['changed'] is False assert not hasattr(results, 'shell') def test_update_user_shell_to_bash(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin', shell='bash' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device access = [{'name': 'all', 'role': 'admin'}] current = Parameters( dict( user='admin', shell='tmsh', partition_access=access ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.exists = Mock(return_value=True) upm.update_on_device = Mock(return_value=True) upm.read_current_from_device = Mock(return_value=current) results = upm.exec_module() assert results['changed'] is True assert results['shell'] == 'bash' def test_update_user_shell_to_bash_mutliple_roles(self, *args): set_module_args(dict( username_credential='someuser', password='password', server='localhost', user='admin', shell='bash' )) client = AnsibleF5Client( argument_spec=self.spec.argument_spec, supports_check_mode=self.spec.supports_check_mode, f5_product_name=self.spec.f5_product_name ) # Configure the parameters that would be returned by querying the # remote device access = [ {'name': 'Common', 'role': 'operator'}, {'name': 'all', 'role': 'guest'} ] current = Parameters( dict( user='admin', shell='tmsh', partition_access=access ) ) # Override methods to force specific logic in the module to happen mm = ModuleManager(client) mm.is_version_less_than_13 = Mock(return_value=True) upm = UnparitionedManager(client) upm.exists = Mock(return_value=True) upm.update_on_device = Mock(return_value=True) upm.read_current_from_device = Mock(return_value=current) msg = "Shell access is only available to 'admin' or " \ "'resource-admin' roles" with pytest.raises(F5ModuleError) as ex: upm.exec_module() assert str(ex.value) == msg