.gitlab-ci.yml

workflow:
  rules:
    # Run pipeline on tags for the main project
    - if: $CI_COMMIT_TAG && $CI_PROJECT_PATH == "nektar/nektar"
    # Run pipeline on the default branch for the main project
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PROJECT_PATH == "nektar/nektar"
    # DO NOT run pipeline if WIP
    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TITLE =~ /^WIP:.*/
      when: never
    # DO NOT run pipeline if Draft
    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TITLE =~ /^Draft:.*/ 
      when: never
    # Other merge requests trigger pipelines
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
    # Manual runs
    - if: $CI_PIPELINE_SOURCE == "web"

stages:
  - build-env-default
  - build-env-full
  - build-and-test
  - quality-checks
  - package-env
  - package-build
  - package-build-dev
  - package-test
  - package-deploy-dev
  - package-deploy

include:
  - local: .gitlab-ci/packaging.yml

.execution-conditions: &execution-conditions
  only:
    refs:
      - merge_requests
      - master@nektar/nektar
      - tags@nektar/nektar
      - web
    changes:
      - "cmake/**/*"
      - "docker/**/*"
      - "docs/**/*"
      - "library/**/*"
      - "solvers/**/*"
      - "tests/**/*"
      - "utilities/**/*"
      - ".gitlab-ci/*"
      - .dockerignore
      - .gitmodules
      - .gitlab-ci.yml
      - CMakeLists.txt

.build-env-template: &build-env-template
  <<: *execution-conditions
  stage: build-env
  image: docker:19.03.6
  timeout: 1h
  variables:
    REMOVE_UCX: 0
  script:
    - OS_DISTRO=$(echo $CI_JOB_NAME | cut -d- -f 1)
    - OS_VERSION=$(echo $CI_JOB_NAME | cut -d- -f 2)
    - BUILD_TYPE=$(echo $CI_JOB_NAME | cut -d- -f 3)
    - sed -e "s %%OS_DISTRO%% $OS_DISTRO g" -e "s %%OS_VERSION%% $OS_VERSION g" -e "s %%REGISTRY%% $CI_REGISTRY_IMAGE g" docker/nektar-env/Dockerfile_${OS_DISTRO}_${BUILD_TYPE} > Dockerfile
    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
    - export IMAGE=$CI_REGISTRY_IMAGE:env-${OS_DISTRO}-${OS_VERSION}-${BUILD_TYPE}
    - docker pull $IMAGE || true
    - docker build --pull --build-arg REMOVE_UCX=${REMOVE_UCX} -t $IMAGE .
    - docker push $IMAGE

.build-and-test-template: &build-and-test-template
  <<: *execution-conditions
  stage: build-and-test
  image: docker:19.03.6
  variables:
    GIT_STRATEGY: clone
  script:
    - OS_DISTRO=$(echo $CI_JOB_NAME | cut -d- -f 1)
    - OS_VERSION=$(echo $CI_JOB_NAME | cut -d- -f 2)
    - BUILD_TYPE=$(echo $CI_JOB_NAME | cut -d- -f 3)
    - export CCACHE_DIR=/cache/nektar/$OS_VERSION/
    - export NUM_CPUS=8
    - export CONTAINER_NAME=test-$CI_JOB_ID
    - export ENV_NAME=env-${OS_DISTRO}-${OS_VERSION}-${BUILD_TYPE}
    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
    - docker pull $CI_REGISTRY_IMAGE:$ENV_NAME
    - sed "s %%BASE_IMAGE%% $CI_REGISTRY_IMAGE:$ENV_NAME g" .gitlab-ci/Dockerfile_add_repo > Dockerfile_tmp
    - export ENV_IMAGE=$(docker build -q -f Dockerfile_tmp .)
    - mkdir -p log
    - if [ ! -d $CCACHE_DIR ]; then mkdir -p $CCACHE_DIR && chown 1000:1000 $CCACHE_DIR; fi
    - docker run --name $CONTAINER_NAME -v ccache:/cache
      -e "BUILD_TYPE=$BUILD_TYPE"
      -e "BUILD_SIMD=$BUILD_SIMD"
      -e "BUILD_CC=$BUILD_CC"
      -e "BUILD_CXX=$BUILD_CXX"
      -e "BUILD_FC=$BUILD_FC"
      -e "NUM_CPUS=$NUM_CPUS"
      -e "CCACHE_DIR=$CCACHE_DIR"
      $ENV_IMAGE
      bash -x .gitlab-ci/build-and-test.sh |
      tee log/${OS_VERSION}_${BUILD_TYPE}.log || true
    - exit_code=$(docker wait $CONTAINER_NAME)
    - >
        echo "Container exit code: $exit_code"
    - if [ $exit_code -ne 0 ];
      then
        export FAIL_IMAGE=$CI_REGISTRY_IMAGE:pipeline_${CI_PIPELINE_ID}_${OS_VERSION}_${BUILD_TYPE};
        echo FAIL $FAIL_IMAGE;
        docker commit $CONTAINER_NAME $FAIL_IMAGE;
        docker push $FAIL_IMAGE; 
        docker rmi $FAIL_IMAGE;
      fi
    - docker rm $CONTAINER_NAME
    - exit $exit_code;
  artifacts:
    expire_in: 1 month
    paths:
      - log/
  timeout: 3h

