ubuntu.yml

name: Ubuntu CI (push and/or release)

on:
  push:
    branches:
      - develop
      - feature/*
      - features/*
      - fix/*
      - issue-*
      - release/*
      - doc/*
      - dependabot/*
  schedule:
    - cron: '21 2 * * *'
  workflow_call:
    inputs:
      run-tests:
        required: true
        type: string
      target_branch:
        required: true
        type: string

env:
  GITHUB_TOKEN: ${{ github.token }}
  IS_RELEASE: ${{ github.event_name == 'workflow_dispatch' }}
  RUN_SIMPLE_TESTS: ${{ github.event_name == 'push' || inputs.run-tests == 'true' }}
  RUN_EXTENDED_TESTS: ${{ github.event_name == 'schedule' || inputs.run-tests == 'true' }}
  REF: ${{ inputs.target_branch =='' && github.ref || inputs.target_branch}}
  VCPKG_ROOT: ${{ github.workspace }}/vcpkg
  triplet: x64-linux
  WX_CONFIG: /usr/bin/wx-config

jobs:

  build:
    name: Build
    env:
      ORTOOLS_DIR: ${{ github.workspace }}/or-tools
      os: ubuntu-20.04
      # Caching strategy of VCPKG dependencies
      VCPKG_BINARY_SOURCES: "clear;files,${{ github.workspace }}/vcpkg_cache,readwrite"

    runs-on: ubuntu-20.04
    if: "!contains(github.event.head_commit.message, '[skip ci]')"

    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ env.REF }}

      - name: Install VCPKG
        run: git submodule update --init vcpkg && ./vcpkg/bootstrap-vcpkg.sh -disableMetrics

      - name: Restore vcpkg binary dir from cache
        id: cache-vcpkg-binary
        uses: actions/cache/restore@v4
        with:
          path: ${{ github.workspace }}/vcpkg_cache
          key: vcpkg-cache-ubuntu-${{ hashFiles('src/vcpkg.json', '.git/modules/vcpkg/HEAD') }}
          # Allows to restore a cache when deps have only partially changed (like adding a dependency)
          restore-keys: vcpkg-cache-ubuntu-

      - name: ccache
        uses: hendrikmuhs/ccache-action@v1.2
        with:
          key: ${{ env.os }}

      - name: Install libraries
        run: |
          sudo apt-get update
          sudo apt-get install uuid-dev libwxgtk3.0-gtk3-dev
          sudo apt-get install g++-10 gcc-10

      - name: Config OR-Tools URL
        run: |
          echo "ORTOOLS_URL=https://github.com/rte-france/or-tools-rte/releases/download/$(cat ortools_tag)/ortools_cxx_ubuntu-20.04_static_sirius.zip" >> $GITHUB_ENV

      - name: Download pre-compiled librairies
        uses: ./.github/workflows/download-extract-precompiled-libraries-tgz
        with:
          os: ${{env.os}}
          ortools-url: ${{env.ORTOOLS_URL}}
          ortools-dir: ${{env.ORTOOLS_DIR}}

      - name: Set up Python
        id: setup-python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip3 install -r src/tests/examples/requirements.txt

      - name: Configure
        run: |
          cmake -B _build -S src \
          -DCMAKE_C_COMPILER_LAUNCHER=ccache \
          -DCMAKE_C_COMPILER=/usr/bin/gcc-10 \
          -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
          -DCMAKE_CXX_COMPILER=/usr/bin/g++-10 \
          -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake \
          -DVCPKG_TARGET_TRIPLET=x64-linux-release \
          -DCMAKE_BUILD_TYPE=Release \
          -DBUILD_TESTING=ON \
          -DBUILD_TOOLS=ON \
          -DCMAKE_PREFIX_PATH=${{ env.ORTOOLS_DIR }}/install \
          -DPython3_EXECUTABLE="${{ env.Python3_ROOT_DIR }}/bin/python"

      - name: Build
        run: |
          cmake --build _build -j$(nproc)

      - name: Run API tests
        run: |
          cmake --install _build --prefix antares_install
          cd src/api_client_example
           cmake -B _build -S . \
           -DCMAKE_C_COMPILER_LAUNCHER=ccache \
           -DCMAKE_C_COMPILER=/usr/bin/gcc-10 \
           -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
           -DCMAKE_CXX_COMPILER=/usr/bin/g++-10 \
           -DCMAKE_BUILD_TYPE=Release \
           -DBUILD_TESTING=ON \
           -DCMAKE_TOOLCHAIN_FILE=${{github.workspace}}/vcpkg/scripts/buildsystems/vcpkg.cmake \
           -DVCPKG_TARGET_TRIPLET=x64-linux-release \
           -DCMAKE_PREFIX_PATH="${{github.workspace}}/rte-antares-deps-Release;${{github.workspace}}/install;${{ env.ORTOOLS_DIR }}/install;${{github.workspace}}/antares_install;${{github.workspace}}/rte-antares-deps-Release;${{github.workspace}}/_build/vcpkg_installed/x64-linux-release"
           cmake --build _build -j$(nproc)
           cd _build
           ctest -C Release --output-on-failure

      - name: Read simtest version
        run: |
          echo 'SIMTEST_JSON<<EOF' >> $GITHUB_ENV
          cat ./simtest.json >> $GITHUB_ENV
          echo 'EOF' >> $GITHUB_ENV

      - name: Export simtest version
        run: |
          echo "SIMTEST=${{ fromJson(env.SIMTEST_JSON).version }}" >> $GITHUB_ENV

      - name: Init submodule Antares_Simulator_Tests_NR
        run: |
          git submodule update --init --remote --recursive src/tests/resources/Antares_Simulator_Tests_NR

      - name: Run named mps tests
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-named-mps
          os: ${{ env.os }}
          variant: "named-mps"

      - name: Run unfeasibility-related tests
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        run: |
          cd _build
          ctest -C Release --output-on-failure -R "^unfeasible$"

      - name: Run unit and end-to-end tests
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        run: |
          cd _build
          ctest -C Release --output-on-failure -L "unit|end-to-end"


      - name: Upload logs for failed tests
        if: ${{ failure() }}
        uses: actions/upload-artifact@v4
        with:
          name: test-log
          path: ${{ github.workspace }}/_build/Testing/Temporary/LastTest.log

      - name: Run tests about infinity on BCs RHS
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-v830
          os: ${{ env.os }}

      - name: Run MILP with CBC
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-milp
          variant: "milp-cbc"
          os: ${{ env.os }}

      - name: Run tests on adequacy patch (CSR)
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: adequacy-patch-CSR
          os: ${{ env.os }}

      - name: Run tests introduced in 8.6.0
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-v860
          os: ${{ env.os }}

      - name: Run tests introduced in 8.7.0
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-v870
          os: ${{ env.os }}

      - name: Run tests introduced in 9.1.0
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-v910
          os: ${{ env.os }}

      - name: Run tests introduced in 9.2.0
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-v920
          os: ${{ env.os }}

      - name: Run short-tests
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: short-tests
          os: ${{ env.os }}

      - name: Run cucumber on short-tests
        uses: ./.github/workflows/cucumber-tests
        with:
          feature: "features/solver-features/short_tests.feature"

      - name: Run mps tests
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-mps
          os: ${{ env.os }}

      - name: Run parallel tests
        if: ${{ env.RUN_EXTENDED_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: valid-parallel
          os: ${{ env.os }}
          variant: "parallel"

      - name: Run tests for time series generator tool
        if: ${{ env.RUN_SIMPLE_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: ts-generator
          os: ${{ env.os }}
          variant: "tsgenerator"

      - name: Run medium-tests
        if: ${{ env.RUN_EXTENDED_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: medium-tests
          os: ${{ env.os }}

      - name: Run cucumber on medium-tests
        uses: ./.github/workflows/cucumber-tests
        with:
          feature: "features/solver-features/medium_tests.feature"

      - name: Run long-tests-1
        if: ${{ env.RUN_EXTENDED_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: long-tests-1
          os: ${{ env.os }}

      - name: Run long-tests-2
        if: ${{ env.RUN_EXTENDED_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: long-tests-2
          os: ${{ env.os }}

      - name: Run long-tests-3
        if: ${{ env.RUN_EXTENDED_TESTS == 'true' && !cancelled() }}
        uses: ./.github/workflows/run-tests
        with:
          simtest-tag: ${{ env.SIMTEST }}
          batch-name: long-tests-3
          os: ${{ env.os }}

      - name: Run cucumber on modeler
        uses: ./.github/workflows/cucumber-tests
        with:
          feature: "features/modeler-features"

      - name: Barrier
        if: ${{ !success() }}
        run: exit 1

      - name: Installer .deb creation
        run: |
          cd _build
          cpack -G DEB

      - name: .tar.gz creation
        run: |
          cd _build
          cpack -G TGZ

      - name: Solver archive creation
        run: |
          cd _build
          cmake --install . --prefix install
          pushd .
          cd install/bin
          tar czf ../../antares-solver_ubuntu20.04.tar.gz antares-solver libsirius_solver.so
          popd
          rm -rf install

      - name: Installer archive upload push
        uses: actions/upload-artifact@v4
        with:
          name: targz
          path: _build/*.tar.gz

      - name: Installer deb upload push
        uses: actions/upload-artifact@v4
        with:
          name: deb
          path: _build/*.deb


      - name: Publish assets
        if: ${{ env.IS_RELEASE == 'true' }}
        env:
          GITHUB_TOKEN: ${{ github.token }}
          tag: ${{ github.event.inputs.release_tag }}
        run: |
          gh release upload "$tag" _build/*.tar.gz _build/*.deb

      - name: Cache vcpkg binary dir
        if: always()
        id: save-cache-vcpkg-binary
        uses: actions/cache/save@v4
        with:
          path: ${{ github.workspace }}/vcpkg_cache
          key: vcpkg-cache-ubuntu-${{ hashFiles('src/vcpkg.json', '.git/modules/vcpkg/HEAD') }}