python.yml

#-------------------------------------------------------------
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#
#-------------------------------------------------------------

name: Python Test

on:
  push:
    paths-ignore:
      - 'docs/**'
      - '*.md'
      - '*.html'
      - 'src/test/**'
      - 'src/assembly/**'
      - 'dev/**'
    branches:
      - main
  pull_request:
    paths-ignore:
      - 'docs/**'
      - '*.md'
      - '*.html'
      - 'src/test/**'
      - 'dev/**'
    branches:
      - main

jobs:
  test:
    runs-on: ${{ matrix.os }}
    timeout-minutes: 60
    env: 
      TORCH_HOME: ${{ github.workspace }}/.torch  # cache root for hub/checkpoints
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.8]
        os: [ubuntu-24.04]
        java: ['17']
        javadist: ['adopt']
        test_mode: [env, noenv, federated, scuro]

    name: ${{ matrix.os }} Java ${{ matrix.java }} ${{ matrix.javadist }} Python ${{ matrix.python-version }}/ ${{ matrix.test_mode}}
    steps:
    - name: Checkout Repository
      uses: actions/checkout@v6

    - name: Setup Java ${{ matrix.java }} ${{ matrix.javadist }}
      uses: actions/setup-java@v5
      with:
        distribution: ${{ matrix.javadist }}
        java-version: ${{ matrix.java }}
        cache: 'maven'

    - name: Cache Pip Dependencies
      uses: actions/cache@v5
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('src/main/python/setup.py') }}

    - name: Cache Datasets
      uses: actions/cache@v5
      with:
        path: |
          src/main/python/systemds/examples/tutorials/mnist
          src/main/python/systemds/examples/tutorials/adult/data.zip
        key: ${{ runner.os }}-mnist-${{ hashFiles('src/main/python/systemds/examples/tutorials/mnist.py') }}-${{ hashFiles('src/main/python/systemds/examples/tutorials/adult.py') }}

    - name: Cache Deb Dependencies
      uses: actions/cache@v5
      with:
        path: /var/cache/apt/archives
        key: ${{ runner.os }}-${{ hashFiles('.github/workflows/python.yml') }}

    - name: Maven clean & package
      run: mvn -ntp clean package -P distribution -B -Ddoc.skip=true

    - name: Setup Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}
        architecture: 'x64'

    - name: Install pip Dependencies
      run: |
        # Install pip twice to update past the versions.
        pip install --upgrade pip
        pip install --upgrade pip
        pip install wheel
        pip install \
          numpy \
          py4j \
          scipy \
          scikit-learn \
          requests \
          pandas \
          unittest-parallel \
          coverage

    - name: Build Python Package
      run: |
        cd src/main/python
        python create_python_dist.py

    - name: Run tests with env
      if: ${{ matrix.test_mode == 'env' }}
      run: |
        export SYSTEMDS_ROOT=$(pwd)
        export PATH=$SYSTEMDS_ROOT/bin:$PATH
        export SYSDS_QUIET=1
        export LOG4JPROP=$SYSTEMDS_ROOT/src/test/resources/log4j.properties
        cd src/main/python
        unittest-parallel -t . -s tests -v --coverage
        mv .coverage .coverage.${{ matrix.test_mode }}

    - name: Run tests no env
      if: ${{ matrix.test_mode == 'noenv' }}
      run: |
        export LOG4JPROP=$(pwd)/src/test/resources/log4j.properties
        cd src/main/python
        unittest-parallel -t . -s tests -v --coverage
        mv .coverage .coverage.${{ matrix.test_mode }}

    - name: Run Federated Python Tests
      if: ${{ matrix.test_mode == 'federated' }}
      run: |
        export SYSTEMDS_ROOT=$(pwd)
        export PATH=$SYSTEMDS_ROOT/bin:$PATH
        cd src/main/python
        ./tests/federated/runFedTest.sh
        mv .coverage .coverage.${{ matrix.test_mode }}


    - name: Cache Torch Hub
      if: ${{ matrix.test_mode == 'scuro' }}
      id: torch-cache
      uses: actions/cache@v5
      with:
        path: .torch
        key: ${{ runner.os }}-torch-${{ hashFiles('requirements.txt') }}
        restore-keys: |
            ${{ runner.os }}-torch-

    - name: Run Scuro Python Tests 
      if: ${{ matrix.test_mode == 'scuro' }}
      env:
        TORCH_HOME: ${{ github.workspace }}/.torch
      run: |
        df -h
        exit
        ( while true; do echo "."; sleep 25; done ) &
        KA=$!
        pip install --upgrade pip wheel setuptools
        # Use CUDA 12.1 wheels to avoid slow/source builds
        pip install --extra-index-url https://download.pytorch.org/whl/cu121 \
          torch==2.4.1 torchvision==0.19.1
        pip install \
          transformers \
          opencv-python \
          librosa \
          h5py \
          gensim \
          opt-einsum \
          nltk \
          fvcore \
          scikit-optimize \
          flair 
        kill $KA 
        cd src/main/python
        coverage run -m unittest discover -s tests/scuro -p 'test_*.py' -v
        mv .coverage .coverage.${{ matrix.test_mode }}

    - name: Save Python Test Coverage as Artifact
      uses: actions/upload-artifact@v5
      with:
        name: .coverage.${{ matrix.test_mode }}
        include-hidden-files: true
        path: ${{ github.workspace }}/src/main/python/.coverage.${{ matrix.test_mode }}
        retention-days: 1
  
  determine_test_coverage:
    name: Determine Test Coverage
    runs-on: ${{ matrix.os }}
    needs: [
      test
      ]
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.8]
        os: [ubuntu-24.04]

    steps:
    - name: Checkout Repository
      uses: actions/checkout@v5
    
    - name: Setup Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}
        architecture: 'x64'

    - name: Install coverage package
      run: |
        pip install --upgrade pip
        pip install coverage

    - name: Download all Python Coverage Artifacts
      uses: actions/download-artifact@v6
      with:
        pattern: .coverage.*
        path: ${{ github.workspace }}/src/main/python/
    
    - name: Merge Python Coverage Reports
      run: |
        cd src/main/python
        coverage combine .coverage.*
        coverage xml -i -o coverage.xml

    - name: Upload merged coverage report to Codecov
      uses: codecov/codecov-action@v5.5.1
      if: github.repository_owner == 'apache'
      with:
        fail_ci_if_error: false
        files: src/main/python/coverage.xml
        flags: python
        name: coverage.xml
        token: ${{ secrets.CODECOV_TOKEN }}

    - name: Upload Coverage Report Artifact PR
      if: (github.repository_owner == 'apache') && (github.ref_name != 'main')
      uses: actions/upload-artifact@v5
      with:
        name: coverage.xml
        path: src/main/python/coverage.xml
        retention-days: 7

    - name: Upload Coverage Report Artifact Main
      if: (github.repository_owner == 'apache') && (github.ref_name == 'main')
      uses: actions/upload-artifact@v5
      with:
        name: coverage.xml
        path: src/main/python/coverage.xml
        retention-days: 30

    - name: Upload Coverage Report Artifact Fork
      if: (github.repository_owner != 'apache')
      uses: actions/upload-artifact@v5
      with:
        name: coverage.xml
        path: src/main/python/coverage.xml
        retention-days: 3