.compiler-warning-template: &compiler-warning-template
  <<: *execution-conditions
  image: debian:10-slim
  stage: quality-checks
  variables:
    WARNING_REGEX: '.*warning[: ].*'
    GIT_STRATEGY: none
  script:
    - export OS=$(echo $CI_JOB_NAME | cut -d- -f 2)
    - export BUILD_TYPE=$(echo $CI_JOB_NAME | cut -d- -f 3)
    - export LOG_FILE="log/${OS}_${BUILD_TYPE}.log"
    - if [ $(grep -c "$WARNING_REGEX" $LOG_FILE) -ne 0 ];
      then
      grep --colour=always -A 1 -B 1 -0 "$WARNING_REGEX" $LOG_FILE;
        exit 1;
      fi
  allow_failure: true
  timeout: 15m

.clang-format-template: &clang-format-template
  <<: *execution-conditions
  image: debian:11-slim
  stage: quality-checks
  variables:
    CL_F_VER: 11
    TARGETS: library solvers templates tests utilities
  before_script:
    - apt-get update && apt-get install -y clang-format-$CL_F_VER git-core
  script:
    - echo `which clang-format-$CL_F_VER`
    - ln -s `which clang-format-$CL_F_VER` /usr/bin/clang-format
    - cd "$CI_PROJECT_DIR"
    - find $TARGETS -iname "*.cpp" -o -iname "*.h" -o -iname "*.hpp" | 
      xargs clang-format-11 --dry-run -Werror
  allow_failure: true
  timeout: 15m

.header-format-template: &header-format-template
  <<: *execution-conditions
  image: debian:11-slim
  stage: quality-checks
  variables:
    TARGETS: library solvers templates tests utilities
  script:
    - cd "$CI_PROJECT_DIR"
    - source .gitlab-ci/header-format-filename.sh
    - source .gitlab-ci/header-format-license.sh
  allow_failure: true
  timeout: 15m

.xml-format-template: &xml-format-template
  <<: *execution-conditions
  image: debian:11-slim
  stage: quality-checks
  variables:
    GIT_STRATEGY: clone
  before_script:
    - apt-get update && apt-get install -y dos2unix
  script:
    - cd "$CI_PROJECT_DIR"
    - .gitlab-ci/checkformatXMLfile.sh
  allow_failure: true
  timeout: 15m

################################################
###################  DEBIAN  ###################
################################################

.build-env-debian-template-default: &build-env-debian-template-default
  <<: *build-env-template
  stage: build-env-default

.build-env-debian-template-full: &build-env-debian-template-full
  <<: *build-env-debian-template-default
  stage: build-env-full

debian-bullseye-default-build-env:
  <<: *build-env-debian-template-default

debian-bullseye-full-build-env:
  <<: *build-env-debian-template-full
  variables:
    REMOVE_UCX: 1
  needs: ["debian-bullseye-default-build-env"]

debian-buster-default-build-env:
  <<: *build-env-debian-template-default

debian-buster-full-build-env:
  <<: *build-env-debian-template-full
  needs: ["debian-buster-default-build-env"]

debian-bullseye-default-build-and-test:
  <<: *build-and-test-template
  needs: ["debian-bullseye-default-build-env"]

debian-bullseye-full-build-and-test:
  <<: *build-and-test-template
  needs: ["debian-bullseye-full-build-env"]

