push.yml

name: Unit tests & build apps

on: ['push', 'pull_request']

env:
  APK_ARTIFACT_FILENAME: bdist_unit_tests_app-debug-1.1.apk
  AAB_ARTIFACT_FILENAME: bdist_unit_tests_app-release-1.1.aab
  AAR_ARTIFACT_FILENAME: bdist_unit_tests_app-release-1.1.aar
  PYTHONFORANDROID_PREREQUISITES_INSTALL_INTERACTIVE: 0

concurrency:
  group: build-${{ github.ref }}
  cancel-in-progress: true

jobs:

  flake8:
    name: Flake8 tests
    runs-on: ubuntu-latest
    steps:
    - name: Checkout python-for-android
      uses: actions/checkout@v5
    - name: Set up Python 3.x
      uses: actions/setup-python@v6
      with:
        python-version: 3.x
    - name: Run flake8
      run: |
        python -m pip install --upgrade pip
        pip install tox>=2.0
        tox -e pep8

  spotless:
    name: Java Spotless check
    runs-on: ubuntu-latest
    steps:
    - name: Checkout python-for-android
      uses: actions/checkout@v5
    - name: Set up Java 17
      uses: actions/setup-java@v4
      with:
        distribution: 'temurin'
        java-version: '17'
    - name: Set up Gradle
      uses: gradle/actions/setup-gradle@v4
    - name: Run Spotless check
      working-directory: pythonforandroid/bootstraps
      run: ./common/build/gradlew spotlessCheck

  test:
    name: Pytest [Python ${{ matrix.python-version }} | ${{ matrix.os }}]
    needs: [flake8, spotless]
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14', '3.14t']
        os: [ubuntu-latest, macos-latest]
    steps:
    - name: Checkout python-for-android
      uses: actions/checkout@v5
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}
        allow-prereleases: true
    - name: Tox tests
      run: |
        python -m pip install --upgrade pip
        pip install tox>=2.0
        make test
    - name: Coveralls
      uses: AndreMiras/coveralls-python-action@develop
      if: ${{ matrix.os == 'ubuntu-latest' }}
      with:
        parallel: true
        flag-name: run-${{ matrix.os }}-${{ matrix.python-version }}

  ubuntu_build:
    name: Build test APP [ ${{ matrix.runs_on }} | ${{ matrix.bootstrap.name }} ]
    needs: [flake8, spotless]
    runs-on: ${{ matrix.runs_on }}
    strategy:
      matrix:
        runs_on: [ubuntu-latest]
        bootstrap:
          - name: sdl2
            target: testapps-with-numpy
          # - name: sdl2_scipy  # TODO: Re-enable this failing test.
          #   target: testapps-with-scipy
          - name: webview
            target: testapps-webview
          - name: service_library
            target: testapps-service_library-aar
          - name: qt
            target: testapps-qt
    steps:
    - name: Maximize build space
      uses: easimon/maximize-build-space@v10
      with:
        root-reserve-mb: 4096
        swap-size-mb: 1024
        remove-dotnet: 'true'
        remove-android: 'true'
        remove-haskell: 'true'
        remove-codeql: 'true'
        remove-docker-images: 'true'
    - name: Checkout python-for-android
      uses: actions/checkout@v5
    - name: Relocate Docker data directory
      run: |
        sudo systemctl stop docker
        sudo mkdir -p "${GITHUB_WORKSPACE}/docker-data"
        echo '{"data-root": "'${GITHUB_WORKSPACE}/docker-data'"}' | sudo tee /etc/docker/daemon.json
        sudo systemctl start docker
        docker info | grep "Docker Root Dir"
    - name: Build python-for-android docker image
      run: |
        docker build --tag=kivy/python-for-android .
    - name: Build multi-arch ${{ matrix.bootstrap.target }} artifact with docker
      run: |
        docker run --name p4a-latest kivy/python-for-android make ${{ matrix.bootstrap.target }}
    - name: Copy produced artifacts from docker container (*.apk, *.aab)
      if: matrix.bootstrap.name != 'service_library'
      run: |
        mkdir -p dist
        docker cp p4a-latest:/home/user/app/testapps/on_device_unit_tests/${{ env.APK_ARTIFACT_FILENAME }} dist/
        docker cp p4a-latest:/home/user/app/testapps/on_device_unit_tests/${{ env.AAB_ARTIFACT_FILENAME }} dist/
    - name: Copy produced artifacts from docker container (*.aar)
      if: matrix.bootstrap.name == 'service_library'
      run: |
        mkdir -p dist
        docker cp p4a-latest:/home/user/app/testapps/on_device_unit_tests/${{ env.AAR_ARTIFACT_FILENAME }} dist/
    - name: Rename artifacts to include the build platform name (*.apk, *.aab, *.aar)
      run: |
        if [ -f dist/${{ env.APK_ARTIFACT_FILENAME }} ]; then mv dist/${{ env.APK_ARTIFACT_FILENAME }} dist/${{ matrix.runs_on }}-${{ matrix.bootstrap.name }}-${{ env.APK_ARTIFACT_FILENAME }}; fi
        if [ -f dist/${{ env.AAB_ARTIFACT_FILENAME }} ]; then mv dist/${{ env.AAB_ARTIFACT_FILENAME }} dist/${{ matrix.runs_on }}-${{ matrix.bootstrap.name }}-${{ env.AAB_ARTIFACT_FILENAME }}; fi
        if [ -f dist/${{ env.AAR_ARTIFACT_FILENAME }} ]; then mv dist/${{ env.AAR_ARTIFACT_FILENAME }} dist/${{ matrix.runs_on }}-${{ matrix.bootstrap.name }}-${{ env.AAR_ARTIFACT_FILENAME }}; fi
    - name: Upload artifacts
      uses: actions/upload-artifact@v4
      with:
        name: ${{ matrix.runs_on }}-${{ matrix.bootstrap.name }}-artifacts
        path: dist

  macos_build:
    name: Build test APP [ ${{ matrix.runs_on }} | ${{ matrix.bootstrap.name }} ]
    needs: [flake8, spotless]
    runs-on: ${{ matrix.runs_on }}
    strategy:
      matrix:
        # macos-latest (ATM macos-15) runs on Apple Silicon,
        # macos-15-intel runs on Intel
        runs_on: ['macos-latest', 'macos-15-intel']
        bootstrap:
          - name: sdl2
            target: testapps-with-numpy
          - name: webview
            target: testapps-webview
    env:
      ANDROID_HOME: ${HOME}/.android
      ANDROID_SDK_ROOT: ${HOME}/.android/android-sdk
      ANDROID_SDK_HOME: ${HOME}/.android/android-sdk
      ANDROID_NDK_HOME: ${HOME}/.android/android-ndk
    steps:
      - name: Checkout python-for-android
        uses: actions/checkout@v5
      - name: Set up Python 3.x
        uses: actions/setup-python@v6
        with:
          python-version: 3.x
      - name: Install python-for-android
        run: |
          python3 -m pip install --editable .
      - name: Install prerequisites via pythonforandroid/prerequisites.py (Experimental)
        run: |
          python3 pythonforandroid/prerequisites.py
      - name: Install dependencies (Legacy)
        run: |
          make --file ci/makefiles/osx.mk
      - name: Build multi-arch apk Python 3 (armeabi-v7a, arm64-v8a, x86_64, x86)
        run: |
          make ${{ matrix.bootstrap.target }}
      - name: Copy produced artifacts into dist/ (*.apk, *.aab)
        run: |
          mkdir -p dist
          cp testapps/on_device_unit_tests/*.apk dist/
          cp testapps/on_device_unit_tests/*.aab dist/
          ls -l dist/
      - name: Rename artifacts to include the build platform name (*.apk, *.aab)
        run: |
          if [ -f dist/${{ env.APK_ARTIFACT_FILENAME }} ]; then mv dist/${{ env.APK_ARTIFACT_FILENAME }} dist/${{ matrix.runs_on }}-${{ matrix.bootstrap.name }}-${{ env.APK_ARTIFACT_FILENAME }}; fi
          if [ -f dist/${{ env.AAB_ARTIFACT_FILENAME }} ]; then mv dist/${{ env.AAB_ARTIFACT_FILENAME }} dist/${{ matrix.runs_on }}-${{ matrix.bootstrap.name }}-${{ env.AAB_ARTIFACT_FILENAME }}; fi
      - name: Upload artifacts
        uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.runs_on }}-${{ matrix.bootstrap.name }}-artifacts
          path: dist

  test_on_emulator:
    name: Run App on Emulator
    needs: ubuntu_build
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v5
      - name: Download Artifacts
        uses: actions/download-artifact@v5
        with:
          name: ubuntu-latest-sdl2-artifacts
          path: dist/

      - name: Setup and start Android Emulator
        uses: reactivecircus/android-emulator-runner@v2
        with:
          api-level: 30
          arch: x86_64
          script: ci/run_emulator_tests.sh

  ubuntu_rebuild_updated_recipes:
    name: Test updated recipes for arch ${{ matrix.android_arch }} [ ubuntu-latest ]
    needs: [flake8, spotless]
    runs-on: ubuntu-latest
    # continue on error to see failures across all architectures
    continue-on-error: true
    strategy:
      matrix:
        android_arch: ["arm64-v8a", "armeabi-v7a", "x86_64", "x86"]
    env:
      REBUILD_UPDATED_RECIPES_EXTRA_ARGS: --arch=${{ matrix.android_arch }}
    steps:
    - name: Maximize build space
      uses: easimon/maximize-build-space@v10
      with:
        root-reserve-mb: 4096
        swap-size-mb: 1024
        remove-dotnet: 'true'
        remove-android: 'true'
        remove-haskell: 'true'
        remove-codeql: 'true'
        remove-docker-images: 'true'
    - name: Checkout python-for-android (all-history)
      uses: actions/checkout@v5
      with:
        fetch-depth: 0
    - name: Relocate Docker data directory
      run: |
        sudo systemctl stop docker
        sudo mkdir -p "${GITHUB_WORKSPACE}/docker-data"
        echo '{"data-root": "'${GITHUB_WORKSPACE}/docker-data'"}' | sudo tee /etc/docker/daemon.json
        sudo systemctl start docker
        docker info | grep "Docker Root Dir"
    - name: Pull docker image
      run: |
        make docker/pull
    - name: Rebuild updated recipes
      run: |
        make docker/run/make/rebuild_updated_recipes

  macos_rebuild_updated_recipes:
    name: Test updated recipes for arch ${{ matrix.android_arch }} [ ${{ matrix.runs_on }} ]
    needs: [flake8, spotless]
    runs-on: ${{ matrix.runs_on }}
    # continue on error to see failures across all architectures
    continue-on-error: true
    strategy:
      matrix:
        android_arch: ["arm64-v8a", "armeabi-v7a", "x86_64", "x86"]
        # macos-latest (ATM macos-15) runs on Apple Silicon,
        # macos-15-intel runs on Intel
        runs_on: ['macos-latest', 'macos-15-intel']
    env:
      ANDROID_HOME: ${HOME}/.android
      ANDROID_SDK_ROOT: ${HOME}/.android/android-sdk
      ANDROID_SDK_HOME: ${HOME}/.android/android-sdk
      ANDROID_NDK_HOME: ${HOME}/.android/android-ndk
      REBUILD_UPDATED_RECIPES_EXTRA_ARGS: --arch=${{ matrix.android_arch }}
    steps:
      - name: Checkout python-for-android (all-history)
        uses: actions/checkout@v5
        with:
          fetch-depth: 0
      - name: Set up Python 3.x
        uses: actions/setup-python@v6
        with:
          python-version: 3.x
      - name: Install python-for-android
        run: |
          python3 -m pip install --editable .
      - name: Install prerequisites via pythonforandroid/prerequisites.py (Experimental)
        run: |
          python3 pythonforandroid/prerequisites.py
      - name: Install dependencies (Legacy)
        run: |
          make --file ci/makefiles/osx.mk
      - name: Rebuild updated recipes
        run: |
          make rebuild_updated_recipes

  coveralls_finish:
    needs: test
    runs-on: ubuntu-latest
    steps:
    - name: Coveralls Finished
      uses: AndreMiras/coveralls-python-action@develop
      with:
        parallel-finished: true

  documentation:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v5
    - name: Requirements
      run: |
        python -m pip install --upgrade pip
        pip install -r doc/requirements.txt
    - name: Check links
      run: sphinx-build -b linkcheck doc/source doc/build
    - name: Generate documentation
      run: sphinx-build doc/source doc/build