.gitlab-ci.yml

# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This file is part of FLEXI, a high-order accurate framework for numerically solving PDEs with discontinuous Galerkin methods.
# For more information see https://www.flexi-project.org and https://numericsresearchgroup.org
#
# Copyright (c) 2010-2022 Prof. Claus-Dieter Munz
# Copyright (c) 2022-2025 Prof. Andrea Beck
#
# FLEXI is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
#
# FLEXI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
# of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License v3.0 for more details.
#
# You should have received a copy of the GNU General Public License along with FLEXI. If not, see <http://www.gnu.org/licenses/>.

# ==================================================================================================================================
# Continuous Integration/Continuous Deployment
# ==================================================================================================================================
spec:
  inputs:
    nightly:
      description: "Run the nightly regression checks"
      type: boolean
      default: false
    weekly:
      description: "Run the weekly regression checks"
      type: boolean
      default: false
    deploy:
      description: "Deploy the code to GitHub"
      type: boolean
      default: false
---


# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Settings
# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Check module environment
before_script:
  - ulimit -s unlimited
  # - module list || true
  - python3 --version
  # Setup Python virtual environment
  - test -f venv/bin/activate && source venv/bin/activate
  # Setup CMake generator
  - export CMAKE_GENERATOR="Ninja"
  - export CMAKE_LINKER_TYPE="MOLD"

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Stages
# ----------------------------------------------------------------------------------------------------------------------------------------------------
stages:
  - lint
  - setup
  - build
  - checkin
  - reggie_nightly
  - reggie_weekly
  - python
  - documentation
  - deploy

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Templates ("hidden jobs")
# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Default parameters for the build and testing stage
.default_build_param: &default_build_param
  tags: [dockertag]
  # Docker image to use for the CI/CD pipeline
  # image: ${CI_REGISTRY_IMAGE}/nrg-fedora:42-x86_64
  image:
    name: registry.iag.uni-stuttgart.de/flexi/flexi/nrg-fedora_42-x86_64
  artifacts:
    name: "${CI_PIPELINE_ID}-${CI_COMMIT_REF_NAME}-${CI_JOB_NAME}"
    expire_in: 1 day
    when: on_failure

.default_python_param: &default_python_param
  <<: *default_build_param

# Deployment needs to be done on the actual server
.default_deploy_param: &default_deploy_param
  tags: [flexitag]

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Default parameters for the reggie stage
.default_param: &default_param
  <<: *default_build_param
  allow_failure: false

.default_param_matrix: &default_param_matrix
  <<: *default_build_param
  allow_failure: false
  image:
    name: $CI_JOB_IMAGE
  parallel:
    matrix:
      # GNU Compiler Collection (GCC)
      - CI_COMPILER:  gnu
        CI_LINKER:    MOLD
        CI_JOB_IMAGE: registry.iag.uni-stuttgart.de/flexi/flexi/nrg-fedora_42-x86_64
      # Low Level Virtual Machine (LLVM)
      # - CI_JOB_IMAGE: registry.iag.uni-stuttgart.de/flexi/flexi/nrg-fedora_42-llvm-x86_64
        # CI_COMPILER:  llvm
      # Intel oneAPI Compiler
      - CI_COMPILER:  intel
        CI_LINKER:    DEFAULT
        CI_JOB_IMAGE: registry.iag.uni-stuttgart.de/flexi/flexi/nrg-fedora_42-intel-x86_64

.default_python: &default_python
  <<: *default_python_param
  allow_failure: false

.venv_cache: &venv_cache
  key: "${CI_PIPELINE_ID}-venv"
  paths:
    - venv
  policy: pull

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Defaults for the standard tests (utilizing "extends" to merge the other "artifacts" options with the specific path)
.defaults: &defaults
  extends: .default_param
  cache:
    - *venv_cache
  variables:
    # The project directory will be cleaned up at the end of the build
    FF_ENABLE_JOB_CLEANUP: true
    # The trace force send interval for logs is dynamically adjusted based on the trace update interval
    FF_USE_DYNAMIC_TRACE_FORCE_SEND_INTERVAL: true
    # Fastzip is a performant archiver for cache/artifact archiving and extraction
    FF_USE_FASTZIP: true
    # Use fast compression for artifacts, resulting in larger archives
    ARTIFACT_COMPRESSION_LEVEL: "fast"
    # Use no compression for caches
    CACHE_COMPRESSION_LEVEL: "fastest"

