mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
eb154003cf
django_createcachetable: new module (#8412)
* django_createcachetabe: new module
* add --noinput arg to testcase
* add module to BOTMETA
* rename module class name
* fix examples documentation
* remove unused config
* adjust version_added
(cherry picked from commit 54df0c9b3a)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
116 lines
4.6 KiB
Python
116 lines
4.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2024, Alexei Znamensky <russoz@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
from ansible.module_utils.common.dict_transformations import dict_merge
|
|
from ansible_collections.community.general.plugins.module_utils.cmd_runner import cmd_runner_fmt
|
|
from ansible_collections.community.general.plugins.module_utils.python_runner import PythonRunner
|
|
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
|
|
|
|
|
|
django_std_args = dict(
|
|
# environmental options
|
|
venv=dict(type="path"),
|
|
# default options of django-admin
|
|
settings=dict(type="str", required=True),
|
|
pythonpath=dict(type="path"),
|
|
traceback=dict(type="bool"),
|
|
verbosity=dict(type="int", choices=[0, 1, 2, 3]),
|
|
skip_checks=dict(type="bool"),
|
|
)
|
|
|
|
_django_std_arg_fmts = dict(
|
|
command=cmd_runner_fmt.as_list(),
|
|
settings=cmd_runner_fmt.as_opt_eq_val("--settings"),
|
|
pythonpath=cmd_runner_fmt.as_opt_eq_val("--pythonpath"),
|
|
traceback=cmd_runner_fmt.as_bool("--traceback"),
|
|
verbosity=cmd_runner_fmt.as_opt_val("--verbosity"),
|
|
no_color=cmd_runner_fmt.as_fixed("--no-color"),
|
|
skip_checks=cmd_runner_fmt.as_bool("--skip-checks"),
|
|
)
|
|
|
|
_django_database_args = dict(
|
|
database=dict(type="str", default="default"),
|
|
)
|
|
|
|
_args_menu = dict(
|
|
std=(django_std_args, _django_std_arg_fmts),
|
|
database=(_django_database_args, {"database": cmd_runner_fmt.as_opt_eq_val("--database")}),
|
|
noinput=({}, {"noinput": cmd_runner_fmt.as_fixed("--noinput")}),
|
|
dry_run=({}, {"dry_run": cmd_runner_fmt.as_bool("--dry-run")}),
|
|
check=({}, {"check": cmd_runner_fmt.as_bool("--check")}),
|
|
)
|
|
|
|
|
|
class _DjangoRunner(PythonRunner):
|
|
def __init__(self, module, arg_formats=None, **kwargs):
|
|
arg_fmts = dict(arg_formats) if arg_formats else {}
|
|
arg_fmts.update(_django_std_arg_fmts)
|
|
|
|
super(_DjangoRunner, self).__init__(module, ["-m", "django"], arg_formats=arg_fmts, **kwargs)
|
|
|
|
def __call__(self, output_process=None, ignore_value_none=True, check_mode_skip=False, check_mode_return=None, **kwargs):
|
|
args_order = (
|
|
("command", "no_color", "settings", "pythonpath", "traceback", "verbosity", "skip_checks") + self._prepare_args_order(self.default_args_order)
|
|
)
|
|
return super(_DjangoRunner, self).__call__(args_order, output_process, ignore_value_none, check_mode_skip, check_mode_return, **kwargs)
|
|
|
|
|
|
class DjangoModuleHelper(ModuleHelper):
|
|
module = {}
|
|
use_old_vardict = False
|
|
django_admin_cmd = None
|
|
arg_formats = {}
|
|
django_admin_arg_order = ()
|
|
use_old_vardict = False
|
|
_django_args = []
|
|
_check_mode_arg = ""
|
|
|
|
def __init__(self):
|
|
self.module["argument_spec"], self.arg_formats = self._build_args(self.module.get("argument_spec", {}),
|
|
self.arg_formats,
|
|
*(["std"] + self._django_args))
|
|
super(DjangoModuleHelper, self).__init__(self.module)
|
|
if self.django_admin_cmd is not None:
|
|
self.vars.command = self.django_admin_cmd
|
|
|
|
@staticmethod
|
|
def _build_args(arg_spec, arg_format, *names):
|
|
res_arg_spec = {}
|
|
res_arg_fmts = {}
|
|
for name in names:
|
|
args, fmts = _args_menu[name]
|
|
res_arg_spec = dict_merge(res_arg_spec, args)
|
|
res_arg_fmts = dict_merge(res_arg_fmts, fmts)
|
|
res_arg_spec = dict_merge(res_arg_spec, arg_spec)
|
|
res_arg_fmts = dict_merge(res_arg_fmts, arg_format)
|
|
|
|
return res_arg_spec, res_arg_fmts
|
|
|
|
def __run__(self):
|
|
runner = _DjangoRunner(self.module,
|
|
default_args_order=self.django_admin_arg_order,
|
|
arg_formats=self.arg_formats,
|
|
venv=self.vars.venv,
|
|
check_rc=True)
|
|
with runner() as ctx:
|
|
run_params = self.vars.as_dict()
|
|
if self._check_mode_arg:
|
|
run_params.update({self._check_mode_arg: self.check_mode})
|
|
results = ctx.run(**run_params)
|
|
self.vars.stdout = ctx.results_out
|
|
self.vars.stderr = ctx.results_err
|
|
self.vars.cmd = ctx.cmd
|
|
if self.verbosity >= 3:
|
|
self.vars.run_info = ctx.run_info
|
|
|
|
return results
|
|
|
|
@classmethod
|
|
def execute(cls):
|
|
cls().run()
|