integration tests: Use single test repository

Modify each test module to use a branch (not a git commit) as a reference inside the new integration test repository that contains all integration (e2e) tests for cachi2. Update and improve a few functions inside utils.py Drop unnecessary lines from each Containerfile that were very often duplicated along with the comments. They were tightly coupled with our code printing output of specific files inside of directories coming from pytest. Remove unused "repo" test parameter. Rename "ref" test parameter to "branch". Closes containerbuildsystem#676 Signed-off-by: Michal Šoltis <[email protected]>
slimreaper35 · Jan 27, 2025 · 4a6c0ad · 4a6c0ad
1 parent f45b8b5
commit 4a6c0ad
Show file tree

Hide file tree

Showing 31 changed files with 284 additions and 529 deletions.
diff --git a/tests/integration/test_bundler.py b/tests/integration/test_bundler.py
@@ -13,8 +13,7 @@
     [
         pytest.param(
             utils.TestParameters(
-                repo="https://github.com/cachito-testing/cachi2-bundler.git",
-                ref="malformed_ruby_missing_gemfile",
+                branch="bundler/missing-gemfile",
                 packages=({"path": ".", "type": "bundler"},),
                 check_output=False,
                 check_deps_checksums=False,
@@ -26,8 +25,7 @@
         ),
         pytest.param(
             utils.TestParameters(
-                repo="https://github.com/cachito-testing/cachi2-bundler.git",
-                ref="malformed_ruby_missing_gemfile_lock",
+                branch="bundler/missing-lockfile",
                 packages=({"path": ".", "type": "bundler"},),
                 check_output=False,
                 check_deps_checksums=False,
@@ -39,8 +37,7 @@
         ),
         pytest.param(
             utils.TestParameters(
-                repo="https://github.com/cachito-testing/cachi2-bundler.git",
-                ref="malformed_ruby_missing_git_revision",
+                branch="bundler/missing-git-revision",
                 packages=({"path": ".", "type": "bundler"},),
                 check_output=False,
                 check_deps_checksums=False,
@@ -56,18 +53,15 @@ def test_bundler_packages(
     test_params: utils.TestParameters,
     cachi2_image: utils.ContainerImage,
     tmp_path: Path,
+    test_repo_dir: Path,
     test_data_dir: Path,
     request: pytest.FixtureRequest,
 ) -> None:
     """Integration tests for bundler package manager."""
     test_case = request.node.callspec.id
 
-    source_folder = utils.clone_repository(
-        test_params.repo, test_params.ref, f"{test_case}-source", tmp_path
-    )
-
     utils.fetch_deps_and_check_output(
-        tmp_path, test_case, test_params, source_folder, test_data_dir, cachi2_image
+        tmp_path, test_case, test_params, test_repo_dir, test_data_dir, cachi2_image
     )
 
 
@@ -76,8 +70,7 @@ def test_bundler_packages(
     [
         pytest.param(
             utils.TestParameters(
-                repo="https://github.com/cachito-testing/cachi2-bundler.git",
-                ref="well_formed_ruby_all_features",
+                branch="bundler/e2e",
                 packages=({"path": ".", "type": "bundler", "allow_binary": "true"},),
                 check_output=True,
                 check_deps_checksums=False,
@@ -91,8 +84,7 @@ def test_bundler_packages(
         ),
         pytest.param(
             utils.TestParameters(
-                repo="https://github.com/cachito-testing/cachi2-bundler.git",
-                ref="well_formed_ruby_without_gemspec",
+                branch="bundler/e2e-missing-gemspec",
                 packages=({"path": ".", "type": "bundler", "allow_binary": "true"},),
                 check_output=True,
                 check_deps_checksums=False,
@@ -112,6 +104,7 @@ def test_e2e_bundler(
     expected_cmd_output: str,
     cachi2_image: utils.ContainerImage,
     tmp_path: Path,
+    test_repo_dir: Path,
     test_data_dir: Path,
     request: pytest.FixtureRequest,
 ) -> None:
@@ -123,17 +116,13 @@ def test_e2e_bundler(
     """
     test_case = request.node.callspec.id
 
-    source_folder = utils.clone_repository(
-        test_params.repo, test_params.ref, f"{test_case}-source", tmp_path
-    )
-
-    output_folder = utils.fetch_deps_and_check_output(
-        tmp_path, test_case, test_params, source_folder, test_data_dir, cachi2_image
+    utils.fetch_deps_and_check_output(
+        tmp_path, test_case, test_params, test_repo_dir, test_data_dir, cachi2_image
     )
 
     utils.build_image_and_check_cmd(
         tmp_path,
-        output_folder,
+        test_repo_dir,
         test_data_dir,
         test_case,
         check_cmd,

diff --git a/tests/integration/test_data/bundler_everything_present/container/Containerfile b/tests/integration/test_data/bundler_everything_present/container/Containerfile
@@ -3,17 +3,6 @@ FROM docker.io/ruby:3.3
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
-
-# Check bundler deps
-RUN ls /tmp/bundler_everything_present-output/deps/bundler
-
-# Check content of source repository folder
-RUN ls /tmp/bundler_everything_present-source/
-
-# This should be a COPY, but the source code and Containerfile are in different directories
-RUN cp -r /tmp/bundler_everything_present-source /src
-
 WORKDIR /src
+
 RUN . /tmp/cachi2.env && bundle install
diff --git a/...s/integration/test_data/bundler_everything_present_except_gemspec/container/Containerfile b/...s/integration/test_data/bundler_everything_present_except_gemspec/container/Containerfile
@@ -3,17 +3,6 @@ FROM docker.io/ruby:3.3
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
-
-# Check bundler deps
-RUN ls /tmp/bundler_everything_present_except_gemspec-output/deps/bundler
-
-# Check content of source repository folder
-RUN ls /tmp/bundler_everything_present_except_gemspec-source/
-
-# This should be a COPY, but the source code and Containerfile are in different directories
-RUN cp -r /tmp/bundler_everything_present_except_gemspec-source /src
-
 WORKDIR /src
+
 RUN . /tmp/cachi2.env && bundle install
diff --git a/tests/integration/test_data/generic_e2e/container/Containerfile b/tests/integration/test_data/generic_e2e/container/Containerfile
@@ -3,6 +3,6 @@ FROM registry.fedoraproject.org/fedora:40
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-RUN cp -r /tmp/generic_e2e-output/deps/generic/ /deps
+RUN cp -r /tmp/cachi2-output/deps/generic/ /deps
 
-CMD ["ls", "-al", "/deps"]
+CMD ["ls", "-al", "/deps"]
diff --git a/tests/integration/test_data/generic_maven_e2e/container/Containerfile b/tests/integration/test_data/generic_maven_e2e/container/Containerfile
@@ -3,6 +3,6 @@ FROM docker.io/ibmjava:11-jdk
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-RUN cp -r /tmp/generic_maven_e2e-output/deps/generic/ /deps
+RUN cp -r /tmp/cachi2-output/deps/generic/ /deps
 
 CMD ["java", "-cp", "/deps/ant.jar:/deps/ant-launcher.jar", "org.apache.tools.ant.Main", "-version"]
diff --git a/tests/integration/test_data/gomod_1.18_e2e_test/container/Containerfile b/tests/integration/test_data/gomod_1.18_e2e_test/container/Containerfile
@@ -1,15 +1,9 @@
-FROM docker.io/golang:1.18.1 AS build
+FROM docker.io/golang:1.18.1
 
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
-
-# Check content of source repository folder
-RUN ls /tmp/gomod_1.18_e2e_test-source/
-
-WORKDIR /tmp/gomod_1.18_e2e_test-source
+WORKDIR /src
 RUN . /tmp/cachi2.env && go build -o /usr/bin/retrodep
 
 CMD retrodep --help
diff --git a/tests/integration/test_data/gomod_1.20_e2e_dirty_go.mod/container/Containerfile b/tests/integration/test_data/gomod_1.20_e2e_dirty_go.mod/container/Containerfile
@@ -1,18 +1,9 @@
-FROM docker.io/golang:1.20.0 AS build
+FROM docker.io/golang:1.20.0
 
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
-
-# Check content of source repository folder
-RUN ls /tmp/gomod_1.20_e2e_dirty_go.mod-source/
-
-WORKDIR /tmp/gomod_1.20_e2e_dirty_go.mod-source/twenty
-
-# Check that repository is clean (go.mod should not be updated)
-RUN if [ -n "$(git status --porcelain)" ]; then echo "Repo is dirty. Check go.mod"; exit 1; fi
+WORKDIR /src/twenty
 
 RUN . /tmp/cachi2.env && go build -o /usr/bin/twenty
 

diff --git a/tests/integration/test_data/gomod_1.21_e2e_test/container/Containerfile b/tests/integration/test_data/gomod_1.21_e2e_test/container/Containerfile
@@ -1,15 +1,9 @@
-FROM docker.io/golang:1.21.5 AS build
+FROM docker.io/golang:1.21.5
 
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
-
-# Check content of source repository folder
-RUN ls /tmp/gomod_1.21_e2e_test-source/
-
-WORKDIR /tmp/gomod_1.21_e2e_test-source
+WORKDIR /src
 RUN . /tmp/cachi2.env && go build -o /usr/bin/retrodep
 
 CMD retrodep --help
diff --git a/tests/integration/test_data/gomod_1.22_e2e_workspace_vendoring/container/Containerfile b/tests/integration/test_data/gomod_1.22_e2e_workspace_vendoring/container/Containerfile
@@ -1,15 +1,9 @@
-FROM docker.io/golang:1.22.0 AS build
+FROM docker.io/golang:1.22.0
 
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
-
-# Check content of source repository folder
-RUN ls /tmp/gomod_1.22_e2e_workspace_vendoring-source
-
-WORKDIR /tmp/gomod_1.22_e2e_workspace_vendoring-source/hi/hiii
+WORKDIR /src/hi/hiii
 RUN . /tmp/cachi2.env && go build -o /usr/bin/hiii
 
 CMD hiii
diff --git a/tests/integration/test_data/gomod_e2e_multiple_modules/container/Containerfile b/tests/integration/test_data/gomod_e2e_multiple_modules/container/Containerfile
@@ -3,10 +3,7 @@ FROM docker.io/golang:1.18.1
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
-
-WORKDIR /tmp/gomod_e2e_multiple_modules-source
+WORKDIR /src
 RUN . /tmp/cachi2.env && \
     cd spam-module && go build -o /usr/bin/spam-module && \
     cd ../eggs-module && go build -o /usr/bin/eggs-module

diff --git a/tests/integration/test_data/npm_lockfile3_aliased_deps/container/Containerfile b/tests/integration/test_data/npm_lockfile3_aliased_deps/container/Containerfile
@@ -3,18 +3,6 @@ FROM docker.io/node:18
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
+WORKDIR /src
 
-# Check npm deps
-RUN ls /tmp/npm_lockfile3_aliased_deps-output/deps/npm
-
-# Check content of source repository folder
-RUN ls /tmp/npm_lockfile3_aliased_deps-source/
-
-WORKDIR /tmp/npm_lockfile3_aliased_deps-source
-
-# Install packages and list them
-RUN . /tmp/cachi2.env && \
-    npm install && \
-    npm ll --parseable > /opt/npm-ls-output.txt
+RUN . /tmp/cachi2.env && npm install
diff --git a/tests/integration/test_data/npm_lockfile3_dev_optional_peer_deps/container/Containerfile b/tests/integration/test_data/npm_lockfile3_dev_optional_peer_deps/container/Containerfile
@@ -3,18 +3,6 @@ FROM docker.io/node:18
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
+WORKDIR /src
 
-# Check npm deps
-RUN ls /tmp/npm_lockfile3_dev_optional_peer_deps-output/deps/npm
-
-# Check content of source repository folder
-RUN ls /tmp/npm_lockfile3_dev_optional_peer_deps-source/
-
-WORKDIR /tmp/npm_lockfile3_dev_optional_peer_deps-source
-
-# Install packages and list them
-RUN . /tmp/cachi2.env && \
-    npm install && \
-    npm ls -a --parseable > /opt/npm-ls-output.txt
+RUN . /tmp/cachi2.env && npm install
diff --git a/tests/integration/test_data/npm_lockfile3_multiple_dep_versions/container/Containerfile b/tests/integration/test_data/npm_lockfile3_multiple_dep_versions/container/Containerfile
@@ -3,18 +3,6 @@ FROM docker.io/node:18
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
+WORKDIR /src
 
-# Check npm deps
-RUN ls /tmp/npm_lockfile3_multiple_dep_versions-output/deps/npm
-
-# Check content of source repository folder
-RUN ls /tmp/npm_lockfile3_multiple_dep_versions-source/
-
-WORKDIR /tmp/npm_lockfile3_multiple_dep_versions-source
-
-# Install packages and list them
-RUN . /tmp/cachi2.env && \
-    npm install && \
-    npm ll --parseable > /opt/npm-ls-output.txt
+RUN . /tmp/cachi2.env && npm install
diff --git a/tests/integration/test_data/npm_multiple_packages_lockfile3/container/Containerfile b/tests/integration/test_data/npm_multiple_packages_lockfile3/container/Containerfile
@@ -3,17 +3,8 @@ FROM docker.io/node:17
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
+WORKDIR /src/first_pkg
+RUN . /tmp/cachi2.env && npm install && npm ls
 
-# Check npm deps
-RUN ls /tmp/npm_multiple_packages_lockfile3-output/deps/npm
-
-# Check content of source repository folder
-RUN ls /tmp/npm_multiple_packages_lockfile3-source/
-
-WORKDIR /tmp/npm_multiple_packages_lockfile3-source
-
-# Install packages
-RUN cd ./first_pkg && . /tmp/cachi2.env && npm i && npm ls
-RUN cd ./second_pkg && . /tmp/cachi2.env && npm i && npm ls
+WORKDIR /src/second_pkg
+RUN . /tmp/cachi2.env && npm install && npm ls
diff --git a/tests/integration/test_data/npm_smoketest_lockfile2/container/Containerfile b/tests/integration/test_data/npm_smoketest_lockfile2/container/Containerfile
@@ -3,16 +3,6 @@ FROM docker.io/node:17
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
+WORKDIR /src
 
-# Check pip deps
-RUN ls /tmp/npm_smoketest_lockfile2-output/deps/npm
-
-# Check content of source repository folder
-RUN ls /tmp/npm_smoketest_lockfile2-source/
-
-WORKDIR /tmp/npm_smoketest_lockfile2-source
-
-# Install packages
-RUN . /tmp/cachi2.env && npm i && npm ls
+RUN . /tmp/cachi2.env && npm install && npm ls
diff --git a/tests/integration/test_data/npm_smoketest_lockfile3/container/Containerfile b/tests/integration/test_data/npm_smoketest_lockfile3/container/Containerfile
@@ -3,16 +3,6 @@ FROM docker.io/node:18
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
+WORKDIR /src
 
-# Check pip deps
-RUN ls /tmp/npm_smoketest_lockfile3-output/deps/npm
-
-# Check content of source repository folder
-RUN ls /tmp/npm_smoketest_lockfile3-source/
-
-WORKDIR /tmp/npm_smoketest_lockfile3-source
-
-# Install packages
-RUN . /tmp/cachi2.env && npm i && npm ls
+RUN . /tmp/cachi2.env && npm install && npm ls
diff --git a/tests/integration/test_data/pip_e2e_test/container/Containerfile b/tests/integration/test_data/pip_e2e_test/container/Containerfile
@@ -3,17 +3,10 @@ FROM docker.io/python:3.8
 # Test disabled network access
 RUN if curl -IsS www.google.com; then echo "Has network access!"; exit 1; fi
 
-# Print cachi2 env vars file
-RUN cat /tmp/cachi2.env
-
-# Check pip deps
-RUN ls /tmp/pip_e2e_test-output/deps/pip
-
-# Check content of source repository folder
-RUN ls /tmp/pip_e2e_test-source/
-
-WORKDIR /tmp/pip_e2e_test-source
-
-# Install packages
+WORKDIR /src
 RUN . /tmp/cachi2.env && python3 -m pip install -r requirements.txt
-RUN cp /tmp/pip_e2e_test-source/src/test_package_cachi2/main.py /opt/test_package_cachi2
+
+# During the build, the source code is only mounted, not copied
+# Some integration tests use CMD that requires the source code to be present
+RUN cp -r /src /app
+WORKDIR /app