debian-bullseye-full-avx2-build-and-test:
  <<: *build-and-test-template
  needs: ["debian-bullseye-full-build-env"]
  variables:
    BUILD_SIMD: avx2
  tags:
    - avx2

debian-bullseye-full-avx512-build-and-test:
  <<: *build-and-test-template
  needs: ["debian-bullseye-full-build-env"]
  variables:
    BUILD_SIMD: avx512
  tags:
    - avx512

debian-buster-default-build-and-test:
  <<: *build-and-test-template
  needs: ["debian-buster-default-build-env"]

debian-buster-full-build-and-test:
  <<: *build-and-test-template
  needs: ["debian-buster-full-build-env"]
  variables:
    GIT_SUBMODULE_STRATEGY: recursive


# COMPILER WARNINGS
debian-bullseye-default-warnings:
  <<: *compiler-warning-template
  needs: ["debian-bullseye-default-build-and-test"]

debian-bullseye-full-warnings:
  <<: *compiler-warning-template
  needs: ["debian-bullseye-full-build-and-test"]

debian-bullseye-full-avx2-warnings:
  <<: *compiler-warning-template
  needs: ["debian-bullseye-full-avx2-build-and-test"]

debian-buster-default-warnings:
  <<: *compiler-warning-template
  needs: ["debian-buster-default-build-and-test"]

debian-buster-full-warnings:
  <<: *compiler-warning-template
  needs: ["debian-buster-full-build-and-test"]


# CODE FORMATTING
debian-bullseye-clang-format:
  <<: *clang-format-template
  needs: []

debian-bullseye-header-format:
  <<: *header-format-template
  needs: []

debian-bullseye-xml-format:
  <<: *xml-format-template
  needs: []


# DOCUMENTATION
debian-bullseye-documentation-build-env:
  <<: *execution-conditions
  image: docker:19.03.6
  stage: build-env-full
  script:
    - export IMAGE=$CI_REGISTRY_IMAGE:env-documentation
    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
    - sed -e "s %%BASE_IMAGE%% $CI_REGISTRY_IMAGE g" docker/nektar-env/Dockerfile_debian_documentation > Dockerfile
    - docker pull $IMAGE || true
    - docker build --pull -t $IMAGE .
    - docker push $IMAGE
  needs: ["debian-bullseye-default-build-env"]

.build-documentation-template: &build-documentation-template
  <<: *build-and-test-template
  image: $CI_REGISTRY_IMAGE:env-documentation
  needs: ["debian-bullseye-documentation-build-env"]

user-guide-build:
  <<: *build-documentation-template
  script:
    - cmake -Bbuild -DCMAKE_BUILD_TYPE:STRING=Release -DNEKTAR_BUILD_LIBRARY:BOOL=OFF -DNEKTAR_BUILD_SOLVERS:BOOL=OFF -DNEKTAR_BUILD_UTILITIES:BOOL=OFF -DNEKTAR_BUILD_TESTS:BOOL=OFF -DNEKTAR_BUILD_DOC:BOOL=ON .
    - make -C build -j 4 user-guide-pdf user-guide-html developer-guide-pdf developer-guide-html
  artifacts:
    expire_in: 1 month
    paths:
      - build/docs/user-guide/user-guide.pdf
      - build/docs/user-guide/html
      - build/docs/developer-guide/developers-guide.pdf
      - build/docs/developer-guide/html

doxygen-build:
  <<: *build-documentation-template
  script:
    - cmake -Bbuild -DCMAKE_BUILD_TYPE:STRING=Release -DNEKTAR_BUILD_LIBRARY:BOOL=OFF -DNEKTAR_BUILD_SOLVERS:BOOL=OFF -DNEKTAR_BUILD_UTILITIES:BOOL=OFF -DNEKTAR_BUILD_TESTS:BOOL=OFF -DNEKTAR_BUILD_DOC:BOOL=ON .
    - make -C build doc
  artifacts:
    expire_in: 1 month
    paths:
      - build/docs/doxygen/html/

tutorials-build:
  <<: *build-documentation-template
  variables:
    GIT_SUBMODULE_STRATEGY: recursive
  script:
    - cmake -Bbuild -DCMAKE_BUILD_TYPE:STRING=Release .
    - make -C build -j 2 tutorials-pdf tutorials-html
  artifacts:
    expire_in: 1 month
    paths:
      - build/docs/tutorial/



################################################
###################  UBUNTU  ###################
################################################

