feat: add Docker Compose files for testing PyMAPDL

.github/workflows/ci.yml

@@ -353,9 +353,108 @@ jobs:
       test_dpf: false
       upload-logs: true
 
+  docker-compose-test-remote:
+    name: "Docker Compose Remote: ${{ matrix.mapdl-version }}"
+    runs-on: ubuntu-latest
+    if: github.ref != 'refs/heads/main' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+    needs: [smoke-tests]
+    permissions:
+      contents: read  # Needed to read repository contents for tests
+      packages: read  # Needed to pull Docker images from GitHub packages
+    strategy:
+      fail-fast: false
+      matrix:
+        mapdl-version: ['v25.2-ubuntu-cicd', 'v25.1-ubuntu-cicd']
+    steps:
+      - name: "Install Git and checkout project"
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6.0.2
+        with:
+          persist-credentials: false
+
+      - name: "Login to GitHub Container Registry"
+        uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 #v3.7.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: "Run docker compose tests (remote-host profile)"
+        working-directory: docker/testing
+        env:
+          ANSYSLMD_LICENSE_FILE: "1055@${{ secrets.LICENSE_SERVER }}"
+          DOCKER_IMAGE: ghcr.io/ansys/mapdl:${{ matrix.mapdl-version }}
+        run: |
+          docker compose --profile remote-host up --build --abort-on-container-exit --exit-code-from pymapdl-host --no-attach mapdl-remote
+
+      - name: "Cleanup docker compose"
+        if: always()
+        env:
+          # To avoid warnings
+          ANSYSLMD_LICENSE_FILE: ""
+          DOCKER_IMAGE: ghcr.io/ansys/mapdl:${{ matrix.mapdl-version }}
+        run: |
+          echo "::group:: MAPDL-remote logs"
+          docker compose -f docker/testing/docker-compose.yml logs mapdl-remote || true
+          echo "::endgroup::"
+
+          echo "::group:: Python host logs"
+          docker compose -f docker/testing/docker-compose.yml logs pymapdl-host || true
+          echo "::endgroup::"
+
+          echo "Stopping all services..."
+          docker compose -f docker/testing/docker-compose.yml --profile remote-host down -v || true
+
+  docker-compose-test-local:
+    name: "Docker Compose Local: ${{ matrix.mapdl-version }}"
+    runs-on: ubuntu-latest
+    if: github.ref != 'refs/heads/main' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+    needs: [smoke-tests]
+    permissions:
+      contents: read  # Needed to read repository contents for tests
+      packages: read  # Needed to pull Docker images from GitHub packages
+    strategy:
+      fail-fast: false
+      matrix:
+        mapdl-version: ['v25.2-ubuntu-cicd', 'v25.1-ubuntu-cicd']
+    steps:
+      - name: "Install Git and checkout project"
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6.0.2
+        with:
+          persist-credentials: false
+
+      - name: "Login to GitHub Container Registry"
+        uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 #v3.7.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: "Run docker compose tests (local-host profile)"
+        working-directory: docker/testing
+        env:
+          ANSYSLMD_LICENSE_FILE: "1055@${{ secrets.LICENSE_SERVER }}"
+          DOCKER_IMAGE: ghcr.io/ansys/mapdl:${{ matrix.mapdl-version }}
+        run: |
+          docker compose --profile local-host up --build --abort-on-container-exit --exit-code-from mapdl-local-host
+
+      - name: "Cleanup docker compose"
+        if: always()
+        working-directory: docker/testing
+        env:
+          # To avoid warnings
+          ANSYSLMD_LICENSE_FILE: ""
+          DOCKER_IMAGE: ghcr.io/ansys/mapdl:${{ matrix.mapdl-version }}
+        run: |
+          echo "::group:: MAPDL-remote logs"
+          docker compose logs mapdl-local-host
+          echo "::endgroup::"
+
+          echo "Stopping all services..."
+          docker compose --profile local-host down -v
+
   package:
     name: "Package library"
-    needs: [build-test-remote, build-test-ubuntu-local, docs-build, build-test-ubuntu-minimal]
+    needs: [build-test-remote, build-test-ubuntu-local, docs-build, build-test-ubuntu-minimal, docker-compose-test-remote, docker-compose-test-local]
     runs-on: ubuntu-latest
     permissions:
       contents: read  # Needed to read repository contents for packaging
