Update 569_keep_mountpoint.yml

escape :

.azure-pipelines/azure-pipelines.yml

@@ -57,21 +57,6 @@ stages:
               test: units
             - name: Lint
               test: lint
-  - stage: Sanity_2_18
-    displayName: Ansible 2.18 sanity
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: "{0}"
-          testFormat: 2.18/{0}
-          targets:
-            - name: Sanity
-              test: sanity
-            - name: Units
-              test: units
-            - name: Lint
-              test: lint
   - stage: Sanity_2_17
     displayName: Ansible 2.17 sanity
     dependsOn: []
@@ -128,20 +113,6 @@ stages:
               test: ubuntu2204
             - name: Ubuntu 24.04
               test: ubuntu2404
-  - stage: Docker_2_18
-    displayName: Docker devel
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/linux/{0}/1
-          targets:
-            - name: Fedora 40
-              test: fedora40
-            - name: Ubuntu 22.04
-              test: ubuntu2204
-            - name: Ubuntu 24.04
-              test: ubuntu2404
   - stage: Docker_2_17
     displayName: Docker 2.17
     dependsOn: []
@@ -205,18 +176,6 @@ stages:
               test: rhel/9.4
             - name: FreeBSD 13.3
               test: freebsd/13.3
-  - stage: Remote_2_18
-    displayName: Remote devel
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/{0}/1
-          targets:
-            - name: RHEL 9.4
-              test: rhel/9.4
-            - name: FreeBSD 13.3
-              test: freebsd/13.3
   - stage: Remote_2_17
     displayName: Remote 2.17
     dependsOn: []
@@ -275,11 +234,8 @@ stages:
       - Sanity_2_17
       - Remote_2_17
       - Docker_2_17
-      - Sanity_2_18
-      - Remote_2_18
-      - Docker_2_18
       - Sanity_devel
-      # - Remote_devel # Wait for test environment release
+      - Remote_devel
-      # - Docker_devel # Wait for test environment release
+      - Docker_devel
     jobs:
       - template: templates/coverage.yml

.github/BOTMETA.yml

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

CHANGELOG.rst

@@ -4,39 +4,6 @@ ansible.posix Release Notes
 
 .. contents:: Topics
 
