Merge d05a5c70b5 into 1994b2cf1c

plugins/callback/profile_tasks.py: Add option to provide a different date/time format

SUMMARY
The new datetime_format key will offer the possibility of providing a different date/time format than the default one ('%A %d %B %Y  %H:%M:%S %z').

The iso8601 value can be used as an '%Y-%m-%dT%H:%M:%S.%f' alias (format of the ISO 8601 date/time standard).

The code has changed from using the time API to the datetime one in order to support sub-second precision (needed by the ISO 8601 format, for example).
Fixes: #279
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
plugins/callback/profile_tasks.py
ADDITIONAL INFORMATION

Output with no key which keeps current behavior:

TASK [Import subscription manifest] *******************************************************************************************************************************************************************************************************************************************************************
Thursday 10 April 2025  00:52:11 +0200 (0:00:17.416)       0:00:17.453 ******** 
changed: [localhost]


Output with datetime_format = 'iso8601':

TASK [Import subscription manifest] *******************************************************************************************************************************************************************************************************************************************************************
2025-04-10T00:55:19.967718 (0:00:15.664)       0:00:15.691 ******************** 
changed: [localhost]


Output with datetime_format = '%Y-%m-%dT%H:%M:%S.%f%z' (ISO 8601 with UTC offset information):

TASK [Import subscription manifest] *******************************************************************************************************************************************************************************************************************************************************************
2025-04-10T00:57:49.290347+0200 (0:00:16.265)       0:00:16.293 *************** 
changed: [localhost]

Reviewed-by: Hideki Saito <saito@fgrep.org>

.azure-pipelines/azure-pipelines.yml

@@ -57,23 +57,8 @@ stages:
               test: units
             - name: Lint
               test: lint
-  - stage: Sanity_2_19
-    displayName: Ansible 2.19 sanitay & Units & Lint
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: "{0}"
-          testFormat: 2.19/{0OI}
-          targets:
-            - name: Sanity
-              test: sanity
-            - name: Units
-              test: units
-            - name: Lint
-              test: lint
   - stage: Sanity_2_18
-    displayName: Ansible 2.18 sanity & Units & Lint
+    displayName: Ansible 2.18 sanity
     dependsOn: []
     jobs:
       - template: templates/matrix.yml
@@ -88,11 +73,10 @@ stages:
             - name: Lint
               test: lint
   - stage: Sanity_2_17
-    displayName: Ansible 2.17 sanity & Units & Lint
+    displayName: Ansible 2.17 sanity
     dependsOn: []
     jobs:
       - template: templates/matrix.yml
-        I
         parameters:
           nameFormat: "{0}"
           testFormat: 2.17/{0}
@@ -104,7 +88,7 @@ stages:
             - name: Lint
               test: lint
   - stage: Sanity_2_16
-    displayName: Ansible 2.16 sanity & Units & Lint
+    displayName: Ansible 2.16 sanity
     dependsOn: []
     jobs:
       - template: templates/matrix.yml
@@ -117,7 +101,7 @@ stages:
             - name: Units
               test: units
   - stage: Sanity_2_15
-    displayName: Ansible 2.15 sanity & Units & Lint
+    displayName: Ansible 2.15 sanity
     dependsOn: []
     jobs:
       - template: templates/matrix.yml
@@ -144,20 +128,6 @@ stages:
               test: ubuntu2204
             - name: Ubuntu 24.04
               test: ubuntu2404
-  - stage: Docker_2_19
-    displayName: Docker 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: devel/linux/{0}/1
-          targets:
-            - name: Fedora 41
-              test: fedora41
-            - name: Ubuntu 22.04
-              test: ubuntu2204
-            - name: Ubuntu 24.04
-              test: ubuntu2404
   - stage: Docker_2_18
     displayName: Docker 2.18
     dependsOn: []
@@ -225,24 +195,6 @@ stages:
         parameters:
           testFormat: devel/{0}/1
           targets:
-            - name: RHEL 10.0
-              test: rhel/10.0
-            - name: RHEL 9.5
-              test: rhel/9.5
-            - name: FreeBSD 14.2
-              test: freebsd/14.2
-            - name: FreeBSD 13.5
-              test: freebsd/13.5
-  - stage: Remote_2_19
-    displayName: Remote 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: devel/{0}/1
-          targets:
-            - name: RHEL 10.0
-              test: rhel/10.0
             - name: RHEL 9.5
               test: rhel/9.5
             - name: FreeBSD 14.2
@@ -285,6 +237,8 @@ stages:
               test: rhel/8.8
             - name: RHEL 9.2
               test: rhel/9.2
+            - name: FreeBSD 13.2
+              test: freebsd/13.2
 
   - stage: Remote_2_15
     displayName: Remote 2.15
