mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-04 07:51:50 +00:00
377a599372
Add basic typing for module_utils (#11222) * Add basic typing for module_utils. * Apply some suggestions. * Make pass again. * Add more types as suggested. * Normalize extra imports. * Add more type hints. * Improve typing. * Add changelog fragment. * Reduce changelog. * Apply suggestions from code review. * Fix typo. * Cleanup. * Improve types and make type checking happy. * Let's see whether older Pythons barf on this. * Revert "Let's see whether older Pythons barf on this." This reverts commit9973af3dbe. * Add noqa. --------- (cherry picked from commitc7f6a28d89) Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
108 lines
2.9 KiB
Python
108 lines
2.9 KiB
Python
# Copyright (C) 2018 IBM CORPORATION
|
|
# Author(s): Tzur Eliyahu <tzure@il.ibm.com>
|
|
#
|
|
# 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 annotations
|
|
|
|
import traceback
|
|
import typing as t
|
|
|
|
from functools import wraps
|
|
from ansible.module_utils.basic import missing_required_lib
|
|
|
|
if t.TYPE_CHECKING:
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
PYXCLI_INSTALLED = True
|
|
PYXCLI_IMP_ERR = None
|
|
try:
|
|
from pyxcli import client, errors
|
|
except ImportError:
|
|
PYXCLI_IMP_ERR = traceback.format_exc()
|
|
PYXCLI_INSTALLED = False
|
|
|
|
AVAILABLE_PYXCLI_FIELDS = [
|
|
"pool",
|
|
"size",
|
|
"snapshot_size",
|
|
"domain",
|
|
"perf_class",
|
|
"vol",
|
|
"iscsi_chap_name",
|
|
"iscsi_chap_secret",
|
|
"cluster",
|
|
"host",
|
|
"lun",
|
|
"override",
|
|
"fcaddress",
|
|
"iscsi_name",
|
|
"max_dms",
|
|
"max_cgs",
|
|
"ldap_id",
|
|
"max_mirrors",
|
|
"max_pools",
|
|
"max_volumes",
|
|
"hard_capacity",
|
|
"soft_capacity",
|
|
]
|
|
|
|
|
|
def xcli_wrapper(func):
|
|
"""Catch xcli errors and return a proper message"""
|
|
|
|
@wraps(func)
|
|
def wrapper(module: AnsibleModule, *args, **kwargs):
|
|
try:
|
|
return func(module, *args, **kwargs)
|
|
except errors.CommandExecutionError as e:
|
|
module.fail_json(msg=f"{e}")
|
|
|
|
return wrapper
|
|
|
|
|
|
@xcli_wrapper
|
|
def connect_ssl(module: AnsibleModule):
|
|
endpoints = module.params["endpoints"]
|
|
username = module.params["username"]
|
|
password = module.params["password"]
|
|
if not (username and password and endpoints):
|
|
module.fail_json(msg="Username, password or endpoints arguments are missing from the module arguments")
|
|
|
|
try:
|
|
return client.XCLIClient.connect_multiendpoint_ssl(username, password, endpoints)
|
|
except errors.CommandFailedConnectionError as e:
|
|
module.fail_json(msg=f"Connection with Spectrum Accelerate system has failed: {e}.")
|
|
|
|
|
|
def spectrum_accelerate_spec() -> dict[str, t.Any]:
|
|
"""Return arguments spec for AnsibleModule"""
|
|
return dict(
|
|
endpoints=dict(required=True),
|
|
username=dict(required=True),
|
|
password=dict(no_log=True, required=True),
|
|
)
|
|
|
|
|
|
@xcli_wrapper
|
|
def execute_pyxcli_command(module: AnsibleModule, xcli_command, xcli_client):
|
|
pyxcli_args = build_pyxcli_command(module.params)
|
|
getattr(xcli_client.cmd, xcli_command)(**(pyxcli_args))
|
|
return True
|
|
|
|
|
|
def build_pyxcli_command(fields):
|
|
"""Builds the args for pyxcli using the exact args from ansible"""
|
|
pyxcli_args = {}
|
|
for field in fields:
|
|
if not fields[field]:
|
|
continue
|
|
if field in AVAILABLE_PYXCLI_FIELDS and fields[field] != "":
|
|
pyxcli_args[field] = fields[field]
|
|
return pyxcli_args
|
|
|
|
|
|
def is_pyxcli_installed(module: AnsibleModule) -> None:
|
|
if not PYXCLI_INSTALLED:
|
|
module.fail_json(msg=missing_required_lib("pyxcli"), exception=PYXCLI_IMP_ERR)
|