.gitlab-ci.yml

# A pipeline is composed of independent jobs that run scripts, grouped into stages.
# Stages run in sequential order, but jobs within stages run in parallel.
#
# For more information, see: https://docs.gitlab.com/ee/ci/yaml/index.html#stages



####################################################################################################
# global settings
####################################################################################################

# list of stages and order of execution
stages:
  - build
  - cleanup_build
  - test
  - cleanup
#   - deploy

# workflow rules (exclude issue branches from pipeline)
workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == "web"
      when: always
    # - changes:
    #   - src/*
    #   - src/*/*
    #   - CMakeLists.txt
    #   when: always
    - if: '$CI_COMMIT_BRANCH =~ /^[\d]+-.*$/'
      when: never
    - if: $CI_COMMIT_MESSAGE =~ /-draft$/
      when: never
    - if: $CI_PIPELINE_SOURCE == "push"
      when: never
    # - when: always

# global variables for all jobs
variables:
  OUTPUT_DIR: output  # Adjust this to your Fortran code's output directory
  TEST_DIR: test      # Adjust this to your Fortran code's output directory
  COMPARE_OUTPUT: ../../tools/output_comparison.py # python output file comparison script

# special job that runs before any other stages
before_script:
  - echo "Setting up environment for jobs"
  - export MODULEPATH="/opt/intel/oneapi/modulefiles:/opt/intel/oneapi/tbb/latest/modulefiles:$MODULEPATH"
  - export MODULEPATH="/home/ned/modules/modulefiles:$MODULEPATH"
#  - apt-get update -qy
#  - apt-get install -y gfortran  # Install gfortran (or any other Fortran compiler you prefer)


####################################################################################################
# jobs
####################################################################################################

# build job - gfortran
build:gfortran:
  stage: build
  when: always
  script:
    # need to query modules before gcc can be found and loaded
    - module avail
    # - /usr/local/gcc-13.2.0/bin/gfortran-13.2.0 --version
    - module load gcc/13.2.0
    - which gfortran-13.2.0
    - gfortran-13.2.0 --version
    - mkdir -p $OUTPUT_DIR
    - echo "Compiling the code using gfortran..."
    - mkdir -p build
    - cd build
    - cmake3 -DCMAKE_BUILD_TYPE="Release" -DCMAKE_INSTALL_PREFIX="../bin" -DCMAKE_Fortran_COMPILER="gfortran-13.2.0" ..
    - make
    - make install
    - cd ..
    - echo "Compile complete using gfortran."
  artifacts:
    paths:
      - bin/
  tags:
    - gfortran

# build job - ifort
build:ifort:
  stage: build
  when: always
  script:
    # - /opt/intel/oneapi/compiler/2023.2.1/linux/bin/intel64/ifort --version
    - module load compiler/2023.2.1
    - which ifort
    - ifort --version
    - mkdir -p $OUTPUT_DIR
    - echo "Compiling the code using ifort..."
    - mkdir -p build
    - cd build
    - cmake3 -DCMAKE_BUILD_TYPE="Release" -DCMAKE_INSTALL_PREFIX="../bin" -DCMAKE_Fortran_COMPILER="ifort" ..
    - make
    - make install
    - cd ..
    - echo "Compile complete using ifort."
  artifacts:
    paths:
      - bin/
  tags:
    - ifort

# build job - ifx
build:ifx:
  stage: build
  when: always
  script:
    # - /opt/intel/oneapi/compiler/2023.2.1/linux/bin/ifx --version
    - module load compiler/2023.2.1
    - which ifx
    - ifx --version
    - mkdir -p $OUTPUT_DIR
    - echo "Compiling the code using ifx..."
    - mkdir -p build
    - cd build
    - cmake3 -DCMAKE_BUILD_TYPE="Release" -DCMAKE_INSTALL_PREFIX="../bin" -DCMAKE_Fortran_COMPILER="ifx" ..
    - make
    - make install
    - cd ..
    - echo "Compile complete using ifx."
  artifacts:
    paths:
      - bin/
  tags:
    - ifx


####################################################################################################
# compilation cleanup on failure
####################################################################################################

# cleanup build job
cleanup_build_job:
  stage: cleanup_build
  when: on_failure
  script:
    - echo "Performing cleanup tasks after failed build jobs"
    - rm -r build


####################################################################################################
# test jobs
####################################################################################################

# unit test job - gfortran
test:gfortran: 
  stage: test
  needs: ["build:gfortran"]
  script:
    # need to query modules before gcc can be found and loaded
    - module avail
    - module load gcc/13.2.0
    - echo "Running unit tests..."
    - cd $TEST_DIR/mnist
    - make FC=gfortran-13.2.0 build
    - ./bin/athena_test -f test_job.in >actual_output.txt
    - python $COMPARE_OUTPUT expected_output_gfortran.txt actual_output.txt
    - cd -
  artifacts:
    paths:
      - $TEST_DIR/mnist/actual_output.txt
  tags:
    - gfortran

# unit test job - ifort
test:ifort:
  stage: test
  needs: ["build:ifort"]
  script:
    - module load compiler/2023.2.1
    - echo "Running unit tests..."
    - cd $TEST_DIR/mnist
    - make FC=ifort build
    - ./bin/athena_test -f test_job.in >actual_output.txt
    - python $COMPARE_OUTPUT expected_output_ifort.txt actual_output.txt
    - cd -
  artifacts:
    paths:
      - $TEST_DIR/mnist/actual_output.txt
  tags:
    - ifort

# unit test job - ifx
test:ifx:
  stage: test
  needs: ["build:ifx"]
  script:
    - module load compiler/2023.2.1
    - echo "Running unit tests..."
    - cd $TEST_DIR/mnist
    - make FC=ifx build
    - ./bin/athena_test -f test_job.in >actual_output.txt
    - python $COMPARE_OUTPUT expected_output_ifx.txt actual_output.txt
    - cd -
  artifacts:
    paths:
      - $TEST_DIR/mnist/actual_output.txt
  tags:
    - ifx


####################################################################################################
# test cleanup on success
####################################################################################################

# cleanup job after test jobs
cleanup_job:
  stage: cleanup
  when: on_success
  script:
    - echo "Performing cleanup tasks after jobs"
    - rm -r build
    - rm -r test/*/obj
    - rm -r test/*/bin
    - rm -r bin


# lint-test-job:   # This job also runs in the test stage.
#   stage: test    # It can run at the same time as unit-test-job (in parallel).
#   script:
#     - echo "Linting code... This will take about 10 seconds."
#     - sleep 10
#     - echo "No lint issues found."

# deploy-job:      # This job runs in the deploy stage.
#   stage: deploy  # It only runs when *both* jobs in the test stage complete successfully.
#   environment: production
#   script:
#     - echo "Deploying application..."
#     - echo "Application successfully deployed."