systemtests: add heat-exchanger-simplified test suite

Add heat-exchanger-simplified to the system test suites, covering the
fluid-top-openfoam, fluid-btm-openfoam, solid-calculix case combination.

Author: AdityaGupta716

changelog-entries/731.md

@@ -0,0 +1 @@
+- Added heat-exchanger-simplified to system tests: new standalone suite `heat_exchanger_simplified_test` and included in `release_test`. Fixed Docker compatibility for Ubuntu 24.04 (default ubuntu user removal with home dir cleanup, docker compose/docker-compose detection, ARG defaults for all adapter refs, wget retries for CalculiX and SU2 downloads).

heat-exchanger-simplified/reference-results/.gitkeep

@@ -117,6 +117,9 @@ calculix-adapter:
     TUTORIALS_REF:
       description: Tutorial git reference to use
       default: "master"
+    PYTHON_BINDINGS_REF:
+      description: Git ref of the Python bindings (required when shared Dockerfile builds python_bindings stage)
+      default: "master"
     CALCULIX_VERSION:
       description: Version of Calculix to use
       default: "2.20"

tools/tests/components.yaml

@@ -2,13 +2,15 @@ FROM ubuntu:24.04 AS base_image
 USER root
 SHELL ["/bin/bash", "-c"]
 ENV DEBIAN_FRONTEND=noninteractive
-# We set a sensical value, but still have the possibilty to influence this via the build time arguments. 
+# We set a sensical value, but still have the possibilty to influence this via the build time arguments.
 # When the dockerfile is built using the systemtests.py we set the PRECICE_UID and PRECICE_GID to the user executing the systemtests.
 # This ensures no file ownership problems down the line and is the most easy fix, as we normally built the containers locally
 # If not built via the systemtests.py its either possible to specify manually but 1000 would be the default anyway.
 ARG PRECICE_UID=1000
 ARG PRECICE_GID=1000
-RUN groupadd -g ${PRECICE_GID} precice && useradd -u ${PRECICE_UID} -g ${PRECICE_GID} -ms /bin/bash precice
+# Ubuntu 24.04+ images include a default user "ubuntu" with UID/GID 1000; remove it so we can create "precice" with the same UID/GID.
+RUN userdel -r ubuntu 2>/dev/null || true; groupdel ubuntu 2>/dev/null || true; \
+    groupadd -g ${PRECICE_GID} precice && useradd -u ${PRECICE_UID} -g ${PRECICE_GID} -ms /bin/bash precice
 ENV PATH="${PATH}:/home/precice/.local/bin" 
 ENV LD_LIBRARY_PATH="/home/precice/.local/lib:${LD_LIBRARY_PATH}" 
 ENV CPATH="/home/precice/.local/include:$CPATH"
@@ -70,7 +72,7 @@ RUN apt-get update &&\
 USER precice
 COPY --from=precice /home/precice/.local/ /home/precice/.local/
 ARG OPENFOAM_ADAPTER_PR
-ARG OPENFOAM_ADAPTER_REF
+ARG OPENFOAM_ADAPTER_REF=master
 # Build the OpenFOAM adapter 
 USER precice
 WORKDIR /home/precice
@@ -83,7 +85,7 @@ RUN git clone https://github.com/precice/openfoam-adapter.git &&\
 
 FROM precice_dependecies AS python_bindings
 COPY --from=precice /home/precice/.local/ /home/precice/.local/
-ARG PYTHON_BINDINGS_REF
+ARG PYTHON_BINDINGS_REF=master
 USER precice
 WORKDIR /home/precice
 # Builds the precice python bindings for python3
@@ -100,7 +102,7 @@ RUN add-apt-repository -y ppa:fenics-packages/fenics && \
     apt-get -qq update && \
     apt-get -qq install --no-install-recommends fenics
 USER precice
-ARG FENICS_ADAPTER_REF
+ARG FENICS_ADAPTER_REF=master
 # Building fenics-adapter
 RUN python3 -m venv --system-site-packages /home/precice/venv && \
     . /home/precice/venv/bin/activate && \
@@ -125,12 +127,12 @@ ARG CALCULIX_VERSION
 USER precice
 #Download Calculix
 WORKDIR /home/precice
-RUN wget http://www.dhondt.de/ccx_${CALCULIX_VERSION}.src.tar.bz2 && \
+RUN wget --tries=3 --retry-connrefused --timeout=30 http://www.dhondt.de/ccx_${CALCULIX_VERSION}.src.tar.bz2 && \
     tar xvjf ccx_${CALCULIX_VERSION}.src.tar.bz2 && \
     rm -fv ccx_${CALCULIX_VERSION}.src.tar.bz2
 
 ARG CALCULIX_ADAPTER_PR
-ARG CALCULIX_ADAPTER_REF
+ARG CALCULIX_ADAPTER_REF=master
 WORKDIR /home/precice
 RUN git clone https://github.com/precice/calculix-adapter.git && \
     cd calculix-adapter && \
@@ -150,13 +152,13 @@ USER precice
 # Download and build SU2 (We could also use pre-built binaries from the SU2 releases)
 # The sed command applies a patch needed for Ubuntu 24.04.
 WORKDIR /home/precice
-RUN wget https://github.com/su2code/SU2/archive/refs/tags/v${SU2_VERSION}.tar.gz && \
+RUN wget --tries=3 --retry-connrefused --timeout=30 https://github.com/su2code/SU2/archive/refs/tags/v${SU2_VERSION}.tar.gz && \
     tar xvzf v${SU2_VERSION}.tar.gz && \
     rm -fv v${SU2_VERSION}.tar.gz
 RUN python3 -m venv /home/precice/venv && \
     . /home/precice/venv/bin/activate
 ARG SU2_ADAPTER_PR
