From 68707471bf690a10a362b21ab5eabd4732124e10 Mon Sep 17 00:00:00 2001
From: David Shrewsbury <Shrews@users.noreply.github.com>
Date: Thu, 20 Jun 2024 10:30:44 -0400
Subject: [PATCH] Guarantee collection base path exists (#683)

---
 src/ansible_builder/containerfile.py             |  4 ++++
 .../empty_galaxy_reqs/execution-environment.yml  | 16 ++++++++++++++++
 test/integration/test_build.py                   | 16 ++++++++++++++++
 test/unit/test_containerfile.py                  |  6 ++++++
 4 files changed, 42 insertions(+)
 create mode 100644 test/data/v3/empty_galaxy_reqs/execution-environment.yml

diff --git a/src/ansible_builder/containerfile.py b/src/ansible_builder/containerfile.py
index c0c70513..6a516d5d 100644
--- a/src/ansible_builder/containerfile.py
+++ b/src/ansible_builder/containerfile.py
@@ -434,6 +434,10 @@ def _prepare_galaxy_install_steps(self) -> None:
             # in the final image.
             env = "ANSIBLE_GALAXY_DISABLE_GPG_VERIFY=1 "
 
+        # If nothing actually gets installed, make sure this directory will exist
+        # to prevent the COPY step from failing later.
+        self.steps.append(f"RUN mkdir -p {os.path.dirname(constants.base_collections_path.rstrip('/'))}")
+
         self.steps.append(
             f"RUN ansible-galaxy role install $ANSIBLE_GALAXY_CLI_ROLE_OPTS "
             f"-r {constants.STD_GALAXY_FILENAME}"
diff --git a/test/data/v3/empty_galaxy_reqs/execution-environment.yml b/test/data/v3/empty_galaxy_reqs/execution-environment.yml
new file mode 100644
index 00000000..bafb6ab7
--- /dev/null
+++ b/test/data/v3/empty_galaxy_reqs/execution-environment.yml
@@ -0,0 +1,16 @@
+version: 3
+
+images:
+  base_image:
+    name: quay.io/centos/centos:stream9
+
+dependencies:
+  ansible_core:
+    package_pip: ansible-core
+  ansible_runner:
+    package_pip: ansible-runner
+  galaxy:
+    collections: []
+
+options:
+  package_manager_path: '/bin/true'
diff --git a/test/integration/test_build.py b/test/integration/test_build.py
index ed82b23b..2e6b70ee 100644
--- a/test/integration/test_build.py
+++ b/test/integration/test_build.py
@@ -282,3 +282,19 @@ def test_extra_build_cli_args(cli, runtime, data_dir, ee_tag, tmp_path):
                  allow_error=True)
 
     assert secret_string in result.stdout
+
+
+@pytest.mark.test_all_runtimes
+def test_empty_galaxy_requirements(cli, runtime, data_dir, ee_tag, tmp_path):
+    """
+    Make sure empty galaxy requirements do not cause the build to fail.
+
+    Bug fix for issues #290 and #641
+    """
+    ee_def = data_dir / 'v3' / 'empty_galaxy_reqs' / 'execution-environment.yml'
+
+    result = cli(f'ansible-builder build --no-cache -c {tmp_path} -f {ee_def} -t {ee_tag} '
+                 f'--container-runtime {runtime} -v 3 ',
+                 allow_error=True)
+
+    assert result.rc == 0
diff --git a/test/unit/test_containerfile.py b/test/unit/test_containerfile.py
index 5cf37cbe..aeaae757 100644
--- a/test/unit/test_containerfile.py
+++ b/test/unit/test_containerfile.py
@@ -1,3 +1,5 @@
+import os
+
 from ansible_builder import constants
 from ansible_builder.containerfile import Containerfile
 from ansible_builder.user_definition import UserDefinition
@@ -50,6 +52,7 @@ def test_prepare_galaxy_install_steps(build_dir_and_ee_yml):
     c = make_containerfile(tmpdir, ee_path)
     c._prepare_galaxy_install_steps()
     expected = [
+        f"RUN mkdir -p {os.path.dirname(constants.base_collections_path.rstrip('/'))}",
         f"RUN ansible-galaxy role install $ANSIBLE_GALAXY_CLI_ROLE_OPTS "
         f"-r {constants.STD_GALAXY_FILENAME} --roles-path \"{constants.base_roles_path}\"",
         f"RUN ANSIBLE_GALAXY_DISABLE_GPG_VERIFY=1 ansible-galaxy collection install "
@@ -68,6 +71,7 @@ def test_prepare_galaxy_install_steps_with_keyring(build_dir_and_ee_yml):
     c = make_containerfile(tmpdir, ee_path, galaxy_keyring=constants.default_keyring_name)
     c._prepare_galaxy_install_steps()
     expected = [
+        f"RUN mkdir -p {os.path.dirname(constants.base_collections_path.rstrip('/'))}",
         f"RUN ansible-galaxy role install $ANSIBLE_GALAXY_CLI_ROLE_OPTS "
         f"-r {constants.STD_GALAXY_FILENAME} --roles-path \"{constants.base_roles_path}\"",
         f"RUN ansible-galaxy collection install $ANSIBLE_GALAXY_CLI_COLLECTION_OPTS "
@@ -89,6 +93,7 @@ def test_prepare_galaxy_install_steps_with_sigcount(build_dir_and_ee_yml):
                            galaxy_required_valid_signature_count=sig_count)
     c._prepare_galaxy_install_steps()
     expected = [
+        f"RUN mkdir -p {os.path.dirname(constants.base_collections_path.rstrip('/'))}",
         f"RUN ansible-galaxy role install $ANSIBLE_GALAXY_CLI_ROLE_OPTS "
         f"-r {constants.STD_GALAXY_FILENAME} --roles-path \"{constants.base_roles_path}\"",
         f"RUN ansible-galaxy collection install $ANSIBLE_GALAXY_CLI_COLLECTION_OPTS "
@@ -111,6 +116,7 @@ def test_prepare_galaxy_install_steps_with_ignore_code(build_dir_and_ee_yml):
                            galaxy_ignore_signature_status_codes=codes)
     c._prepare_galaxy_install_steps()
     expected = [
+        f"RUN mkdir -p {os.path.dirname(constants.base_collections_path.rstrip('/'))}",
         f"RUN ansible-galaxy role install $ANSIBLE_GALAXY_CLI_ROLE_OPTS "
         f"-r {constants.STD_GALAXY_FILENAME} --roles-path \"{constants.base_roles_path}\"",
         f"RUN ansible-galaxy collection install $ANSIBLE_GALAXY_CLI_COLLECTION_OPTS "