.gitlab-ci.yml

stages:
  - image-build
  - apiwrap
  - fetch-scripts
  - build
  - analyze
  - test
  # - test-gdxtools
  - leak-check
  - perf-check
  - docs
  - deploy

#=======================================================================================================================

include:
  - project: 'devel/ciscripts'
    file: '.shared-vars.yml'
  - project: 'devel/ciscripts'
    file: '.codechecker.yml'
  - project: 'devel/ciscripts'
    file: '.shared-snippets.yml'
  - project: 'devel/ciscripts'
    file: '.fetch-job.yml'
  - project: 'devel/ciscripts'
    file: '.image-build.yml'

variables:
  extends: .shared-variables
  GIT_SUBMODULE_STRATEGY: recursive

#=======================================================================================================================

build-leg-image:
  extends: .build-leg-image
  script:
    - docker build -t registry.gams.com/devel/gdx/leg/builder-gdx:latest ci/images/leg
    - docker push registry.gams.com/devel/gdx/leg/builder-gdx:latest

build-leg-analyze-image:
  extends: .build-leg-image
  script:
    - docker build -t registry.gams.com/devel/gdx/leg/builder-analyze:latest ci/images/leg-analyze
    - docker push registry.gams.com/devel/gdx/leg/builder-analyze:latest

build-leg-deploy-image:
  extends: .build-leg-image
  script:
    - docker build -t registry.gams.com/devel/gdx/leg/builder-deploy:latest ci/images/leg-deploy
    - docker push registry.gams.com/devel/gdx/leg/builder-deploy:latest

#=======================================================================================================================

