mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
bc4ef99533
* openstack: standardize tls params * tower: tower_verify_ssl->validate_certs * docker: use standard tls config params - cacert_path -> ca_cert - cert_path -> client_cert - key_path -> client_key - tls_verify -> validate_certs * k8s: standardize tls connection params - verify_ssl -> validate_certs - ssl_ca_cert -> ca_cert - cert_file -> client_cert - key_file -> client_key * ingate: verify_ssl -> validate_certs * manageiq: standardize tls params - verify_ssl -> validate_certs - ca_bundle_path -> ca_cert * mysql: standardize tls params - ssl_ca -> ca_cert - ssl_cert -> client_cert - ssl_key -> client_key * nios: ssl_verify -> validate_certs * postgresql: ssl_rootcert -> ca_cert * rabbitmq: standardize tls params - cacert -> ca_cert - cert -> client_cert - key -> client_key * rackspace: verify_ssl -> validate_certs * vca: verify_certs -> validate_certs * kubevirt_cdi_upload: upload_host_verify_ssl -> upload_host_validate_certs * lxd: standardize tls params - key_file -> client_key - cert_file -> client_cert * get_certificate: ca_certs -> ca_cert * get_certificate.py: clarify one or more certs in a file Co-Authored-By: jamescassell <code@james.cassell.me> * zabbix: tls_issuer -> ca_cert * bigip_device_auth_ldap: standardize tls params - ssl_check_peer -> validate_certs - ssl_client_cert -> client_cert - ssl_client_key -> client_key - ssl_ca_cert -> ca_cert * vdirect: vdirect_validate_certs -> validate_certs * mqtt: standardize tls params - ca_certs -> ca_cert - certfile -> client_cert - keyfile -> client_key * pulp_repo: standardize tls params remove `importer_ssl` prefix * rhn_register: sslcacert -> ca_cert * yum_repository: standardize tls params The fix for yum_repository is not straightforward since this module is only a thin wrapper for the underlying commands and config. In this case, we add the new values as aliases, keeping the old as primary, only due to the internal structure of the module. Aliases added: - sslcacert -> ca_cert - sslclientcert -> client_cert - sslclientkey -> client_key - sslverify -> validate_certs * gitlab_hook: enable_ssl_verification -> hook_validate_certs * Adjust arguments for docker_swarm inventory plugin. * foreman callback: standardize tls params - ssl_cert -> client_cert - ssl_key -> client_key * grafana_annotations: validate_grafana_certs -> validate_certs * nrdp callback: validate_nrdp_certs -> validate_certs * kubectl connection: standardize tls params - kubectl_cert_file -> client_cert - kubectl_key_file -> client_key - kubectl_ssl_ca_cert -> ca_cert - kubectl_verify_ssl -> validate_certs * oc connection: standardize tls params - oc_cert_file -> client_cert - oc_key_file -> client_key - oc_ssl_ca_cert -> ca_cert - oc_verify_ssl -> validate_certs * psrp connection: cert_trust_path -> ca_cert TODO: cert_validation -> validate_certs (multi-valued vs bool) * k8s inventory: standardize tls params - cert_file -> client_cert - key_file -> client_key - ca_cert -> ca_cert - verify_ssl -> validate_certs * openshift inventory: standardize tls params - cert_file -> client_cert - key_file -> client_key - ca_cert -> ca_cert - verify_ssl -> validate_certs * tower inventory: verify_ssl -> validate_certs * hashi_vault lookup: cacert -> ca_cert * k8s lookup: standardize tls params - cert_file -> client_cert - key_file -> client_key - ca_cert -> ca_cert - verify_ssl -> validate_certs * laps_passord lookup: cacert_file -> ca_cert * changelog for TLS parameter standardization
285 lines
13 KiB
Python
285 lines
13 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright 2017 Radware LTD.
|
|
#
|
|
# 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/>.
|
|
|
|
import os
|
|
from units.compat.mock import patch, MagicMock
|
|
|
|
from units.compat import unittest
|
|
from units.compat.mock import patch
|
|
|
|
BASE_PARAMS = {'vdirect_ip': None, 'vdirect_user': None, 'vdirect_password': None,
|
|
'vdirect_wait': None, 'vdirect_secondary_ip': None,
|
|
'vdirect_https_port': None, 'vdirect_http_port': None,
|
|
'vdirect_timeout': None, 'vdirect_use_ssl': None, 'validate_certs': None}
|
|
|
|
RUNNABLE_PARAMS = {'runnable_type': 'ConfigurationTemplate', 'runnable_name': 'runnable',
|
|
'action_name': None, 'parameters': None}
|
|
|
|
RUNNABLE_OBJECTS_RESULT = [200, '', '', {'names': ['runnable']}]
|
|
AVAILABLE_ACTIONS_RESULT = [200, '', '', {'names': ['a', 'b']}]
|
|
ACTIONS_PARAMS_RESULT = [200, '', '', {'parameters': [{'name': 'pin', 'type': 'in', 'direction': 'in'},
|
|
{'name': 'pout', 'type': 'out', 'direction': 'out'},
|
|
{'name': 'alteon', 'type': 'alteon'}]}]
|
|
|
|
RUN_RESULT = [200, '', '', {
|
|
"uri": "https://10.11.12.13:2189/api/status?token=Workflow%5Ca%5Capply%5Cc4b533a8-8764-4cbf-a19c-63b11b9ccc09",
|
|
"targetUri": "https://10.11.12.13:2189/api/workflow/a",
|
|
"complete": True, "status": 200, "success": True, "messages": [], "action": "apply", "parameters": {},
|
|
}]
|
|
|
|
MODULE_RESULT = {"msg": "Configuration template run completed.", "parameters": {}}
|
|
|
|
|
|
@patch('vdirect_client.rest_client.RestClient')
|
|
class RestClient:
|
|
def __init__(self, vdirect_ip=None, vdirect_user=None, vdirect_password=None, wait=None,
|
|
secondary_vdirect_ip=None, https_port=None, http_port=None,
|
|
timeout=None, https=None, strict_http_results=None,
|
|
verify=None):
|
|
pass
|
|
|
|
|
|
@patch('vdirect_client.rest_client.Runnable')
|
|
class Runnable:
|
|
available_actions_result = None
|
|
action_info_result = None
|
|
runnable_objects_result = None
|
|
run_result = None
|
|
|
|
def __init__(self, client):
|
|
self.client = client
|
|
|
|
@classmethod
|
|
def set_action_info_result(cls, result):
|
|
Runnable.action_info_result = result
|
|
|
|
@classmethod
|
|
def set_available_actions_result(cls, result):
|
|
Runnable.available_actions_result = result
|
|
|
|
@classmethod
|
|
def set_run_result(cls, result):
|
|
Runnable.run_result = result
|
|
|
|
@classmethod
|
|
def set_runnable_objects_result(cls, result):
|
|
Runnable.runnable_objects_result = result
|
|
|
|
def get_available_actions(self, type=None, name=None):
|
|
return Runnable.available_actions_result
|
|
|
|
def get_action_info(self, type, name, action_name):
|
|
return Runnable.action_info_result
|
|
|
|
def run(self, data, type, name, action_name):
|
|
return Runnable.run_result
|
|
|
|
def get_runnable_objects(self, type):
|
|
return Runnable.runnable_objects_result
|
|
|
|
|
|
class TestManager(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
self.module_mock = MagicMock()
|
|
self.module_mock.rest_client.RESP_STATUS = 0
|
|
self.module_mock.rest_client.RESP_REASON = 1
|
|
self.module_mock.rest_client.RESP_STR = 2
|
|
self.module_mock.rest_client.RESP_DATA = 3
|
|
|
|
def test_missing_parameter(self, *args):
|
|
with patch.dict('sys.modules', **{
|
|
'vdirect_client': self.module_mock,
|
|
'vdirect_client.rest_client': self.module_mock,
|
|
}):
|
|
from ansible.modules.network.radware import vdirect_runnable
|
|
|
|
try:
|
|
params = BASE_PARAMS.copy()
|
|
vdirect_runnable.VdirectRunnable(params)
|
|
self.fail("KeyError was not thrown for missing parameter")
|
|
except KeyError:
|
|
assert True
|
|
|
|
def test_validate_runnable_exists(self, *args):
|
|
with patch.dict('sys.modules', **{
|
|
'vdirect_client': self.module_mock,
|
|
'vdirect_client.rest_client': self.module_mock,
|
|
}):
|
|
from ansible.modules.network.radware import vdirect_runnable
|
|
|
|
Runnable.set_runnable_objects_result(RUNNABLE_OBJECTS_RESULT)
|
|
BASE_PARAMS.update(RUNNABLE_PARAMS)
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable.client.runnable = Runnable(vdirectRunnable.client)
|
|
vdirectRunnable._validate_runnable_exists()
|
|
assert True
|
|
|
|
BASE_PARAMS.update(RUNNABLE_PARAMS)
|
|
BASE_PARAMS['runnable_name'] = "missing"
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable.client.runnable = Runnable(vdirectRunnable.client)
|
|
try:
|
|
vdirectRunnable._validate_runnable_exists()
|
|
self.fail("MissingRunnableException was not thrown for missing runnable name")
|
|
except vdirect_runnable.MissingRunnableException:
|
|
assert True
|
|
|
|
def test_validate_action_name(self, *args):
|
|
with patch.dict('sys.modules', **{
|
|
'vdirect_client': self.module_mock,
|
|
'vdirect_client.rest_client': self.module_mock,
|
|
}):
|
|
from ansible.modules.network.radware import vdirect_runnable
|
|
|
|
Runnable.set_runnable_objects_result(RUNNABLE_OBJECTS_RESULT)
|
|
BASE_PARAMS.update(RUNNABLE_PARAMS)
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable._validate_action_name()
|
|
assert vdirectRunnable.action_name == vdirect_runnable.VdirectRunnable.RUN_ACTION
|
|
|
|
BASE_PARAMS['runnable_type'] = vdirect_runnable.WORKFLOW_TEMPLATE_RUNNABLE_TYPE
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable._validate_action_name()
|
|
assert vdirectRunnable.action_name == vdirect_runnable.VdirectRunnable.CREATE_WORKFLOW_ACTION
|
|
|
|
BASE_PARAMS['runnable_type'] = vdirect_runnable.WORKFLOW_RUNNABLE_TYPE
|
|
BASE_PARAMS['action_name'] = 'a'
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable.client.runnable = Runnable(vdirectRunnable.client)
|
|
Runnable.set_available_actions_result(AVAILABLE_ACTIONS_RESULT)
|
|
vdirectRunnable._validate_action_name()
|
|
assert vdirectRunnable.action_name == 'a'
|
|
|
|
BASE_PARAMS['action_name'] = 'c'
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable.client.runnable = Runnable(vdirectRunnable.client)
|
|
Runnable.set_available_actions_result(AVAILABLE_ACTIONS_RESULT)
|
|
try:
|
|
vdirectRunnable._validate_action_name()
|
|
self.fail("WrongActionNameException was not thrown for wrong action name")
|
|
except vdirect_runnable.WrongActionNameException:
|
|
assert True
|
|
|
|
def test_validate_required_action_params(self, *args):
|
|
with patch.dict('sys.modules', **{
|
|
'vdirect_client': self.module_mock,
|
|
'vdirect_client.rest_client': self.module_mock,
|
|
}):
|
|
from ansible.modules.network.radware import vdirect_runnable
|
|
|
|
Runnable.set_runnable_objects_result(RUNNABLE_OBJECTS_RESULT)
|
|
BASE_PARAMS.update(RUNNABLE_PARAMS)
|
|
BASE_PARAMS['runnable_type'] = vdirect_runnable.WORKFLOW_RUNNABLE_TYPE
|
|
BASE_PARAMS['action_name'] = 'a'
|
|
BASE_PARAMS['parameters'] = {"alteon": "x"}
|
|
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable.client.runnable = Runnable(vdirectRunnable.client)
|
|
Runnable.set_available_actions_result(AVAILABLE_ACTIONS_RESULT)
|
|
Runnable.set_action_info_result(ACTIONS_PARAMS_RESULT)
|
|
|
|
vdirectRunnable._validate_action_name()
|
|
try:
|
|
vdirectRunnable._validate_required_action_params()
|
|
self.fail("MissingActionParametersException was not thrown for missing parameters")
|
|
except vdirect_runnable.MissingActionParametersException:
|
|
assert True
|
|
|
|
BASE_PARAMS['parameters'] = {"alteon": "x"}
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable._validate_action_name()
|
|
try:
|
|
vdirectRunnable._validate_required_action_params()
|
|
self.fail("MissingActionParametersException was not thrown for missing parameters")
|
|
except vdirect_runnable.MissingActionParametersException:
|
|
assert True
|
|
|
|
BASE_PARAMS['parameters'] = {"pin": "x", "alteon": "x"}
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable._validate_action_name()
|
|
vdirectRunnable._validate_required_action_params()
|
|
assert True
|
|
|
|
def test_run(self, *args):
|
|
with patch.dict('sys.modules', **{
|
|
'vdirect_client': self.module_mock,
|
|
'vdirect_client.rest_client': self.module_mock,
|
|
}):
|
|
from ansible.modules.network.radware import vdirect_runnable
|
|
|
|
Runnable.set_runnable_objects_result(RUNNABLE_OBJECTS_RESULT)
|
|
|
|
BASE_PARAMS.update(RUNNABLE_PARAMS)
|
|
|
|
BASE_PARAMS['runnable_type'] = vdirect_runnable.CONFIGURATION_TEMPLATE_RUNNABLE_TYPE
|
|
BASE_PARAMS['parameters'] = {"pin": "x", "alteon": "x"}
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable.client.runnable = Runnable(vdirectRunnable.client)
|
|
Runnable.set_available_actions_result(AVAILABLE_ACTIONS_RESULT)
|
|
Runnable.set_action_info_result(ACTIONS_PARAMS_RESULT)
|
|
Runnable.set_run_result(RUN_RESULT)
|
|
res = vdirectRunnable.run()
|
|
assert res == MODULE_RESULT
|
|
|
|
BASE_PARAMS['runnable_type'] = vdirect_runnable.WORKFLOW_TEMPLATE_RUNNABLE_TYPE
|
|
MODULE_RESULT['msg'] = "Workflow created."
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable.client.runnable = Runnable(vdirectRunnable.client)
|
|
res = vdirectRunnable.run()
|
|
assert res == MODULE_RESULT
|
|
|
|
BASE_PARAMS['runnable_type'] = vdirect_runnable.WORKFLOW_RUNNABLE_TYPE
|
|
BASE_PARAMS['action_name'] = 'a'
|
|
MODULE_RESULT['msg'] = "Workflow action run completed."
|
|
vdirectRunnable = vdirect_runnable.VdirectRunnable(BASE_PARAMS)
|
|
vdirectRunnable.client.runnable = Runnable(vdirectRunnable.client)
|
|
Runnable.set_available_actions_result(AVAILABLE_ACTIONS_RESULT)
|
|
Runnable.set_action_info_result(ACTIONS_PARAMS_RESULT)
|
|
res = vdirectRunnable.run()
|
|
assert res == MODULE_RESULT
|
|
|
|
result_parameters = {"param1": "value1", "param2": "value2"}
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_DATA]['parameters'] = result_parameters
|
|
MODULE_RESULT['parameters'] = result_parameters
|
|
res = vdirectRunnable.run()
|
|
assert res == MODULE_RESULT
|
|
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_DATA]['status'] = 404
|
|
vdirectRunnable.run()
|
|
assert res == MODULE_RESULT
|
|
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_STATUS] = 400
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_REASON] = "Reason"
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_STR] = "Details"
|
|
try:
|
|
vdirectRunnable.run()
|
|
self.fail("RunnableException was not thrown for failed run.")
|
|
except vdirect_runnable.RunnableException as e:
|
|
assert str(e) == "Reason: Reason. Details:Details."
|
|
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_STATUS] = 200
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_DATA]["status"] = 400
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_DATA]["success"] = False
|
|
RUN_RESULT[self.module_mock.rest_client.RESP_DATA]["exception"] = {"message": "exception message"}
|
|
try:
|
|
vdirectRunnable.run()
|
|
self.fail("RunnableException was not thrown for failed run.")
|
|
except vdirect_runnable.RunnableException as e:
|
|
assert str(e) == "Reason: exception message. Details:Details."
|