fix(devel): drop --driver-name from init scenario, patch molecule.yml… (#358)

* fix(devel): drop --driver-name from init scenario, patch molecule.yml for Molecule 4.x

Made-with: Cursor

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* linting fixes

* force pipeline to re-run due to timeout on last job

* revert dict sort back

* XFAIL fixes?

* fix role init

* remove linting not needed

* remove --role-name

* fix docker test?

* docker fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 2 people

.config/dictionary.txt

@@ -2,47 +2,78 @@ Libera
 OAEP
 Sbarnea
 Sorin
+addopts
+allitems
 assumeyes
 azcollection
+bindep
+buildargs
 cachier
 calver
+certdir
 cgroupfs
 cgroupns
 codespell
+confpath
+contentdir
+cpuset
 createdbymolecule
 devel
 dockerfiles
+endraw
 endmacro
+equalto
 esxi
+Freenode
+FIPS
 fqcn
+fstack
 googleapiclient
+insertafter
+iitem
+keypair
 keypairs
 libvirtd
 libvirtdoverlayfs
-libvirtdoverlayfs
 lineinfile
 linuxgce
+machineaccount
+makecache
 netns
 noconfirm
 norecursedirs
 numvcpus
 openstacksdk
 overlayfs
 pacman
+passwordless
 polkit
 pypa
 rebake
+resourcegroup
+rpmbuild
 runas
 sameas
+seccomp
 slirp
+snet
+snat
+subnetworks
 tcp_syncookies
+testbox
+testconf
 testinfra
+testrole
+TESTBOX
 tlsverify
 tmpfs
+ulimits
 vagrantdir
 virbr
+virtualnetwork
 virsh
 virtualmachine
+vnet
 westus
 xbps
 xfreerdp

conftest.py

@@ -1,6 +1,7 @@
 import contextlib
 import os
 import random
+import re
 import shutil
 import string
 from pathlib import Path
@@ -78,6 +79,30 @@ def get_molecule_file(path):
     return config.molecule_file(path)
 
 
+def set_driver_in_scenario_molecule_yml(
+    scenario_directory: str, driver_name: str
+) -> None:
+    """Set driver name in molecule.yml after 'molecule init scenario' (no --driver-name).
+
+    Molecule 4.x+ removed --driver-name from 'init scenario'. Init then patch the file.
+    """
+    molecule_yml = os.path.join(scenario_directory, "molecule.yml")
+    with open(molecule_yml) as f:
+        content = f.read()
+    driver_block = f"\ndriver:\n  name: {driver_name}\n"
+    if "driver:" not in content:
+        content = content.replace("---\n", "---" + driver_block, 1)
+    else:
+        content = re.sub(
+            r"(driver:\s*\n\s*name:)\s*\w+",
+            f"\\1 {driver_name}",
+            content,
+            count=1,
+        )
+    with open(molecule_yml, "w") as f:
+        f.write(content)
+
+
 def metadata_lint_update(role_directory: str) -> None:
     # By default, ansible-lint will fail on newly-created roles because the
     # fields in this file have not been changed from their defaults. This is

test/azure/functional/test_azure.py

@@ -24,7 +24,7 @@
 
 import pytest
 
-from conftest import change_dir_to
+from conftest import change_dir_to, set_driver_in_scenario_molecule_yml
 from molecule import logger
 from molecule.app import get_app
 
@@ -69,11 +69,10 @@ def test_azure_command_init_scenario(temp_dir):
             "init",
             "scenario",
             "test_scenario",
-            "--driver-name",
-            "azure",
         ]
         result = get_app(Path()).run_command(cmd)
         assert result.returncode == 0
+        set_driver_in_scenario_molecule_yml(scenario_directory, "azure")
 
         assert os.path.isdir(scenario_directory)
 

test/containers/functional/test_containers.py

@@ -23,7 +23,11 @@
 import os
 from pathlib import Path
 
-from conftest import change_dir_to, molecule_directory
+from conftest import (
+    change_dir_to,
+    molecule_directory,
+    set_driver_in_scenario_molecule_yml,
+)
 from molecule import logger
 from molecule.app import get_app
 
@@ -39,11 +43,10 @@ def test_containers_command_init_scenario(temp_dir):
             "init",
             "scenario",
             "default",
-            "--driver-name",
-            "containers",
         ]
         result = get_app(Path()).run_command(cmd)
         assert result.returncode == 0
+        set_driver_in_scenario_molecule_yml(scenario_directory, "containers")
 
         assert os.path.isdir(scenario_directory)
 

test/docker/test_func.py

@@ -8,12 +8,29 @@
 
 import pytest
 
