14 Commits
Author SHA1 Message Date
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
Hideki SaitoandGitHub e98d9a0756 Release 2.2.2 commit (#771)
Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-07-13 10:14:46 +09:00
Hideki SaitoandGitHub 73939ba8ff Update README Support section to reference Red Hat Automation Hub (#768) (#770)
Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-07-08 15:11:56 +09:00
Hideki SaitoandGitHub 2504f532b8 Remove meta-runtime[unsupported-version] line from the skip_list (#767) (#769)
Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-07-08 11:43:37 +09:00
Hideki SaitoandGitHub 4ac4603af5 Release 2.2.1 commit (#765)
2.2.1 release

Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-07-02 10:43:07 +09:00
Hideki SaitoandGitHub a4805b92b7 Fixes the symlink handling issue in the authorized_key module (#760) (#762)
- Addresses CVE-2026-11837
- Fixes #759

Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-07-01 12:30:27 +09:00
Hideki SaitoandGitHub ee1461f46c Replace remote test env RHEL9.7 and 10.1 with 9.8 and 10.2 (#764)
- Replace 9.7 with 9.8
- Replace 10.1 with 10.2
- Addresses https://github.com/ansible/ansible/pull/87120

Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-07-01 11:56:25 +09:00
Hideki SaitoandGitHub 78fb77c8d5 Replace AZP remote test FreeBSD-14.2 with 14.3 for Ansible Core 2.19 (#755) (#756)
(cherry picked from commit 674315f2da)

Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-06-10 12:54:21 +09:00
Hideki SaitoandGitHub d4ac6f63f4 [CI] AZP bump test container version to 8.0.0 (#751) (#752)
- Bump test container version to 8.0.0 for Ansible Core 2.18+
- Keep using 7.0.0 for Ansible Core 2.16 and 2.17. Both versions don't support Python3.13.


(cherry picked from commit f7945c4bc9)

Signed-off-by: Hideki Saito <saito@fgrep.org>
2026-06-02 10:04:19 +09:00
b42cbb2a97 authorized_key: Use loop instead of with_file in example (#740) (#749)
Fixes: #607


(cherry picked from commit af933670cc)

Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2026-05-27 17:01:01 +09:00
aaacdb9d13 In FreeBSD, fail if loader.conf shall be reloaded. (#664) (#748)
Fix #663

(cherry picked from commit 3c232a2429)

Co-authored-by: Vladimir Botka <vbotka@gmail.com>
2026-05-27 15:45:16 +09:00
955acdca44 docs: added attributes metadata for check_mode support (fixes #643) (#741) (#747)
(cherry picked from commit 9cd0a1f0ef)

Co-authored-by: Patrick Kingston <66141901+pkingstonxyz@users.noreply.github.com>
Co-authored-by: jkhall81 <jason.kei.hall@gmail.com>
2026-05-27 14:18:58 +09:00
21 changed files with 447 additions and 42 deletions
-1
View File
@@ -4,7 +4,6 @@
# SPDX-FileCopyrightText: 2024, Ansible Project
skip_list:
- meta-runtime[unsupported-version] # This rule doesn't make any sense
- fqcn[deep] # This rule produces false positives for files in tests/unit/plugins/action/fixtures/
- sanity[cannot-ignore] # This rule is skipped to keep backward compatibility with Python 2
+16 -9
View File
@@ -37,8 +37,9 @@ variables:
resources:
containers:
- container: default
image: quay.io/ansible/azure-pipelines-test-container:8.0.0
- container: legacy
image: quay.io/ansible/azure-pipelines-test-container:7.0.0
pool: Standard
stages:
@@ -128,6 +129,7 @@ stages:
jobs:
- template: templates/matrix.yml
parameters:
container: legacy
nameFormat: "{0}"
testFormat: 2.17/{0}
targets:
@@ -145,6 +147,7 @@ stages:
jobs:
- template: templates/matrix.yml
parameters:
container: legacy
nameFormat: "{0}"
testFormat: 2.16/{0}
targets:
@@ -237,6 +240,7 @@ stages:
jobs:
- template: templates/matrix.yml
parameters:
container: legacy
testFormat: 2.17/linux/{0}/1
targets:
- name: Fedora 39
@@ -250,6 +254,7 @@ stages:
jobs:
- template: templates/matrix.yml
parameters:
container: legacy
testFormat: 2.16/linux/{0}/1
targets:
- name: Fedora 38
@@ -266,14 +271,14 @@ stages:
parameters:
testFormat: devel/{0}/1
targets:
- name: RHEL 10.1
test: rhel/10.1
- name: RHEL 9.7
test: rhel/9.7
- name: RHEL 10.2
test: rhel/10.2
- name: RHEL 9.8
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
@@ -321,8 +326,8 @@ stages:
test: rhel/10.1
- name: RHEL 9.7
test: rhel/9.7
- name: FreeBSD 14.2
test: freebsd/14.2
- name: FreeBSD 14.3
test: freebsd/14.3
- name: FreeBSD 13.5
test: freebsd/13.5
@@ -347,6 +352,7 @@ stages:
jobs:
- template: templates/matrix.yml
parameters:
container: legacy
testFormat: 2.17/{0}/1
targets:
- name: RHEL 10.0
@@ -360,6 +366,7 @@ stages:
jobs:
- template: templates/matrix.yml
parameters:
container: legacy
testFormat: 2.16/{0}/1
targets:
- name: RHEL 10.1
+7
View File
@@ -14,6 +14,12 @@ parameters:
type: object
default: []
# An optional container resource name to use for the test jobs.
# Defaults to "default" if not specified.
- name: container
type: string
default: default
# An optional format string used to generate the job name.
# - {0} is the name of an item in the targets list.
- name: nameFormat
@@ -43,6 +49,7 @@ parameters:
jobs:
- template: test.yml
parameters:
container: ${{ parameters.container }}
jobs:
- ${{ if eq(length(parameters.groups), 0) }}:
- ${{ each target in parameters.targets }}:
+7 -1
View File
@@ -7,11 +7,17 @@ parameters:
- name: jobs
type: object
# An optional container resource name to use for the test jobs.
# Defaults to "default" if not specified.
- name: container
type: string
default: default
jobs:
- ${{ each job in parameters.jobs }}:
- job: test_${{ replace(replace(replace(job.test, '/', '_'), '.', '_'), '-', '_') }}
displayName: ${{ job.name }}
container: default
container: ${{ parameters.container }}
workspace:
clean: all
steps:
+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
+37
View File
@@ -4,6 +4,43 @@ ansible.posix Release Notes
.. contents:: Topics
v2.2.2
======
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.2.1
Bugfixes
--------
- README - Added ``Red Hat Automation Hub`` as correct contact information for Red Hat Ansible Automation Platform subscribers.
v2.2.1
======
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.2.0
Security Fixes
--------------
- authorized_key - fix local privilege escalation via symlink-following when running as root (https://github.com/ansible-collections/ansible.posix/issues/759).
Bugfixes
--------
- sysctl - reload sysctl only if the sysctl file is ``/etc/sysctl.conf`` or ``/etc/sysctl.conf.local`` (https://github.com/ansible-collections/ansible.posix/issues/663).
v2.2.0
======
+2 -1
View File
@@ -99,7 +99,8 @@ We welcome community contributions to this collection. For more details, see [Co
## Support
See [Communication](#Communication) section.
* Community users can find help through the [Communication](#Communication) section.
* Red Hat Ansible Automation Platform subscribers can request support through [Automation Hub](https://console.redhat.com/ansible/automation-hub/collections/published/ansible/posix/) by using the "Create issue" button on the collection page.
## Release Notes and Roadmap
+41
View File
@@ -578,3 +578,44 @@ releases:
- firewalld_info_warnings.yml
- patch_removed.yml
release_date: '2026-05-18'
2.2.1:
changes:
bugfixes:
- sysctl - reload sysctl only if the sysctl file is ``/etc/sysctl.conf`` or
``/etc/sysctl.conf.local`` (https://github.com/ansible-collections/ansible.posix/issues/663).
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.2.0'
security_fixes:
- authorized_key - fix local privilege escalation via symlink-following when
running as root (https://github.com/ansible-collections/ansible.posix/issues/759).
fragments:
- 2.2.1.yml
- 643-sysctl-docs.yml
- 751_ci_test_container_update.yml
- 755_ci_test_container_update.yml
- 759_cve_2026_11837.yml
- 763_ci_azp_update_devel.yml
- freebsd_sysctl.yml
release_date: '2026-07-01'
2.2.2:
changes:
bugfixes:
- README - Added ``Red Hat Automation Hub`` as correct contact information for
Red Hat Ansible Automation Platform subscribers.
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.2.1'
fragments:
- 2.2.2.yml
- 767_remove_unsupported_version_skip.yml
- 768_update_support_section.yml
release_date: '2026-07-08'
@@ -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.
...
+1 -1
View File
@@ -1,7 +1,7 @@
---
namespace: ansible
name: posix
version: 2.2.0
version: 2.2.2
readme: README.md
authors:
- Ansible (github.com/ansible)
+90 -15
View File
@@ -63,6 +63,17 @@ DOCUMENTATION = '''
- section: callback_profile_tasks
key: datetime_format
version_added: 3.0.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)
+25 -12
View File
@@ -121,10 +121,10 @@ EXAMPLES = r'''
ansible.posix.authorized_key:
user: deploy
state: present
key: '{{ item }}'
with_file:
- public_keys/doe-jane
- public_keys/doe-john
key: "{{ lookup('file', item) }}"
loop:
- public_keys/doe-jane
- public_keys/doe-john
- name: Set authorized key defining key options
ansible.posix.authorized_key:
@@ -307,6 +307,17 @@ class keydict(dict):
return [item[1] for item in self.items()]
def _safe_open_write(module, path, follow):
flags = os.O_WRONLY | os.O_CREAT | os.O_TRUNC
if not follow and hasattr(os, 'O_NOFOLLOW'):
flags |= os.O_NOFOLLOW
try:
fd = os.open(path, flags, int('0600', 8))
except OSError as e:
module.fail_json(msg="File open failed %s : %s" % (path, to_native(e)))
return fd
def keyfile(module, user, write=False, path=None, manage_dir=True, follow=False):
"""
Calculate name of authorized keys file, optionally creating the
@@ -359,7 +370,7 @@ def keyfile(module, user, write=False, path=None, manage_dir=True, follow=False)
module.fail_json(msg="Failed to create directory %s : %s" % (sshdir, to_native(e)))
if module.selinux_enabled():
module.set_default_selinux_context(sshdir, False)
os.chown(sshdir, uid, gid)
os.chown(sshdir, uid, gid, follow_symlinks=follow)
os.chmod(sshdir, int('0700', 8))
if not os.path.exists(keysfile):
@@ -367,16 +378,13 @@ def keyfile(module, user, write=False, path=None, manage_dir=True, follow=False)
if not os.path.exists(basedir):
os.makedirs(basedir)
f = None
try:
f = open(keysfile, "w") # touches file so we can set ownership and perms
finally:
f.close()
fd = _safe_open_write(module, keysfile, follow)
os.close(fd)
if module.selinux_enabled():
module.set_default_selinux_context(keysfile, False)
try:
os.chown(keysfile, uid, gid)
os.chown(keysfile, uid, gid, follow_symlinks=follow)
os.chmod(keysfile, int('0600', 8))
except OSError:
pass
@@ -607,7 +615,7 @@ def enforce_state(module, params):
# check current state -- just get the filename, don't create file
do_write = False
params["keyfile"] = keyfile(module, user, do_write, path, manage_dir)
params["keyfile"] = keyfile(module, user, do_write, path, manage_dir, follow)
existing_content = readfile(module, params["keyfile"])
existing_keys = parsekeys(module, existing_content)
@@ -696,6 +704,11 @@ def enforce_state(module, params):
if not module.check_mode:
writefile(module, filename, new_content)
user_entry = pwd.getpwnam(user)
uid = user_entry.pw_uid
gid = user_entry.pw_gid
os.chown(filename, uid, gid, follow_symlinks=follow)
os.chmod(filename, int('0600', 8))
params['changed'] = True
return params
+17
View File
@@ -44,6 +44,7 @@ options:
- If V(true), performs a C(/sbin/sysctl -p) if the O(sysctl_file) is
updated. If V(false), does not reload C(sysctl) even if the
O(sysctl_file) is updated.
- For FreeBSD, can not be used with O(sysctl_file) other than C(/etc/sysctl.conf) or C(/etc/sysctl.conf.local).
type: bool
default: true
sysctl_file:
@@ -56,6 +57,17 @@ options:
- Verify token value with the sysctl command and set with C(-w) if necessary.
type: bool
default: false
attributes:
check_mode:
support: full
description: Can run in check_mode and return changed status prediction without modifying target.
diff_mode:
support: none
description: Does not support differences output.
platform:
platforms: posix
support: full
description: Supported on POSIX-compliant systems.
author:
- David CHANIAL (@davixx)
'''
@@ -155,6 +167,11 @@ class SysctlModule(object):
self.platform = platform.system().lower()
# system specific tests
freebsd_sysctl_files = ['/etc/sysctl.conf', '/etc/sysctl.conf.local']
if self.platform == 'freebsd' and self.sysctl_file not in freebsd_sysctl_files and self.args['reload']:
self.module.fail_json(msg="%s can not be reloaded. Set reload=False." % self.sysctl_file)
# Whitespace is bad
self.args['name'] = self.args['name'].strip()
self.args['value'] = self._parse_value(self.args['value'])
@@ -0,0 +1,22 @@
---
#
# Check: keysfile is symlink and follow=false
#
- name: Try to add key with keysfile as symlink
ansible.posix.authorized_key:
user: testuser
key: "{{ rsa_key_basic }}"
state: present
manage_dir: false
follow: false
- name: Assert target file ownership unchanged
ansible.builtin.stat:
path: /tmp/symlink_test_target/target_file
register: target_file_stat
- name: Verify target file is still owned by root
ansible.builtin.assert:
that:
- target_file_stat.stat.uid == 0
...
@@ -0,0 +1,12 @@
---
- name: Remove testuser
ansible.builtin.user:
name: testuser
state: absent
remove: true
- name: Remove symlink target directory
ansible.builtin.file:
path: /tmp/symlink_test_target
state: absent
...
@@ -0,0 +1,38 @@
---
- name: Create testuser for symlink tests
ansible.builtin.user:
name: testuser
create_home: true
register: testuser_result
- name: Create symlink target directory
ansible.builtin.file:
path: /tmp/symlink_test_target
state: directory
owner: root
mode: '0700'
- name: Create a target file owned by root
ansible.builtin.copy:
dest: /tmp/symlink_test_target/target_file
content: "sensitive data"
owner: root
mode: '0600'
- name: Remove .ssh directory if exists
ansible.builtin.file:
path: "{{ testuser_result.home }}/.ssh"
state: absent
- name: Create .ssh directory
ansible.builtin.file:
path: "{{ testuser_result.home }}/.ssh"
state: directory
mode: '0700'
- name: Create symlink from authorized_keys to target file
ansible.builtin.file:
src: /tmp/symlink_test_target/target_file
dest: "{{ testuser_result.home }}/.ssh/authorized_keys"
state: link
...
@@ -17,7 +17,7 @@
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
- name: Setup testing environment
- name: Setup for testing environment
ansible.builtin.import_tasks: setup_steps.yml
- name: Test for multiple keys handling
@@ -37,3 +37,12 @@
- name: Test for permission denied files
ansible.builtin.import_tasks: check_permissions.yml
- name: CVE-2026-11837 Setup for symlink tests
ansible.builtin.import_tasks: check_symlink_setup.yml
- name: CVE-2026-11837 Test for symlink tests
ansible.builtin.import_tasks: check_symlink.yml
- name: CVE-2026-11837 Cleanup symlink test
ansible.builtin.import_tasks: check_symlink_cleanup.yml
@@ -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('.')]),
)