.build-env-ubuntu-template-default: &build-env-ubuntu-template-default
  <<: *build-env-template
  stage: build-env-default

.build-env-ubuntu-template-full: &build-env-ubuntu-template-full
  <<: *build-env-ubuntu-template-default
  stage: build-env-full

ubuntu-jammy-default-build-env:
  <<: *build-env-ubuntu-template-default

ubuntu-jammy-full-build-env:
  <<: *build-env-ubuntu-template-full
  needs: ["ubuntu-jammy-default-build-env"]

ubuntu-focal-default-build-env:
  <<: *build-env-ubuntu-template-default

ubuntu-focal-full-build-env:
  <<: *build-env-ubuntu-template-full
  needs: ["ubuntu-focal-default-build-env"]

ubuntu-bionic-default-build-env:
  <<: *build-env-ubuntu-template-default

ubuntu-bionic-full-build-env:
  <<: *build-env-ubuntu-template-full
  needs: ["ubuntu-bionic-default-build-env"]

ubuntu-jammy-default-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-jammy-default-build-env"]

ubuntu-jammy-full-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-jammy-full-build-env"]

ubuntu-jammy-full-clang14-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-jammy-full-build-env"]
  variables:
    BUILD_CC: clang-14
    BUILD_CXX: clang++-14

ubuntu-jammy-full-clang14-avx2-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-jammy-full-build-env"]
  variables:
    BUILD_CC: clang-14
    BUILD_CXX: clang++-14
    BUILD_SIMD: avx2
  tags:
    - avx2

ubuntu-jammy-full-clang14-avx512-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-jammy-full-build-env"]
  variables:
    BUILD_CC: clang-14
    BUILD_CXX: clang++-14
    BUILD_SIMD: avx512
  tags:
    - avx512

ubuntu-focal-default-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-focal-default-build-env"]

ubuntu-focal-full-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-focal-full-build-env"]

ubuntu-bionic-default-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-bionic-default-build-env"]

ubuntu-bionic-full-build-and-test:
  <<: *build-and-test-template
  needs: ["ubuntu-bionic-full-build-env"]


# COMPILER WARNINGS
ubuntu-jammy-default-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-jammy-default-build-and-test"]

ubuntu-jammy-full-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-jammy-full-build-and-test"]

ubuntu-jammy-full-clang14-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-jammy-full-clang14-build-and-test"]

ubuntu-jammy-full-clang14-avx2-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-jammy-full-clang14-avx2-build-and-test"]

ubuntu-jammy-full-clang14-avx512-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-jammy-full-clang14-avx512-build-and-test"]

ubuntu-focal-default-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-focal-default-build-and-test"]

ubuntu-focal-full-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-focal-full-build-and-test"]

ubuntu-bionic-default-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-bionic-default-build-and-test"]

ubuntu-bionic-full-warnings:
  <<: *compiler-warning-template
  needs: ["ubuntu-bionic-full-build-and-test"]


################################################
###################  FEDORA  ###################
################################################

.build-env-fedora-template-default: &build-env-fedora-template-default
  <<: *build-env-template
  stage: build-env-default

.build-env-fedora-template-full: &build-env-fedora-template-full
  <<: *build-env-fedora-template-default
  stage: build-env-full

fedora-35-default-build-env:
  <<: *build-env-fedora-template-default

fedora-35-full-build-env:
  <<: *build-env-fedora-template-full
  needs: ["fedora-35-default-build-env"]

fedora-36-default-build-env:
  <<: *build-env-fedora-template-default

fedora-36-full-build-env:
  <<: *build-env-fedora-template-full
  needs: ["fedora-36-default-build-env"]

fedora-35-default-build-and-test:
  <<: *build-and-test-template
  needs: ["fedora-35-default-build-env"]

fedora-35-full-build-and-test:
  <<: *build-and-test-template
  needs: ["fedora-35-full-build-env"]

fedora-36-default-build-and-test:
  <<: *build-and-test-template
  needs: ["fedora-36-default-build-env"]

fedora-36-full-build-and-test:
  <<: *build-and-test-template
  needs: ["fedora-36-full-build-env"]


# COMPILER WARNINGS
fedora-35-default-warnings:
  <<: *compiler-warning-template
  needs: ["fedora-35-default-build-and-test"]

fedora-35-full-warnings:
  <<: *compiler-warning-template
  needs: ["fedora-35-full-build-and-test"]

