main.yml

name: Build and Test

on:
  pull_request:
  push:
    branches:
      - '**'
    tags-ignore:
      # This tag is (re)created when a build on main succeeds, it'd be
      # pointless to trigger yet another build in response to it.
      - continuous
  schedule:
    # Every Monday and Thursday at 11:18 AM.
    - cron: '18 11 * * 1,4'

env:
  CARGO_TERM_COLOR: always
  CMAKE_COLOR_DIAGNOSTICS: ON
  CLICOLOR_FORCE: 1

jobs:
  test:
    name: ${{ matrix.cross_os || matrix.os }} ${{ matrix.bits }}bit Qt ${{ matrix.qt }}${{ matrix.cross_os && format(' on {0}', matrix.os) }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-20.04
          - macos-latest
          - windows-latest
        qt:
          - 5.15.8
        bits:
          - 64
          - 32
        cross_os:
          - ''
          - Android

        exclude:
          - os: windows-latest
            cross_os: Android
          - os: macos-latest
            cross_os: Android
          - os: macos-latest
            bits: 32
          - os: ubuntu-20.04
            bits: 32

        # There's ways to deduplicate these includes, but any mistake causes
        # utterly confounding errors, so just explicitly specify each target.
        include:
          - os: ubuntu-20.04
            cross_os: ''
            qt: 5.15.8
            bits: 64
            sccache_triplet: x86_64-unknown-linux-musl
            build_flags: -DINITSYS=systemd
            # This causes the AppImage to be generated, instead of just creating
            # the portable tree, because there seems to be no way to separate
            # these steps with linuxdeploy
            # Even though the svg component is linked explicitly,
            # linuxdeploy-plugin-qt does not seem to notice and so does not
            # export the iconengine if it is not told that we really, really
            # want svg plugins please
            packager: >-
              EXTRA_QT_PLUGINS="svg;"
              VERSION="${{ startsWith(github.ref, 'refs/tags/') && github.ref_name || '$(git describe)' }}"
              cmake --install build --config Release
            # The runner has multiple clang versions installed and CMake/Qt gets
            # confused about which one to pick for some reason, so this also
            # sets Clang_ROOT during the Qt build
            qt_pre_build: >
              sudo apt-get update &&
              sudo apt-get install --no-install-recommends
              libatspi2.0-dev libmtdev-dev libts-dev libgtk-3-dev
              libgl1-mesa-dev libglu1-mesa-dev libxi-dev libdrm-dev
              libgbm-dev libgl-dev libgles-dev libegl-dev libegl1-mesa-dev
              libxext-dev libxfixes-dev libxrender-dev libx11-dev
              libxcb1-dev libx11-xcb-dev libxcb-glx0-dev libxcb-util0-dev
              libxkbcommon-dev libxkbcommon-x11-dev libxcb-keysyms1-dev
              libxcb-image0-dev libxcb-shm0-dev libxcb-icccm4-dev
              libxcb-sync-dev libxcb-xfixes0-dev libxcb-shape0-dev
              libxcb-randr0-dev libxcb-render0-dev libxcb-render-util0-dev
              libxcb-util-dev libinput-dev libvulkan-dev
              libxcb-xinerama0-dev libxcb-xkb-dev libxcb-xinput-dev libclang-12-dev
              libasound2-dev libpulse-dev libcups2-dev libssl-dev
              libfontconfig1-dev libgstreamer-plugins-base1.0-dev
              libgstreamer1.0-dev libgstreamer-plugins-good1.0-dev
              libgstreamer-plugins-bad1.0-dev &&
              echo "Clang_ROOT=/usr/lib/llvm-12" >> $GITHUB_ENV
            other_pre_build: >
              sudo apt-get update &&
              sudo apt-get install --no-install-recommends
              libsecret-1-dev

          - os: ubuntu-20.04
            cross_os: Android
            qt: 5.15.8
            bits: 64
            sccache_triplet: x86_64-unknown-linux-musl
            packager: cmake --install build --config Release --prefix .
            cross_qt_args: >-
              "-DANDROID_SDK_ROOT=$ANDROID_SDK_ROOT"
              "-DANDROID_NDK_ROOT=$ANDROID_NDK_ROOT"
              "-DANDROID_HOST_PATH=$GITHUB_WORKSPACE/.github/deps/qt"
              -DANDROID_ABI=arm64-v8a
            cross_other_args: >-
              "-DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_ROOT/build/cmake/android.toolchain.cmake"
              -DANDROID_PLATFORM=android-23
              -DANDROID_ABI=arm64-v8a
            build_flags: >-
              "-DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_ROOT/build/cmake/android.toolchain.cmake"
              -DANDROID_PLATFORM=android-23
              -DANDROID_ABI=arm64-v8a
              -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=on
              -DCMAKE_FIND_ROOT_PATH_MODE_INCLUDE=BOTH
              -DCMAKE_FIND_ROOT_PATH_MODE_LIBRARY=BOTH
              -DCMAKE_FIND_ROOT_PATH_MODE_PROGRAM=BOTH
            # The runner has multiple clang versions installed and CMake/Qt gets
            # confused about which one to pick for some reason, so this also
            # sets Clang_ROOT during the Qt build
            qt_pre_build: >
              sudo apt-get update &&
              sudo apt-get install --no-install-recommends
              libatspi2.0-dev libmtdev-dev libts-dev libgtk-3-dev
              libgl1-mesa-dev libglu1-mesa-dev libxi-dev libdrm-dev
              libgbm-dev libgl-dev libgles-dev libegl-dev libegl1-mesa-dev
              libxext-dev libxfixes-dev libxrender-dev libx11-dev
              libxcb1-dev libx11-xcb-dev libxcb-glx0-dev libxcb-util0-dev
              libxkbcommon-dev libxkbcommon-x11-dev libxcb-keysyms1-dev
              libxcb-image0-dev libxcb-shm0-dev libxcb-icccm4-dev
              libxcb-sync-dev libxcb-xfixes0-dev libxcb-shape0-dev
              libxcb-randr0-dev libxcb-render0-dev libxcb-render-util0-dev
              libxcb-util-dev libinput-dev libvulkan-dev
              libxcb-xinerama0-dev libxcb-xkb-dev libxcb-xinput-dev libclang-12-dev
              libasound2-dev libpulse-dev libcups2-dev libssl-dev
              libfontconfig1-dev &&
              echo "Clang_ROOT=/usr/lib/llvm-12" >> $GITHUB_ENV
            other_pre_build: >
              sudo apt-get update &&
              sudo apt-get install --no-install-recommends
              libsecret-1-dev

          - os: ubuntu-20.04
            cross_os: Android
            qt: 5.15.8
            bits: 32
            sccache_triplet: x86_64-unknown-linux-musl
            packager: cmake --install build --config Release --prefix .
            cross_qt_args: >-
              "-DANDROID_SDK_ROOT=$ANDROID_SDK_ROOT"
              "-DANDROID_NDK_ROOT=$ANDROID_NDK_ROOT"
              "-DANDROID_HOST_PATH=$GITHUB_WORKSPACE/.github/deps/qt"
              -DANDROID_ABI=armeabi-v7a
            cross_other_args: >-
              "-DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_ROOT/build/cmake/android.toolchain.cmake"
              -DANDROID_PLATFORM=android-23
              -DANDROID_ABI=armeabi-v7a
            build_flags: >-
              "-DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_ROOT/build/cmake/android.toolchain.cmake"
              -DANDROID_PLATFORM=android-23
              -DANDROID_ABI=armeabi-v7a
              -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=on
              -DCMAKE_FIND_ROOT_PATH_MODE_INCLUDE=BOTH
              -DCMAKE_FIND_ROOT_PATH_MODE_LIBRARY=BOTH
              -DCMAKE_FIND_ROOT_PATH_MODE_PROGRAM=BOTH
            # The runner has multiple clang versions installed and CMake/Qt gets
            # confused about which one to pick for some reason, so this also
            # sets Clang_ROOT during the Qt build
            qt_pre_build: >
              sudo apt-get update &&
              sudo apt-get install --no-install-recommends
              libatspi2.0-dev libmtdev-dev libts-dev libgtk-3-dev
              libgl1-mesa-dev libglu1-mesa-dev libxi-dev libdrm-dev
              libgbm-dev libgl-dev libgles-dev libegl-dev libegl1-mesa-dev
              libxext-dev libxfixes-dev libxrender-dev libx11-dev
              libxcb1-dev libx11-xcb-dev libxcb-glx0-dev libxcb-util0-dev
              libxkbcommon-dev libxkbcommon-x11-dev libxcb-keysyms1-dev
              libxcb-image0-dev libxcb-shm0-dev libxcb-icccm4-dev
              libxcb-sync-dev libxcb-xfixes0-dev libxcb-shape0-dev
              libxcb-randr0-dev libxcb-render0-dev libxcb-render-util0-dev
              libxcb-util-dev libinput-dev libvulkan-dev
              libxcb-xinerama0-dev libxcb-xkb-dev libxcb-xinput-dev libclang-12-dev
              libasound2-dev libpulse-dev libcups2-dev libssl-dev
              libfontconfig1-dev &&
              echo "Clang_ROOT=/usr/lib/llvm-12" >> $GITHUB_ENV
            other_pre_build: >
              sudo apt-get update &&
              sudo apt-get install --no-install-recommends
              libsecret-1-dev

          - os: macos-latest
            qt: 5.15.8
            bits: 64
            sccache_triplet: x86_64-apple-darwin
            packager: cpack --verbose --config build/CPackConfig.cmake -C Release

          - os: windows-latest
            qt: 5.15.8
            bits: 64
            sccache_triplet: x86_64-pc-windows-msvc
            build_flags: -DBUILD_PACKAGE_SUFFIX=64bit -G Ninja
            qt_pre_build: >
              choco install gperf jom winflexbison3 &&
              New-Item -Path C:\ProgramData\Chocolatey\bin\flex.exe -ItemType SymbolicLink -Value C:\ProgramData\Chocolatey\bin\win_flex.exe &&
              New-Item -Path C:\ProgramData\Chocolatey\bin\bison.exe -ItemType SymbolicLink -Value C:\ProgramData\Chocolatey\bin\win_bison.exe
            # Copying files is a disgusting hack because windeployqt does not
            # search PATH to find DLLs and it gets confused by QtKeychain having
            # a Qt prefix and thinks it is part of Qt and tries to process it
            # and fails if it is not in the Qt bin directory with the rest of
            # them
            packager: >
              cp .github/deps/other/bin/qt*.dll .github/deps/qt/bin &&
              cpack --verbose --config build/CPackConfig.cmake -C Release

          - os: windows-latest
            qt: 5.15.8
            bits: 32
            sccache_triplet: x86_64-pc-windows-msvc
            build_flags: -DCARGO_TRIPLE=i686-pc-windows-msvc -DBUILD_PACKAGE_SUFFIX=32bit -G Ninja
            qt_pre_build: >
              choco install gperf jom winflexbison3 &&
              New-Item -Path C:\ProgramData\Chocolatey\bin\flex.exe -ItemType SymbolicLink -Value C:\ProgramData\Chocolatey\bin\win_flex.exe &&
              New-Item -Path C:\ProgramData\Chocolatey\bin\bison.exe -ItemType SymbolicLink -Value C:\ProgramData\Chocolatey\bin\win_bison.exe
            # Copying files is a disgusting hack because windeployqt does not
            # search PATH to find DLLs and it gets confused by QtKeychain having
            # a Qt prefix and thinks it is part of Qt and tries to process it
            # and fails if it is not in the Qt bin directory with the rest of
            # them
            packager: >
              cp .github/deps/other/bin/qt*.dll .github/deps/qt/bin &&
              cpack --verbose --config build/CPackConfig.cmake -C Release

    steps:
      - name: Check out code
        uses: actions/checkout@v3
        with:
          fetch-depth: 0 # for git-describe
          submodules: true

      - name: Activate MSVC
        uses: ilammy/msvc-dev-cmd@v1
        with:
          arch: win${{ matrix.bits }}
        if: runner.os == 'Windows'

      - name: Install NASM for building OpenSSL in Windows
        uses: ilammy/setup-nasm@v1
        with:
          platform: win${{ matrix.bits }}
        if: runner.os == 'Windows'

      - name: Add msbuild to PATH
        uses: microsoft/setup-msbuild@v1.1
        with:
          msbuild-architecture: x${{ matrix.bits }}
        if: runner.os == 'Windows'

      - name: Work around QTBUG-112465
        run: |
          # Moving directories is faster than deleting everything inside them
          mv ${ANDROID_SDK_ROOT}/platforms/{android-*-*,..}
          ls "${ANDROID_SDK_ROOT}/platforms"
        shell: bash
        if: matrix.cross_os == 'Android'

      - name: Configure Linux system dependencies
        uses: ./.github/actions/restore-linux
        if: runner.os == 'Linux'

      - name: Build dependencies
        uses: ./.github/actions/build-deps
        id: deps
        with:
          cache_key: ${{ runner.os }}${{ matrix.bits == 32 && '32' || '' }}
          path: .github/deps
          target_bits: "${{ matrix.bits }}"
          qt: ${{ matrix.qt }}
          qt_pre_build: ${{ matrix.qt_pre_build }}
          qt_args: ${{ matrix.qt_args }}
          other_pre_build: ${{ matrix.other_pre_build }}
          other_args: ${{ matrix.other_args }}
        if: '!matrix.cross_os'

      - name: Build cross-compiler dependencies
        uses: ./.github/actions/build-deps
        id: cross-deps
        with:
          cache_key: ${{ runner.os }}+${{ matrix.cross_os }}${{ matrix.bits == 32 && '32' || '' }}
          path: .github/cross-deps
          target_bits: "${{ matrix.bits }}"
          qt: ${{ matrix.qt }}
          qt_pre_build: ${{ matrix.cross_qt_pre_build }}
          qt_args: ${{ matrix.cross_qt_args }}
          other_pre_build: ${{ matrix.cross_other_pre_build }}
          other_args: ${{ matrix.cross_other_args }}
        if: matrix.cross_os

      - name: Set up compiler cache
        uses: ./.github/actions/pre-sccache
        id: sccache
        with:
          triplet: ${{ matrix.sccache_triplet }}
          cache_key: ${{ runner.os }}${{ matrix.bits == 32 && '32' || '' }}${{ matrix.cross_os && format('+{0}', matrix.cross_os) }}-${{ matrix.qt }}

      - name: Cache gradle
        uses: actions/cache@v3
        with:
          # The zip file is unnecessary but the .zip.ok file is needed or it
          # will blow away the installation and redownload everything
          path: |-
            ~/.gradle/wrapper/dists/gradle-*/*/gradle-*
            !~/.gradle/wrapper/dists/gradle-*/*/gradle-*.zip
          key: gradle-${{ runner.os }}${{ matrix.bits == 32 && '32' || '' }}+${{ matrix.cross_os }}-${{ matrix.qt }}
        if: matrix.cross_os == 'Android'

      - name: Install Android 64 bit Rust target
        run: >
          rustup target add aarch64-linux-android
        if: matrix.cross_os == 'Android' && matrix.bits == 64

      - name: Install Android 32 bit Rust target
        run: >
          rustup target add armv7-linux-androideabi
        if: matrix.cross_os == 'Android' && matrix.bits == 32

      - name: Generate project
        run: >
          cmake -S . -B build --log-level=VERBOSE
          -DCMAKE_BUILD_TYPE=Release
          -DCMAKE_C_COMPILER_LAUNCHER=sccache
          -DCMAKE_CXX_COMPILER_LAUNCHER=sccache
          -DCMAKE_OBJC_COMPILER_LAUNCHER=sccache
          -DCMAKE_OBJCXX_COMPILER_LAUNCHER=sccache
          -DCLIENT=on
          -DSERVER=on
          -DSERVERGUI=on
          -DTOOLS=on
          -DTESTS=on
          -DUSE_GENERATORS=off
          "-DCMAKE_PREFIX_PATH=${{ matrix.cross_os && format('{0};', steps.cross-deps.outputs.path) }}${{ steps.deps.outputs.path }}"
          -DCMAKE_INSTALL_PREFIX=out
          -DCLANG_TIDY=off
          -DDIST_BUILD=${{ matrix.packager && 'on' }}
          -DSOURCE_ASSETS=off
          -DCMAKE_INTERPROCEDURAL_OPTIMIZATION=${{
            matrix.packager
            && startsWith(github.ref, 'refs/tags/')
            && 'on'
          }}
          -DBUILD_VERSION='${{
            matrix.packager
            && startsWith(github.ref, 'refs/tags/')
            && github.ref_name
          }}'
          ${{ matrix.build_flags }}

      - name: Prepare APK signing
        run: |
          if [ -n "$ANDROID_KEYSTORE" ] && [ -n "$ANDROID_KEYSTORE_PASS" ]; then
            keystore_path="$GITHUB_WORKSPACE/drawpile.keystore"
            echo "$ANDROID_KEYSTORE" | base64 -d > "$keystore_path"
            echo QT_ANDROID_KEYSTORE_PATH="$keystore_path" >> "$GITHUB_ENV"
          fi
        env:
          ANDROID_KEYSTORE: ${{ secrets.ANDROID_KEYSTORE }}
          ANDROID_KEYSTORE_PASS: ${{ secrets.ANDROID_KEYSTORE_PASS }}
        if: matrix.cross_os == 'Android' && matrix.packager

      - name: Build project
        run: cmake --build build --parallel $(nproc || sysctl -n hw.ncpu || echo 2) --config Release
        env:
          RUSTC_WRAPPER: sccache
          SCCACHE_CACHE_SIZE: 200M
          SCCACHE_DIR: ${{ steps.sccache.outputs.path }}/cache
          QT_ANDROID_KEYSTORE_ALIAS: drawpile
          QT_ANDROID_KEYSTORE_STORE_PASS: ${{ secrets.ANDROID_KEYSTORE_PASS }}

      - name: Run C++ tests
        run: ctest -C Release --output-on-failure
        working-directory: build
        if: '!matrix.cross_os'

      - name: Run packaging
        run: ${{ matrix.packager }}
        if: matrix.packager

      - name: Upload artifact
        uses: actions/upload-artifact@v3
        if: matrix.packager
        with:
          name: Drawpile-${{ matrix.cross_os || runner.os }}-${{ matrix.bits }}bit-Qt${{ matrix.qt }}
          path: |
            Drawpile-*.AppImage
            Drawpile-*.apk
            Drawpile-*.dmg
            Drawpile-*.msi
            Drawpile-*.zip

      - name: Upload error logs and artefacts
        uses: actions/upload-artifact@v3
        if: failure()
        with:
          name: ${{ matrix.cross_os || runner.os }} error logs and artefacts
          path: |
            **/*.log
            **/*.wxs

      - name: Save sccache
        uses: ./.github/actions/post-sccache
        with:
          cache-hit: ${{ steps.sccache.outputs.cache-hit }}
          cache_key: ${{ steps.sccache.outputs.cache_key }}
        if: success() || failure()
        continue-on-error: true

      - name: sccache stats
        run: sccache --show-stats
        if: success() || failure()
        continue-on-error: true

  release:
    needs: test
    runs-on: ubuntu-20.04
    if: >
      success() && (
          github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
          || startsWith(github.ref, 'refs/tags/'))
    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v3

      - name: Dump directory contents
        run: ls -alFR

      - name: Check out code
        uses: actions/checkout@v3
        with:
          path: checkout

      - name: Collect release notes
        if: startsWith(github.ref, 'refs/tags/')
        run: awk -v RS='' '/^[[:digit:]]{4}-[[:digit:]]{2}-[[:digit:]]{2} Version ${{ github.ref_name }}/,/^[[:digit:]]/' checkout/ChangeLog | tail '+2' > release-description

      - name: Write continuous release description
        if: "!startsWith(github.ref, 'refs/tags/')"
        env:
          RELEASE_DESCRIPTION: >
            This release is an automatically generated snapshot of the current
            state of development. It is continuously updated with
            work-in-progress changes that may be broken, incomplete, or
            incompatible with other versions of Drawpile. For downloads, take a
            look at the Assets below.


            Unless you really, really know what you're doing, **pick the 64bit
            options**. 32bit is probably *not* what you want unless you have a
            very strange device.
        run:
          echo "$RELEASE_DESCRIPTION" > release-description

      - name: Create release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          TARGET_COMMIT: ${{ github.sha }}
          RELEASE_DESCRIPTION_FILE: release-description
          RELEASE_NAME: ${{ startsWith(github.ref, 'refs/tags/') && github.ref_name || 'continuous' }}
          CLOBBER_EXISTING: ${{ !startsWith(github.ref, 'refs/tags/') }}
          PRERELEASE: ${{ !startsWith(github.ref, 'refs/tags/') || contains(github.ref, '-') }}
        run: |
          checkout/pkg/make-github-release.sh \
            'Drawpile-Android-64bit-Qt5.15.8;Drawpile-*.apk;Android APK 64bit' \
            'Drawpile-Linux-64bit-Qt5.15.8;Drawpile-*.AppImage;Linux AppImage 64bit' \
            'Drawpile-macOS-64bit-Qt5.15.8;Drawpile-*.dmg;macOS Disk Image' \
            'Drawpile-Windows-64bit-Qt5.15.8;Drawpile-*.msi;Windows Installer 64bit' \
            'Drawpile-Windows-64bit-Qt5.15.8;Drawpile-*.zip;Windows Portable ZIP 64bit' \
            'Drawpile-Android-32bit-Qt5.15.8;Drawpile-*.apk;Android APK 32bit - do not use, you want 64bit' \
            'Drawpile-Windows-32bit-Qt5.15.8;Drawpile-*.msi;Windows Installer 32bit - do not use, you want 64bit' \
            'Drawpile-Windows-32bit-Qt5.15.8;Drawpile-*.zip;Windows Portable ZIP 32bit - do not use, you want 64bit'