ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-24 04:39:15 +00:00
Code Activity

Make all doc fragments, module utils, and plugin utils private (#11896)

Browse source 
* Make all doc fragments private.

* Make all plugin utils private.

* Make all module utils private.

* Reformat.

* Changelog fragment.

* Update configs and ignores.

* Adjust unit test names.
This commit is contained in:
Felix Fontein 2026-04-20 20:16:26 +02:00 • committed by GitHub
parent 9ef1dbb6d5
commit 4fa82b9617
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
807 changed files with 2041 additions and 1702 deletions
Download patch file Download diff file Expand all files Collapse all files

99
plugins/module_utils/influxdb.py
View file

@ -1,99 +0,0 @@
# Copyright (c) 2017, 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 annotations
import traceback
import typing as t
from ansible.module_utils.basic import missing_required_lib
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
if t.TYPE_CHECKING:
from ansible.module_utils.basic import AnsibleModule
REQUESTS_IMP_ERR = None
try:
import requests.exceptions # noqa: F401, pylint: disable=unused-import
HAS_REQUESTS = True
except ImportError:
REQUESTS_IMP_ERR = traceback.format_exc()
HAS_REQUESTS = False
INFLUXDB_IMP_ERR = None
try:
from influxdb import ( # pylint: disable=unused-import
InfluxDBClient,
exceptions, # noqa: F401
)
from influxdb import __version__ as influxdb_version
HAS_INFLUXDB = True
except ImportError:
INFLUXDB_IMP_ERR = traceback.format_exc()
HAS_INFLUXDB = False
class InfluxDb:
def __init__(self, module: AnsibleModule) -> None:
self.module = module
self.params = self.module.params
self.check_lib()
self.hostname = self.params["hostname"]
self.port = self.params["port"]
self.path = self.params["path"]
self.username = self.params["username"]
self.password = self.params["password"]
self.database_name = self.params.get("database_name")
def check_lib(self) -> None:
if not HAS_REQUESTS:
self.module.fail_json(msg=missing_required_lib("requests"), exception=REQUESTS_IMP_ERR)
if not HAS_INFLUXDB:
self.module.fail_json(msg=missing_required_lib("influxdb"), exception=INFLUXDB_IMP_ERR)
@staticmethod
def influxdb_argument_spec() -> dict[str, t.Any]:
return dict(
hostname=dict(type="str", default="localhost"),
port=dict(type="int", default=8086),
path=dict(type="str", default=""),
username=dict(type="str", default="root", aliases=["login_username"]),
password=dict(type="str", default="root", no_log=True, aliases=["login_password"]),
ssl=dict(type="bool", default=False),
validate_certs=dict(type="bool", default=True),
timeout=dict(type="int"),
retries=dict(type="int", default=3),
proxies=dict(type="dict", default={}),
use_udp=dict(type="bool", default=False),
udp_port=dict(type="int", default=4444),
)
def connect_to_influxdb(self) -> InfluxDBClient:
args = dict(
host=self.hostname,
port=self.port,
username=self.username,
password=self.password,
database=self.database_name,
ssl=self.params["ssl"],
verify_ssl=self.params["validate_certs"],
timeout=self.params["timeout"],
use_udp=self.params["use_udp"],
udp_port=self.params["udp_port"],
proxies=self.params["proxies"],
)
influxdb_api_version = LooseVersion(influxdb_version)
if influxdb_api_version >= LooseVersion("4.1.0"):
# retries option is added in version 4.1.0
args.update(retries=self.params["retries"])
if influxdb_api_version >= LooseVersion("5.1.0"):
# path argument is added in version 5.1.0
args.update(path=self.path)
return InfluxDBClient(**args)