config.yml

# CircleCI jobs are only enabled to on Pull Requests and commits to master branch.
# "Only build pull requests" enabled in Project's Advanced Settings.
version: 2.1
orbs:
  slack: circleci/slack@4.4.2
  python: circleci/python@2.0.3

jobs:
  build_test:
    docker:
      # Important: Don't change this otherwise we will stop testing the earliest
      # python version we have to support.
      - image: python:3.6-buster
    resource_class: medium
    parallelism: 6
    steps:
      - checkout # checkout source code to working directory
      - run:
          name: Install Basic Environment Dependencies
          command: | # install dependencies
            echo $PWD
            apt-get update
            apt-get -y install curl libgeos-dev
            pip install --upgrade pip
            pip install poetry
      - python/install-packages:
          include-python-in-cache-key: false
          pkg-manager: poetry
      - run:
          name: Test Imports (extras need to be guarded!)
          command: | # Make sure that importing works without extras installed
            poetry run python -c 'import nucleus'
      - run:
          name: Install Extra Dependencies
          command: | # install dependencies
            poetry install -E metrics -E launch
      - run:
          name: Black Formatting Check # Only validation, without re-formatting
          command: |
            poetry run black --check -t py36 .
      - run:
          name: Flake8 Lint Check # Uses setup.cfg for configuration
          command: |
            poetry run flake8 . --count --statistics
      - run:
          name: Pylint Lint Check # Uses .pylintrc for configuration
          command: |
            poetry run pylint nucleus
      - run :
          name: MyPy typing check
          command: |
            poetry run mypy --ignore-missing-imports nucleus
      - run :
          name: Isort Import Formatting Check # Only validation, without re-formatting
          command: |
            poetry run isort --check-only .
      - run:
          name: Pytest Test Cases
          command: | # Run test suite, uses NUCLEUS_TEST_API_KEY env variable
            mkdir test_results
            set -e
            TEST_FILES=$(circleci tests glob "tests/**/test_*.py" | circleci tests split --split-by=timings)
            poetry run coverage run --include=nucleus/* -m pytest -s -v --junitxml=test_results/junit.xml $TEST_FILES
            poetry run coverage report
            poetry run coverage html
      - store_test_results:
          path: htmlcov
      - store_test_results:
          path: test_results
      - store_artifacts:
          path: test_results
      - slack/notify:
          branch_pattern: master
          event: fail
          template: basic_fail_1

  pypi_publish:
    docker:
      - image: cimg/python:3.6
    steps:
      - checkout # checkout source code to working directory
      - run:
          name: Validate Tag Version # Check if the tag name matches the package version
          command: |
            PKG_VERSION=$(sed -n 's/^version = //p' pyproject.toml | sed -e 's/^"//' -e 's/"$//')
            if [[ "$CIRCLE_TAG" != "v${PKG_VERSION}" ]]; then
                echo "ERROR: Tag name ($CIRCLE_TAG) must match package version (v${PKG_VERSION})."
                exit 1;
            fi
      - run:
          name: Validate SDK Version Increment # Check if the version is already on PyPI
          command: |
            PKG_VERSION=$(sed -n 's/^version = //p' pyproject.toml | sed -e 's/^"//' -e 's/"$//')
            if pip install "scale-nucleus>=${PKG_VERSION}" > /dev/null 2>&1;
            then
                echo "ERROR: You need to increment to a new version before publishing!"
                echo "Version (${PKG_VERSION}) already exists on PyPI."
                exit 1;
            fi
      - run:
          name: Build
          command: | # install env dependencies
            poetry build
      - run:
          name: Publish to PyPI
          command: |
            if test -z "${PYPI_USERNAME}" || test -z "${PYPI_PASSWORD}" ; then
                echo "ERROR: Please assign PYPI_USERNAME and PYPI_PASSWORD as environment variables"
                exit 1
            fi
            poetry publish --username=$PYPI_USERNAME --password=$PYPI_PASSWORD
  test_poetry_installation:
    parameters:
      python_version:
        type: string
    docker:
      - image: cimg/python:<<parameters.python_version>>
    steps:
      - checkout
      - run:
          command: |
            pip install --upgrade pip
          name: Upgrade pip
      - python/install-packages:
            pkg-manager: poetry
      - run:
          command: |
            poetry run python -c 'import nucleus'
          name: Test import nucleus
  test_client_installation:
    parameters:
      python_version:
        type: string
    docker:
      - image: cimg/python:<<parameters.python_version>>
    steps:
      - checkout
      - run:
          command: |
            pip install --upgrade pip
          name: Upgrade pip
      - run:
          command: |
            poetry build
          name: Build the package
      - run:
          command: |
            export FOUND_PKG=$(find ./dist -name "*.tar.gz")
            pip install $FOUND_PKG
          name: Install with Python Version
workflows:
  nightly_build_test:
    triggers:
      - schedule:
          cron: "0 0 * * *"
          filters:
            branches:
              only:
                - master
    jobs:
      - build_test:
          context: Nucleus
  installation_matrix:
    jobs:
      - test_poetry_installation:
          matrix:
            parameters:
              python_version: ['3.6', '3.7', '3.8', '3.9'] #, '3.10'] Haven't gotten the 3.10 poetry install test to work
          context: Nucleus
      - test_client_installation:
          matrix:
            parameters:
              python_version: ['3.6', '3.7', '3.8', '3.9', '3.10']
          context: Nucleus
  build_test_publish:
    jobs:
      - build_test:
          context: Nucleus
          filters:
            tags:
              only: /^v\d+\.\d+\.\d+$/ # Runs only for tags with the format [v1.2.3]
      - pypi_publish:
          requires:
            - build_test
          filters:
            branches:
              ignore: /.*/ # Runs for none of the branches
            tags:
              only: /^v\d+\.\d+\.\d+$/ # Runs only for tags with the format [v1.2.3]