-v1.6.2
-======
-
-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
---------
-
-- backport - Drop ansible-core 2.14 and set 2.15 minimum version (https://github.com/ansible-collections/ansible.posix/issues/578).
-
-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
 ======

README.md

@@ -74,14 +74,11 @@ None
 
 <!-- List the versions of Ansible the collection has been tested with. Must match what is in galaxy.yml. -->
 
-- ansible-core 2.19 (devel)
+- ansible-core 2.18 (devel)
-- ansible-core 2.18 (stable) *
 - ansible-core 2.17 (stable)
 - ansible-core 2.16 (stable)
 - ansible-core 2.15 (stable)
 
-*Note: For ansible-core 2.18, CI only covers sanity tests and no integration tests will be run until the test environment is released.*
-
 ## Roadmap
 
 <!-- Optional. Include the roadmap for this collection, and the proposed release/versioning strategy so users can anticipate the upgrade/update cycle. -->

changelogs/changelog.yaml

@@ -405,43 +405,3 @@ 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'
-  1.6.2:
-    changes:
-      bugfixes:
-      - backport - Drop ansible-core 2.14 and set 2.15 minimum version (https://github.com/ansible-collections/ansible.posix/issues/578).
-      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.2.yml
-    - 580_drop_ansible214.yml
-    release_date: '2024-10-22'

changelogs/fragments/566_bump_version_161.yml

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

changelogs/fragments/567_remove_version_added.yml

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

changelogs/fragments/569_keep_mountpoint.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+- keep_mountpoint - added keep_mountpoint option with default value false. If set to true keep_mountpoint changes the behaviour of state\: absent by keeping the mountpoint.

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: ansible
 name: posix
-version: 1.6.2
+version: 1.6.1
 readme: README.md
 authors:
   - Ansible (github.com/ansible)

meta/runtime.yml

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

plugins/callback/skippy.py

@@ -1,43 +0,0 @@
-# (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/modules/acl.py

@@ -75,10 +75,6 @@ options:
   use_nfsv4_acls:
     description:
     - Use NFSv4 ACLs instead of POSIX ACLs.
-    - This feature uses C(nfs4_setfacl) and C(nfs4_getfacl). The behavior depends on those implementation.
-      And currently it only supports C(A) in ACE, so C(D) must be replaced with the appropriate C(A).
-    - Permission is set as optimised ACLs by the system. You can check the actual ACLs that has been set using the return value.
-    - More info C(man nfs4_setfacl)
     type: bool
     default: false
   recalculate_mask:
@@ -183,7 +179,7 @@ def split_entry(entry):
 def build_entry(etype, entity, permissions=None, use_nfsv4_acls=False):
     '''Builds and returns an entry string. Does not include the permissions bit if they are not provided.'''
     if use_nfsv4_acls:
-        return ':'.join(['A', 'g' if etype == 'group' else '', entity, permissions + 'tcy'])
+        return ':'.join([etype, entity, permissions, 'allow'])
 
     if permissions:
         return etype + ':' + entity + ':' + permissions
@@ -191,27 +187,22 @@ def build_entry(etype, entity, permissions=None, use_nfsv4_acls=False):
     return etype + ':' + entity
 
 
-def build_command(module, mode, path, follow, default, recursive, recalculate_mask, use_nfsv4_acls, entry=''):
+def build_command(module, mode, path, follow, default, recursive, recalculate_mask, entry=''):
     '''Builds and returns a getfacl/setfacl command.'''
     if mode == 'set':
-        cmd = [module.get_bin_path('nfs4_setfacl' if use_nfsv4_acls else 'setfacl', True)]
+        cmd = [module.get_bin_path('setfacl', True)]
-        cmd.extend(['-a' if use_nfsv4_acls else '-m', entry])
+        cmd.extend(['-m', entry])
     elif mode == 'rm':
-        cmd = [module.get_bin_path('nfs4_setfacl' if use_nfsv4_acls else 'setfacl', True)]
+        cmd = [module.get_bin_path('setfacl', True)]
         cmd.extend(['-x', entry])
     else:  # mode == 'get'
         cmd = [module.get_bin_path('getfacl', True)]
         # prevents absolute path warnings and removes headers
         if platform.system().lower() == 'linux':
-            if use_nfsv4_acls:
-                # use nfs4_getfacl instead of getfacl if use_nfsv4_acls is True
-                cmd = [module.get_bin_path('nfs4_getfacl', True)]
-            else:
-                cmd = [module.get_bin_path('getfacl', True)]
-                cmd.append('--absolute-names')
             cmd.append('--omit-header')
+            cmd.append('--absolute-names')
 
-    if recursive and not use_nfsv4_acls:
+    if recursive:
         cmd.append('--recursive')
 
     if recalculate_mask == 'mask' and mode in ['set', 'rm']:
@@ -219,7 +210,7 @@ def build_command(module, mode, path, follow, default, recursive, recalculate_ma
     elif recalculate_mask == 'no_mask' and mode in ['set', 'rm']:
         cmd.append('--no-mask')
 
-    if not follow and not use_nfsv4_acls:
+    if not follow:
         if platform.system().lower() == 'linux':
             cmd.append('--physical')
         elif platform.system().lower() == 'freebsd':
@@ -232,34 +223,24 @@ def build_command(module, mode, path, follow, default, recursive, recalculate_ma
     return cmd
 
 
-def acl_changed(module, cmd, entry, use_nfsv4_acls=False):
+def acl_changed(module, cmd):
     '''Returns true if the provided command affects the existing ACLs, false otherwise.'''
-    # To check the ACL changes, use the output of setfacl or nfs4_setfacl with '--test'.
+    # FreeBSD do not have a --test flag, so by default, it is safer to always say "true"
-    # FreeBSD do not have a --test flag, so by default, it is safer to always say "true".
     if platform.system().lower() == 'freebsd':
         return True
 
     cmd = cmd[:]  # lists are mutables so cmd would be overwritten without this
     cmd.insert(1, '--test')
     lines = run_acl(module, cmd)
-    counter = 0
-    for line in lines:
-        if line.endswith('*,*') and not use_nfsv4_acls:
-            return False
-        # if use_nfsv4_acls and entry is listed
-        if use_nfsv4_acls and entry == line:
-            counter += 1
 
-    # The current 'nfs4_setfacl --test' lists a new entry,
+    for line in lines:
-    #  which will be added at the top of list, followed by the existing entries.
+        if not line.endswith('*,*'):
-    # So if the entry has already been registered, the entry should be find twice.
-    if counter == 2:
-        return False
             return True
+    return False
 
 
 def run_acl(module, cmd, check_rc=True):
-    '''Runs the provided command and returns the output as a list of lines.'''
+
     try:
         (rc, out, err) = module.run_command(cmd, check_rc=check_rc)
     except Exception as e:
@@ -332,7 +313,7 @@ def main():
             module.fail_json(msg="'recalculate_mask' MUST NOT be set to 'mask' or 'no_mask' when 'state=query'.")
 
     if not entry:
-        if state == 'absent' and permissions and not use_nfsv4_acls:
+        if state == 'absent' and permissions:
             module.fail_json(msg="'permissions' MUST NOT be set when 'state=absent'.")
 
         if state == 'absent' and not entity:
@@ -369,24 +350,21 @@ def main():
         entry = build_entry(etype, entity, permissions, use_nfsv4_acls)
         command = build_command(
             module, 'set', path, follow,
-            default, recursive, recalculate_mask, use_nfsv4_acls, entry
+            default, recursive, recalculate_mask, entry
         )
-        changed = acl_changed(module, command, entry, use_nfsv4_acls)
+        changed = acl_changed(module, command)
 
         if changed and not module.check_mode:
             run_acl(module, command)
         msg = "%s is present" % entry
 
     elif state == 'absent':
-        if use_nfsv4_acls:
-            entry = build_entry(etype, entity, permissions, use_nfsv4_acls)
-        else:
         entry = build_entry(etype, entity, use_nfsv4_acls)
         command = build_command(
             module, 'rm', path, follow,
-            default, recursive, recalculate_mask, use_nfsv4_acls, entry
+            default, recursive, recalculate_mask, entry
         )
-        changed = acl_changed(module, command, entry, use_nfsv4_acls)
+        changed = acl_changed(module, command)
 
         if changed and not module.check_mode:
             run_acl(module, command, False)
@@ -397,10 +375,7 @@ def main():
 
     acl = run_acl(
         module,
-        build_command(
+        build_command(module, 'get', path, follow, default, recursive, recalculate_mask)
-            module, 'get', path, follow, default, recursive,
-            recalculate_mask, use_nfsv4_acls
-        )
     )
 
     module.exit_json(changed=changed, msg=msg, acl=acl)

plugins/modules/mount.py

@@ -87,7 +87,8 @@ options:
         real source. V(absent) does not unmount recursively, and the module will
         fail if multiple devices are mounted on the same mount point. Using
         V(absent) with a mount point that is not registered in the I(fstab) has
-        no effect, use V(unmounted) instead.
+        no effect, use V(unmounted) instead. You can set O(keep_mountpoint) to
+        True to keep the mountpoint.
       - V(remounted) specifies that the device will be remounted for when you
         want to force a refresh on the mount itself (added in 2.9). This will
         always return RV(ignore:changed=true). If O(opts) is set, the options will be
@@ -132,6 +133,16 @@ options:
         the original file back if you somehow clobbered it incorrectly.
     type: bool
     default: false
+  keep_mountpoint:
+    description:
+    - Change the default behaviour of state=absent by keeping the mountpoint
+    - With keep_mountpoint=true, state=absent is like unmounted plus the
+      fstab update.
+    - Use it if you care about finding original mountpoint content without failing
+      and want to remove the entry in fstab. If you have no entry to clean in
+      fstab you can use state=unmounted
+    type: bool
+    default: false
 notes:
   - As of Ansible 2.3, the O(name) option has been changed to O(path) as
     default, but O(name) still works as well.
@@ -175,6 +186,23 @@ EXAMPLES = r'''
     path: /tmp/mnt-pnt
     state: remounted
 
+# The following will fail on first run
+# if /home/mydir is not empty after unmounting,
+# though unmount and remove from fstab are successfull.
+# It will be successfull on subsequent runs (already unmounted).
+- name: Unmount and remove from fstab, then if unmount was necessary try to remove mountpoint /home/mydir
+  ansible.posix.mount:
+    path: /home/mydir
+    state: absent
+# The following will not fail on first run
+# if /home/mydir is not empty after unmounting.
+# It will leave /home/mydir and its content (if any) after unmounting.
+- name: Unmount and remove from fstab, but keep /home/mydir
+  ansible.posix.mount:
+    path: /home/mydir
+    state: absent
+    keep_mountpoint: true
+
 # The following will not save changes to fstab, and only be temporary until
 # a reboot, or until calling "state: unmounted" followed by "state: mounted"
 # on the same "path"
@@ -779,6 +807,7 @@ def main():
             src=dict(type='path'),
             backup=dict(type='bool', default=False),
             state=dict(type='str', required=True, choices=['absent', 'absent_from_fstab', 'mounted', 'present', 'unmounted', 'remounted', 'ephemeral']),
+            keep_mountpoint=dict(type='bool', default=False),
         ),
         supports_check_mode=True,
         required_if=(
@@ -850,6 +879,9 @@ def main():
             args['warnings'].append("Ignore the 'boot' due to 'opts' contains 'noauto'.")
         elif not module.params['boot']:
             args['boot'] = 'no'
+            if 'defaults' in opts:
+                args['warnings'].append("Ignore the 'boot' due to 'opts' contains 'defaults'.")
+            else:
                 opts.append('noauto')
                 args['opts'] = ','.join(opts)
 
@@ -896,7 +928,7 @@ def main():
                     module.fail_json(
                         msg="Error unmounting %s: %s" % (name, msg))
 
-            if os.path.exists(name):
+            if os.path.exists(name) and module.params['keep_mountpoint'] is False:
                 try:
                     os.rmdir(name)
                 except (OSError, IOError) as e:

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

@@ -472,25 +472,6 @@
         path: /tmp/myfs
         state: absent
 
-    - name: Mount the FS with noauto option and defaults
-      ansible.posix.mount:
-        path: /tmp/myfs
-        src: /tmp/myfs.img
-        fstype: ext3
-        state: mounted
-        boot: false
-      register: mount_info
-
-    - name: Assert the mount without noauto was successful
-      ansible.builtin.assert:
-        that:
-          - "'noauto' in mount_info['opts'].split(',')"
-
-    - name: Unmount FS
-      ansible.posix.mount:
-        path: /tmp/myfs
-        state: absent
-
     - name: Remove the test FS
       ansible.builtin.file:
         path: '{{ item }}'
@@ -808,3 +789,85 @@
       loop:
         - /tmp/myfs.img
         - /tmp/myfs
+
+- name: Block to test keep_mountpoint option
+  block:
+  - name: Create the mount point
+    ansible.builtin.file:
+      state: directory
+      path: '/tmp/myfs'
+      mode: '0755'
+
+  - name: Create empty file for FS aaa
+    community.general.filesize:
+      path: /tmp/myfs.img
+      size: 20M
+
+  - name: Format FS bbb
+    community.general.filesystem:
+      fstype: xfs
+      dev: /tmp/myfs.img
+
+  - name: Put data in the mount point before mounting
+    ansible.builtin.copy:
+      content: 'Testing
+        This is the data before mounting
+        '
+      dest: '/tmp/myfs/test_file'
+      mode: '0644'
+    register: file_before_info
+
+  - name: Mount with fstab
+    ansible.posix.mount:
+      path: '/tmp/myfs'
+      fstype: xfs
+      state: mounted
+      src: '/tmp/myfs.img'
+
+  - name: Check data disappears - stat data
+    ansible.builtin.stat:
+      path: '/tmp/myfs/test_file'
+    register: file_stat_after_mount
+  - name: Check data disappears - file does not exist
+    ansible.builtin.assert:
+      that:
+      - file_stat_after_mount['stat']['exists'] == false
+  - name: Put data in the mount point after mounting
+    ansible.builtin.copy:
+      content: 'Testing
+        This is the data updated after mounting
+        '
+      dest: '/tmp/myfs/test_file'
+      mode: '0644'
+    register: file_after_info
+  - name: Umount with keep_mountpoint
+    ansible.posix.mount:
+      path: '/tmp/myfs'
+      fstype: xfs
+      state: absent
+      keep_mountpoint: true
+  - name: Check original data reappears - stat data
+    ansible.builtin.stat:
+      path: '/tmp/myfs/test_file'
+    register: file_stat_after_umount
+  - name: Check original data reappears - compare checksums
+    ansible.builtin.assert:
+      that:
+      - file_stat_after_umount['stat']['checksum'] == file_before_info['checksum']
+  always:
+    - name: Remove the first test file
+      ansible.builtin.file:
+        path: /tmp/myfs/test_file
+        state: absent
+    - name: Unmount FS
+      ansible.posix.mount:
+        path: /tmp/myfs
+        state: absent
+    - name: Remove the test FS and the second test file
+      ansible.builtin.file:
+        path: '{{ item }}'
+        state: absent
+      loop:
+        - /tmp/myfs/test_file
+        - /tmp/myfs.img
+        - /tmp/myfs

tests/integration/targets/selinux/tasks/selinux.yml

@@ -128,8 +128,8 @@
   ansible.builtin.assert:
     that:
       - selinux_config_original | length == selinux_config_after | length
-      - (selinux_config_after | select("search", "^SELINUX=disabled\s*$") | list | length) > 0
+      - selinux_config_after[selinux_config_after.index('SELINUX=disabled')]  is search("^SELINUX=\w+$")
-      - (selinux_config_after | select("search", "^SELINUXTYPE=targeted\s*$") | list | length) > 0
+      - selinux_config_after[selinux_config_after.index('SELINUXTYPE=targeted')]  is search("^SELINUXTYPE=\w+$")
 
 - name: TEST 1 | Disable SELinux again, with kernel arguments update
   ansible.posix.selinux:

tests/sanity/ignore-2.19.txt

@@ -1 +0,0 @@
-tests/utils/shippable/timing.py shebang