Relax ruamel-yaml requirements (#3433)

.config/requirements-lock.txt

@@ -26,7 +26,7 @@ pygments==2.15.1
 pyrsistent==0.19.3
 pyyaml==6.0
 rich==13.3.5
-ruamel-yaml==0.17.24
+ruamel-yaml==0.17.26
 subprocess-tee==0.4.1
 tomli==2.0.1
 typing-extensions==4.5.0

.config/requirements-test.txt

@@ -10,6 +10,7 @@ pytest >= 7.2.2
 pytest-mock
 pytest-plus >= 0.2 # for PYTEST_REQPASS
 pytest-xdist >= 2.1.0
+ruamel.yaml>=0.17.26,<0.18 # only the latest is expected to pass our tests
 ruamel-yaml-clib  # needed for mypy
 spdx-tools >= 0.7.1 # Apache
 types-jsonschema # IDE support

.config/requirements.in

@@ -8,7 +8,7 @@ jsonschema>=4.10.0 # MIT, version needed for improved errors
 packaging>=21.3 # Apache-2.0,BSD-2-Clause
 pyyaml>=5.4.1 # MIT (centos 9 has 5.3.1)
 rich>=12.0.0 # MIT
-ruamel.yaml>=0.17.24,<0.18 # MIT, next version is planned to have breaking changes
+ruamel.yaml>=0.17.0,<0.18 # MIT, next version is planned to have breaking changes
 subprocess-tee>=0.4.1 # MIT, used by ansible-compat
 yamllint >= 1.30.0 # GPLv3
 wcmatch>=8.1.2 # MIT

.config/requirements.txt

@@ -88,7 +88,7 @@ rdflib==6.3.2
 regex==2023.3.23
 requests==2.28.2
 rich==13.3.5
-ruamel-yaml==0.17.24
+ruamel-yaml==0.17.26
 six==1.16.0
 soupsieve==2.4
 spdx-tools==0.7.1

.pre-commit-config.yaml

@@ -153,7 +153,7 @@ repos:
           - jinja2
           - pytest>=7.2.2
           - rich>=13.2.0
-          - ruamel-yaml>=0.17.24
+          - ruamel-yaml>=0.17.26
           - ruamel-yaml-clib>=0.2.7
           - spdx-tools
           - subprocess-tee
@@ -183,7 +183,7 @@ repos:
           - pytest>=7.2.2
           - pyyaml
           - rich>=13.2.0
-          - ruamel-yaml>=0.17.24
+          - ruamel-yaml>=0.17.26
           - ruamel-yaml-clib>=0.2.7
           - spdx-tools
           - typing_extensions

src/ansiblelint/__main__.py

@@ -32,9 +32,9 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Callable, TextIO
 
-from ansible_compat.config import ansible_version
 from ansible_compat.prerun import get_cache_dir
 from filelock import FileLock, Timeout
+from rich.markup import escape
 
 from ansiblelint import cli
 from ansiblelint._mockings import _perform_mockings_cleanup
@@ -46,7 +46,13 @@
     reconfigure,
     render_yaml,
 )
-from ansiblelint.config import Options, get_version_warning, log_entries, options
+from ansiblelint.config import (
+    Options,
+    get_deps_versions,
+    get_version_warning,
+    log_entries,
+    options,
+)
 from ansiblelint.constants import RC
 from ansiblelint.loaders import load_ignore_txt
 from ansiblelint.skip_utils import normalize_tag
@@ -208,9 +214,12 @@ def main(argv: list[str] | None = None) -> int:  # noqa: C901
     reconfigure(console_options)
 
     if options.version:
-        console.print(
-            f"ansible-lint [repr.number]{__version__}[/] using ansible [repr.number]{ansible_version()}[/]",
-        )
+        deps = get_deps_versions()
+        msg = f"ansible-lint [repr.number]{__version__}[/] using[dim]"
+        for k, v in deps.items():
+            msg += f" {escape(k)}:[repr.number]{v}[/]"
+        msg += "[/]"
+        console.print(msg, markup=True, highlight=False)
         msg = get_version_warning()
         if msg:
             console.print(msg)
@@ -252,6 +261,16 @@ def main(argv: list[str] | None = None) -> int:  # noqa: C901
     result = _get_matches(rules, options)
 
     if options.write_list:
+        ruamel_safe_version = "0.17.26"
+        from packaging.version import Version
+        from ruamel.yaml import __version__ as ruamel_yaml_version_str
+
+        if Version(ruamel_safe_version) > Version(ruamel_yaml_version_str):
+            _logger.warning(
+                "We detected use of `--write` feature with a buggy ruamel-yaml %s library instead of >=%s, upgrade it before reporting any bugs like dropped comments.",
+                ruamel_yaml_version_str,
+                ruamel_safe_version,
+            )
         _do_transform(result, options)
 
     mark_as_success = True

src/ansiblelint/config.py

@@ -10,6 +10,7 @@
 import warnings
 from dataclasses import dataclass, field
 from functools import lru_cache
+from importlib.metadata import PackageNotFoundError, version
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 from urllib.error import HTTPError, URLError
@@ -240,6 +241,18 @@ def guess_install_method() -> str:
     return pip if use_pip else ""
 
 
+def get_deps_versions() -> dict[str, Version | None]:
+    """Return versions of most important dependencies."""
+    result: dict[str, Version | None] = {}
+
+    for name in ["ansible-core", "ruamel-yaml", "ruamel-yaml-clib"]:
+        try:
+            result[name] = Version(version(name))
+        except PackageNotFoundError:
+            result[name] = None
+    return result
+
+
 def get_version_warning() -> str:
     """Display warning if current version is outdated."""
     # 0.1dev1 is special fallback version