upx/.github/workflows/ci.yml

# Support for GitHub Actions -- https://github.com/features/actions
# Copyright (C) Markus Franz Xaver Johannes Oberhumer

# note: GitHub Actions runner images are frequently updated, and
# unfortunately this sometimes breaks builds in mysterious ways...
# see https://github.com/actions/runner-images.git

name: 'CI'

on:
  push:
    branches:
      - '*'
      - '!appveyor*'
      - '!gitea*'
      - '!gitlab*'
      - '!travis*'
  workflow_dispatch:

env:
  UPX_CMAKE_BUILD_FLAGS: --verbose

jobs:
  job-rebuild-and-verify-stubs:
    name: 'Rebuild stubs'
    runs-on: ubuntu-20.04
    steps:
      - name: 'Install extra packages'
        run: |
          uname -a; pwd; id; umask
          mkdir ../deps; cd ../deps; mkdir packages
          # for ubuntu-22.04: install python2-minimal
          ##export DEBIAN_FRONTEND=noninteractive
          ##sudo apt-get update && sudo apt-get install -y --no-install-recommends python2-minimal
          # manually install compat libs from Ubuntu 16.04
          wget -q 'http://archive.kernel.org/ubuntu-archive/ubuntu/pool/main/m/mpfr4/libmpfr4_3.1.6-1_amd64.deb'
          for f in ./*.deb; do dpkg -x $f ./packages; done
          sudo mv -v -n ./packages/usr/lib/x86_64-linux-gnu/lib* /usr/lib/x86_64-linux-gnu/
          rm -rf ./*.deb ./packages
          sudo ldconfig
          wget -q -O - https://github.com/upx/upx-stubtools/releases/download/v20221212/bin-upx-20221212.tar.xz | tar -xJ
      - name: 'Check out code'
        uses: actions/checkout@v3
        with: { submodules: true }
      - name: 'Rebuild and verify stubs'
        run: |
          export PATH="$(readlink -en ../deps/bin-upx-20221212):$PATH"
          make -C src/stub maintainer-clean extra-clean
          git status || true
          make -C src/stub extra-all all
          if ! git diff --quiet; then git diff; exit 1; fi
      - name: 'Check source code formatting'
        run: |
          bash ./misc/scripts/check_whitespace_git.sh
          UPX_CLANG_FORMAT="$PWD/../deps/bin-upx-20221212/clang-format-15.0.6" make -C src clang-format
          if ! git diff --quiet; then git diff; exit 1; fi

  job-linux-cmake:
    needs: [ job-rebuild-and-verify-stubs ]
    name: ${{ format('{0} cmake', matrix.os) }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - { os: ubuntu-20.04, use_m32: false }
          - { os: ubuntu-22.04, use_m32: true }
    steps:
      - name: 'Install extra 32-bit packages'
        if: ${{ matrix.use_m32 }}
        run: |
          export DEBIAN_FRONTEND=noninteractive
          sudo dpkg --add-architecture i386
          sudo apt-get update
          sudo apt-get install -y gcc-multilib g++-multilib
      - name: 'Check out code'
        uses: actions/checkout@v3
        with: { submodules: true }
      - name: 'Check out test suite'
        run: 'git clone --depth=1 https://github.com/upx/upx-testsuite ../deps/upx-testsuite'
      - name: 'Build cmake extra/gcc/debug'
        run:   'make build/extra/gcc/debug'
      - name: 'Build cmake extra/gcc/release'
        run:   'make build/extra/gcc/release'
      - name: 'Build cmake extra/clang/debug'
        run:   'make build/extra/clang/debug'
      - name: 'Build cmake extra/clang/release'
        run:   'make build/extra/clang/release'
      - name: 'Build cmake extra/gcc-m32/debug'
        if: ${{ matrix.use_m32 }}
        run:   'make build/extra/gcc-m32/debug'
      - name: 'Build cmake extra/gcc-m32/release'
        if: ${{ matrix.use_m32 }}
        run:   'make build/extra/gcc-m32/release'
      - name: 'Make artifact'
        run: |
          N=upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-${{ matrix.os }}
          mkdir -p "tmp/artifact/$N"
          (cd build/extra && cp -ai --parents */*/upx "../../tmp/artifact/$N")
          (cd tmp/artifact && tar --sort=name -czf "$N.tar.gz" "$N" && rm -rf "./$N")
          # GitHub Actions magic: set "artifact_name" environment value for use in next step
          echo "artifact_name=$N" >> $GITHUB_ENV
      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
        uses: actions/upload-artifact@v3
        with:
          name: ${{ env.artifact_name }}
          path: tmp/artifact
      - name: 'Run basic tests'
        run: |
          make -C build/extra/gcc/debug test
          make -C build/extra/gcc/release test
          make -C build/extra/clang/debug test
          make -C build/extra/clang/release test
      - name: 'Run basic tests 32-bit'
        if: ${{ matrix.use_m32 }}
        run: |
          make -C build/extra/gcc-m32/debug test
          make -C build/extra/gcc-m32/release test
      - name: 'Run test suite build/extra/gcc/release'
        run: |
          export upx_testsuite_SRCDIR="$(readlink -en ../deps/upx-testsuite)"
          testsuite_1=$(readlink -en ./.github/travis_testsuite_1.sh)
          env -C build/extra/gcc/release upx_exe=./upx bash "$testsuite_1"

  job-macos-cmake:
    needs: [ job-rebuild-and-verify-stubs ]
    name: ${{ format('{0} cmake', matrix.os) }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - { os: macos-11, gcc: gcc-10, gxx: 'g++-10', testsuite: true }
          # { os: macos-12, gcc: gcc-11, gxx: 'g++-11', testsuite: true } # disable gcc - XCode 14.0.1 ld bug; supposed to be fixed in 14.1
          - { os: macos-12, testsuite: true }
    steps:
      - name: 'Install brew packages'
        if: ${{ matrix.testsuite }}
        run: |
          brew update
          brew install coreutils
      - name: 'Check out code'
        uses: actions/checkout@v3
        with: { submodules: true }
      - name: 'Check out test suite'
        run: 'git clone --depth=1 https://github.com/upx/upx-testsuite ../deps/upx-testsuite'
      - name: 'Build cmake extra/gcc/debug'
        if: ${{ matrix.gcc != '' }}
        run:   'make build/extra/gcc/debug CC=${{ matrix.gcc }} CXX=${{ matrix.gxx }}'
      - name: 'Build cmake extra/gcc/release'
        if: ${{ matrix.gcc != '' }}
        run:   'make build/extra/gcc/release CC=${{ matrix.gcc }} CXX=${{ matrix.gxx }}'
      - name: 'Build cmake extra/clang/debug'
        run:   'make build/extra/clang/debug'
      - name: 'Build cmake extra/clang/release'
        run:   'make build/extra/clang/release'
      - name: 'Make artifact'
        run: |
          N=upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-${{ matrix.os }}
          mkdir -p "tmp/artifact/$N"
          (cd build/extra && rsync -R -a */*/upx "../../tmp/artifact/$N/")
          (cd tmp/artifact && gtar --sort=name -czf "$N.tar.gz" "$N" && rm -rf "./$N")
          # GitHub Actions magic: set "artifact_name" environment value for use in next step
          echo "artifact_name=$N" >> $GITHUB_ENV
      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
        uses: actions/upload-artifact@v3
        with:
          name: ${{ env.artifact_name }}
          path: tmp/artifact
      - name: 'Run basic tests'
        run: |
          make -C build/extra/clang/debug test
          make -C build/extra/clang/release test
      - name: 'Run test suite build/extra/clang/release'
        if: ${{ matrix.testsuite }}
        run: |
          export PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"
          export upx_testsuite_SRCDIR="$(readlink -en ../deps/upx-testsuite)"
          testsuite_1=$(readlink -en ./.github/travis_testsuite_1.sh)
          env -C build/extra/clang/release upx_exe=./upx bash "$testsuite_1"

  job-windows-cmake:
    needs: [ job-rebuild-and-verify-stubs ]
    name: ${{ format('{0} cmake', matrix.os) }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          # windows-2019 used to work but got broken with the 20220821.1
          # runner-image update; disable for now
          # see https://github.com/actions/runner-images.git
          ####- { os: windows-2019 }
          - { os: windows-2022 }
    steps:
      - name: 'Check out code'
        uses: actions/checkout@v3
        with: { submodules: true }
      - name: 'Check out test suite'
        run: 'git clone --depth=1 https://github.com/upx/upx-testsuite ../deps/upx-testsuite'
      - name: 'Inspect runner-image settings'
        # see https://github.com/actions/runner-images.git
        if: ${{ false }}
        run: |
          Get-Command bash; Get-Command cmake; Get-Command make
          bash --version; cmake --version; make --version
          Get-Command cl -ErrorAction SilentlyContinue
      - name: 'Build cmake debug'
        run:   'make build/debug'
      - name: 'Build cmake release'
        run:   'make build/release'
      - name: 'Make artifact'
        shell: bash
        run: |
          N=upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-${{ matrix.os }}
          mkdir -p "tmp/artifact/$N"
          (cd build && cp -ai --parents */*/upx.exe "../tmp/artifact/$N")
          # GitHub Actions magic: set "artifact_name" environment value for use in next step
          echo "artifact_name=$N" >> $GITHUB_ENV
      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
        uses: actions/upload-artifact@v3
        with:
          name: ${{ env.artifact_name }}
          path: tmp/artifact
      - name: 'Run basic tests'
        run: |
          cmake --build build/debug   --config Debug   --target RUN_TESTS
          cmake --build build/release --config Release --target RUN_TESTS
      - name: 'Run test suite build/release'
        shell: bash
        run: |
          export upx_testsuite_SRCDIR="$(readlink -en ../deps/upx-testsuite)"
          testsuite_1=$(readlink -en ./.github/travis_testsuite_1.sh)
          env -C build/release/Release upx_exe=./upx bash "$testsuite_1"

  job-windows-toolchains:
    needs: [ job-rebuild-and-verify-stubs ]
    name: ${{ matrix.name }}
    runs-on: ${{ matrix.os }}
    env:
      C: ${{ matrix.C }}
      B: release
      H: 'd:\a\upx\upx'
    strategy:
      fail-fast: false
      matrix:
        include:
          - { name: amd64-win64-vs2019, os: windows-2019, C: msvc-14.2-x64, arch: amd64 }
          - { name: amd64-win64-vs2022, os: windows-2022, C: msvc-14.3-x64, arch: amd64 }
          - { name: arm64-win64-vs2019, os: windows-2019, C: msvc-14.2-x64, arch: amd64_arm64 }
          - { name: arm64-win64-vs2022, os: windows-2022, C: msvc-14.3-x64, arch: amd64_arm64 }
          - { name: i386-win32-vs2019,  os: windows-2019, C: msvc-14.2-x86, arch: amd64_x86 }
          - { name: i386-win32-vs2022,  os: windows-2022, C: msvc-14.3-x86, arch: amd64_x86 }
    steps:
      - name: 'Check out code'
        uses: actions/checkout@v3
        with: { submodules: true }
      - name: 'Prepare sources and Check out test suite'
        shell: bash
        run: |
          git config --global core.autocrlf input
          git --version && bash --version
          git clone --depth=1 https://github.com/upx/upx-testsuite ../deps/upx-testsuite
          mkdir -p -v build/$C/$B/{ucl,upx,zlib,zstd}
      - name: 'Set up Developer Command Prompt'
        uses: ilammy/msvc-dev-cmd@v1
        with:
          arch: ${{ matrix.arch }}
      - name: 'Build'
        shell: cmd
        run: |
          @REM setup directories
          where cl & where link
          set BDIR=%H%\build\%C%\%B%
          set DEFS=-D_CRT_NONSTDC_NO_WARNINGS -D_CRT_SECURE_NO_WARNINGS
          git rev-parse --short=12 HEAD > %BDIR%\upx\.GITREV.txt
          @REM ===== build UCL =====
          cd %BDIR%\ucl
          set s=%H%\vendor\ucl
          cl -MT -J -O2 -W4 -WX %DEFS% -I%s%\include -I%s% -c %s%\src\*.c
          link -lib -out:ucl.lib *.obj
          @REM ===== build zlib =====
          cd %BDIR%\zlib
          cl -MT -J -O2 -W3 -WX %DEFS% -c %H%\vendor\zlib\*.c
          link -lib -out:zlib.lib *.obj
          @REM ===== build zstd =====
          cd %BDIR%\zstd
          set s=%H%\vendor\zstd\lib
          cl -MT -J -O2 -W4 -WX -DDYNAMIC_BMI2=0 -DZSTD_DISABLE_ASM %DEFS% -c %s%\common\*.c %s%\compress\*.c %s%\decompress\*.c
          link -lib -out:zstd.lib *.obj
          @REM ===== build UPX =====
          cd %BDIR%\upx
          set s=%H%\src
          cat .GITREV.txt
          set /p GITREV=<.GITREV.txt
          set sources=%s%\*.cpp %s%\check\*.cpp %s%\compress\*.cpp %s%\console\*.cpp %s%\filter\*.cpp %s%\util\*.cpp
          cl -std:c++17 -Zc:__cplusplus -EHsc -J -O2 -W4 -WX -DUPX_VERSION_GITREV="""%GITREV%""" -DWITH_ZSTD %DEFS% -I%H%\vendor -I%H%\vendor\boost-pfr\include -Feupx.exe %sources% %BDIR%\ucl\ucl.lib %BDIR%\zlib\zlib.lib %BDIR%\zstd\zstd.lib /link setargv.obj
      - name: 'Make artifact'
        shell: bash
        run: |
          N=upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-${{ matrix.name }}
          mkdir -p "tmp/artifact/$N/$B"
          cp -ai build/$C/$B/upx/upx*.exe "tmp/artifact/$N/$B"
          # GitHub Actions magic: set "artifact_name" environment value for use in next step
          echo "artifact_name=$N" >> $GITHUB_ENV
      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
        uses: actions/upload-artifact@v3
        with:
          name: ${{ env.artifact_name }}
          path: tmp/artifact
      - name: 'Run basic tests'
        if: ${{ matrix.arch != 'amd64_arm64' }}
        run: |
          $ErrorActionPreference = 'stop'
          $ErrorView = 'NormalView'
          cd $Env:H\build\$Env:C\$Env:B\upx
          $Env:UPX = "--no-color --no-progress"
          .\upx.exe --version
          .\upx.exe upx.exe -o upx_packed.exe
          dir *.exe
          .\upx.exe -l upx_packed.exe
          .\upx.exe -t upx_packed.exe
          .\upx_packed.exe --version
      - name: 'Run test suite'
        if: ${{ matrix.arch != 'amd64_arm64' }}
        shell: bash
        run: |
          export upx_testsuite_SRCDIR="$(readlink -en ../deps/upx-testsuite)"
          testsuite_1=$(readlink -en ./.github/travis_testsuite_1.sh)
          env -C build/$C/$B/upx upx_exe=./upx.exe bash "$testsuite_1"

# vim:set ts=2 sw=2 et: