config.yml

version: 2.1

commands:
  setup_pip:
    description: "Set Up Dependencies"
    parameters:
      python-version:
        type: string
      urllib3-version:
        type: string
        default: "2.0"
      install-dev:
        description: Install dev dependencies (not just test dependencies)
        type: boolean
        default: false
      install-docs:
        description: Install docs dependencies
        type: boolean
        default: false
    steps:
      - restore_cache:
          keys:
            - cache_v10-wayback-<< parameters.python-version >>-{{ arch }}-{{ checksum "pyproject.toml" }}
            - cache_v10-wayback-<< parameters.python-version >>-{{ arch }}-

      - run:
          name: Install Dependencies
          command: |
            python -m venv ~/venv
            . ~/venv/bin/activate
            # Ensure pip is up-to-date
            pip install --upgrade pip
            pip install .[test]
            pip install 'urllib3 ~=<< parameters.urllib3-version >>'

      # Dev dependencies are only compatible on Python 3.8+, so only install
      # them on demand.
      - when:
          condition: << parameters.install-dev >>
          steps:
            - run:
                command: |
                  . ~/venv/bin/activate
                  pip install .[dev]

      # Docs dependencies are only compatible on Python 3.10+, so only install
      # them on demand.
      - when:
          condition: << parameters.install-docs >>
          steps:
            - run:
                command: |
                  . ~/venv/bin/activate
                  pip install .[docs]

      - save_cache:
          key: cache_v10-wayback-<< parameters.python-version >>-{{ arch }}-{{ checksum "pyproject.toml" }}
          paths:
            - ~/venv

jobs:
  test:
    parameters:
      python-version:
        type: string
      urllib3-version:
        type: string

    working_directory: ~/wayback
    docker:
      - image: cimg/python:<< parameters.python-version >>
    steps:
      - checkout
      - setup_pip:
          python-version: << parameters.python-version >>
          urllib3-version: << parameters.urllib3-version >>

      - run:
          name: Tests
          command: |
            . ~/venv/bin/activate
            coverage run -m pytest -vv
      - run:
          name: Coverage
          command: |
            . ~/venv/bin/activate
            coverage report -m

  lint:
    working_directory: ~/wayback
    docker:
      - image: cimg/python:3.12
    steps:
      - checkout
      - setup_pip:
          python-version: "3.12"
          install-dev: true
      - run:
          name: Code linting
          command: |
            . ~/venv/bin/activate
            flake8 .

  build:
    working_directory: ~/wayback
    docker:
      - image: cimg/python:3.12
    steps:
      - checkout
      - setup_pip:
          python-version: "3.12"
          install-dev: true
      - run:
          name: Build Distribution
          command: |
            . ~/venv/bin/activate
            python -m build .
      - run:
          name: Check Distribution
          command: |
            . ~/venv/bin/activate
            twine check dist/*
            check-wheel-contents dist

  # NOTE: The docs are mainly built and published directly by readthedocs.com.
  # This job is meant to verify there are no issues with the docs and it is NOT
  # responsible for building what actually gets published. (Readthedocs.com
  # builds with rather loose error handling, and does not fail even when there
  # may be significant issues.)
  docs:
    working_directory: ~/wayback
    docker:
      - image: cimg/python:3.12
    steps:
      - checkout
      - setup_pip:
          python-version: "3.12"
          install-docs: true
      - run:
          name: Build docs
          command: |
            . ~/venv/bin/activate
            make -C docs html

workflows:
  ci:
    jobs:
      - test:
          matrix:
            parameters:
              python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
              urllib3-version: ["1.20", "2.0"]
      - lint
      - build
      - docs