.gitlab-ci.yml

variables:
  GIT_STRATEGY: $CORSIKA8_GIT_STRATEGY # clone: fresh clone, fetch: update
  GIT_SSL_NO_VERIFY: "1"
  GIT_DEPTH: "2"
  # to re-use clones also in different forks
  GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_CONCURRENT_ID/$CI_PROJECT_NAME
  ## Runtime options for sanitizers
  # (detect_leaks=0 because leak detection doesn't work in CI, but you can
  # try to test with leak detection locally by using detect_leaks=1)
  UBSAN_OPTIONS: "print_stacktrace=1"
  LSAN_OPTIONS: "log_threads=1"
  ASAN_OPTIONS: "detect_leaks=0:detect_stack_use_after_return=1"
  # location of AirShowerPhysics/corsika-data
  CORSIKA_DATA: "${CI_PROJECT_DIR}/modules/data" # the git submodule
  corsika_DIR: "${CI_PROJECT_DIR}/build/install" # for cmake to find corsikaConfig.cmake
  # _alternatively_ corsika-data can be downloaded as submodule:
  GIT_SUBMODULE_STRATEGY: recursive # none: we get the submodules in before_script,
                                 # normal: get submodules automatically
  CTEST_OUTPUT_ON_FAILURE: 1


#
# multi-step pipeline for each commit
#
# Note: "Draft/WIP:" merge request, non-Draft/non-WIP merge requests and "Ready for Code Review" MR are all
#       handled explicitly
#
stages:
  - quality
  - config
  - build_test
  - build_test_example
  - python
  - optional



####### CODE QUALITY CHECK ##############

##########################################################
check-copyrights:
  image: corsika/devel:u-22.04
  stage: quality
  tags:
    - corsika
  script:
    - ./do-copyright.py
  rules:
    - if: $CI_MERGE_REQUEST_ID
    - if: $CI_COMMIT_TAG
    - if: $CI_COMMIT_BRANCH
  allow_failure: true

##########################################################
check-clang-format:
  image: corsika/devel:clang-8
  stage: quality
  tags:
    - corsika
  script:
    - ./do-clang-format.py --all
  rules:
    - if: $CI_MERGE_REQUEST_ID
    - if: $CI_COMMIT_TAG
    - if: $CI_COMMIT_BRANCH
  allow_failure: true

### CodeQuality tool ####
#include:
#  - template: Code-Quality.gitlab-ci.yml
#
#code_quality:
#  stage: quality
#  rules:
#    - if: '$CODE_QUALITY_DISABLED'
#      when: never
#    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' # Run code quality job in merge request pipelines
#    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'      # Run code quality job in pipelines on the master branch (but not in other branch pipelines)
#    - if: '$CI_COMMIT_TAG'                               # Run code quality job in pipelines for tags

####### CONFIG ##############

##########################################################
# the generic config template job
# job/stage to just prepare cmake
.config:
  stage: config
  tags:
    - corsika
  script:
    - mkdir -p build
    - cd build
    - ../conan-install.sh
    - cmake .. -DCMAKE_INSTALL_PREFIX=$PWD/install -DCMAKE_BUILD_TYPE=Debug -DUSE_Pythia8_C8=C8
  rules:
    - if: $CI_MERGE_REQUEST_ID
    - if: $CI_COMMIT_TAG
    - if: $CI_COMMIT_BRANCH
  artifacts:
    when: on_failure
    expire_in: 3 days
    paths:
      - ${CI_PROJECT_DIR}/build/CMakeFiles/CMakeOutput.log

# config for gcc
config-u-22_04:
  extends: .config
  image: corsika/devel:u-22.04

# config for clang
config-clang-14:
  extends: .config
  image: corsika/devel:clang-14



####### BUILD-TEST (all builds <= Draft/WIP, default) ##############