-ARG SU2_ADAPTER_REF
+ARG SU2_ADAPTER_REF=master
 WORKDIR /home/precice
 ENV SU2_RUN="/home/precice/SU2_RUN" 
 ENV SU2_HOME="/home/precice/SU2-${SU2_VERSION}"
@@ -179,7 +181,7 @@ RUN apt-get update &&\
 USER precice
 COPY --from=precice /home/precice/.local/ /home/precice/.local/
 ARG DEALII_ADAPTER_PR
-ARG DEALII_ADAPTER_REF
+ARG DEALII_ADAPTER_REF=master
 # Build the deal.II adapter 
 USER precice
 WORKDIR /home/precice
@@ -189,4 +191,4 @@ RUN git clone https://github.com/precice/dealii-adapter.git &&\
     if [ -n "${DEALII_ADAPTER_PR}" ]; then git fetch origin pull/${DEALII_ADAPTER_PR}/head; fi && \
     git checkout ${DEALII_ADAPTER_REF} && \
     cmake . && \
-    make -j $(nproc)
+    make -j $(nproc)

tools/tests/dockerfiles/ubuntu_2404/Dockerfile

@@ -19,10 +19,37 @@
 import os
 
 
-GLOBAL_TIMEOUT = 600
+GLOBAL_TIMEOUT = 900
 SHORT_TIMEOUT = 10
 
 
+# Cached result of docker compose command detection
+_DOCKER_COMPOSE_CMD = None
+
+
+def _get_docker_compose_cmd():
+    """Return the docker compose command list: ['docker', 'compose'] or ['docker-compose']."""
+    global _DOCKER_COMPOSE_CMD
+    if _DOCKER_COMPOSE_CMD is not None:
+        return _DOCKER_COMPOSE_CMD
+    try:
+        subprocess.run(
+            ['docker', 'compose', 'version'],
+            capture_output=True, timeout=5, check=True,
+        )
+        _DOCKER_COMPOSE_CMD = ['docker', 'compose']
+    except (subprocess.CalledProcessError, FileNotFoundError, subprocess.TimeoutExpired):
+        try:
+            subprocess.run(
+                ['docker-compose', 'version'],
+                capture_output=True, timeout=5, check=True,
+            )
+            _DOCKER_COMPOSE_CMD = ['docker-compose']
+        except (subprocess.CalledProcessError, FileNotFoundError, subprocess.TimeoutExpired):
+            _DOCKER_COMPOSE_CMD = ['docker', 'compose']  # default; will fail with clear error
+    return _DOCKER_COMPOSE_CMD
+
+
 def slugify(value, allow_unicode=False):
     """
     Taken from https://github.com/django/django/blob/master/django/utils/text.py
@@ -381,13 +408,11 @@ def _run_field_compare(self):
             file.write(docker_compose_content)
         try:
             # Execute docker-compose command
-            process = subprocess.Popen(['docker',
-                                        'compose',
-                                        '--file',
-                                        'docker-compose.field_compare.yaml',
-                                        'up',
-                                        '--exit-code-from',
-                                        'field-compare'],
+            cmd = _get_docker_compose_cmd() + [
+                '-f', 'docker-compose.field_compare.yaml',
+                'up', '--exit-code-from', 'field-compare'
+            ]
+            process = subprocess.Popen(cmd,
                                        stdout=subprocess.PIPE,
                                        stderr=subprocess.PIPE,
                                        start_new_session=True,
@@ -428,11 +453,11 @@ def _build_docker(self):
 
         try:
             # Execute docker-compose command
-            process = subprocess.Popen(['docker',
-                                        'compose',
-                                        '--file',
-                                        'docker-compose.tutorial.yaml',
-                                        'build'],
+            cmd = _get_docker_compose_cmd() + [
+                '-f', 'docker-compose.tutorial.yaml',
+                'build'
+            ]
+            process = subprocess.Popen(cmd,
                                        stdout=subprocess.PIPE,
                                        stderr=subprocess.PIPE,
                                        start_new_session=True,
@@ -472,11 +497,11 @@ def _run_tutorial(self):
         stderr_data = []
         try:
             # Execute docker-compose command
-            process = subprocess.Popen(['docker',
-                                        'compose',
-                                        '--file',
-                                        'docker-compose.tutorial.yaml',
-                                        'up'],
+            cmd = _get_docker_compose_cmd() + [
+                '-f', 'docker-compose.tutorial.yaml',
+                'up'
+            ]
+            process = subprocess.Popen(cmd,
                                        stdout=subprocess.PIPE,
                                        stderr=subprocess.PIPE,
                                        start_new_session=True,

tools/tests/systemtests/Systemtest.py

@@ -128,4 +128,18 @@ test_suites:
           - fluid-openfoam
           - solid-upstream-dealii
           - solid-downstream-dealii
-        reference_result: ./perpendicular-flap/reference-results/fluid-openfoam_solid-upstream-dealii_solid-downstream-dealii.tar.gz
+        reference_result: ./perpendicular-flap/reference-results/fluid-openfoam_solid-upstream-dealii_solid-downstream-dealii.tar.gz
+      - path: heat-exchanger-simplified
+        case_combination:
+          - fluid-top-openfoam
+          - fluid-btm-openfoam
+          - solid-calculix
+        reference_result: ./heat-exchanger-simplified/reference-results/fluid-top-openfoam_fluid-btm-openfoam_solid-calculix.tar.gz
+  heat_exchanger_simplified_test:
+    tutorials:
+      - path: heat-exchanger-simplified
+        case_combination:
+          - fluid-top-openfoam
+          - fluid-btm-openfoam
+          - solid-calculix
+        reference_result: ./heat-exchanger-simplified/reference-results/fluid-top-openfoam_fluid-btm-openfoam_solid-calculix.tar.gz