Merge pull request #574 from saito-hideki/stable-1_v1.6.1

Release 1.6.1 commit

SUMMARY
Release 1.6.1 commit

#149
#463

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

ansible.posix

ADDITIONAL INFORMATION
None

.github/BOTMETA.yml

@@ -40,6 +40,7 @@ files:
     labels: debug
   $plugins/patch.py:
     labels: patch
+  $plugins/skippy.py:
   $plugins/synchronize.py:
     labels: synchronize
   $plugins/timer.py:

CHANGELOG.rst

@@ -4,6 +4,23 @@ ansible.posix Release Notes
 
 .. contents:: Topics
 
+v1.6.1
+======
+
+Release Summary
+---------------
+
+This is the bugfix release of the stable version ``ansible.posix`` collection.
+This changelog contains all changes to the modules and plugins
+in this collection that have been added after the release of
+``ansible.posix`` 1.6.1.
+
+Bugfixes
+--------
+
+- acl - Fixed to set ACLs on paths mounted with NFS version 4 correctly (https://github.com/ansible-collections/ansible.posix/issues/240).
+- mount - Handle ``boot`` option on Linux, NetBSD and OpenBSD correctly (https://github.com/ansible-collections/ansible.posix/issues/364).
+- skippy - Revert removal of skippy plugin. It will be removed in version 2.0.0 (https://github.com/ansible-collections/ansible.posix/issues/573).
 
 v1.6.0
 ======

changelogs/changelog.yaml

@@ -405,3 +405,27 @@ releases:
     - dropping-ansible29.yml
     - test-reqs.yml
     release_date: '2024-09-11'
+  1.6.1:
+    changes:
+      bugfixes:
+      - acl - Fixed to set ACLs on paths mounted with NFS version 4 correctly (https://github.com/ansible-collections/ansible.posix/issues/240).
+      - mount - Handle ``boot`` option on Linux, NetBSD and OpenBSD correctly (https://github.com/ansible-collections/ansible.posix/issues/364).
+      - skippy - Revert removal of skippy plugin. It will be removed in version 2.0.0
+        (https://github.com/ansible-collections/ansible.posix/issues/573).
+      release_summary: 'This is the bugfix release of the stable version ``ansible.posix``
+        collection.
+
+        This changelog contains all changes to the modules and plugins
+
+        in this collection that have been added after the release of
+
+        ``ansible.posix`` 1.6.1.'
+    fragments:
+    - 1.6.1.yml
+    - 365-boot-linux.yml
+    - 566_bump_version_161.yml
+    - 567_remove_version_added.yml
+    - 570_nfs4_acl.yml
+    - 571_ci_bump_core_version.yml
+    - 572_revert_removal_of_skippy.yml
+    release_date: '2024-10-11'

changelogs/fragments/220_synchronize_add_quiet_option.yml

@@ -1,2 +0,0 @@
-minor_changes:
-- synchronize - add the ``quiet`` option to suppress non-error messages (https://github.com/ansible-collections/ansible.posix/issues/171).

changelogs/fragments/365-boot-linux.yml

@@ -1,3 +0,0 @@
----
-bugfixes:
-  - mount - Handle ``boot`` option on Linux, NetBSD and OpenBSD correctly (https://github.com/ansible-collections/ansible.posix/issues/364).

changelogs/fragments/387_callback_output_header.yml

@@ -1,3 +0,0 @@
----
-minor_changes:
-  - callback plugins - Add recap information to timer, profile_roles and profile_tasks callback outputs (https://github.com/ansible-collections/ansible.posix/pull/387).

changelogs/fragments/566_bump_version_161.yml

@@ -1,3 +0,0 @@
----
-trivial:
-  - Bump version to 1.6.1 for next release.

changelogs/fragments/567_remove_version_added.yml

@@ -1,3 +0,0 @@
----
-trivial:
-  - mount - remove wrong version_added section from ``opts_no_log``.

changelogs/fragments/568_update_authorized_key.yml

@@ -1,3 +0,0 @@
----
-minor_changes:
-  - authorized_keys - allow using absolute path to a file as a SSH key(s) source (https://github.com/ansible-collections/ansible.posix/pull/568)

changelogs/fragments/570_nfs4_acl.yml

@@ -1,3 +0,0 @@
----
-bugfixes:
-  - acl - Fixed to set ACLs on paths mounted with NFS version 4 correctly (https://github.com/ansible-collections/ansible.posix/issues/240).

changelogs/fragments/571_ci_bump_core_version.yml

@@ -1,3 +0,0 @@
----
-trivial:
-  - Bump ansible-core version to 2.19 of devel branch and add 2.18 to CI.

meta/runtime.yml

@@ -1,2 +1,8 @@
 ---
-requires_ansible: ">=2.15.0"
+requires_ansible: ">=2.14.0"
+plugin_routing:
+  callback:
+    skippy:
+      deprecation:
+        removal_date: "2024-12-05"
+        warning_text: See the plugin documentation for more details

plugins/callback/profile_roles.py

@@ -128,10 +128,7 @@ class CallbackModule(CallbackBase):
         self._display_tasktime()
 
     def playbook_on_stats(self, stats):
-        # Align summary report header with other callback plugin summary
-        self._display.banner("ROLES RECAP")
-
-        self._display.display(tasktime())
+        self._display_tasktime()
         self._display.display(filled("", fchar="="))
 
         timestamp(self)

plugins/callback/profile_tasks.py

@@ -193,10 +193,7 @@ class CallbackModule(CallbackBase):
         self._display_tasktime()
 
     def playbook_on_stats(self, stats):
-        # Align summary report header with other callback plugin summary
-        self._display.banner("TASKS RECAP")
-
-        self._display.display(tasktime())
+        self._display_tasktime()
         self._display.display(filled("", fchar="="))
 
         timestamp(self)

plugins/callback/skippy.py

@@ -0,0 +1,43 @@
+# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
+# (c) 2017 Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = '''
+    name: skippy
+    type: stdout
+    requirements:
+      - set as main display callback
+    short_description: Ansible screen output that ignores skipped status
+    deprecated:
+      why: The 'default' callback plugin now supports this functionality
+      removed_at_date: '2024-12-05'
+      alternative: "'default' callback plugin with 'display_skipped_hosts = no' option"
+    extends_documentation_fragment:
+      - default_callback
+    description:
+      - This callback does the same as the default except it does not output skipped host/task/item status
+'''
+
+from ansible.plugins.callback.default import CallbackModule as CallbackModule_default
+
+
+class CallbackModule(CallbackModule_default):
+
+    '''
+    This is the default callback interface, which simply prints messages
+    to stdout when new callback events are received.
+    '''
+
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'stdout'
+    CALLBACK_NAME = 'ansible.posix.skippy'
+
+    def v2_runner_on_skipped(self, result):
+        pass
+
+    def v2_runner_item_on_skipped(self, result):
+        pass

plugins/callback/timer.py

@@ -46,6 +46,4 @@ class CallbackModule(CallbackBase):
     def v2_playbook_on_stats(self, stats):
         end_time = datetime.utcnow()
         runtime = end_time - self.start_time
-        # Align summary report header with other callback plugin summary
-        self._display.banner("PLAYBOOK RECAP")
-        self._display.display("Playbook run took %s days, %s hours, %s minutes, %s seconds\n\r" % (self.days_hours_minutes_seconds(runtime)))
+        self._display.display("Playbook run took %s days, %s hours, %s minutes, %s seconds" % (self.days_hours_minutes_seconds(runtime)))

plugins/modules/authorized_key.py

@@ -24,7 +24,6 @@ options:
   key:
     description:
       - The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys).
-      - You can also use V(file://) prefix to search remote for a file with SSH key(s).
     type: str
     required: true
   path:
@@ -97,12 +96,6 @@ EXAMPLES = r'''
     state: present
     key: https://github.com/charlie.keys
 
-- name: Set authorized keys taken from path on controller node
-  ansible.posix.authorized_key:
-    user: charlie
-    state: present
-    key: file:///home/charlie/.ssh/id_rsa.pub
-
 - name: Set authorized keys taken from url using lookup
   ansible.posix.authorized_key:
     user: charlie
@@ -230,7 +223,6 @@ from operator import itemgetter
 from ansible.module_utils._text import to_native
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.urls import fetch_url
-from ansible.module_utils.six.moves.urllib.parse import urlparse
 
 
 class keydict(dict):
@@ -564,7 +556,7 @@ def enforce_state(module, params):
     follow = params.get('follow', False)
     error_msg = "Error getting key from: %s"
 
-    # if the key is a url or file, request it and use it as key source
+    # if the key is a url, request it and use it as key source
     if key.startswith("http"):
         try:
             resp, info = fetch_url(module, key)
@@ -578,19 +570,6 @@ def enforce_state(module, params):
         # resp.read gives bytes on python3, convert to native string type
         key = to_native(key, errors='surrogate_or_strict')
 
-    if key.startswith("file"):
-        # if the key is an absolute path, check for existense and use it as a key source
-        key_path = urlparse(key).path
-        if not os.path.exists(key_path):
-            module.fail_json(msg="Path to a key file not found: %s" % key_path)
-        if not os.path.isfile(key_path):
-            module.fail_json(msg="Path to a key is a directory and must be a file: %s" % key_path)
-        try:
-            with open(key_path, 'r') as source_fh:
-                key = source_fh.read()
-        except OSError as e:
-            module.fail_json(msg="Failed to read key file %s : %s" % (key_path, to_native(e)))
-
     # extract individual keys into an array, skipping blank lines and comments
     new_keys = [s for s in key.splitlines() if s and not s.startswith('#')]
 

plugins/modules/synchronize.py

@@ -8,6 +8,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
+
 DOCUMENTATION = r'''
 ---
 module: synchronize
@@ -203,12 +204,6 @@ options:
     description: Internal use only. See O(use_ssh_args) for ssh arg settings.
     type: str
     required: false
-  quiet:
-    description:
-      - This option specifies quiet option which on true suppresses the output.
-    type: bool
-    default: false
-    version_added: 1.6.0
 
 notes:
    - C(rsync) must be installed on both the local and remote host.
@@ -366,12 +361,6 @@ EXAMPLES = r'''
         src: /tmp/localpath/
         dest: /tmp/remotepath
         rsync_path: /usr/gnu/bin/rsync
-
-- name: Synchronization with quiet option enabled
-  ansible.posix.synchronize:
-    src: some/relative/path
-    dest: /some/absolute/path
-    quiet: true
 '''
 
 
@@ -449,7 +438,6 @@ def main():
             delay_updates=dict(type='bool', default=True),
             mode=dict(type='str', default='push', choices=['pull', 'push']),
             link_dest=dict(type='list', elements='path'),
-            quiet=dict(type='bool', default=False)
         ),
         supports_check_mode=True,
     )
@@ -490,7 +478,6 @@ def main():
     verify_host = module.params['verify_host']
     link_dest = module.params['link_dest']
     delay_updates = module.params['delay_updates']
-    quiet = module.params['quiet']
 
     if '/' not in rsync:
         rsync = module.get_bin_path(rsync, required=True)
@@ -615,9 +602,6 @@ def main():
 
     cmd.append(shlex_quote(source))
     cmd.append(shlex_quote(dest))
-    if quiet:
-        cmd.append('--quiet')
-
     cmdstr = ' '.join(cmd)
 
     # If we are using password authentication, write the password into the pipe
@@ -650,17 +634,14 @@ def main():
     out_lines = out_clean.split('\n')
     while '' in out_lines:
         out_lines.remove('')
-
-    result = dict(changed=changed, rc=rc, cmd=cmdstr, stdout_lines=out_lines, msg=out_clean)
-
-    if quiet:
-        changes = out.count(changed_marker) if changed else 0
-        result['msg'] = "%s files/directories have been synchronized" % changes
-
     if module._diff:
-        result['diff'] = {'prepared': out_clean}
+        diff = {'prepared': out_clean}
+        return module.exit_json(changed=changed, msg=out_clean,
+                                rc=rc, cmd=cmdstr, stdout_lines=out_lines,
+                                diff=diff)
 
-    return module.exit_json(**result)
+    return module.exit_json(changed=changed, msg=out_clean,
+                            rc=rc, cmd=cmdstr, stdout_lines=out_lines)
 
 
 if __name__ == '__main__':

tests/integration/inventory

@@ -1,2 +0,0 @@
-[testgroup]
-testhost ansible_connection="local" ansible_pipelining="yes" ansible_python_interpreter="/Users/mandkulk/venv3.9/bin/python"

tests/integration/targets/authorized_key/defaults/main.yml

@@ -35,5 +35,3 @@ multiple_keys_comments: |
   ssh-rsa DATA_BASIC 1@testing
   # I like adding comments yo-dude-this-is-not-a-key INVALID_DATA 2@testing
   ecdsa-sha2-nistp521 ECDSA_DATA 4@testing
-
-key_path: /tmp/id_rsa.pub

tests/integration/targets/authorized_key/tasks/check_path.yml

@@ -1,32 +0,0 @@
----
-- name: Create key file for test
-  ansible.builtin.copy:
-    dest: "{{ key_path }}"
-    content: "{{ rsa_key_basic }}"
-    mode: "0600"
-
-- name: Add key using path
-  ansible.posix.authorized_key:
-    user: root
-    key: file://{{ key_path }}
-    state: present
-    path: "{{ output_dir | expanduser }}/authorized_keys"
-  register: result
-
-- name: Assert that the key was added
-  ansible.builtin.assert:
-    that:
-      - result.changed == true
-
-- name: Add key using path again
-  ansible.posix.authorized_key:
-    user: root
-    key: file://{{ key_path }}
-    state: present
-    path: "{{ output_dir | expanduser }}/authorized_keys"
-  register: result
-
-- name: Assert that no changes were applied
-  ansible.builtin.assert:
-    that:
-      - result.changed == false

tests/integration/targets/authorized_key/tasks/main.yml

@@ -31,6 +31,3 @@
 
 - name: Test for the management of comments with key
   ansible.builtin.import_tasks: comments.yml
-
-- name: Test for specifying key as a path
-  ansible.builtin.import_tasks: check_path.yml

tests/integration/targets/synchronize/tasks/main.yml

@@ -339,37 +339,6 @@
       - stat_result_b.stat.exists == True
       - stat_result_b.stat.checksum == '2aae6c35c94fcfb415dbe95f408b9ce91ee846ed'
 
-- name: Synchronize files with quiet option
-  ansible.posix.synchronize:
-    src: '{{ output_dir }}/foo.txt'
-    dest: '{{ output_dir }}/foo.result'
-    quiet: true
-  register: sync_result
-
-- name: Assertion for synchronize with quiet option
-  ansible.builtin.assert:
-    that:
-      - '''files/directories have been synchronized'' in sync_result.msg'
-
-- name: Cleanup
-  ansible.builtin.file:
-    state: absent
-    path: '{{ output_dir }}/{{ item }}'
-  loop:
-    - foo.result
-    - bar.result
-
-- name: Synchronize files without quiet option
-  ansible.posix.synchronize:
-    src: '{{ output_dir }}/foo.txt'
-    dest: '{{ output_dir }}/foo.result'
-  register: sync_result
-
-- name: Assertion for synchronize without quiet option
-  ansible.builtin.assert:
-    that:
-      - '''files/directories have been synchronized'' not in sync_result.msg'
-
 - name: Cleanup
   ansible.builtin.file:
     state: absent