##########################################################
# the generic build_test template job
# normal pipeline for each commit
.build_test:
  stage: build_test
  tags:
    - corsika
  script:
    - mkdir -p build
    - cd build
    - ../conan-install.sh
    - cmake .. -DCMAKE_BUILD_TYPE=Debug -DUSE_Pythia8_C8=C8
    - cmake --build . -- -j4
    - set -o pipefail
    - ctest -j4 
  rules:
    - if: '$CI_MERGE_REQUEST_ID && ($CI_MERGE_REQUEST_TITLE =~ /^Draft:/ || $CI_MERGE_REQUEST_TITLE =~ /^WIP:/)'
      allow_failure: false
    - if: $CI_MERGE_REQUEST_ID
      when: manual
      allow_failure: true
  artifacts:
    when: always
    expire_in: 3 days
    paths:
      - ${CI_PROJECT_DIR}/build/test_outputs/junit*.xml
    reports:
      junit:
        - ${CI_PROJECT_DIR}/build/test_outputs/junit*.xml

# build_test for gcc
build_test-u-22_04:
  extends: .build_test
  image: corsika/devel:u-22.04
  needs:
    - job: config-u-22_04
      artifacts: false

# build_test for clang
build_test-clang-14:
  extends: .build_test
  image: corsika/devel:clang-14
  needs:
    - job: config-clang-14
      artifacts: false



####### BUILD-TEST-EXAMPLE (only non-Draft/non-WIP)  ##############

##########################################################
# generic example template job
# normal pipeline for each commit
# artefacts are needed as input for python jobs
.build_test_example:
  stage: build_test_example
  tags:
    - corsika
  script:
    - mkdir -p build
    - cd build
    - ../conan-install.sh
    - cmake .. -DCMAKE_INSTALL_PREFIX=$PWD/install -DCMAKE_BUILD_TYPE=Debug -DUSE_Pythia8_C8=C8
    - cmake --build . -- VERBOSE=1 -j4
    - set -o pipefail
    - ctest -j4
    - cmake --install .
    - mkdir -p build_examples
    - cd build_examples
    - cmake -DCMAKE_BUILD_TYPE=Debug ../install/share/corsika/examples
    - cmake --build . -- -j2
    - cmake --build . --target run_examples -- -j2 
  rules:
    - if: '$CI_MERGE_REQUEST_ID && ($CI_MERGE_REQUEST_TITLE =~ /^Draft:/ || $CI_MERGE_REQUEST_TITLE =~ /^WIP:/)'
      when: manual
      allow_failure: true
    - if: $CI_COMMIT_BRANCH
    - if: $CI_MERGE_REQUEST_ID
    - if: $CI_COMMIT_TAG
      when: manual
      allow_failure: true
  artifacts:
    when: always
    expire_in: 3 days
    reports:
      junit:
        - ${CI_PROJECT_DIR}/build/test_outputs/junit*.xml
    paths:
      - ${CI_PROJECT_DIR}/build/build_examples/example_outputs
      - ${CI_PROJECT_DIR}/build/test_outputs/junit*.xml

# build_test_example for gcc
build_test_example-u-22_04:
  extends: .build_test_example
  image: corsika/devel:u-22.04
  needs:
    - job: config-u-22_04
      artifacts: false


# build_test_example for clang
build_test_example-clang-14:
  extends: .build_test_example
  image: corsika/devel:clang-14
  needs:
    - job: config-clang-14
      artifacts: false





####### OPTIONAL ##############

##########################################################
# generic release template job
# optional release pipeline for each commit
.release:
  stage: optional
  tags:
    - corsika
  script:
    - mkdir -p build
    - cd build
    - ../conan-install.sh
    - cmake .. -DCMAKE_INSTALL_PREFIX=$PWD/install -DCMAKE_BUILD_TYPE=Release -DUSE_Pythia8_C8=C8
    - cmake --build . -- -j4
    - set -o pipefail
    - ctest -j4
    - cmake --install .
    - mkdir -p build_examples
    - cd build_examples
    - cmake -DCMAKE_BUILD_TYPE=Release ../install/share/corsika/examples
    - cmake --build . -- VERBOSE=1 -j2
    - cmake --build . --target run_examples -- -j2 
  rules:
    - if: '$CI_MERGE_REQUEST_LABELS =~ /Ready for Code Review/' # run on merge requests, if label 'Ready for Code Review' is set
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
      when: manual
      allow_failure: true
    - if: $CI_MERGE_REQUEST_ID
      when: manual
      allow_failure: true
    - if: $CI_COMMIT_TAG
      when: manual
      allow_failure: true
  artifacts:
    when: always
    expire_in: 3 days
    reports:
      junit:
        - ${CI_PROJECT_DIR}/build/test_outputs/junit*.xml
    paths:
      - ${CI_PROJECT_DIR}/build/test_outputs/junit*.xml

