pythonbuild.yml

name: Build

on:
  push:
    branches:
      - master
  pull_request:

env:
  FLYTE_SDK_LOGGING_LEVEL: 10 # debug

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        python-version: ["3.8", "3.9", "3.10", "3.11"]
        exclude:
          # Ignore this test because we failed to install docker-py
          # docker-py will install pywin32==227, whereas pywin only added support for python 3.10 in version 301.
          # For more detail, see https://github.com/flyteorg/flytekit/pull/856#issuecomment-1067152855
          - python-version: 3.10
            os: windows-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Cache pip
        uses: actions/cache@v2
        with:
          # This path is specific to Ubuntu
          path: ~/.cache/pip
          # Look to see if there is a cache hit for the corresponding requirements files
          key: ${{ format('{0}-pip-{1}', runner.os, hashFiles('dev-requirements.in', 'requirements.in')) }}
      - name: Install dependencies
        run: |
          make setup && pip freeze
      - name: Test with coverage
        run: |
          make unit_test_codecov
      - name: Codecov
        uses: codecov/codecov-action@v3.1.0
        with:
          fail_ci_if_error: false

  build-integration:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        # python 3.11 has intermittent issues with the docker build + push step
        # https://github.com/flyteorg/flytekit/actions/runs/5800978835/job/15724237979?pr=1579
        python-version: ["3.8", "3.9", "3.10"]
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Cache pip
        uses: actions/cache@v2
        with:
          # This path is specific to Ubuntu
          path: ~/.cache/pip
          # Look to see if there is a cache hit for the corresponding requirements files
          key: ${{ format('{0}-pip-{1}', runner.os, hashFiles('dev-requirements.in', 'requirements.in')) }}
      - name: Install dependencies
        run: make setup && pip freeze
      - name: Install FlyteCTL
        uses: unionai-oss/flytectl-setup-action@master
      - name: Setup Flyte Sandbox
        run: |
          flytectl demo start
          flytectl config init
      - name: Build and push to local registry
        run: |
          docker build . -f Dockerfile.dev -t localhost:30000/flytekit:dev --build-arg PYTHON_VERSION=${{ matrix.python-version }}
          docker push localhost:30000/flytekit:dev
      - name: Integration Test with coverage
        env:
          FLYTEKIT_IMAGE: localhost:30000/flytekit:dev
          FLYTEKIT_CI: 1
        run: make integration_test_codecov
      - name: Codecov
        uses: codecov/codecov-action@v3.1.0
        with:
          fail_ci_if_error: false

  build-plugins:
    needs: build
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11"]
        plugin-names:
          # Please maintain an alphabetical order in the following list
          - flytekit-aws-athena
          - flytekit-aws-batch
          - flytekit-aws-sagemaker
          - flytekit-bigquery
          - flytekit-dask
          - flytekit-data-fsspec
          - flytekit-dbt
          - flytekit-deck-standard
          - flytekit-dolt
          - flytekit-duckdb
          - flytekit-envd
          - flytekit-greatexpectations
          - flytekit-hive
          - flytekit-huggingface
          - flytekit-k8s-pod
          - flytekit-kf-mpi
          - flytekit-kf-pytorch
          - flytekit-kf-tensorflow
          - flytekit-mlflow
          - flytekit-modin
          - flytekit-onnx-pytorch
          - flytekit-onnx-scikitlearn
          # onnx-tensorflow needs a version of tensorflow that does not work with protobuf>4.
          # The issue is being tracked on the tensorflow side in https://github.com/tensorflow/tensorflow/issues/53234#issuecomment-1330111693
          # flytekit-onnx-tensorflow
          - flytekit-pandera
          - flytekit-papermill
          - flytekit-polars
          - flytekit-ray
          - flytekit-snowflake
          - flytekit-spark
          - flytekit-sqlalchemy
          - flytekit-vaex
          - flytekit-whylogs
        exclude:
          # flytekit-modin depends on ray which does not have a 3.11 wheel yet.
          # Issue tracked in https://github.com/ray-project/ray/issues/27881
          - python-version: 3.11
            plugin-names: "flytekit-modin"
          - python-version: 3.11
            plugin-names: "flytekit-ray"
          # Great-expectations does not support python 3.11 due to sqlachemy>=2.0.0
          # not being supported yet:
          # https://github.com/great-expectations/great_expectations/issues/7020
          - python-version: 3.11
            plugin-names: "flytekit-greatexpectations"
          # onnxruntime does not support python 3.10 yet
          # https://github.com/microsoft/onnxruntime/issues/9782
          - python-version: 3.10
            plugin-names: "flytekit-onnx-pytorch"
          - python-version: 3.10
            plugin-names: "flytekit-onnx-scikitlearn"
          - python-version: 3.10
            plugin-names: "flytekit-onnx-tensorflow"
          - python-version: 3.11
            plugin-names: "flytekit-onnx-pytorch"
          - python-version: 3.11
            plugin-names: "flytekit-onnx-scikitlearn"
          - python-version: 3.11
            plugin-names: "flytekit-onnx-tensorflow"
          # numba, a dependency of mlflow, doesn't support python 3.11
          # https://github.com/numba/numba/issues/8304
          - python-version: 3.11
            plugin-names: "flytekit-mlflow"
          # pyspark 3.4.0 will support python 3.11, which isn't available yet
          # Issue tracked in: https://github.com/apache/spark/pull/38987
          - python-version: 3.11
            plugin-names: "flytekit-spark"
          # vaex currently doesn't support python 3.11
          - python-version: 3.11
            plugin-names: "flytekit-vaex"
          # whylogs does support python 3.11 dataclass restrictions
          # See: https://github.com/flyteorg/flytekit/actions/runs/4493746408/jobs/7905368664
          - python-version: 3.11
            plugin-names: "flytekit-whylogs"
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Cache pip
        uses: actions/cache@v2
        with:
          # This path is specific to Ubuntu
          path: ~/.cache/pip
          # Look to see if there is a cache hit for the corresponding requirements files
          key: ${{ format('{0}-pip-{1}', runner.os, hashFiles('dev-requirements.txt', format('plugins/{0}/requirements.txt', matrix.plugin-names ))) }}
      - name: Install dependencies
        run: |
          make setup
          cd plugins/${{ matrix.plugin-names }}
          pip install -r requirements.txt
          if [ -f dev-requirements.txt ]; then pip install -r dev-requirements.txt; fi
          pip install -U https://github.com/flyteorg/flytekit/archive/${{ github.sha }}.zip#egg=flytekit
          pip freeze
      - name: Test with coverage
        run: |
          cd plugins/${{ matrix.plugin-names }}
          # onnx plugins does not support protobuf>4 yet (in fact it is tensorflow that
          # does not support that yet). More details in https://github.com/onnx/onnx/issues/4239.
          if [[ ${{ matrix.plugin-names }} == *"onnx"* || ${{ matrix.plugin-names }} == "flytekit-whylogs" || ${{ matrix.plugin-names }} == "flytekit-mlflow" ]]; then
             PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python coverage run -m pytest tests
          else
             coverage run -m pytest tests
          fi
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: Fetch the code
        uses: actions/checkout@v2
      - name: Set up Python 3.8
        uses: actions/setup-python@v2
        with:
          python-version: 3.8
      - uses: actions/cache@v2
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/dev-requirements.in') }}
          restore-keys: |
            ${{ runner.os }}-pip-
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r dev-requirements.in
      - name: Lint
        run: |
          make lint
      - name: ShellCheck
        uses: ludeeus/action-shellcheck@master
        with:
          ignore_paths: boilerplate

  docs:
    runs-on: ubuntu-latest
    steps:
      - name: Fetch the code
        uses: actions/checkout@v3
      - name: Set up Python 3.9
        uses: actions/setup-python@v4
        with:
          python-version: 3.9
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip==21.2.4 setuptools wheel
          pip install -r doc-requirements.txt
      - name: Build the documentation
        run: |
          # TODO: Remove after buf migration is done and packages updated
          PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python make -C docs html