5 Commits
Author SHA1 Message Date
7dfac5e719 mount: restore fstab file if umount fails (#742) (#787)
* mount: restore fstab file if umount fails

* Refactored code

Fixes: #605



* Make CI green



---------

Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2026-08-26 11:59:31 +09:00
Hideki SaitoandGitHub 3db746aed3 Fix version_added for profile_tasks datetime_format (#784) (#786)
- Fixes #783
- Replaced version_added value with 2.2.0 for datetime_format

Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-08-26 10:49:45 +09:00
7a70c0607c fix(callback): align profile_tasks recap output width (#773) (#782)
Use display.columns and get_text_width() for TASKS RECAP headers,
timestamps, and timing rows so output matches display.banner() width.
Add truncate_task_names (default false, version_added 2.3.0) with
display-width-aware truncation and padding for multibyte task names.
Add unit tests for ASCII and CJK recap rows, including the reproducer
from #773.

Co-authored-by: Tom Paine <github@aioue.net>
2026-08-25 16:52:30 +09:00
Hideki SaitoandGitHub 61dba1eb25 [CI] Bump partner-certification-checker to v4.1.0 (#780) (#781)
- Fixes ansible-lint import crash

Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-08-25 16:03:40 +09:00
Hideki SaitoandGitHub e0adbf54c4 Update AZP to follow ansible-test (#775) (#776)
- Replace FreeBSD 15.0 with 15.1


(cherry picked from commit ffdf9ef998)

Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-08-07 16:07:03 +09:00
11 changed files with 284 additions and 78 deletions
+2 -2
View File
@@ -277,8 +277,8 @@ stages:
test: rhel/9.8
- name: FreeBSD 14.4
test: freebsd/14.4
- name: FreeBSD 15.0
test: freebsd/15.0
- name: FreeBSD 15.1
test: freebsd/15.1
- stage: Remote_2_21
displayName: Remote 2.21
+1 -1
View File
@@ -32,4 +32,4 @@ concurrency:
# for each affected version of ansible-core (for example, `tests/sanity/ignore-2.18.txt`) and add corresponding entries.
jobs:
call:
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@v0.1
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@v4.1.0
@@ -0,0 +1,5 @@
---
bugfixes:
- profile_tasks callback - align TASKS RECAP output with ``display.banner()`` width instead of a hardcoded 79 columns (https://github.com/ansible-collections/ansible.posix/pull/773).
minor_changes:
- profile_tasks callback - add ``truncate_task_names`` option (default ``false``) to ellipsize long task names in the TASKS RECAP summary (https://github.com/ansible-collections/ansible.posix/pull/773).
@@ -0,0 +1,3 @@
---
trivial:
- AZP - Update AZP matrix to follow ansible-test changes.
@@ -0,0 +1,4 @@
---
trivial:
- CI - Bump partner-certification-checker to v4.1.0 to fix ansible-lint compatibility.
...
@@ -0,0 +1,4 @@
---
bugfixes:
- profile_tasks - fix incorrect ``version_added`` for ``datetime_format`` option(https://github.com/ansible-collections/ansible.posix/issues/783).
...
@@ -0,0 +1,3 @@
---
bugfixes:
- mount - restore fstab if umount fails (https://github.com/ansible-collections/ansible.posix/issues/605).
+91 -16
View File
@@ -62,7 +62,18 @@ DOCUMENTATION = '''
ini:
- section: callback_profile_tasks
key: datetime_format
version_added: 3.0.0
version_added: 2.2.0
truncate_task_names:
description:
- Truncate long task names in the TASKS RECAP summary with an ellipsis so rows stay within the terminal width.
type: bool
default: false
env:
- name: PROFILE_TASKS_TRUNCATE_TASK_NAMES
ini:
- section: callback_profile_tasks
key: truncate_task_names
version_added: 2.3.0
'''
EXAMPLES = '''
@@ -88,6 +99,7 @@ from datetime import datetime
from functools import reduce
from ansible.plugins.callback import CallbackBase
from ansible.utils.display import get_text_width
# define start time
@@ -102,16 +114,64 @@ def secondsToStr(t):
return "%d:%02d:%02d.%03d" % tuple(reduce(rediv, [[t * 1000, ], 1000, 60, 60]))
def filled(msg, fchar="*"):
if len(msg) == 0:
width = 79
def filled(msg, columns, fchar="*"):
"""Fill to the same width as display.banner() (columns + 1)."""
if not msg:
return fchar * (columns + 1)
try:
msg_width = get_text_width(msg)
except EnvironmentError:
msg_width = len(msg)
fill_len = columns - msg_width
if fill_len < 3:
fill_len = 3
return "%s %s" % (msg, fchar * fill_len)
def _text_width(text):
try:
return get_text_width(text)
except EnvironmentError:
return len(text)
def truncate_name(name, width):
if width <= 0:
return name
if _text_width(name) <= width:
return name
if width <= 3:
return name[:width]
ellipsis = '...'
for end in range(len(name), 0, -1):
candidate = name[:end] + ellipsis
if _text_width(candidate) <= width:
return candidate
return ellipsis
def pad_to_display_width(text, width, fillchar='-'):
current = _text_width(text)
if current >= width:
return text
return text + fillchar * (width - current)
def format_timing_row(task_name, elapsed, columns, truncate=False):
line_width = columns + 1
time_field_width = 9
name_field_width = line_width - time_field_width
if truncate:
task_name = truncate_name(task_name, name_field_width - 1)
prefix = task_name + u' '
gap = name_field_width - _text_width(prefix)
if gap == 1:
# A lone dash before the timing field looks like misaligned padding.
left = prefix + u' '
else:
msg = "%s " % msg
width = 79 - len(msg)
if width < 3:
width = 3
filler = fchar * width
return "%s%s " % (msg, filler)
left = pad_to_display_width(prefix, name_field_width)
timing = u' {0:.02f}s'.format(elapsed)
return left + timing.rjust(time_field_width, u'-')
def timestamp(self):
@@ -127,7 +187,10 @@ def tasktime(self):
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))
return filled(
'%s (%s)%s%s' % (datetime_current, time_elapsed, ' ' * 7, time_total_elapsed),
self._display.columns,
)
class CallbackModule(CallbackBase):
@@ -148,6 +211,7 @@ class CallbackModule(CallbackBase):
self.summary_only = None
self.task_output_limit = None
self.datetime_format = None
self.truncate_task_names = None
super(CallbackModule, self).__init__()
@@ -178,6 +242,8 @@ class CallbackModule(CallbackBase):
if self.datetime_format == 'iso8601':
self.datetime_format = '%Y-%m-%dT%H:%M:%S.%f'
self.truncate_task_names = self.get_option('truncate_task_names')
def _display_tasktime(self):
if not self.summary_only:
self._display.display(tasktime(self))
@@ -210,11 +276,12 @@ class CallbackModule(CallbackBase):
self._record_task(task)
def v2_playbook_on_stats(self, stats):
# Align summary report header with other callback plugin summary
self._display.banner("TASKS RECAP")
columns = self._display.columns
line_width = columns + 1
self._display.display(filled("TASKS RECAP", columns))
self._display.display(tasktime(self))
self._display.display(filled("", fchar="="))
self._display.display(filled("", columns, fchar="="))
timestamp(self)
self.current = None
@@ -234,7 +301,15 @@ class CallbackModule(CallbackBase):
# Print the timings
for uuid, result in results:
msg = u"{0:-<{2}}{1:->9}".format(result['name'] + u' ', u' {0:.02f}s'.format(result['elapsed']), self._display.columns - 9)
msg = format_timing_row(
result['name'],
result['elapsed'],
columns,
truncate=self.truncate_task_names,
)
if 'path' in result:
msg += u"\n{0:-<{1}}".format(result['path'] + u' ', self._display.columns)
path_name = result['path']
if self.truncate_task_names:
path_name = truncate_name(path_name, line_width - 1)
msg += u"\n%s" % pad_to_display_width(path_name + u' ', line_width)
self._display.display(msg)
+62 -59
View File
@@ -229,12 +229,14 @@ from ansible.module_utils.common.text.converters import to_bytes, to_native
from ansible.module_utils.parsing.convert_bool import boolean
PLATFORM = platform.system().lower()
def write_fstab(module, lines, path):
backup_file = ""
if module.params['backup']:
backup_file = module.backup_local(path)
else:
backup_file = ""
fs_w = open(path, 'w')
@@ -257,12 +259,7 @@ def _escape_fstab(v):
if isinstance(v, int):
return v
else:
return (
v.
replace('\\', '\\134').
replace(' ', '\\040').
replace('&', '\\046'))
return v.replace('\\', '\\134').replace(' ', '\\040').replace('&', '\\046')
def set_mount(module, args):
@@ -281,7 +278,7 @@ def _set_mount_save_old(module, args):
escaped_args = dict([(k, _escape_fstab(v)) for k, v in args.items()])
new_line = '%(src)s %(name)s %(fstype)s %(opts)s %(dump)s %(passno)s\n'
if platform.system() == 'SunOS':
if PLATFORM == 'sunos':
new_line = (
'%(src)s - %(name)s %(fstype)s %(passno)s %(boot)s %(opts)s\n')
@@ -307,16 +304,16 @@ def _set_mount_save_old(module, args):
# Check if we got a valid line for splitting
# (on Linux the 5th and the 6th field is optional)
if (
platform.system() == 'SunOS' and len(fields) != 7 or
platform.system() == 'Linux' and len(fields) not in [4, 5, 6] or
platform.system() not in ['SunOS', 'Linux'] and len(fields) != 6):
PLATFORM == 'sunos' and len(fields) != 7 or
PLATFORM == 'linux' and len(fields) not in [4, 5, 6] or
PLATFORM not in ['sunos', 'linux'] and len(fields) != 6):
to_write.append(line)
continue
ld = {}
if platform.system() == 'SunOS':
if PLATFORM == 'sunos':
(
ld['src'],
dash,
@@ -354,7 +351,7 @@ def _set_mount_save_old(module, args):
exists = True
args_to_check = ('src', 'fstype', 'opts', 'dump', 'passno')
if platform.system() == 'SunOS':
if PLATFORM == 'sunos':
args_to_check = ('src', 'fstype', 'passno', 'boot', 'opts')
for t in args_to_check:
@@ -377,35 +374,35 @@ def _set_mount_save_old(module, args):
return (args['name'], old_lines, changed)
def unset_mount(module, args):
def unset_mount(module, args, backup=False):
"""Remove a mount point from fstab."""
to_write = []
changed = False
escaped_name = _escape_fstab(args['name'])
for line in open(args['fstab'], 'r').readlines():
lines = open(args['fstab'], 'r').readlines()
for line in lines:
if not line.strip():
to_write.append(line)
continue
if line.strip().startswith('#'):
to_write.append(line)
continue
line_fields = line.split()
# Check if we got a valid line for splitting
if (
platform.system() == 'SunOS' and len(line.split()) != 7 or
platform.system() != 'SunOS' and len(line.split()) != 6):
PLATFORM == 'sunos' and len(line_fields) != 7 or
PLATFORM != 'sunos' and len(line_fields) != 6):
to_write.append(line)
continue
ld = {}
if platform.system() == 'SunOS':
if PLATFORM == 'sunos':
(
ld['src'],
dash,
@@ -414,7 +411,7 @@ def unset_mount(module, args):
ld['passno'],
ld['boot'],
ld['opts']
) = line.split()
) = line_fields
else:
(
ld['src'],
@@ -423,7 +420,7 @@ def unset_mount(module, args):
ld['opts'],
ld['dump'],
ld['passno']
) = line.split()
) = line_fields
if (
ld['name'] != escaped_name or (
@@ -442,7 +439,9 @@ def unset_mount(module, args):
if changed and not module.check_mode:
write_fstab(module, to_write, args['fstab'])
return (args['name'], changed)
if backup:
return (args['name'], changed, lines)
return (args['name'], changed, [])
def _set_fstab_args(fstab_file):
@@ -451,8 +450,8 @@ def _set_fstab_args(fstab_file):
if (
fstab_file and
fstab_file != '/etc/fstab' and
platform.system().lower() != 'sunos'):
if platform.system().lower().endswith('bsd'):
PLATFORM != 'sunos'):
if PLATFORM.endswith('bsd'):
result.append('-F')
else:
result.append('-T')
@@ -465,7 +464,7 @@ def _set_fstab_args(fstab_file):
def _set_ephemeral_args(args):
result = []
# Set fstype switch according to platform. SunOS/Solaris use -F
if platform.system().lower() == 'sunos':
if PLATFORM == 'sunos':
result.append('-F')
else:
result.append('-t')
@@ -487,7 +486,7 @@ def mount(module, args):
name = args['name']
cmd = [mount_bin]
if platform.system().lower() == 'openbsd':
if PLATFORM == 'openbsd':
# Use module.params['fstab'] here as args['fstab'] has been set to the
# default value.
if module.params['fstab'] is not None:
@@ -508,8 +507,7 @@ def mount(module, args):
if rc == 0:
return 0, ''
else:
return rc, out + err
return rc, out + err
def umount(module, path):
@@ -522,8 +520,7 @@ def umount(module, path):
if rc == 0:
return 0, ''
else:
return rc, out + err
return rc, out + err
def remount(module, args):
@@ -532,7 +529,7 @@ def remount(module, args):
cmd = [mount_bin]
# Multiplatform remount opts
if platform.system().lower().endswith('bsd'):
if PLATFORM.endswith('bsd'):
if module.params['state'] == 'remounted' and args['opts'] != 'defaults':
cmd += ['-u', '-o', args['opts']]
else:
@@ -543,7 +540,7 @@ def remount(module, args):
else:
cmd += ['-o', 'remount']
if platform.system().lower() == 'openbsd':
if PLATFORM == 'openbsd':
# Use module.params['fstab'] here as args['fstab'] has been set to the
# default value.
if module.params['fstab'] is not None:
@@ -562,7 +559,7 @@ def remount(module, args):
out = err = ''
try:
if module.params['state'] != 'ephemeral' and platform.system().lower().endswith('bsd'):
if module.params['state'] != 'ephemeral' and PLATFORM.endswith('bsd'):
# Note: Forcing BSDs to do umount/mount due to BSD remount not
# working as expected (suspect bug in the BSD mount command)
# Interested contributor could rework this to use mount options on
@@ -618,7 +615,7 @@ def is_bind_mounted(module, linux_mounts, dest, src=None, fstype=None):
is_mounted = False
if platform.system() == 'Linux' and linux_mounts is not None:
if PLATFORM == 'linux' and linux_mounts is not None:
if src is None:
# That's for unmounted/absent
if dest in linux_mounts:
@@ -732,7 +729,7 @@ def _is_same_mount_src(module, src, mountpoint, linux_mounts):
return False
# Treat Linux bind mounts
if platform.system() == 'Linux' and linux_mounts is not None:
if PLATFORM == 'linux' and linux_mounts is not None:
# For Linux bind mounts only: the mount command does not return
# the actual source for bind mounts, but the device of the source.
# is_bind_mounted() called with the 'src' parameter will return True if
@@ -796,30 +793,35 @@ def main():
# name, src, fstype, opts, dump, passno, state, fstab=/etc/fstab
# Note: Do not modify module.params['fstab'] as we need to know if the user
# explicitly specified it in mount() and remount()
if platform.system().lower() == 'sunos':
args = dict(
name=module.params['path'],
opts='-',
passno='-',
fstab=module.params['fstab'],
boot='yes' if module.params['boot'] else 'no',
args = dict(
name=module.params['path'],
)
if PLATFORM == 'sunos':
args.update(
dict(
opts='-',
passno='-',
fstab=module.params['fstab'],
boot='yes' if module.params['boot'] else 'no',
)
)
if args['fstab'] is None:
args['fstab'] = '/etc/vfstab'
else:
args = dict(
name=module.params['path'],
opts='defaults',
dump='0',
passno='0',
fstab=module.params['fstab'],
boot='yes',
args.update(
dict(
opts='defaults',
dump='0',
passno='0',
fstab=module.params['fstab'],
boot='yes',
)
)
if args['fstab'] is None:
args['fstab'] = '/etc/fstab'
# FreeBSD doesn't have any 'default' so set 'rw' instead
if platform.system() == 'FreeBSD':
if PLATFORM == 'freebsd':
args['opts'] = 'rw'
args['backup_file'] = ""
@@ -827,7 +829,7 @@ def main():
# Cache all mounts here in order we have consistent results if we need to
# call is_bind_mounted() multiple times
if platform.system() == 'Linux':
if PLATFORM == 'linux':
linux_mounts = get_linux_mounts(module)
if linux_mounts is None:
@@ -837,7 +839,7 @@ def main():
for key in ('src', 'fstype', 'passno', 'opts', 'dump', 'fstab'):
if module.params[key] is not None:
args[key] = module.params[key]
if platform.system().lower() == 'linux' or platform.system().lower().endswith('bsd'):
if PLATFORM == 'linux' or PLATFORM.endswith('bsd'):
# Linux, FreeBSD, NetBSD and OpenBSD have 'noauto' as mount option to
# handle mount on boot. To avoid mount option conflicts, if 'noauto'
# specified in 'opts', mount module will ignore 'boot'.
@@ -880,17 +882,18 @@ def main():
changed = False
if state == 'absent_from_fstab':
name, changed = unset_mount(module, args)
name, changed, _dummy = unset_mount(module, args, backup=False)
elif state == 'absent':
name, changed = unset_mount(module, args)
name, changed, backup_lines = unset_mount(module, args, backup=True)
if changed and not module.check_mode:
if ismount(name) or is_bind_mounted(module, linux_mounts, name):
res, msg = umount(module, name)
if res:
module.fail_json(
msg="Error unmounting %s: %s" % (name, msg))
# failed to unmount, restore fstab
write_fstab(module, backup_lines, args['fstab'])
module.fail_json(msg="Error unmounting %s: %s" % (name, msg))
if os.path.exists(name):
try:
@@ -1007,7 +1010,7 @@ def main():
# If the managed node is Solaris, convert the boot value type to Boolean
# to match the type of return value with the module argument.
if platform.system().lower() == 'sunos':
if PLATFORM == 'sunos':
args['boot'] = boolean(args['boot'])
module.exit_json(changed=changed, **args)
@@ -0,0 +1,109 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
from ansible_collections.ansible.posix.tests.unit.compat import unittest
from ansible.utils.display import get_text_width
from ansible_collections.ansible.posix.plugins.callback.profile_tasks import (
filled,
format_timing_row,
pad_to_display_width,
truncate_name,
)
class ProfileTasksDisplayTestCase(unittest.TestCase):
COLUMNS = 79
LINE_WIDTH = COLUMNS + 1
# Reproducer from https://github.com/ansible-collections/ansible.posix/pull/773#issuecomment-5325694910
MAINTAINER_ASCII_LONG = (
'012345678901234567890123456789012345678901234567890'
'12345678901234567890123456789'
)
MAINTAINER_CJK_LONG = (
'零一二三四五六七八九零一二三四五六七八九'
'零一二三四五六七八九零一二三四五六七八九'
)
ASCII_LONG = MAINTAINER_ASCII_LONG
CJK_LONG = MAINTAINER_CJK_LONG
def test_filled_banner_matches_display_width(self):
line = filled('TASKS RECAP', self.COLUMNS)
self.assertEqual(get_text_width(line), self.LINE_WIDTH)
self.assertTrue(line.endswith('*'))
def test_filled_separator_matches_display_width(self):
line = filled('', self.COLUMNS, fchar='=')
self.assertEqual(get_text_width(line), self.LINE_WIDTH)
self.assertEqual(line, '=' * self.LINE_WIDTH)
def test_truncate_name_shortens_ascii_to_display_width(self):
truncated = truncate_name(self.ASCII_LONG, 71)
self.assertLessEqual(get_text_width(truncated), 71)
self.assertTrue(truncated.endswith('...'))
def test_truncate_name_shortens_cjk_to_display_width(self):
truncated = truncate_name(self.CJK_LONG, 71)
self.assertLessEqual(get_text_width(truncated), 71)
self.assertTrue(truncated.endswith('...'))
def test_truncate_name_leaves_short_names_unchanged(self):
short = 'Short task'
self.assertEqual(truncate_name(short, 71), short)
self.assertEqual(truncate_name(self.CJK_LONG[:5], 71), self.CJK_LONG[:5])
def test_format_timing_row_ascii_fits_terminal_width(self):
row = format_timing_row(self.ASCII_LONG, 0.01, self.COLUMNS, truncate=True)
self.assertEqual(get_text_width(row), self.LINE_WIDTH)
self.assertIn('0.01s', row)
def test_format_timing_row_cjk_fits_terminal_width(self):
row = format_timing_row(self.CJK_LONG, 0.01, self.COLUMNS, truncate=True)
self.assertEqual(get_text_width(row), self.LINE_WIDTH)
self.assertIn('0.01s', row)
def test_maintainer_cjk_reproducer_fits_under_len_budget_but_not_display_width(self):
self.assertEqual(len(self.MAINTAINER_CJK_LONG), 40)
self.assertEqual(get_text_width(self.MAINTAINER_CJK_LONG), 80)
self.assertGreater(len(self.MAINTAINER_CJK_LONG), 0)
def test_maintainer_cjk_reproducer_truncates_with_ellipsis(self):
truncated = truncate_name(self.MAINTAINER_CJK_LONG, 71)
self.assertLessEqual(get_text_width(truncated), 71)
self.assertTrue(truncated.endswith('...'))
self.assertNotEqual(truncated, self.MAINTAINER_CJK_LONG)
def test_maintainer_ascii_and_cjk_recap_rows_match_terminal_width(self):
ascii_row = format_timing_row(
self.MAINTAINER_ASCII_LONG, 0.01, self.COLUMNS, truncate=True,
)
cjk_row = format_timing_row(
self.MAINTAINER_CJK_LONG, 0.01, self.COLUMNS, truncate=True,
)
self.assertEqual(get_text_width(ascii_row), self.LINE_WIDTH)
self.assertEqual(get_text_width(cjk_row), self.LINE_WIDTH)
self.assertIn('...', ascii_row)
self.assertIn('...', cjk_row)
def test_format_timing_row_uses_dash_padding_for_timing_field(self):
row = format_timing_row('Short task', 0.01, self.COLUMNS, truncate=True)
self.assertTrue(row.endswith('--- 0.01s'))
self.assertEqual(get_text_width(row), self.LINE_WIDTH)
def test_pad_to_display_width_handles_cjk(self):
padded = pad_to_display_width(self.MAINTAINER_CJK_LONG[:5] + u' ', 71)
self.assertEqual(get_text_width(padded), 71)
self.assertTrue(padded.endswith('-'))
def test_format_timing_row_cjk_timing_suffix_matches_ascii(self):
ascii_row = format_timing_row(self.MAINTAINER_ASCII_LONG, 0.01, self.COLUMNS, truncate=True)
cjk_row = format_timing_row(self.MAINTAINER_CJK_LONG, 0.01, self.COLUMNS, truncate=True)
self.assertTrue(ascii_row.endswith('--- 0.01s'))
self.assertTrue(cjk_row.endswith('--- 0.01s'))
self.assertNotIn('----', cjk_row)
self.assertEqual(
get_text_width(ascii_row[:ascii_row.rindex('.')]),
get_text_width(cjk_row[:cjk_row.rindex('.')]),
)