mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-25 21:44:00 -07:00
123c7efe5e* Move licenses to LICENSES/, run add-license.py, add LICENSES/MIT.txt. * Replace 'Copyright:' with 'Copyright' sed -i 's|Copyright:\(.*\)|Copyright\1|' $(rg -l 'Copyright:') Co-authored-by: Maxwell G <gotmax@e.email>
89 lines
2.4 KiB
Python
89 lines
2.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
# (c) 2020, Alexei Znamensky <russoz@gmail.com>
|
|
# Copyright (c) 2020, Ansible Project
|
|
# Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
|
|
# SPDX-License-Identifier: BSD-2-Clause
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.community.general.plugins.module_utils.mh.exceptions import ModuleHelperException as _MHE
|
|
from ansible_collections.community.general.plugins.module_utils.mh.deco import module_fails_on_exception
|
|
|
|
|
|
class ModuleHelperBase(object):
|
|
module = None
|
|
ModuleHelperException = _MHE
|
|
_delegated_to_module = (
|
|
'check_mode', 'get_bin_path', 'warn', 'deprecate',
|
|
)
|
|
|
|
def __init__(self, module=None):
|
|
self._changed = False
|
|
|
|
if module:
|
|
self.module = module
|
|
|
|
if not isinstance(self.module, AnsibleModule):
|
|
self.module = AnsibleModule(**self.module)
|
|
|
|
@property
|
|
def diff_mode(self):
|
|
return self.module._diff
|
|
|
|
@property
|
|
def verbosity(self):
|
|
return self.module._verbosity
|
|
|
|
def do_raise(self, *args, **kwargs):
|
|
raise _MHE(*args, **kwargs)
|
|
|
|
def __getattr__(self, attr):
|
|
if attr in self._delegated_to_module:
|
|
return getattr(self.module, attr)
|
|
raise AttributeError("ModuleHelperBase has no attribute '%s'" % (attr, ))
|
|
|
|
def __init_module__(self):
|
|
pass
|
|
|
|
def __run__(self):
|
|
raise NotImplementedError()
|
|
|
|
def __quit_module__(self):
|
|
pass
|
|
|
|
def __changed__(self):
|
|
raise NotImplementedError()
|
|
|
|
@property
|
|
def changed(self):
|
|
try:
|
|
return self.__changed__()
|
|
except NotImplementedError:
|
|
return self._changed
|
|
|
|
@changed.setter
|
|
def changed(self, value):
|
|
self._changed = value
|
|
|
|
def has_changed(self):
|
|
raise NotImplementedError()
|
|
|
|
@property
|
|
def output(self):
|
|
raise NotImplementedError()
|
|
|
|
@module_fails_on_exception
|
|
def run(self):
|
|
self.__init_module__()
|
|
self.__run__()
|
|
self.__quit_module__()
|
|
output = self.output
|
|
if 'failed' not in output:
|
|
output['failed'] = False
|
|
self.module.exit_json(changed=self.has_changed(), **output)
|
|
|
|
@classmethod
|
|
def execute(cls, module=None):
|
|
cls(module).run()
|