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

add helper factory function to avoid breaking network modules in devel

This is a temporary change to keep the get_module() function until all
of the network module refactoring is completed to avoid breaking them
in devel.   The get_module() function should not be used and will be
removed before 2.2 final.
This commit is contained in:
Peter Sprygada 2016-07-09 07:03:18 -04:00
commit c0c9cf6441
2 changed files with 55 additions and 48 deletions

View file

@ -19,12 +19,15 @@
import re import re
from ansible.module_utils.basic import json, get_exception, AnsibleModule from ansible.module_utils.basic import json, AnsibleModule, get_exception
from ansible.module_utils.network import Command, NetCli, NetworkError, get_module from ansible.module_utils.network import NetCli, NetworkError, NetworkModule, Command
from ansible.module_utils.network import add_argument, register_transport, to_list from ansible.module_utils.network import add_argument, register_transport, to_list
from ansible.module_utils.netcfg import NetworkConfig from ansible.module_utils.netcfg import NetworkConfig
from ansible.module_utils.urls import fetch_url, url_argument_spec from ansible.module_utils.urls import fetch_url, url_argument_spec
# temporary fix until modules are update. to be removed before 2.2 final
from ansible.module_utils.network import get_module
EAPI_FORMATS = ['json', 'text'] EAPI_FORMATS = ['json', 'text']
add_argument('use_ssl', dict(default=True, type='bool')) add_argument('use_ssl', dict(default=True, type='bool'))

View file

@ -48,24 +48,6 @@ def to_list(val):
else: else:
return list() return list()
def connect(module):
try:
if not module.connected:
module.connection.connect(module.params)
if module.params['authorize']:
module.connection.authorize(module.params)
except NetworkError:
exc = get_exception()
module.fail_json(msg=exc.message)
def disconnect(module):
try:
if module.connected:
module.connection.disconnect()
except NetworkError:
exc = get_exception()
module.fail_json(msg=exc.message)
class Command(object): class Command(object):
@ -157,15 +139,39 @@ class NetworkError(Exception):
class NetworkModule(AnsibleModule): class NetworkModule(AnsibleModule):
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
connect_on_load = kwargs.pop('connect_on_load', True)
argument_spec = NET_TRANSPORT_ARGS.copy()
argument_spec['transport']['choices'] = NET_CONNECTIONS.keys()
argument_spec.update(NET_CONNECTION_ARGS.copy())
if kwargs.get('argument_spec'):
argument_spec.update(kwargs['argument_spec'])
kwargs['argument_spec'] = argument_spec
super(NetworkModule, self).__init__(*args, **kwargs) super(NetworkModule, self).__init__(*args, **kwargs)
self.connection = None self.connection = None
self._cli = None self._cli = None
self._config = None self._config = None
try:
transport = self.params['transport'] or '__default__'
cls = NET_CONNECTIONS[transport]
self.connection = cls()
except KeyError:
self.fail_json(msg='Unknown transport or no default transport specified')
except (TypeError, NetworkError):
exc = get_exception()
self.fail_json(msg=exc.message)
if connect_on_load:
self.connect()
@property @property
def cli(self): def cli(self):
if not self.connected: if not self.connected:
connect(self) self.connect()
if self._cli: if self._cli:
return self._cli return self._cli
self._cli = Cli(self.connection) self._cli = Cli(self.connection)
@ -174,7 +180,7 @@ class NetworkModule(AnsibleModule):
@property @property
def config(self): def config(self):
if not self.connected: if not self.connected:
connect(self) self.connect()
if self._config: if self._config:
return self._config return self._config
self._config = Config(self.connection) self._config = Config(self.connection)
@ -193,6 +199,24 @@ class NetworkModule(AnsibleModule):
if self.params.get(key) is None and value is not None: if self.params.get(key) is None and value is not None:
self.params[key] = value self.params[key] = value
def connect(self):
try:
if not self.connected:
self.connection.connect(self.params)
if self.params['authorize']:
self.connection.authorize(self.params)
except NetworkError:
exc = get_exception()
self.fail_json(msg=exc.message)
def disconnect(self):
try:
if self.connected:
self.connection.disconnect()
except NetworkError:
exc = get_exception()
self.fail_json(msg=exc.message)
class NetCli(object): class NetCli(object):
"""Basic paramiko-based ssh transport any NetworkModule can use.""" """Basic paramiko-based ssh transport any NetworkModule can use."""
@ -249,32 +273,6 @@ class NetCli(object):
raise NetworkError(exc.message, commands=commands) raise NetworkError(exc.message, commands=commands)
def get_module(connect_on_load=True, **kwargs):
argument_spec = NET_TRANSPORT_ARGS.copy()
argument_spec['transport']['choices'] = NET_CONNECTIONS.keys()
argument_spec.update(NET_CONNECTION_ARGS.copy())
if kwargs.get('argument_spec'):
argument_spec.update(kwargs['argument_spec'])
kwargs['argument_spec'] = argument_spec
module = NetworkModule(**kwargs)
try:
transport = module.params['transport'] or '__default__'
cls = NET_CONNECTIONS[transport]
module.connection = cls()
except KeyError:
module.fail_json(msg='Unknown transport or no default transport specified')
except (TypeError, NetworkError):
exc = get_exception()
module.fail_json(msg=exc.message)
if connect_on_load:
connect(module)
return module
def register_transport(transport, default=False): def register_transport(transport, default=False):
def register(cls): def register(cls):
NET_CONNECTIONS[transport] = cls NET_CONNECTIONS[transport] = cls
@ -286,3 +284,9 @@ def register_transport(transport, default=False):
def add_argument(key, value): def add_argument(key, value):
NET_CONNECTION_ARGS[key] = value NET_CONNECTION_ARGS[key] = value
def get_module(*args, **kwargs):
# This is a temporary factory function to avoid break all modules
# until the modules are updated. This function *will* be removed
# before 2.2 final
return NetworkModule(*args, **kwargs)