ci.yml

name: CI

on: [push, workflow_dispatch]

env:
  COVERALLS_PARALLEL: true
  COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
  SF_MKDOCS_BUILD_LOCALES: "False"

jobs:
  test:
    name: "Python ${{ matrix.python-version }}"
    runs-on: SFDO-Tooling-Ubuntu
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
    steps:
      - uses: "actions/checkout@v4"
      - uses: "actions/setup-python@v5"
        with:
          python-version: "${{ matrix.python-version }}"

      - name: "Install dependencies"
        run: |
          python -VV
          python -m pip install --upgrade pip
          pip install -r requirements_dev.txt

      - name: "Run tox targets for ${{ matrix.python-version }}"
        run: python -m tox

      - name: Report Coverage
        run: coveralls

      - name: Test snowbench
        run: |
          python setup.py install
          snowbench snowfakery/tools/benchmark_1.yml --num-records 10_000  --num-records-tablename Account --number-of-processes 4
          snowbench | tee bench.txt
          tail -n 7 bench.txt >> $GITHUB_STEP_SUMMARY

  with_cci:
    name: With CumulusCI
    runs-on: SFDO-Tooling-Ubuntu
    steps:
      - uses: "actions/checkout@v4"
      - run: |
          git fetch --no-tags origin main:_remote_main_

      - uses: "actions/setup-python@v5"
        with:
          python-version: "3.9"

      - name: Install dependencies
        run: |
          python -VV
          python -m pip install --upgrade pip
          pip install -r requirements_dev.txt
          python -m pip install git+https://github.com/SFDO-Tooling/CumulusCI.git@main

      - name: Run Tests
        run: |
          python -m coverage run -m pytest

      - name: Check Coverage
        run: |
          coverage xml
          coverage report
          git diff HEAD.._remote_main_
          diff-cover coverage.xml --fail-under 100 --compare-branch=_remote_main_ --diff-range-notation=.. --show-uncovered --markdown-report coverage.md
          cat coverage.md >> $GITHUB_STEP_SUMMARY

      - name: Type Check
        run: pyright

  faker_docs:
    name: Faker Docs
    runs-on: SFDO-Tooling-Ubuntu
    steps:
      - uses: "actions/checkout@v4"
      - uses: "actions/setup-python@v5"
        with:
          python-version: "3.9"

      - name: Install dependencies
        run: |
          python -VV
          pip install -r requirements_dev.txt
          # docs build requires a proper install
          python setup.py install

      - name: Make Docs
        run: make docs

  pip:
    name: "Install from Pip ${{ matrix.python-version }}"
    runs-on: SFDO-Tooling-Ubuntu
    strategy:
      matrix:
        python-version: ["3.8", "3.10"]
    steps:
      - uses: "actions/checkout@v4"
      - uses: "actions/setup-python@v5"
        with:
          python-version: "${{ matrix.python-version }}"

      - name: "Install dependencies"
        run: |
          python -VV
          python -m pip install --upgrade pip

      - name: "Install using pip"
        run: |
          pip install .

      - name: "Test installation"
        run: |
          python -m snowfakery --version

  windows:
    name: Windows ${{ matrix.python-version }}
    runs-on: sfdc-windows-latest
    strategy:
      matrix:
        python-version: ["3.9", "3.10"]
    steps:
      - uses: "actions/checkout@v4"
      - uses: "actions/setup-python@v5"
        with:
          python-version: "${{ matrix.python-version }}"

      - name: "Install dependencies"
        run: |
          python -VV
          python -m pip install --upgrade pip
          pip install -r requirements_dev.txt

      - name: Run Tests
        run: python -m pytest

  coveralls_done:
    name: Finalize coveralls
    needs: [test]
    runs-on: SFDO-Tooling-Ubuntu
    steps:
      - run: curl -k https://coveralls.io/webhook?repo_token=$COVERALLS_REPO_TOKEN -d "payload[build_num]=$GITHUB_SHA&payload[status]=done"