fedora-36-default-warnings:
  <<: *compiler-warning-template
  needs: ["fedora-36-default-build-and-test"]

fedora-36-full-warnings:
  <<: *compiler-warning-template
  needs: ["fedora-36-full-build-and-test"]


# ################################################
# ###################  macOS  ####################
# ################################################

.build-and-test-macos-template: &build-and-test-macos-template
  <<: *build-and-test-template
  tags:
    - macos
  script:
    - mkdir -p log
    - export OS_VERSION="macos"
    - export NUM_CPUS=8
    - bash -x ./.gitlab-ci/build-and-test.sh |
      tee log/${OS_VERSION}_${BUILD_TYPE}.log

# Intel runners
macos-default-intel-build-and-test:
  <<: *build-and-test-macos-template
  variables:
    BUILD_TYPE: "default"
  needs: []

macos-full-intel-build-and-test:
  <<: *build-and-test-macos-template
  variables:
    BUILD_TYPE: "full"
  needs: []

macos-default-intel-warnings:
  <<: *compiler-warning-template
  needs: ["macos-default-intel-build-and-test"]

macos-full-intel-warnings:
  <<: *compiler-warning-template
  needs: ["macos-full-intel-build-and-test"]

# ARM runners
macos-default-arm-build-and-test:
  <<: *build-and-test-macos-template
  tags:
    - macos-arm
  variables:
    BUILD_TYPE: "default"
  needs: []

macos-full-arm-build-and-test:
  <<: *build-and-test-macos-template
  tags:
    - macos-arm
  variables:
    BUILD_TYPE: "full"
  needs: []

macos-default-arm-warnings:
  <<: *compiler-warning-template
  needs: ["macos-default-arm-build-and-test"]

macos-full-arm-warnings:
  <<: *compiler-warning-template
  needs: ["macos-full-arm-build-and-test"]


# ################################################
# #################  WINDOWS  ####################
# ################################################

win10-default-build-and-test:
  <<: *build-and-test-template
  tags:
    - win10
  script:
    - $Env:path = "$CI_PROJECT_DIR\build\dist\bin;$CI_PROJECT_DIR\ThirdParty;$CI_PROJECT_DIR\build\ThirdParty\dist\bin;" + $Env:path
    - echo $Env:path
    - mkdir build
    - cd build
    - cmake.exe -G "Visual Studio 14 2015 Win64" --config Debug ..
    - cmake.exe --build . --target ALL_BUILD --config Debug
    - cmake.exe --build . --target INSTALL --config Debug
    - ctest --output-on-failure -C Debug -j8
  after_script:
    # This script identifies any orphan Tester-g processes still running
    # and terminates them (and their children recursively), to ensure the build
    # files can then be removed.
    #
    # The function Kill-ProcessTree gets all the processes (Get-CimInstance
    # Win32_Process) and selects those which have $ppid as their parent. It
    # recursively calls Kill-ProcessTree on them to kill their children. It
    # finally kills the process itself.
    #
    # The script below identifies all orphaned Tester-g processes and calls
    # Kill-ProcessTree to kill each of them. It then removes the source and
    # build trees to maximise space on the runner in light of multiple forks.
    - function Kill-ProcessTree {
        Param([int]$ppid)
        Get-CimInstance Win32_Process | Where-Object {
          $_.ParentProcessId -eq $ppid 
        } | ForEach-Object { 
          Kill-ProcessTree $_.ProcessId
        }
        Stop-Process -Id $ppid -Force
      };
      $tester = Get-Process Tester-g -ErrorAction SilentlyContinue ;
      if ($tester) {
        Kill-ProcessTree $tester.Id
        Sleep 5
      } ;
      Remove-Item -Force -Recurse *
  needs: []
  artifacts:
  timeout: 4h

