tests.yml

name: Tests

on:
  - push
  - pull_request

env:
  COLREV_PACKAGES: >
    colrev.literature_review
    colrev.files_dir
    colrev.export_man_prep
    colrev.dedupe
    colrev.colrev_cli_prescreen
    colrev.local_index
    colrev.unpaywall
    colrev.download_from_website
    colrev.colrev_cli_pdf_get_man
    colrev.ocrmypdf
    colrev.remove_coverpage
    colrev.remove_last_page
    colrev.grobid_tei
    colrev.colrev_cli_pdf_prep_man
    colrev.colrev_cli_screen
    colrev.paper_md
    colrev.source_specific_prep
    colrev.exclude_non_latin_alphabets
    colrev.exclude_collections
    colrev.exclude_complementary_materials
    colrev.local_index
    colrev.exclude_languages
    colrev.remove_urls_with_500_errors
    colrev.remove_broken_ids
    colrev.get_doi_from_urls
    colrev.get_year_from_vol_iss_jour
    colrev.crossref
    colrev.pubmed
    colrev.europe_pmc
    colrev.dblp
    colrev.open_library
    colrev.unknown_source
    colrev.conditional_prescreen
    colrev.psycinfo
    colrev.springer_link
    colrev.acm_digital_library
    colrev.abi_inform_proquest
    colrev.scopus
    colrev.taylor_and_francis
    colrev.web_of_science
    colrev.wiley
    colrev.trid
    colrev.jstor
    colrev.ebsco_host
    colrev.google_scholar
    colrev.eric
    colrev.ais_library
    colrev.ieee

jobs:
  test-minimal-deps:
    strategy:
      matrix:
        platform: [ubuntu-latest]
        python-version: ['3.12']
    runs-on: ${{ matrix.platform }}
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install poetry
        run: pipx install poetry
      - name: Update setuptools
        run: python -m pip install --upgrade pip setuptools --break-system-packages
      - name: Install poetry dependencies
        run: |
          poetry install -E dev --verbose --no-cache
          poetry run colrev install ${{ env.COLREV_PACKAGES }}
      - name: Setup git
        run: |
          git config --global user.name "CoLRev update"
          git config --global user.email "actions@users.noreply.github.com"
          git config --global url.https://github.com/.insteadOf git://github.com/
      - name: Run poetry tests (minimal-deps)
        run: poetry run pytest tests/0_core/ -vv

  test-full-deps:
    needs: test-minimal-deps
    strategy:
      matrix:
        platform: [ubuntu-latest, macos-latest]
        python-version: ['3.10', '3.11', '3.12']
    runs-on: ${{ matrix.platform }}
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install poetry
        run: |
          pipx uninstall-all
          rm -rf ~/.local/pipx/venvs/poetry
          pipx install poetry --python $(python -c "import sys; print(sys.executable)")
          poetry cache clear --all pypi
      - name: Install poetry dependencies
        run: |
          poetry env remove python || true
          poetry install -E dev --verbose --no-cache
          poetry run colrev install ${{ env.COLREV_PACKAGES }}
      - name: Setup git
        run: |
          git config --global user.name "CoLRev update"
          git config --global user.email "actions@users.noreply.github.com"
          git config --global url.https://github.com/.insteadOf git://github.com/
      - name: Run poetry tests
        run: poetry run pytest --slow -vv

  test-full-deps-windows: # Separate due to poetry installation concurrency issue: https://github.com/python-poetry/poetry/issues/7370
    needs: test-minimal-deps
    strategy:
      matrix:
        platform: [windows-latest]
        python-version: ['3.12']
    runs-on: ${{ matrix.platform }}
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install poetry
        run: |
          pipx install poetry --python $(python -c "import sys; print(sys.executable)")
          poetry cache clear --all pypi
      - name: Set POETRY_CACHE_DIR
        run: echo "POETRY_CACHE_DIR=${{runner.temp}}/poetry_cache" >> $GITHUB_ENV
      - name: Install poetry dependencies
        run: |
          poetry env remove python || true
          poetry install -E dev --verbose --no-cache
          poetry run colrev install ${{ env.COLREV_PACKAGES }}
      - name: Setup git
        run: |
          git config --global user.name "CoLRev update"
          git config --global user.email "actions@users.noreply.github.com"
          git config --global url.https://github.com/.insteadOf git://github.com/
      - name: Run poetry tests
        run: poetry run pytest --slow -vv

  test-pip-install:
    needs: test-minimal-deps
    strategy:
      matrix:
        platform: [ubuntu-latest,  macos-latest, windows-latest]
        python-version: ['3.10', '3.11', '3.12']
    runs-on: ${{ matrix.platform }}
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install via pip
        run: |
          pip install -e .[dev,tests]
          colrev install ${{ env.COLREV_PACKAGES }}
      - name: Setup git
        run: |
          git config --global user.name "CoLRev update"
          git config --global user.email "actions@users.noreply.github.com"
          git config --global url.https://github.com/.insteadOf git://github.com/
      - name: Run tests
        run: pytest tests --slow -vv