apigenerator:
  stage: apiwrap
  tags: [linux]
  dependencies: []
  image:
    name: registry.gams.com/devel/gdx/leg/builder-gdx:latest
    entrypoint: [ "" ]
  script:
    - mkdir -p apifiles
    - python3 src/yaml2doxy.py --input src/gdxapi.yaml --template_folder src/templates --output apifiles/gdx.h
    - python3 src/yaml2cwrap.py --input src/gdxapi.yaml --template_folder src/templates --output apifiles/gdxcwrap.hpp
    - >
      python3
      src/yaml2cwrap.py
      --input src/gdxapi.yaml
      --output apifiles/gdxcppwrap.h 
      --template_folder src/templates
      --template gdxcppwrap.template.j2
    # somehow I need absolute path for apidef arg
    - python3 src/apigenerator/src/mkapi.py --apidef `pwd`/src/gdxapi.yaml --outputpath apifiles/ --output cc cpplib
    - cp src/apigenerator/include/gc*.h apifiles
    - cp src/gdx.h generated/gdx.h
    - |
      for f in "gdxcc.h" "gdxcc.c" "gdxcclib.cpp" "gclgms.h" "gdx.h" "gdxcwrap.hpp" "gdxcppwrap.h"; do
        echo "Diffing 'apifiles/$f' with 'generated/$f'"
        if ! diff -w --strip-trailing-cr apifiles/$f generated/$f; then
          echo "Warning: $f stored in repo and freshly generated differ!"
        fi
      done
  artifacts:
    name: apifiles
    expire_in: 2 hours
    paths: [apifiles/*]

#=======================================================================================================================

build-leg:
  stage: build
  tags: [linux]
  image:
    name: $MACHINES_CONTAINER_REG/leg/builder-devel:latest
    entrypoint: [""]
  script:
    - !reference [.get-gams]
    - !reference [.gams-folder-leg]
    - cp apifiles/* src/
    - cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_VERBOSE_MAKEFILE:BOOL=OFF CMakeLists.txt
    - cmake --build . 2>&1 | tee build_log.txt
    - python3 ciscripts/report_for_log.py gcc build_log.txt warnings.xml
    - mv libgdx-static.a libgdx-linux.a
    - mkdir -p ./build
    - mv {gdxdump,gdxdiff,gdxmerge} ./build
  needs: [fetch-ci-scripts,apigenerator]
  artifacts:
    name: gdx-leg
    paths: [gdxtest,gdxwraptest,libgdxcclib64.so,libgdx-linux.a,build]
    expire_in: 2 hours
    reports:
      junit: warnings.xml

build-debug-leg:
  stage: build
  tags: [linux]
  image:
    name: $MACHINES_CONTAINER_REG/leg/builder-devel:latest
    entrypoint: [""]
  script:
    - !reference [.get-gams]
    - !reference [.gams-folder-leg]
    - cp apifiles/* src/
    - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_VERBOSE_MAKEFILE:BOOL=OFF CMakeLists.txt
    - cmake --build . 2>&1
    - mv gdxtest gdxtest_dbg
  needs: [fetch-ci-scripts,apigenerator]
  artifacts:
    name: gdx-debug-leg
    paths: [gdxtest_dbg]
    expire_in: 2 hours

build-deg:
  stage: build
  tags: [macos]
  script:
    - !reference [.get-gams]
    - !reference [.gams-folder-deg]
    - cp apifiles/* src/
    - cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_VERBOSE_MAKEFILE:BOOL=OFF -DCMAKE_CXX_COMPILER=clang++ CMakeLists.txt
    - cmake --build . 2>&1 | tee build_log.txt
    - python3 ciscripts/report_for_log.py clang build_log.txt warnings.xml
    - mv libgdx-static.a libgdx-macos.a
    - mkdir -p ./build
    - mv {gdxdump,gdxdiff,gdxmerge} ./build
  needs: [fetch-ci-scripts,apigenerator]
  artifacts:
    name: gdx-deg
    paths: [gdxtest,gdxwraptest,libgdxcclib64.dylib,libgdx-macos.a,build]
    expire_in: 2 hours
    reports:
      junit: warnings.xml

build-dac:
  stage: build
  tags: [macos-arm64]
  script:
    - !reference [.get-gams]
    - !reference [.gams-folder-dac]
    - mv libgdxcclib64.dylib libgdxcclib64_deg.dylib
    - mv libgdx-macos.a libgdx-macos-deg.a
    - cp apifiles/* src/
    - cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_VERBOSE_MAKEFILE:BOOL=OFF -DCMAKE_CXX_COMPILER=clang++ CMakeLists.txt
    - cmake --build . 2>&1 | tee build_log.txt
    - python3 ciscripts/report_for_log.py clang build_log.txt warnings.xml
    - mv libgdxcclib64.dylib libgdxcclib64_dac.dylib
    - mv libgdx-static.a libgdx-macos-dac.a
    - lipo -create libgdxcclib64_deg.dylib libgdxcclib64_dac.dylib -output libgdxcclib64.dylib
    - lipo -create libgdx-macos-deg.a libgdx-macos-dac.a -output libgdx-macos.a
    - mkdir -p ./build
    - mv {gdxdump,gdxdiff,gdxmerge} ./build
  needs: [fetch-ci-scripts,apigenerator,build-deg]
  artifacts:
    name: gdx-dac
    paths: [gdxtest,gdxwraptest,libgdxcclib64.dylib,libgdx-macos.a,build]
    expire_in: 2 hours
    reports:
      junit: warnings.xml

build-wei:
  stage: build
  tags: [windows]
  image:
    name: $MACHINES_CONTAINER_REG/wei/builder-full:latest
  script:
    - !reference [.get-gams-wei]
    - !reference [.gams-folder-wei]
    - cp apifiles/* src/
    - cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_VERBOSE_MAKEFILE:BOOL=OFF CMakeLists.txt
    - cmake --build  . --config Release -- -m | Tee-Object -FilePath 'build_log.txt'
    - python ciscripts/report_for_log.py msvc build_log.txt warnings.xml
  needs: [fetch-ci-scripts,apigenerator]
  artifacts:
    name: gdx-wei
    paths: [Release]
    expire_in: 2 hours
    reports:
      junit: warnings.xml

#=======================================================================================================================

codechecker-leg-debug:
  extends: .codechecker-leg-debug
  needs: [fetch-ci-scripts,apigenerator]
  script:
    - !reference [.get-gams]
    - !reference [.gams-folder-leg]
    - cp apifiles/* src/
    - !reference [.default-codecheck-script-debug, script]

#=======================================================================================================================

test-leg:
  stage: test
  tags: [linux]
  image:
    name: $MACHINES_CONTAINER_REG/leg/builder-devel:latest
    entrypoint: [""]
  needs: [fetch-ci-scripts,build-leg]
  script:
    - !reference [ .get-gams ]
    - !reference [ .gams-folder-leg ]
    - GAMS_PATH=/cache/gams-installs/`cat gams_folder_leg.txt`/
    - PATH=$GAMS_PATH:$PATH LD_LIBRARY_PATH="$GAMS_PATH" GMSPYTHONLIB="$GAMS_PATH/GMSPython/lib/libpython3.12.so" ./gdxtest --reporters=junit --out=doctest_results_linux.xml
    - LD_LIBRARY_PATH=`pwd` ./gdxwraptest --reporters=junit --out=doctest_results_wrap_linux.xml
  artifacts:
    name: unittest-results-linux
    paths: [./*.xml]
    expire_in: 2 hours
    reports:
      junit: doctest_results_*linux.xml

test-deg:
  stage: test
  tags: [macos]
  needs: [fetch-ci-scripts,build-deg]
  script:
    - !reference [ .get-gams ]
    - !reference [ .gams-folder-deg ]
    - GAMS_PATH=$HOME/cache/gams-installs/`cat gams_folder_deg.txt`
    - PATH=$GAMS_PATH:$PATH DYLD_LIBRARY_PATH=$(pwd)/lib:$GAMS_PATH GMSPYTHONLIB=$GAMS_PATH/GMSPython/lib/libpython3.12.dylib ./gdxtest --reporters=junit --out=doctest_results_deg.xml
    - ./gdxwraptest --reporters=junit --out=doctest_results_wrap_deg.xml
  artifacts:
    name: unittest-results-deg
    paths: [./*.xml]
    reports:
      junit: doctest_results_*deg.xml

test-dac:
  stage: test
  tags: [macos-arm64]
  needs: [fetch-ci-scripts,build-dac]
  script:
    - !reference [ .get-gams ]
    - !reference [ .gams-folder-dac ]
    - GAMS_PATH=$HOME/cache/gams-installs/`cat gams_folder_dac.txt`
    - PATH=$GAMS_PATH:$PATH DYLD_LIBRARY_PATH=$(pwd)/lib:$GAMS_PATH GMSPYTHONLIB=$GAMS_PATH/GMSPython/lib/libpython3.12.dylib ./gdxtest --reporters=junit --out=doctest_results_dac.xml
    - ./gdxwraptest --reporters=junit --out=doctest_results_wrap_dac.xml
  artifacts:
    name: unittest-results-dac
    paths: [./*.xml]
    reports:
      junit: doctest_results_*dac.xml

test-wei:
  stage: test
  tags: [windows]
  image:
    name: $MACHINES_CONTAINER_REG/wei/builder-full:latest
  needs: [fetch-ci-scripts,build-wei]
  script:
    - !reference [ .get-gams-wei ]
    - !reference [ .gams-folder-wei ]
    - $gmsdirname = Get-Content mygmsdir.tmp -Raw
    - $GAMS_PATH = "C:\Cache\gams-installs\$gmsdirname"
    - $env:Path = "$GAMS_PATH;$GAMS_PATH\gbin;" + $env:Path
    - $env:GAMSDIR = "$GAMS_PATH;$GAMS_PATH\gbin"
    - ./Release/gdxtest --reporters=junit --out=doctest_results_windows.xml
    - ./Release/gdxwraptest --reporters=junit --out=doctest_results_wrap_windows.xml
  artifacts:
    name: unittest-results-windows
    paths: [./*.xml]
    reports:
      junit: doctest_results_*windows.xml

#=======================================================================================================================

# test-gdxtools-leg:
#   stage: test-gdxtools
#   tags: [linux]
#   image:
#     name: $MACHINES_CONTAINER_REG/leg/builder-full:latest
#     entrypoint: [""]
#   needs: [fetch-ci-scripts,build-leg]
#   script:
#     - !reference [ .get-gams ]
#     - !reference [ .gams-folder-leg ]
#     - GAMS_PATH=/cache/gams-installs/`cat gams_folder_leg.txt`/
#     - PATH="$GAMS_PATH:$PATH"
#     - mkdir -p ~/miniconda3
#     - curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -o ~/miniconda3/miniconda.sh
#     - bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
#     - rm -rf ~/miniconda3/miniconda.sh
#     - ~/miniconda3/bin/conda init bash
#     - source ~/.bashrc
#     - ./src/tools/tests/environments/conda/install.sh
#     - conda activate gdxtools
#     - python3 ./src/tools/tests/main.py

# test-gdxtools-deg:
#   stage: test-gdxtools
#   tags: [macos]
#   needs: [fetch-ci-scripts,build-deg]
#   script:
#     - !reference [ .get-gams ]
#     - !reference [ .gams-folder-deg ]
#     - GAMS_PATH=$HOME/cache/gams-installs/`cat gams_folder_deg.txt`
#     - PATH="$GAMS_PATH:$PATH"
#     - mkdir -p ~/miniconda3
#     - curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh -o ~/miniconda3/miniconda.sh
#     - bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
#     - rm -rf ~/miniconda3/miniconda.sh
#     - ~/miniconda3/bin/conda init bash
#     - source ~/.bashrc
#     - ./src/tools/tests/environments/conda/install.sh
#     - conda activate gdxtools
#     - python3 ./src/tools/tests/main.py

# test-gdxtools-dac:
#   stage: test-gdxtools
#   tags: [macos-arm64]
#   needs: [fetch-ci-scripts,build-dac]
#   script:
#     - !reference [ .get-gams ]
#     - !reference [ .gams-folder-dac ]
#     - GAMS_PATH=$HOME/cache/gams-installs/`cat gams_folder_dac.txt`
#     - PATH="$GAMS_PATH:$PATH"
#     - mkdir -p ~/miniconda3
#     - curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o ~/miniconda3/miniconda.sh
#     - bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
#     - rm -rf ~/miniconda3/miniconda.sh
#     - ~/miniconda3/bin/conda init bash
#     - source ~/.bashrc
#     - ./src/tools/tests/environments/conda/install.sh
#     - conda activate gdxtools
#     - python3 ./src/tools/tests/main.py

# test-gdxtools-wei:
#   stage: test-gdxtools
#   tags: [windows]
#   image:
#     name: $MACHINES_CONTAINER_REG/wei/builder-full:latest
#   needs: [fetch-ci-scripts,build-wei]
#   script:
#     - !reference [ .get-gams-wei ]
#     - !reference [ .gams-folder-wei ]
#     - $gmsdirname = Get-Content mygmsdir.tmp -Raw
#     - $GAMS_PATH = "C:\Cache\gams-installs\$gmsdirname"
#     - $env:Path = "$GAMS_PATH;$GAMS_PATH\gbin;" + $env:Path
#     # - $env:GAMSDIR = "$GAMS_PATH;$GAMS_PATH\gbin"
#     - curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o miniconda.exe
#     - start /wait "" miniconda.exe /S
#     - del miniconda.exe
#     # - Update-SessionEnvironment
#     - .\src\tools\tests\environments\conda\install.sh
#     - conda activate gdxtools
#     - python3 .\src\tools\tests\main.py

#=======================================================================================================================

leak-check-leg:
  stage: leak-check
  tags: [linux]
  image:
    name: registry.gams.com/devel/ciscripts/leg/builder-valgrind-codequality:latest
    entrypoint: [""]
  when: manual # FIXME: resolve GLIBC_2.* not found!
  needs: [fetch-ci-scripts,build-debug-leg]
  script:
    - !reference [ .get-gams ]
    - !reference [ .gams-folder-leg ]
    - GAMS_PATH=/cache/gams-installs/`cat gams_folder_leg.txt`/
    - ulimit -n 1024
    - PATH=$GAMS_PATH:$PATH LD_LIBRARY_PATH="$GAMS_PATH" GMSPYTHONLIB="$GAMS_PATH/GMSPython/lib/libpython3.12.so" valgrind --leak-check=yes ./gdxtest_dbg
    - PATH=$GAMS_PATH:$PATH LD_LIBRARY_PATH="$GAMS_PATH" GMSPYTHONLIB="$GAMS_PATH/GMSPython/lib/libpython3.12.so" valgrind --leak-check=yes --xml=yes --xml-file=valgrind_out.xml ./gdxtest_dbg
    - PYTHONPATH=$PYTHONPATH:valgrind-codequality python3 -m valgrind_codequality --input-file valgrind_out.xml --output-file valgrind_out.json
    - python3 ciscripts/codechecker_to_xml.py valgrind_out.json valgrind_junit.xml
  artifacts:
    name: leak-check-results-leg
    expire_in: 2 hours
    reports:
      codequality: valgrind_out.json
      junit: valgrind_junit.xml
    paths: [valgrind_out.*]

#=======================================================================================================================

perf-check-leg:
  stage: perf-check
  tags: [linux]
  image:
    name: $MACHINES_CONTAINER_REG/leg/builder-devel:latest
    entrypoint: [""]
  needs: [fetch-ci-scripts,build-leg]
  when: manual
  script:
    - !reference [ .get-gams ]
    - !reference [ .gams-folder-leg ]
    - SUITE_NAME=gdxfiles
    - PERF_CALL="gams gdxperf procTreeMemMonitor=1 --RUN=suite --SUITE=${SUITE_NAME} --RUNDEFAULT=0 --RUNCAPI=1"
    - ARCHIVE_NAME="gdxfiles.zip"
    - curl https://cloud.gams.com/s/pxSEJNMWszJn3if/download/gdxfiles.zip > $ARCHIVE_NAME
    - unzip $ARCHIVE_NAME -d $SUITE_NAME
    - rm $ARCHIVE_NAME
    - cp -R /cache/gams-installs/`cat gams_folder_leg.txt` mygamsdist # need local copy as we modify libgdxcclib64.so
    - cp libgdxcclib64.so mygamsdist
    - GAMS_PATH=`pwd`/mygamsdist/
    - ${GAMS_PATH}apilib gdxperf
    - PATH=$GAMS_PATH:$PATH LD_LIBRARY_PATH="$GAMS_PATH" GMSPYTHONLIB="$GAMS_PATH/GMSPython/lib/libpython3.12.so" ${PERF_CALL} | tee cppgdx.log
#    - python3 ciscripts/fetch_gams.py fetch_and_install dist43 $SSH_KEY_PORTING
#    - python3 ciscripts/fetch_gams.py version $PF_CUSTOM_BRANCH $SSH_KEY_PORTING > gams43_folder_leg.txt
#    - GAMS_PATH=/cache/gams-installs/`cat gams43_folder_leg.txt`/
    - G43_ARCHIVE="gamsdist43.tar.bz2"
    - G43_CLOUD_URL="$GAMS43_CLOUD_URL"
    - G43_DIR=gamsdist43_tmp
    - G43_PATH=/cache/gams-installs/$G43_DIR
    - GAMS_PATH=$G43_PATH/gams43.4_linux_x64_64_sfx/
    - |
      if [[ -d $GAMS_PATH ]]; then
        echo "Found cached GAMS43 system directory. Skipping fetch and extract."
      else
        echo "No cached GAMS43 system directory found. Fetching and extracting!"
        curl $G43_CLOUD_URL > $G43_ARCHIVE # fetch from web
        mkdir -p $G43_PATH
        tar -xjf $G43_ARCHIVE -C $G43_PATH # extract
        rm $G43_ARCHIVE # clean zip
      fi
    - cp /builds/devel/gdx/mygamsdist/gamslice.txt $GAMS_PATH
    - ${GAMS_PATH}apilib gdxperf
    - PATH=$GAMS_PATH:$PATH LD_LIBRARY_PATH="$GAMS_PATH" GMSPYTHONLIB="$GAMS_PATH/GMSPython/lib/libpython3.8.so" ${PERF_CALL} | tee delphigdx.log
    - rm -rf mygamsdist # clean temporary modded GAMS system dir but keep cached GAMS43 dir
    - python3 ci/perflogparse.py | tee perf.json
  artifacts:
    name: gdxperf-logs
    paths: [cppgdx.log,delphigdx.log,perf.json]
    expire_in: 1 day

#=======================================================================================================================

doxygen-html:
  stage: docs
  tags: [linux]
  image:
    name: $MACHINES_CONTAINER_REG/leg/builder-devel:latest
    entrypoint: [""]
  script:
    - python3 ci/readme_filter.py
    - doxygen
    - rm README_filtered.md
  artifacts:
    name: doxygen-html-docs
    paths: [docs/html]
    expire_in: 1 day

#=======================================================================================================================

deploy-gitlab-github:
  stage: deploy
  when: manual
  rules:
    - if: $CI_COMMIT_TAG
      when: never
    - if: $CI_COMMIT_BRANCH == 'main'
      when: on_success
  tags: [linux]
  needs: [build-leg,build-dac,build-wei,apigenerator]
  image:
    name: registry.gams.com/devel/gdx/leg/builder-deploy:latest
    entrypoint: [""]   # prevent startup.sh
  script:
    - GDX_TAG_NAME="`python3 ci/changelog_head.py tag_name`"
    - GDX_RELEASE_NAME="${GDX_TAG_NAME}"
    - GDX_DESCRIPTION="`python3 ci/changelog_head.py description`"
    - PATH="/opt/github-release:${PATH}"
    - >
      GITHUB_TOKEN=${GITHUB_TOKEN}
      github-release
      -v
      release
      -u GAMS-dev
      -r gdx
      -t "${GDX_TAG_NAME}"
      -d "${GDX_DESCRIPTION}"
      -n "${GDX_RELEASE_NAME}"
    - sleep 10s # make sure the release is available to reference
    - cp Release/gdxcclib64.dll apifiles/*.h apifiles/*.hpp apifiles/*.c apifiles/*.cpp .
    - cp Release/gdx-static.lib libgdx-windows.lib
    - |
      for fn in libgdxcclib64.so gdxcclib64.dll libgdxcclib64.dylib libgdx-macos.a libgdx-linux.a libgdx-windows.lib gclgms.h gcmutex.h gdxcc.h gdxcc.c gdxcwrap.hpp gdxcclib.cpp
      do
        GITHUB_TOKEN=${GITHUB_TOKEN} github-release -v upload -R -u GAMS-dev -r gdx -t "${GDX_TAG_NAME}" -n $fn -f $fn
      done
    - >
      release-cli
      create
      --name "${GDX_RELEASE_NAME}"
      --tag-name "${GDX_TAG_NAME}"
      --description "${GDX_DESCRIPTION}"
      --ref "$CI_COMMIT_SHA"