noxfile.py

# Copyright 2022 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.

import nox
import os
import pathlib

PYTHON_VERSIONS = ["3.10", "3.11", "3.12", "3.13", "3.14"]

TEST_COMMAND = [
    "coverage",
    "run",
    "--append",
    "-m",
    "unittest",
    "discover",
    "--buffer",
    "-s=tests",
    "-p",
    "*_test.py",
]
COVERAGE_COMMAND = [
    "coverage",
    "report",
    "-m",
    "--omit=.nox/*,examples/*,*/__init__.py",
]
FREEZE_COMMAND = ["python", "-m", "pip", "freeze"]
TEST_DEPENDENCIES = [
    "pyfakefs>=5.0.0,<6.0",
    "coverage>=7.0.0",
]


@nox.session(python=PYTHON_VERSIONS)
def tests(session):
    session.install(".")
    # modules for testing
    session.install(*TEST_DEPENDENCIES)
    session.run(*FREEZE_COMMAND)
    session.run(
        *TEST_COMMAND,
    )
    session.run(*COVERAGE_COMMAND)


def _format(session, check=False):
    black_command = ["black"]
    if check:
        black_command.append("--check")
    black_command.append(".")
    session.run(*black_command)


@nox.session(venv_backend="none")
def lint(session):
    """Fails if the code is not formatted correctly."""
    _format(session, check=True)


@nox.session(venv_backend="none")
def format(session):
    """Runs the black formatter and applies formatting fixes."""
    _format(session)


@nox.session(python="3.12")
def compile_kokoro_requirements(session):
    """Recompiles .kokoro/requirements.txt.

    NOTE: Forking Renovate automatically manages routine updates to this file.
    Only run this session for manual overrides (e.g. urgent security patches).
    """
    custom_command = (
        "nox -s compile_kokoro_requirements\n"
        "#\n"
        "# Note: Forking Renovate automatically manages routine updates to this file.\n"
        "# Only run the command above for rare manual overrides (e.g. urgent security patches)."
    )

    session.install("pip-tools")
    session.run(
        "pip-compile",
        "--upgrade",
        "--verbose",
        "--generate-hashes",
        "--no-emit-index-url",
        "--no-emit-trusted-host",
        "--output-file=.kokoro/requirements.txt",
        ".kokoro/requirements.in",
        env={"CUSTOM_COMPILE_COMMAND": custom_command},
    )