win10-mpi-default-build-and-test:
  <<: *build-and-test-template
  tags:
    - win10
  script:
    - $Env:path = "$CI_PROJECT_DIR\build\dist\bin;$CI_PROJECT_DIR\ThirdParty;$CI_PROJECT_DIR\build\ThirdParty\dist\bin;" + $Env:path
    - echo $Env:path
    - mkdir build
    - cd build
    - cmake.exe -G "Visual Studio 14 2015 Win64" -DNEKTAR_USE_MPI=ON --config Debug ..
    - cmake.exe --build . --target ALL_BUILD --config Debug
    - cmake.exe --build . --target INSTALL --config Debug
    - ctest --output-on-failure -C Debug -j8
  after_script:
    # This script identifies any orphan Tester-g processes still running
    # and terminates them (and their children recursively), to ensure the build
    # files can then be removed.
    #
    # The function Kill-ProcessTree gets all the processes (Get-CimInstance
    # Win32_Process) and selects those which have $ppid as their parent. It
    # recursively calls Kill-ProcessTree on them to kill their children. It
    # finally kills the process itself.
    #
    # The script below identifies all orphaned Tester-g processes and calls
    # Kill-ProcessTree to kill each of them. It then removes the source and
    # build trees to maximise space on the runner in light of multiple forks.
    - function Kill-ProcessTree {
        Param([int]$ppid)
        Get-CimInstance Win32_Process | Where-Object {
          $_.ParentProcessId -eq $ppid
        } | ForEach-Object {
          Kill-ProcessTree $_.ProcessId
        }
        Stop-Process -Id $ppid -Force
      };
      $tester = Get-Process Tester-g -ErrorAction SilentlyContinue ;
      if ($tester) {
        Kill-ProcessTree $tester.Id
        Sleep 5
      } ;
      Remove-Item -Force -Recurse *
  needs: []
  artifacts:
  timeout: 4h

# ##################################################
# #################  DOCKERHUB  ####################
# ##################################################

# Docker Hub build template. We build images and push them into the gitlab
# container registry first; this way, we can test the images before they are
# deployed, modify images or test adjustments to the CI by using docker/*
# branches on gitlab, and test the images before they are deployed.
#
# Images are tagged with both :latest and the short SHA commit, so that the
# correct image version can be grabbed from the container registry.
.dockerhub_build_template: &dockerhub_build_template
  image: docker:stable
  <<: *execution-conditions
  script:
    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
    - IMAGE=$CI_REGISTRY_IMAGE/${image_name}
    - docker pull $IMAGE || true
    - docker build ${args} --pull -t $IMAGE -f ${dockerfile} .
    - docker tag $IMAGE $IMAGE:$CI_COMMIT_SHORT_SHA
    - docker tag $IMAGE $IMAGE:latest
    - docker push $IMAGE:$CI_COMMIT_SHORT_SHA
    - docker push $IMAGE:latest

# Docker Hub test template, which runs an image from the gitlab container
# registry on a particular SHA commit.
.dockerhub-test-template: &dockerhub_test_template
  image: ${CI_REGISTRY_IMAGE}/${image_name}:$CI_COMMIT_SHORT_SHA
  <<: *execution-conditions
  stage: package-test
  script:
    - mpirun -n 3 IncNavierStokesSolver $CI_PROJECT_DIR/solvers/IncNavierStokesSolver/Tests/ChanFlow_m3_par.xml
    - test_output=`IncNavierStokesSolver $CI_PROJECT_DIR/solvers/IncNavierStokesSolver/Tests/ChanFlow_m3_par.xml | grep "L 2 error (variable u)" | awk '{print ($7 < 1e-7)}'`
    - if [ "$test_output" -eq 0 ]; then echo "Tolerance test failed on parallel IncNavierStokesSolver run"; exit 1; fi
    - cd $CI_PROJECT_DIR/library/Demos/Python/MultiRegions
    - mpirun -n 2 python3 Helmholtz2D.py ../../MultiRegions/Tests/Helmholtz2D_P7.xml
    - test_output=`mpirun -n 2 python3 Helmholtz2D.py ../../MultiRegions/Tests/Helmholtz2D_P7.xml | grep "L 2 error (variable nek)" | awk '{print ($7 < 1e-4)}'`
    - if [ "$test_output" -eq 0 ]; then echo "Tolerance test failed on parallel Python run"; exit 1; fi