# release for gcc
release-full-u-22_04:
  extends: .release
  image: corsika/devel:u-22.04
  needs:
    - job: config-u-22_04
      artifacts: false

# release for clang
release-full-clang-14:
  extends: .release
  image: corsika/devel:clang-14
  needs:
    - job: config-clang-14
      artifacts: false




##########################################################
# the coverage generation should either run when manually requested, OR always on the master

coverage:
  image: corsika/devel:u-22.04
  needs:
    - job: config-u-22_04
      artifacts: false
  stage: optional
  tags:
    - corsika
  script:
    - mkdir -p build
    - cd build
    - ../conan-install.sh
    - cmake .. -DCMAKE_BUILD_TYPE=Coverage -DUSE_Pythia8_C8=C8
    - cmake --build . -- -j4
    - ctest -j4 
    - cmake --build . --target coverage
    - tar czf coverage-report.tar.gz coverage-report
  coverage: '/^.*lines\.+:\s(.*\%)\s/'
  rules:
    - if: '$CI_MERGE_REQUEST_LABELS =~ /Ready for Code Review/' # run on merge requests, if label 'Ready for Code Review' is set
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
    - if: $CI_MERGE_REQUEST_ID
      when: manual
      allow_failure: true
    - if: $CI_COMMIT_TAG
      when: manual
      allow_failure: true
  artifacts:
    when: always
    expire_in: 3 month
    paths:
      - ${CI_PROJECT_DIR}/build/coverage-report.tar.gz







##########################################################
sanity:
  image: corsika/devel:u-22.04
  needs:
    - job: config-u-22_04
      artifacts: false

  stage: optional
  tags:
    - corsika
  script:
    - mkdir -p build
    - cd build
    - ../conan-install.sh
    - cmake .. -DWITH_CORSIKA_SANITIZERS_ENABLED=ON -DCMAKE_BUILD_TYPE=Debug -DUSE_Pythia8_C8=C8
    - cmake --build . -- -j4
  rules:
    - if: '$CI_MERGE_REQUEST_LABELS =~ /Ready for Code Review/' # run on merge requests, if label 'Ready for Code Review' is set
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
      when: manual
      allow_failure: true
    - if: $CI_MERGE_REQUEST_ID
      when: manual
      allow_failure: true
    - if: $CI_COMMIT_TAG
      when: manual
      allow_failure: true


######  Python ##########

##########################################################
# template for all Python jobs
.python:
  stage: python
  tags:
    - corsika
  script:
    - cd ${CI_PROJECT_DIR}/python  # change into the Python directory
    - pip3 install --user -e '.[test]'  # install the package + test deps
    - python3 --version
    - python3 -m mypy corsika
    - python3 -m isort --atomic --check-only corsika tests
    - python3 -m black -t py37 corsika tests
    - python3 -m flake8 corsika tests
    - python3 -m pytest --cov=corsika tests
    - cd ${CI_PROJECT_DIR}  # reset the directory
  coverage: '/^TOTAL\s*\d+\s*\d+\s*(.*\%)/'

# the default Python version Ubuntu 22.04 is Python3.8
python-3.8:
  extends: .python
  image: corsika/analysis:python-3.9.5
  needs:
    - job: build_test_example-u-22_04
      artifacts: true
  artifacts:
    when: always
    expire_in: 3 month
    paths:
      - ${CI_PROJECT_DIR}/Python/python-test.log
  allow_failure: true