noxfile.py

"""
Copyright 2019 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

from __future__ import absolute_import

import os

import nox

BLACK_VERSION = "black==24.10.0"
ISORT_VERSION = "isort==5.13.2"

LINT_PATHS = ["google", "tests", "noxfile.py", "setup.py"]

TEST_PYTHON_VERSIONS = ["3.9", "3.10", "3.11", "3.12", "3.13"]


@nox.session
def lint(session):
    """Run linters.
    Returns a failure if the linters find linting errors or sufficiently
    serious code quality issues.
    """
    session.install("-r", "requirements.txt")
    session.install(
        "flake8",
        "flake8-annotations",
        "mypy",
        BLACK_VERSION,
        ISORT_VERSION,
        "twine",
        "build",
        "importlib_metadata==7.2.1",
    )
    session.run(
        "isort",
        "--fss",
        "--check-only",
        "--diff",
        "--profile=black",
        "--force-single-line-imports",
        "--dont-order-by-type",
        "--single-line-exclusions=typing",
        "-w=88",
        *LINT_PATHS,
    )
    session.run("black", "--check", "--diff", *LINT_PATHS)
    session.run(
        "flake8",
        "google",
        "tests",
    )
    session.run(
        "mypy",
        "-p",
        "google",
        "--install-types",
        "--non-interactive",
        "--show-traceback",
    )
    # verify that setup.py is valid
    session.run("python", "-m", "build", "--sdist")
    session.run("twine", "check", "--strict", "dist/*")


@nox.session()
def format(session):
    """
    Run isort to sort imports. Then run black
    to format code to uniform standard.
    """
    session.install(BLACK_VERSION, ISORT_VERSION)
    # Use the --fss option to sort imports using strict alphabetical order.
    # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sectionss
    session.run(
        "isort",
        "--fss",
        "--profile=black",
        "--force-single-line-imports",
        "--dont-order-by-type",
        "--single-line-exclusions=typing",
        "-w=88",
        *LINT_PATHS,
    )
    session.run(
        "black",
        *LINT_PATHS,
    )


def default(session, path):
    # Install all test dependencies, then install this package in-place.
    session.install("-r", "requirements-test.txt")
    session.install("-e", ".")
    session.install("-r", "requirements.txt")
    # Run py.test against the unit tests.
    session.run(
        "pytest",
        "--cov=google.cloud.sql.connector",
        "-v",
        "--cov-config=.coveragerc",
        "--cov-report=",
        "--cov-fail-under=0",
        "--junitxml=sponge_log.xml",
        path,
        *session.posargs,
    )


@nox.session(python=TEST_PYTHON_VERSIONS)
def unit(session):
    default(session, os.path.join("tests", "unit"))


@nox.session(python=TEST_PYTHON_VERSIONS)
def system(session):
    default(session, os.path.join("tests", "system"))


@nox.session(python=TEST_PYTHON_VERSIONS)
def test(session):
    default(session, os.path.join("tests", "unit"))
    default(session, os.path.join("tests", "system"))