-from conftest import change_dir_to
+from conftest import change_dir_to, set_driver_in_scenario_molecule_yml
 from molecule import logger
 from molecule.app import get_app
 
 LOG = logger.get_logger(__name__)
 
+# Root of the test/docker tree (for scenario paths)
+TEST_DOCKER_DIR = pathlib.Path(__file__).resolve().parent
+
+
+def is_docker_available() -> bool:
+    """Return True if Docker daemon is reachable (e.g. docker info succeeds)."""
+    try:
+        r = subprocess.run(
+            ["docker", "info"],
+            capture_output=True,
+            timeout=10,
+            check=False,
+        )
+        return r.returncode == 0
+    except (FileNotFoundError, subprocess.TimeoutExpired):
+        return False
+
 
 def format_result(result: subprocess.CompletedProcess):
     """Return friendly representation of completed process run."""
@@ -24,7 +41,10 @@ def format_result(result: subprocess.CompletedProcess):
     )
 
 
-@pytest.mark.skip(reason="broken, fix welcomed")
+@pytest.mark.skipif(
+    not is_docker_available(),
+    reason="Docker not available or daemon not reachable",
+)
 def test_command_init_and_test_scenario(tmp_path: pathlib.Path, DRIVER: str) -> None:
     """Verify that init scenario works."""
     shutil.rmtree(tmp_path, ignore_errors=True)
@@ -38,11 +58,11 @@ def test_command_init_and_test_scenario(tmp_path: pathlib.Path, DRIVER: str) ->
             "molecule",
             "init",
             "scenario",
-            "--driver-name",
-            DRIVER,
+            scenario_name,
         ]
         result = get_app(tmp_path).run_command(cmd)
         assert result.returncode == 0
+        set_driver_in_scenario_molecule_yml(str(scenario_directory), DRIVER)
 
         assert scenario_directory.exists()
 
@@ -63,29 +83,41 @@ def test_command_init_and_test_scenario(tmp_path: pathlib.Path, DRIVER: str) ->
         assert result.returncode == 0
 
 
-@pytest.mark.skip(reason="broken, fix welcomed")
+@pytest.mark.skipif(
+    not is_docker_available(),
+    reason="Docker not available or daemon not reachable",
+)
 def test_command_static_scenario() -> None:
     """Validate that the scenario we included with code still works."""
-    cmd = ["molecule", "test"]
-
-    result = get_app(Path()).run_command(cmd)
-    assert result.returncode == 0
+    scenario_dir = TEST_DOCKER_DIR / "scenarios" / "with-context"
+    with change_dir_to(str(scenario_dir)):
+        result = get_app(Path()).run_command(["molecule", "test"])
+        assert result.returncode == 0
 
 
-@pytest.mark.skip(reason="broken, fix welcomed")
+@pytest.mark.skipif(
+    not is_docker_available(),
+    reason="Docker not available or daemon not reachable",
+)
 def test_dockerfile_with_context() -> None:
     """Verify that Dockerfile.j2 with context works."""
-    with change_dir_to("test/docker/scenarios/with-context"):
-        cmd = ["molecule", "--debug", "test"]
-        result = get_app(Path()).run_command(cmd)
+    scenario_dir = TEST_DOCKER_DIR / "scenarios" / "with-context"
+    with change_dir_to(str(scenario_dir)):
+        result = get_app(Path()).run_command(["molecule", "--debug", "test"])
         assert result.returncode == 0
 
 
-@pytest.mark.skip(reason="broken, fix welcomed")
+@pytest.mark.skipif(
+    not is_docker_available(),
+    reason="Docker not available or daemon not reachable",
+)
 def test_env_substitution() -> None:
     """Verify that env variables in molecule.yml are replaced properly."""
     os.environ["MOLECULE_ROLE_IMAGE"] = "debian:bullseye"
-    with change_dir_to("test/docker/scenarios/env-substitution"):
-        cmd = ["molecule", "--debug", "test"]
-        result = get_app(Path()).run_command(cmd)
-        assert result.returncode == 0
+    try:
+        scenario_dir = TEST_DOCKER_DIR / "scenarios" / "env-substitution"
+        with change_dir_to(str(scenario_dir)):
+            result = get_app(Path()).run_command(["molecule", "--debug", "test"])
+            assert result.returncode == 0
+    finally:
+        os.environ.pop("MOLECULE_ROLE_IMAGE", None)

test/ec2/functional/test_ec2.py

@@ -24,36 +24,37 @@
 
 import pytest
 
-from conftest import change_dir_to, metadata_lint_update
+from conftest import (
+    change_dir_to,
+    set_driver_in_scenario_molecule_yml,
+)
 from molecule import logger
 from molecule.app import get_app
 
 LOG = logger.get_logger(__name__)
 
 