.defaults_python: &defaults_python
  extends: .default_python
  variables:
    # The project directory will be cleaned up at the end of the build
    FF_ENABLE_JOB_CLEANUP: true
    # The trace force send interval for logs is dynamically adjusted based on the trace update interval
    FF_USE_DYNAMIC_TRACE_FORCE_SEND_INTERVAL: true
    # Fastzip is a performant archiver for cache/artifact archiving and extraction
    FF_USE_FASTZIP: true
    # Use fast compression for artifacts, resulting in larger archives
    ARTIFACT_COMPRESSION_LEVEL: "fast"
    # Use no compression for caches
    CACHE_COMPRESSION_LEVEL: "fastest"

.defaults_nightly: &defaults_nightly
  <<: *defaults
  rules:
    - if: '"$[[ inputs.nightly ]]" == "true"'
  # Stage: Requires reggie artifacts
  needs:
    - reggie_download
  script:
    - reggie ./regressioncheck/checks/${CI_JOB_NAME} -j 6

.defaults_weekly: &defaults_weekly
  <<: *defaults
  rules:
    - if: '"$[[ inputs.weekly ]]" == "true"'
  # Stage: Requires reggie artifacts
  needs:
    - reggie_download
  script:
    - reggie ./regressioncheck/checks/${CI_JOB_NAME} -j 6

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Stage "lint": Run the linters
# policy: allow failure without stopping pipeline only on feature branches
# ----------------------------------------------------------------------------------------------------------------------------------------------------
fortitude:
  <<: *defaults_python
  stage: lint
  dependencies: []
  script:
    - fortitude --version
    - fortitude check --output-format=grouped src
  rules:
    # Skip running this job for merge requests targeting the default branch
  - if: '$CI_MERGE_REQUEST_ID && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH'
    when: never
    # For feature branches, allow failure without stopping the pipeline
  - if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
    allow_failure: true
    # For master branch, do not allow failure without stopping the pipeline
  - when: always
    allow_failure: false

ruff:
  <<: *defaults_python
  stage: lint
  dependencies: []
  script:
    - ruff --version
    - ruff check --extend-ignore=E201,E202,E203,E221,E222,E225,E231,E271,E272 --line-length=132 --preview docs tools

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Stage "setup": Setup the reggie environment
# ----------------------------------------------------------------------------------------------------------------------------------------------------

venv_create:
  # Stage: Creates the venv and pushes it as artifact
  extends: .default_build_param
  stage: setup
  # Stage: Does not require any artifacts
  dependencies: []
  # Stage: Artifacts are not too large yet but will be so in reggie_download
  # artifacts:
  #   paths:
  #     - venv/
  #   when: on_success
  #   expire_in: 1 day
  cache:
    - key: "${CI_PIPELINE_ID}-venv"
      paths:
        - venv
      policy: push
  script:
    - deactivate || true
    - rm -rf venv
    - uv venv venv
    - source venv/bin/activate
    - uv pip install --upgrade pip setuptools wheel
    - uv pip install --upgrade pytest pytest-cov

reggie_download:
  # Stage: Pulls the artifacted venv and uploads it as artifact
  extends: .default_build_param
  stage: setup
  # Stage: Requires venv artifacts
  needs:
    - venv_create
  # Stage: Artifacts are too large to upload
  # artifacts:
  #   paths:
  #     - venv/
  #   when: on_success
  #   expire_in: 1 day
  cache:
    - key: "${CI_PIPELINE_ID}-venv"
      paths:
        - venv
      policy: pull-push
  script:
    # Install Reggie
    - uv pip install git+https://github.com/piclas-framework/reggie2.0.git
    # Check Reggie
    - reggie --help

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Stage "reggie_checkin": Run most simple reggie with previous builds on check-in
# ----------------------------------------------------------------------------------------------------------------------------------------------------
build:
  extends: .default_param_matrix
  stage: build
  # artifacts:
  #   paths:
  #     - build/
  #     - build_intel/
  #   when: on_success
  #   expire_in: 1 day
  cache:
    key: "${CI_PIPELINE_ID}-${CI_COMPILER}"
    paths:
      - build_${CI_COMPILER}
    policy: push
  script:
    - export CMAKE_LINKER_TYPE=${CI_LINKER}
    - cmake -B build_${CI_COMPILER} -DLIBS_BUILD_HDF5=OFF
    - cmake --build build_${CI_COMPILER} -j6

checkin:
  extends: .default_param_matrix
  stage: checkin
  # Stage: Requires build artifacts
  needs:
    - reggie_download
    - build
  cache:
    - *venv_cache
    - key: "${CI_PIPELINE_ID}-${CI_COMPILER}"
      paths:
        - build
        - build_intel
      policy: pull
  script:
    - cd build_${CI_COMPILER}
    - reggie ../regressioncheck/checks/run_basic/freestream_3D -j 6 -e ./bin/flexi

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Stage "reggie_nightly": Build and run
#                         - build all specified compile options in "run_basic" with LIBS_BUILD_HDF5=ON
#                         - h-p-convtests
#                         - parabolic testcases
#                         - riemann solver tests
# ----------------------------------------------------------------------------------------------------------------------------------------------------
build_all:
  <<: *defaults_nightly
  stage: reggie_nightly
  script:
    - reggie ./regressioncheck/checks/run_basic -j 6

