fix: avoid project cache creation in offline mode (#5066)

Signed-off-by: go165 <196723798+go165@users.noreply.github.com>
Co-authored-by: go165 <196723798+go165@users.noreply.github.com>
Co-authored-by: RAKESH S <124438543+rockygeekz@users.noreply.github.com>

Author: 3 people

src/ansiblelint/__main__.py

@@ -143,26 +143,28 @@ def initialize_options(arguments: list[str] | None = None) -> BaseFileLock | Non
         or options.list_rules
         or options.list_tags
     ):
-        options.cache_dir = get_cache_dir(pathlib.Path(options.project_dir))
+        options.cache_dir = get_cache_dir(
+            pathlib.Path(options.project_dir),
+            isolated=not options.offline,
+        )
 
     options.project_dir = Path(options.project_dir).resolve().as_posix()
 
     # add a lock file so we do not have two instances running inside at the same time
-    if options.cache_dir:
+    if options.cache_dir and not options.offline:
         options.cache_dir.mkdir(parents=True, exist_ok=True)
 
         # lock file can only be used if cache_dir is set and writable
-        if not options.offline:  # pragma: no cover
-            cache_dir_lock = FileLock(
-                f"{options.cache_dir}/.lock",
+        cache_dir_lock = FileLock(
+            f"{options.cache_dir}/.lock",
+        )
+        try:
+            cache_dir_lock.acquire(timeout=180)
+        except Timeout:  # pragma: no cover
+            _logger.error(  # noqa: TRY400
+                "Timeout waiting for another instance of ansible-lint to release the lock.",
             )
-            try:
-                cache_dir_lock.acquire(timeout=180)
-            except Timeout:  # pragma: no cover
-                _logger.error(  # noqa: TRY400
-                    "Timeout waiting for another instance of ansible-lint to release the lock.",
-                )
-                sys.exit(RC.LOCK_TIMEOUT)
+            sys.exit(RC.LOCK_TIMEOUT)
 
     # Avoid extra output noise from Ansible about using devel versions
     if "ANSIBLE_DEVEL_WARNING" not in os.environ:  # pragma: no branch

src/ansiblelint/app.py

@@ -49,7 +49,7 @@ def __init__(self, options: Options):
         # Without require_module, our _set_collections_basedir may fail
         self.runtime = Runtime(
             project_dir=Path(options.project_dir),
-            isolated=True,
+            isolated=not options.offline,
             require_module=True,
             verbosity=options.verbosity,
         )
@@ -403,6 +403,19 @@ def _add_collections_path_if_needed(
             collections_paths.insert(0, str(mock_path))
 
 
+def _add_module_path_if_needed(
+    options: Options,
+    module_paths: list[str],
+) -> None:
+    """Add plain mock modules path to module_paths if module mocks exist."""
+    if options.cache_dir and any(
+        len(module_name.split(".")) < 3 for module_name in options.mock_modules
+    ):
+        mock_path = options.cache_dir / "modules"
+        if str(mock_path) not in module_paths:
+            module_paths.insert(0, str(mock_path))
+
+
 def get_app(*, offline: bool | None = None, cached: bool = False) -> App:
     """Return the application instance, caching the return value."""
     # Avoids ever running the app initialization twice if cached argument
@@ -445,6 +458,7 @@ def get_app(*, offline: bool | None = None, cached: bool = False) -> App:
 
     # https://github.com/ansible/ansible-lint/issues/4973
     _add_collections_path_if_needed(app.options, app.runtime.config.collections_paths)
+    _add_module_path_if_needed(app.options, app.runtime.config.default_module_path)
 
     app.runtime.prepare_environment(
         install_local=(not offline),

test/test_app.py

@@ -79,6 +79,36 @@ def test_app_fixed_violations_coverage(tmp_path: Path) -> None:
     assert exit_code == RC.FIXED_VIOLATIONS
 
 
+def test_add_module_path_for_plain_mock_modules(tmp_path: Path) -> None:
+    """Plain module mocks are exposed through Ansible's module path."""
+    from ansiblelint.app import _add_module_path_if_needed
+    from ansiblelint.config import Options
+
+    options = Options()
+    options.cache_dir = tmp_path / ".ansible"
+    options.mock_modules = ["zuul_return", "ns.coll.mod"]
+    module_paths = ["/usr/share/ansible/plugins/modules"]
+
+    _add_module_path_if_needed(options, module_paths)
+
+    assert module_paths[0] == str(options.cache_dir / "modules")
+
+
+def test_add_module_path_skips_collection_only_mocks(tmp_path: Path) -> None:
+    """Collection module mocks are exposed through collection paths instead."""
+    from ansiblelint.app import _add_module_path_if_needed
+    from ansiblelint.config import Options
+
+    options = Options()
+    options.cache_dir = tmp_path / ".ansible"
+    options.mock_modules = ["ns.coll.mod"]
+    module_paths = ["/usr/share/ansible/plugins/modules"]
+
+    _add_module_path_if_needed(options, module_paths)
+
+    assert module_paths == ["/usr/share/ansible/plugins/modules"]
+
+
 def test_ignore_file_with_skip_and_strict(tmp_path: Path) -> None:
     """Test that .ansible-lint-ignore with skip qualifier returns exit code 0 with --strict.
 

test/test_main.py

@@ -7,6 +7,7 @@
 import tempfile
 import time
 from collections.abc import Mapping
+from copy import deepcopy
 from http.client import RemoteDisconnected
 from os.path import abspath
 from pathlib import Path
@@ -121,6 +122,47 @@ def test_get_version_warning_offline(mocker: MockerFixture) -> None:
         assert get_version_warning() == ""  # noqa: PLC1901
 
 
+@pytest.mark.parametrize(
+    ("offline", "cache_created"),
+    (
+        pytest.param(True, False, id="offline"),
+        pytest.param(False, True, id="online"),
+    ),
+)
+def test_initialize_options_cache_dir_creation(
+    tmp_path: Path,
+    offline: bool,
+    cache_created: bool,
+) -> None:
+    """Check that offline mode does not create an isolated cache directory."""
+    from ansiblelint.__main__ import initialize_options
+
+    old_options = deepcopy(options)
+    project_dir = tmp_path / "project"
+    project_dir.mkdir()
+    cache_dir = project_dir / ".ansible"
+
+    arguments = ["--config-file", "/dev/null", "--project-dir", str(project_dir)]
+    if offline:
+        arguments.append("--offline")
+
+    cache_dir_lock = initialize_options(arguments)
+    try:
+        expected_cache_dir = (
+            Path(os.environ.get("ANSIBLE_HOME", "~/.ansible")).expanduser()
+            if offline
+            else cache_dir
+        )
+        assert options.cache_dir == expected_cache_dir
+        assert cache_dir.exists() is cache_created
+    finally:
+        if cache_dir_lock:
+            cache_dir_lock.release()
+            Path(cache_dir_lock.lock_file).unlink(missing_ok=True)
+        options.__dict__.clear()
+        options.__dict__.update(old_options.__dict__)
+
+
 @pytest.mark.parametrize(
     ("lintable"),
     (