-@pytest.mark.xfail(reason="need to fix template path")
 def test_ec2_command_init_scenario(temp_dir):
+    """Verify init scenario with ec2 driver; run molecule test only with AWS creds."""
     role_directory = os.path.join(temp_dir.strpath, "test-init")
-    cmd = ["molecule", "init", "role", "test-init"]
+    # molecule init role was removed in molecule 25.x; use ansible-galaxy like Azure test
+    cmd = ["ansible-galaxy", "role", "init", "test-init"]
     assert get_app(Path()).run_command(cmd).returncode == 0
-    metadata_lint_update(role_directory)
 
     with change_dir_to(role_directory):
         molecule_directory = pytest.helpers.molecule_directory()
         scenario_directory = os.path.join(molecule_directory, "test-scenario")
-        cmd = [
-            "molecule",
-            "init",
-            "scenario",
-            "test-scenario",
-            "--role_name=test-init",
-            "--driver-name=ec2",
-        ]
+        cmd = ["molecule", "init", "scenario", "test-scenario"]
         assert get_app(Path()).run_command(cmd).returncode == 0
+        set_driver_in_scenario_molecule_yml(scenario_directory, "ec2")
 
         assert os.path.isdir(scenario_directory)
-        os.unlink(os.path.join(scenario_directory, "create.yml"))
-        os.unlink(os.path.join(scenario_directory, "destroy.yml"))
-
-        cmd = ["molecule", "test", "-s", "test-scenario"]
-        assert get_app(Path()).run_command(cmd).returncode == 0
+        has_creds = "AWS_ACCESS_KEY_ID" in os.environ or "AWS_PROFILE" in os.environ
+        if not has_creds:
+            os.unlink(os.path.join(scenario_directory, "create.yml"))
+            os.unlink(os.path.join(scenario_directory, "destroy.yml"))
+
+        # Run full molecule test only when AWS credentials are available
+        if has_creds:
+            cmd = ["molecule", "test", "-s", "test-scenario"]
+            assert get_app(Path()).run_command(cmd).returncode == 0

test/gce/functional/test_func.py

@@ -24,40 +24,38 @@
 
 import pytest
 
-from conftest import change_dir_to, metadata_lint_update
+from conftest import (
+    change_dir_to,
+    set_driver_in_scenario_molecule_yml,
+)
 from molecule import logger
 from molecule.app import get_app
 
 LOG = logger.get_logger(__name__)
 driver_name = __name__.split(".")[0].split("_")[-1]
 
 
-@pytest.mark.xfail(reason="need to fix template path")
 def test_gce_command_init_scenario(temp_dir):
-    """Test init scenario with driver."""
+    """Test init scenario with driver; run molecule test only with GCE creds."""
     role_directory = os.path.join(temp_dir.strpath, "test-init")
-    cmd = ["molecule", "init", "role", "test-init"]
+    # molecule init role was removed in molecule 25.x; use ansible-galaxy like Azure test
+    cmd = ["ansible-galaxy", "role", "init", "test-init"]
     assert get_app(Path()).run_command(cmd).returncode == 0
-    metadata_lint_update(role_directory)
 
     with change_dir_to(role_directory):
         molecule_directory = pytest.helpers.molecule_directory()
         scenario_directory = os.path.join(molecule_directory, "test-scenario")
-        cmd = [
-            "molecule",
-            "init",
-            "scenario",
-            "test-scenario",
-            "--role-name",
-            "test-init",
-            "--driver-name",
-            driver_name,
-        ]
+        cmd = ["molecule", "init", "scenario", "test-scenario"]
         assert get_app(Path()).run_command(cmd).returncode == 0
+        set_driver_in_scenario_molecule_yml(scenario_directory, driver_name)
 
         assert os.path.isdir(scenario_directory)
-        os.unlink(os.path.join(scenario_directory, "create.yml"))
-        os.unlink(os.path.join(scenario_directory, "destroy.yml"))
-
-        cmd = ["molecule", "test", "-s", "test-scenario"]
-        assert get_app(Path()).run_command(cmd).returncode == 0
+        has_creds = "GOOGLE_APPLICATION_CREDENTIALS" in os.environ
+        if not has_creds:
+            os.unlink(os.path.join(scenario_directory, "create.yml"))
+            os.unlink(os.path.join(scenario_directory, "destroy.yml"))
+
+        # Run full molecule test only when GCE credentials are available
+        if has_creds:
+            cmd = ["molecule", "test", "-s", "test-scenario"]
+            assert get_app(Path()).run_command(cmd).returncode == 0