@@ -440,7 +539,7 @@ jobs:
 
   notify:
     name: "Notify failed build"
-    needs: [smoke-tests, docs-build, build-test-remote, build-test-ubuntu-local, build-test-ubuntu-minimal]
+    needs: [smoke-tests, docs-build, build-test-remote, build-test-ubuntu-local, build-test-ubuntu-minimal, docker-compose-test-remote, docker-compose-test-local]
     if: failure() && github.event_name == 'schedule'
     runs-on: ubuntu-latest
     permissions:
@@ -480,7 +579,7 @@ jobs:
   pytest-summary:
     name: Pytest summary for all the test jobs
     needs: [
-      build-test-remote, build-test-ubuntu-local, build-test-ubuntu-console, build-test-ubuntu-minimal
+      build-test-remote, build-test-ubuntu-local, build-test-ubuntu-console, build-test-ubuntu-minimal, docker-compose-test-remote, docker-compose-test-local
       ]
     if: always()
     runs-on: ubuntu-latest

.gitignore

@@ -42,21 +42,21 @@ doc/source/images/auto-generated/*
 
 
 # Testing
+./Testing/
+.benchmarks/
+.coverage
+.pytest_cache/
+.tox/
+*,cover
+coverage.xml
 factory/
-Testing/
-UnitTesting/
-TODO
+test-output.xml
 test.sh
-.pytest_cache/
 tests/.coverage
-tests/htmlcov
 tests/cyclic/htmlcov
-.coverage
-*,cover
-.benchmarks/
-test-output.xml
-coverage.xml
-.tox/
+tests/htmlcov
+TODO
+UnitTesting/
 
 \#*
 .\#*

doc/changelog.d/4274.added.md

@@ -0,0 +1 @@
+Add Docker Compose files for testing PyMAPDL

docker/testing/Dockerfile

@@ -0,0 +1,204 @@
+# PyMAPDL docker image that runs the tests.
+
+# Dummy default so there is no error if not set.
+# It needs to be set here because we are using it
+# later on the FROM.
+ARG DOCKER_IMAGE="mapdl:latest"
+
+#######################################################
+FROM ubuntu:22.04 AS python-container
+#######################################################
+
+
+ARG USE_LOCAL_REPO
+ARG PYTHON_VERSION=3.11
+
+ENV USE_LOCAL_REPO=${USE_LOCAL_REPO}
+ENV UV_PYTHON=${PYTHON_VERSION}
+
+WORKDIR /home
+
+# Install system dependencies
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends  \
+    ca-certificates \
+    libgl1-mesa-glx \
+    xvfb \
+    libgomp1 \
+    graphviz \
+    git \
+    openssh-client \
+    curl && \
+    # Installing uv
+    curl -LsSf https://astral.sh/uv/install.sh | sh \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN ls -al
+
+# Cloning repo if needed.
+RUN if [ "$USE_LOCAL_REPO" = "false" ]; then \
+        echo "Cloning PyMAPDL repository..." && \
+        git clone https://github.com/ansys/pymapdl.git . && \
+        git config --global --add safe.directory $(pwd); \
+    fi
+
+# Set PATH to include uv
+ENV PATH="/root/.local/bin:$HOME/.local/bin:$PATH"
+RUN uv --version
+
+# Pre-install Python in container-local directory to avoid re-downloads
+# This creates a Python installation that persists in the container layer
+RUN uv python install ${PYTHON_VERSION}
+
+# Configuration
+# -------------
+# Variable for running as if it were on CICD while testing
+ENV ON_CI=True
+# To simulate running on local machine
+ENV ON_LOCAL=False
+# For tests that check if running on ubuntu.
+ENV ON_UBUNTU=False
+# Some tests check if running on student machines
+ENV ON_STUDENT=False
+
+# PyMAPDL testing env vars
+# ------------------------
+# To work without a screen.
+ENV PYANSYS_OFF_SCREEN=True
+# Enable debugging for PyMAPDL
+ENV PYMAPDL_DEBUG_TESTING=True
+# To connect to an already alive or remote MAPDL instance
+ENV PYMAPDL_START_INSTANCE=False
+# Set MAPDL port to connect to
+ENV PYMAPDL_PORT=50052
+# Use insecure gRPC transport for testing. This is needed to connect to the remote MAPDL instance, which is what we want to do in this container.
+ENV PYMAPDL_GRPC_TRANSPORT=insecure
+
+# DPF testing
+# -----------
+# Not testing against DPF
+#
+# To connect to a remote DPF server
+ENV DPF_START_SERVER=False
+# Simulate not having DPF
+ENV HAS_DPF=False
+# Not testing DPF-Results backend
+ENV TEST_DPF_BACKEND=False
+# MAPDL and DPF are running on the same container
+ENV ON_SAME_CONTAINER=False
+
+# Pytest settings
+# ---------------
+ENV PYTEST_ARGUMENTS='--ignore_image_cache'
+
+# Setting entrypoint
+# ------------------
+COPY start.sh /
+RUN chmod +x /start.sh
+
+ENTRYPOINT [ "/bin/bash", "/start.sh" ]
+
+SHELL [ "/bin/bash", "-c" ]
+
+
+#######################################################
+FROM ${DOCKER_IMAGE} AS mapdl-container
+#######################################################
+#
+# WARNING: This container is designed to work using an Ubuntu base image.
+#
+ARG USE_LOCAL_REPO
+ARG PYTHON_VERSION=3.11
+
+ENV UV_PYTHON=${PYTHON_VERSION}
+ENV USE_LOCAL_REPO=${USE_LOCAL_REPO}
+
+ENV OMPI_ALLOW_RUN_AS_ROOT=1
+ENV OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1
+
+# OS configuration
+# ----------------
+# Installing dependencies
+USER root
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+    ca-certificates \
+    libgl1-mesa-glx \
+    xvfb \
+    libgomp1 \
+    graphviz \
+    git \
+    openssh-client \
+    curl \
+    # Installing uv
+    && curl -LsSf https://astral.sh/uv/install.sh | sh \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set PATH to include uv for root user
+ENV PATH="/root/.local/bin:$PATH"
+
+RUN USER=mapdl && chown -R $USER:$USER /home/mapdl
+USER mapdl
+
+ENV PATH="$HOME/.local/bin:$PATH"
+
+# Cloning repo if needed.
+RUN if [ "$USE_LOCAL_REPO" = "false" ]; then \
+        echo "Cloning PyMAPDL repository..." && \
+        git clone https://github.com/ansys/pymapdl.git . && \
+        git config --global --add safe.directory /workspace; \
+    fi && \
+    uv --version
+
+# Configuration
+# -------------
+# Variable for running as if it were on CICD while testing
+ENV ON_CI=True
+# To simulate running on local machine
+ENV ON_LOCAL=True
+# For tests that check if running on ubuntu.
+ENV ON_UBUNTU=False
+# Some tests check if running on student machines
+ENV ON_STUDENT=False
+
+# PyMAPDL testing env vars
+# ------------------------
+# To work without a screen.
+ENV PYANSYS_OFF_SCREEN=True
+# Enable debugging for PyMAPDL
+ENV PYMAPDL_DEBUG_TESTING=True
+# Force launching an instance of MAPDL. This is needed to test the connection to a remote instance, which is what we want to do in this container.
+ENV PYMAPDL_START_INSTANCE=True
+# Set MAPDL port to connect to
+ENV PYMAPDL_PORT=50052
+# Set additional switches for MAPDL. In this case, we are enabling MPI with OpenMPI.
+ENV PYMAPDL_ADDITIONAL_SWITCHES="-mpi openmpi"
+# DPF testing
+# -----------
+# Not testing against DPF
+#
+# To connect to a remote DPF server
+ENV DPF_START_SERVER=False
+# Simulate not having DPF
+ENV HAS_DPF=False
+# Not testing DPF-Results backend
+ENV TEST_DPF_BACKEND=False
+# MAPDL and DPF are running on the same container
+ENV ON_SAME_CONTAINER=False
+
+# Pytest settings
+# ---------------
+ENV PYTEST_ARGUMENTS='--ignore_image_cache'
+
+# Setting entrypoint
+# ------------------
+USER root
+COPY start.sh /
+RUN chmod +x /start.sh
+USER mapdl
+
+ENTRYPOINT [ "/bin/bash", "/start.sh" ]
+SHELL [ "/bin/bash" ]