mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-06-11 10:35:34 +00:00
d4031f36e4
* Add kopia module util * fix pipeline suggestions * add kopia repository module * apply code review changes * remove kopia_runner instance unit test * update botmeta with kopia * refactor docs and redundant state * add kopia_info module and fix kopia_repository check mode support - Add kopia_info module for read-only repository information gathering (kopia repository status, kopia repository throttle get) following the pacemaker_info pattern with ModuleHelper and info_module fragment - Add _fmt_throttle to _kopia.py and register throttle format in kopia_runner; remove throttle_operation get option from kopia_repository per Ansible best practices (info ops belong in _info modules) - Add throttle suboption dict to kopia_repository with all seven kopia repository throttle set flags - Fix check_mode: support from full to actually full by implementing _predict_value() in kopia_repository; previously check_mode_skip caused changed to always be false in check mode - Add check mode test cases to test_kopia_repository.yaml covering created and disconnected states for both connected and disconnected initial conditions - Add BOTMETA.yml entry and full test fixture for kopia_info * apply code review suggestions
109 lines
3 KiB
Python
109 lines
3 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2026, Dexter Le <dextersydney2001@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 annotations
|
|
|
|
DOCUMENTATION = r"""
|
|
module: kopia_repository_info
|
|
short_description: Gather information about a Kopia repository
|
|
author:
|
|
- Dexter Le (@munchtoast)
|
|
version_added: "13.1.0"
|
|
description:
|
|
- Gather read-only information about the current Kopia repository connection and throttle settings.
|
|
- Runs C(kopia repository status) and C(kopia repository throttle get).
|
|
extends_documentation_fragment:
|
|
- community.general._attributes
|
|
- community.general._attributes.info_module
|
|
- community.general._kopia
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: Gather Kopia repository info
|
|
community.general.kopia_repository_info:
|
|
config: /etc/kopia/root.config
|
|
register: result
|
|
|
|
- name: Show repository status
|
|
ansible.builtin.debug:
|
|
msg: "{{ result.repository_status }}"
|
|
|
|
- name: Show throttle settings
|
|
ansible.builtin.debug:
|
|
msg: "{{ result.throttle }}"
|
|
"""
|
|
|
|
RETURN = r"""
|
|
repository_status:
|
|
description: Output of C(kopia repository status).
|
|
type: str
|
|
returned: always
|
|
sample: |-
|
|
Connected to repository: s3:/my-bucket/
|
|
Config file: /etc/kopia/root.config
|
|
...
|
|
throttle:
|
|
description: Output of C(kopia repository throttle get) showing current throttle limits.
|
|
type: str
|
|
returned: always
|
|
sample: |-
|
|
upload-bytes-per-second: 0
|
|
download-bytes-per-second: 0
|
|
"""
|
|
|
|
from ansible_collections.community.general.plugins.module_utils._kopia import (
|
|
KOPIA_COMMON_ARGUMENT_SPEC,
|
|
kopia_runner,
|
|
)
|
|
from ansible_collections.community.general.plugins.module_utils._module_helper import ModuleHelper
|
|
|
|
|
|
class KopiaRepositoryInfo(ModuleHelper):
|
|
module = dict(
|
|
argument_spec=dict(**KOPIA_COMMON_ARGUMENT_SPEC),
|
|
supports_check_mode=True,
|
|
)
|
|
output_params = ["repository_status", "throttle"]
|
|
|
|
def __init_module__(self):
|
|
self.runner = kopia_runner(self.module)
|
|
|
|
def _process_command_output(self, cli_action=""):
|
|
def process(rc, out, err):
|
|
if rc != 0:
|
|
self.do_raise(f"kopia {cli_action} failed with error (rc={rc}): {err}")
|
|
return out.rstrip() if out else None
|
|
|
|
return process
|
|
|
|
def __run__(self):
|
|
with self.runner(
|
|
"status config",
|
|
output_process=self._process_command_output("repository status"),
|
|
) as ctx:
|
|
self.vars.set(
|
|
"repository_status",
|
|
ctx.run(),
|
|
output=True,
|
|
)
|
|
|
|
with self.runner(
|
|
"get_throttle config",
|
|
output_process=self._process_command_output("repository throttle get"),
|
|
) as ctx:
|
|
self.vars.set(
|
|
"throttle",
|
|
ctx.run(),
|
|
output=True,
|
|
)
|
|
|
|
|
|
def main():
|
|
KopiaRepositoryInfo.execute()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|