From bebe162a226cce4f43e8e5cb4714e793a401af4d Mon Sep 17 00:00:00 2001 From: Kevin Wise <41447823+Klistel@users.noreply.github.com> Date: Sun, 19 May 2024 23:17:08 -0700 Subject: [PATCH] Add toggle for verbose logging to pkg5.py (#8382) * Add toggle for verbose logging Updated params with 'verbose' mode (defaults to False, which is existing behavior) to allow users to toggle verbose to True, which disables the '-q' flag that was hardcoded in the original module * Create 8379-verbose-mode-pkg5.yml * update pkg5.py to conform to PEP8 length requirements The new verbosity argument on line 172 broke the 160 character length PEP8 requirement - split the line in two to conform to PEP8 * Add PR link to changelog fragement yml Co-authored-by: Felix Fontein * Add version_added and make the description of the verbose param clearer * Update pkg5.py verbose description to conform to ansible documentation for semantic markup Co-authored-by: Felix Fontein --------- Co-authored-by: Felix Fontein --- changelogs/fragments/8379-verbose-mode-pkg5.yml | 2 ++ plugins/modules/pkg5.py | 15 ++++++++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 changelogs/fragments/8379-verbose-mode-pkg5.yml diff --git a/changelogs/fragments/8379-verbose-mode-pkg5.yml b/changelogs/fragments/8379-verbose-mode-pkg5.yml new file mode 100644 index 0000000000..abc1c61dce --- /dev/null +++ b/changelogs/fragments/8379-verbose-mode-pkg5.yml @@ -0,0 +1,2 @@ +minor_changes: + - pkg5 - add support for non-silent execution (https://github.com/ansible-collections/community.general/issues/8379, https://github.com/ansible-collections/community.general/pull/8382). diff --git a/plugins/modules/pkg5.py b/plugins/modules/pkg5.py index c4aace9f28..08fa9272f7 100644 --- a/plugins/modules/pkg5.py +++ b/plugins/modules/pkg5.py @@ -54,6 +54,12 @@ options: - Refresh publishers before execution. type: bool default: true + verbose: + description: + - Set to V(true) to disable quiet execution. + type: bool + default: false + version_added: 9.0.0 ''' EXAMPLES = ''' - name: Install Vim @@ -90,6 +96,7 @@ def main(): accept_licenses=dict(type='bool', default=False, aliases=['accept', 'accept_licences']), be_name=dict(type='str'), refresh=dict(type='bool', default=True), + verbose=dict(type='bool', default=False), ), supports_check_mode=True, ) @@ -156,9 +163,15 @@ def ensure(module, state, packages, params): else: no_refresh = ['--no-refresh'] + if params['verbose']: + verbosity = [] + else: + verbosity = ['-q'] + to_modify = list(filter(behaviour[state]['filter'], packages)) if to_modify: - rc, out, err = module.run_command(['pkg', behaviour[state]['subcommand']] + dry_run + accept_licenses + beadm + no_refresh + ['-q', '--'] + to_modify) + rc, out, err = module.run_command( + ['pkg', behaviour[state]['subcommand']] + dry_run + accept_licenses + beadm + no_refresh + verbosity + ['--'] + to_modify) response['rc'] = rc response['results'].append(out) response['msg'] += err