# Docker Hub deployment template. Only builds for master or tags on the main
# Nektar repository. The strategy is to login to the container registry and pull
# an image onto the runner; we then tag the image as appropriate (with :latest
# and SHA commit, as well as the git tag if this happens to be a tagged commit),
# then push the image up to Docker Hub. Note that cleanup of images on the
# runners can be difficult if they are tagged multiple times, so we also perform
# a quick rmi to make sure we only keep the images from the registry.
.dockerhub-deploy-template: &dockerhub_deploy_template
  <<: *execution-conditions
  image: docker:stable
  stage: package-deploy
  only:
    - master@nektar/nektar
    - tags@nektar/nektar
  script:
    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
    - CI_IMAGE=$CI_REGISTRY_IMAGE/${image_name}:$CI_COMMIT_SHORT_SHA
    - DH_IMAGE=${DOCKERIO_REGISTRY}/nektarpp/${image_name}
    - docker pull $CI_IMAGE
    - docker logout
    - docker login -u "$DOCKERIO_REGISTRY_USER" -p "$DOCKERIO_REGISTRY_PASSWORD" $DOCKERIO_REGISTRY
    - if [ ! -z $CI_COMMIT_TAG ]; then docker tag $CI_IMAGE $DH_IMAGE:$CI_COMMIT_TAG; docker push $DH_IMAGE:$CI_COMMIT_TAG; docker rmi $DH_IMAGE:$CI_COMMIT_TAG; fi
    - docker tag $CI_IMAGE $DH_IMAGE:$CI_COMMIT_SHORT_SHA
    - docker tag $CI_IMAGE $DH_IMAGE:latest
    - docker push $DH_IMAGE:$CI_COMMIT_SHORT_SHA
    - docker push $DH_IMAGE:latest
    - docker rmi $DH_IMAGE:$CI_COMMIT_SHORT_SHA $DH_IMAGE:latest

# nektarpp/nektar-env image
dockerhub-build-env:
  <<: *dockerhub_build_template
  stage: package-env
  needs: []
  variables:
    image_name: nektar-env
    dockerfile: docker/nektar-env/Dockerfile

# nektarpp/nektar image
dockerhub-build-nektar:
  <<: *dockerhub_build_template
  stage: package-build
  needs: [ "dockerhub-build-env" ]
  variables:
    image_name: nektar
    dockerfile: docker/nektar/Dockerfile
    args: --build-arg ENV_IMAGE=$CI_REGISTRY_IMAGE/nektar-env:$CI_COMMIT_SHORT_SHA
    GIT_SUBMODULE_STRATEGY: normal

# nektarpp/nektar image
dockerhub-build-workbook:
  <<: *dockerhub_build_template
  stage: package-build
  needs: []
  variables:
    image_name: nektar-workbook
    dockerfile: docker/nektar-workbook/Dockerfile

# nektarpp/nektar-dev image
dockerhub-build-dev:
  <<: *dockerhub_build_template
  stage: package-build-dev
  needs: [ "dockerhub-build-nektar" ]
  variables:
    image_name: nektar-dev
    args: --build-arg ENV_IMAGE=$CI_REGISTRY_IMAGE/nektar-env:$CI_COMMIT_SHORT_SHA --build-arg NEKTAR_IMAGE=$CI_REGISTRY_IMAGE/nektar:$CI_COMMIT_SHORT_SHA
    dockerfile: docker/nektar-dev/Dockerfile

# Test the dockerhub images: runs a quick solve and Python code.
dockerhub-test-nektar:
  <<: *dockerhub_test_template
  needs: [ "dockerhub-build-nektar" ]
  variables:
    image_name: nektar

dockerhub-test-nektar-dev:
  <<: *dockerhub_test_template
  needs: [ "dockerhub-build-dev" ]
  variables:
    image_name: nektar-dev
  script:
    - cd $CI_PROJECT_DIR/templates/executable
    - ./test.sh /usr/local/lib64/nektar++/cmake 3 /usr/bin/cmake

dockerhub-test-workbook:
  <<: *dockerhub_test_template
  needs: [ "dockerhub-build-workbook" ]
  variables:
    image_name: nektar-workbook

# Deployment
dockerhub-deploy-nektar:
  <<: *dockerhub_deploy_template
  needs: [ "dockerhub-test-nektar" ]
  variables:
    image_name: nektar
dockerhub-deploy-nektar-env:
  <<: *dockerhub_deploy_template
  needs: [ "dockerhub-build-env" ]
  variables:
    image_name: nektar-env
dockerhub-deploy-nektar-dev:
  <<: *dockerhub_deploy_template
  needs: [ "dockerhub-test-nektar-dev" ]
  variables:
    image_name: nektar-dev
dockerhub-deploy-nektar-workbook:
  <<: *dockerhub_deploy_template
  needs: [ "dockerhub-build-workbook" ]
  variables:
    image_name: nektar-workbook