timedisc:
  <<: *defaults_nightly
  stage: reggie_nightly

convtest:
  <<: *defaults_nightly
  stage: reggie_nightly

parabolic:
  <<: *defaults_nightly
  stage: reggie_nightly

riemann:
  <<: *defaults_nightly
  stage: reggie_nightly

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Stage "reggie_weekly": Build and run more complex tests, basically complete simulatons
#                         - Taylor-Green vortex
#                         - NACA profile
#                         - Advanced FV simulations
#                         - RANS channel
# ----------------------------------------------------------------------------------------------------------------------------------------------------
tgv:
  <<: *defaults_weekly
  stage: reggie_weekly

naca:
  <<: *defaults_weekly
  stage: reggie_weekly

fv_switch:
  <<: *defaults_weekly
  stage: reggie_weekly

fv_blend:
  <<: *defaults_weekly
  stage: reggie_weekly

channelRANS:
  <<: *defaults_weekly
  stage: reggie_weekly

imperator:
  <<: *defaults_weekly
  stage: reggie_weekly
  script:
    - reggie ./regressioncheck/checks/preconditioner -j 6

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Stage "documentation": Creates doxygen documentation & compiles the documentation creating the *.pdf
# ----------------------------------------------------------------------------------------------------------------------------------------------------
documentation:
  extends: .default_build_param
  stage: documentation
  rules:
    - if: '"$[[ inputs.deploy ]]" == "true"'
    - if: '"$[[ inputs.weekly ]]" == "true"'
  script:
    - cd docs/doxygen
    - ./builddoxy.sh
  artifacts:
    paths:
      - src
      - docs/doxygen
  cache:
    key: "${CI_COMMIT_REF_SLUG}-DOC"
    paths: [docs/doxygen]
    policy: push

userguide:
  extends: .default_build_param
  stage: documentation
  image: sphinxdoc/sphinx-latexpdf:latest
  rules:
    - if: '"$[[ inputs.deploy ]]" == "true"'
    - if: '"$[[ inputs.weekly ]]" == "true"'
  script:
    - cd docs/documentation
    - python3 -m pip install --exists-action=w --no-cache-dir -r requirements.txt
    - python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
    - ls -l _build/html
    - python3 -m sphinx -b latex -D language=en -d _build/doctrees . _build/latex
    - ls -l _build/latex
    - cd _build/latex
    - latexmk -r latexmkrc -pdf -f -dvi- -ps- -jobname=flexi -interaction=nonstopmode || true
    - ls -l
    - ls -l flexi.pdf
  artifacts:
    paths:
      - docs/documentation
  cache:
    key: "${CI_COMMIT_REF_SLUG}-USERGUIDE"
    paths: [docs/documentation]
    policy: push

# ----------------------------------------------------------------------------------------------------------------------------------------------------
# Stage "deploy": Copies the doxygen documentation and userguide *.pdf to the homepage server & copies the repository to github
# ----------------------------------------------------------------------------------------------------------------------------------------------------
homepage:
  extends: .default_deploy_param
  stage: deploy
  rules:
    - if: '"$[[ inputs.deploy ]]" == "true" && $CI_SERVER_URL =~ /.*\.iag\.uni-stuttgart\.de$/'
  cache:
    - key: "${CI_COMMIT_REF_SLUG}-USERGUIDE"
      paths: [docs/documentation]
      policy: pull
  variables:
    FF_ENABLE_JOB_CLEANUP: 1
  script:
    - rsync --recursive --delete docs/documentation/_build/latex/flexi.pdf webserver:nrg.git/nrg_website/NRG/userguide/pdf/userguide.pdf
    - rsync --recursive --delete docs/documentation/_build/html/*          webserver:nrg.git/nrg_website/NRG/userguide/html/.

github:
  extends: .default_deploy_param
  stage: deploy
  rules:
    - if: '"$[[ inputs.deploy ]]" == "true" && $CI_SERVER_URL =~ /.*\.iag\.uni-stuttgart\.de$/'
  variables:
    FF_ENABLE_JOB_CLEANUP: 1
  script:
    - git clone --single-branch git@gitlab.iag.uni-stuttgart.de:flexi/flexi.git flexi_github
    - cd flexi_github
    - git push --mirror git@github.com:flexi-framework/flexi.git
    # - git push --mirror git@github.com:flexi-framework/flexi-extensions.git