@@ -300,6 +254,8 @@ stages:
               test: rhel/8.7
             - name: RHEL 9.1
               test: rhel/9.1
+            - name: FreeBSD 13.2
+              test: freebsd/13.2
 
   ## Finally
 
@@ -318,9 +274,6 @@ stages:
       - Sanity_2_18
       - Remote_2_18
       - Docker_2_18
-      - Sanity_2_19
-      - Remote_2_19
-      - Docker_2_19
       - Sanity_devel
       - Remote_devel
       - Docker_devel

CHANGELOG.rst

@@ -4,27 +4,6 @@ ansible.posix Release Notes
 
 .. contents:: Topics
 
-v2.1.0
-======
-
-Release Summary
----------------
-
-This is the minor release of the ``ansible.posix`` collection.
-This changelog contains all changes to the modules and plugins
-in the stable-2 branch that have been added after the release of
-``ansible.posix`` 2.0.0
-
-Minor Changes
--------------
-
-- profile_tasks and profile_roles callback plugins - avoid deleted/deprecated callback functions, instead use modern interface that was introduced a longer time ago (https://github.com/ansible-collections/ansible.posix/issues/650).
-
-Bugfixes
---------
-
-- ansible.posix.cgroup_perf_recap - fixes json module load path (https://github.com/ansible-collections/ansible.posix/issues/630).
-
 v2.0.0
 ======
 

changelogs/changelog.yaml

@@ -490,25 +490,3 @@ releases:
     - 597_remove_fstab_comment_on_updating.yml
     - 598_icmp_block_inversion.yml
     release_date: '2024-12-04'
-  2.1.0:
-    changes:
-      bugfixes:
-      - ansible.posix.cgroup_perf_recap - fixes json module load path (https://github.com/ansible-collections/ansible.posix/issues/630).
-      minor_changes:
-      - profile_tasks and profile_roles callback plugins - avoid deleted/deprecated
-        callback functions, instead use modern interface that was introduced a longer
-        time ago (https://github.com/ansible-collections/ansible.posix/issues/650).
-      release_summary: 'This is the minor release of the ``ansible.posix`` collection.
-
-        This changelog contains all changes to the modules and plugins
-
-        in the stable-2 branch that have been added after the release of
-
-        ``ansible.posix`` 2.0.0'
-    fragments:
-    - 2.1.0.yml
-    - 631_fixes_module_path.yml
-    - 642_ci_add_rhel10.yml
-    - 650-profile_tasks_roles.yml
-    - 654_ci_bump_core_version.yml
-    release_date: '2025-07-16'

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.

changelogs/fragments/603_bump_version_3.yml

@@ -0,0 +1,2 @@
+trivial:
+  - Bump version to 3.0.0 for the next release (https://github.com/ansible-collections/ansible.posix/issues/603).

changelogs/fragments/618_ci_remove_ubuntu2004.yml

@@ -0,0 +1,2 @@
+trivial:
+  - Remove ubuntu20.04 from CI tests (https://github.com/ansible-collections/ansible.posix/issues/612).

changelogs/fragments/626_profile_tasks_datetime_format.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - profile_tasks - Add option to provide a different date/time format (https://github.com/ansible-collections/ansible.posix/issues/279).

changelogs/fragments/631_fixes_module_path.yml

@@ -0,0 +1,6 @@
+---
+bugfixes:
+  - ansible.posix.cgroup_perf_recap - fixes json module load path (https://github.com/ansible-collections/ansible.posix/issues/630).
+trivial:
+  - ansible.posix.seboolean - remove unnecessary condition from seboolean integration tests (https://github.com/ansible-collections/ansible.posix/issues/630).
+  - ansible.posix.selinux - optimize conditions for selinux integration tests (https://github.com/ansible-collections/ansible.posix/issues/630).

galaxy.yml

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

plugins/callback/profile_roles.py

@@ -124,7 +124,10 @@ class CallbackModule(CallbackBase):
     def v2_playbook_on_handler_task_start(self, task):
         self._record_task(task)
 
-    def v2_playbook_on_stats(self, stats):
+    def playbook_on_setup(self):
+        self._display_tasktime()
+
+    def playbook_on_stats(self, stats):
         # Align summary report header with other callback plugin summary
         self._display.banner("ROLES RECAP")
 

plugins/callback/profile_tasks.py

@@ -52,6 +52,17 @@ DOCUMENTATION = '''
           - section: callback_profile_tasks
             key: summary_only
         version_added: 1.5.0
+      datetime_format:
+        description:
+          - Datetime format, as expected by the C(strftime) and C(strptime) methods.
+            An C(iso8601) alias will be translated to C('%Y-%m-%dT%H:%M:%S.%f') if that datetime standard wants to be used.
+        default: '%A %d %B %Y  %H:%M:%S %z'
+        env:
+          - name: PROFILE_TASKS_DATETIME_FORMAT
+        ini:
+          - section: callback_profile_tasks
+            key: datetime_format
+        version_added: 3.0.0
 '''
 
 EXAMPLES = '''
@@ -72,14 +83,15 @@ sample output: >
 '''
 
 import collections
-import time
+
+from datetime import datetime
 
 from ansible.module_utils.six.moves import reduce
 from ansible.plugins.callback import CallbackBase
 
 
 # define start time
-t0 = tn = time.time()
+dt0 = dtn = datetime.now().astimezone()
 
 
 def secondsToStr(t):
@@ -104,17 +116,18 @@ def filled(msg, fchar="*"):
 
 def timestamp(self):
     if self.current is not None:
-        elapsed = time.time() - self.stats[self.current]['started']
+        elapsed = (datetime.now().astimezone() - self.stats[self.current]['started']).total_seconds()
         self.stats[self.current]['elapsed'] += elapsed
 
 
-def tasktime():
-    global tn
-    time_current = time.strftime('%A %d %B %Y  %H:%M:%S %z')
-    time_elapsed = secondsToStr(time.time() - tn)
-    time_total_elapsed = secondsToStr(time.time() - t0)
-    tn = time.time()
-    return filled('%s (%s)%s%s' % (time_current, time_elapsed, ' ' * 7, time_total_elapsed))
+def tasktime(self):
+    global dtn
+    cdtn = datetime.now().astimezone()
+    datetime_current = cdtn.strftime(self.datetime_format)
+    time_elapsed = secondsToStr((cdtn - dtn).total_seconds())
+    time_total_elapsed = secondsToStr((cdtn - dt0).total_seconds())
+    dtn = cdtn
+    return filled('%s (%s)%s%s' % (datetime_current, time_elapsed, ' ' * 7, time_total_elapsed))
 
 
 class CallbackModule(CallbackBase):
@@ -134,6 +147,7 @@ class CallbackModule(CallbackBase):
         self.sort_order = None
         self.summary_only = None
         self.task_output_limit = None
+        self.datetime_format = None
 
         super(CallbackModule, self).__init__()
 
@@ -159,9 +173,14 @@ class CallbackModule(CallbackBase):
             else:
                 self.task_output_limit = int(self.task_output_limit)
 
+        self.datetime_format = self.get_option('datetime_format')
+        if self.datetime_format is not None:
+            if self.datetime_format == 'iso8601':
+                self.datetime_format = '%Y-%m-%dT%H:%M:%S.%f'
+
     def _display_tasktime(self):
         if not self.summary_only:
-            self._display.display(tasktime())
+            self._display.display(tasktime(self))
 
     def _record_task(self, task):
         """
@@ -176,10 +195,11 @@ class CallbackModule(CallbackBase):
         #            with the same UUID is executed when `serial` is specified in a playbook.
         #   elapsed: Elapsed time since the first serialized task was started
         self.current = task._uuid
+        dtn = datetime.now().astimezone()
         if self.current not in self.stats:
-            self.stats[self.current] = {'started': time.time(), 'elapsed': 0.0, 'name': task.get_name()}
+            self.stats[self.current] = {'started': dtn, 'elapsed': 0.0, 'name': task.get_name()}
         else:
-            self.stats[self.current]['started'] = time.time()
+            self.stats[self.current]['started'] = dtn
         if self._display.verbosity >= 2:
             self.stats[self.current]['path'] = task.get_path()
 
@@ -189,11 +209,14 @@ class CallbackModule(CallbackBase):
     def v2_playbook_on_handler_task_start(self, task):
         self._record_task(task)
 
-    def v2_playbook_on_stats(self, stats):
+    def playbook_on_setup(self):
+        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.display(tasktime(self))
         self._display.display(filled("", fchar="="))
 
         timestamp(self)

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=(
@@ -896,7 +925,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:

plugins/modules/sysctl.py

@@ -80,6 +80,13 @@ EXAMPLES = r'''
     sysctl_file: /tmp/test_sysctl.conf
     reload: false
 
+# Enable resource limits management in FreeBSD
+- ansible.posix.sysctl:
+    name: kern.racct.enable
+    value: '1'
+    sysctl_file: /boot/loader.conf
+    reload: false
+
 # Set ip forwarding on in /proc and verify token value with the sysctl command
 - ansible.posix.sysctl:
     name: net.ipv4.ip_forward

tests/integration/targets/acl/tasks/acl.yml

@@ -46,12 +46,6 @@
     path: "{{ test_dir }}"
     state: directory
     mode: "0755"
-
-- name: Install acl package
-  ansible.builtin.package:
-    name: acl
-    state: present
-
 ##############################################################################
 - name: Grant ansible user read access to a file
   ansible.posix.acl:

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

@@ -1132,3 +1132,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/sanity/ignore-2.20.txt

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