noxfile.py

# Copyright (c) 2020-present, Carberra
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
#    contributors may be used to endorse or promote products derived from
#    this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from __future__ import annotations

import typing as t
from pathlib import Path

import nox

PROJECT_DIR: t.Final = Path(__file__).parent
PROJECT_NAME: t.Final = Path(__file__).parent.stem.lower()

CHECK_PATHS: t.Final = (
    str(PROJECT_DIR / PROJECT_NAME),
    str(PROJECT_DIR / "noxfile.py"),
)


def fetch_installs(*categories: str) -> list[str]:
    installs = []

    with open(PROJECT_DIR / "requirements-dev.txt") as f:
        in_cat = None

        for line in f:
            if line.startswith("#") and line[2:].strip() in categories:
                in_cat = True
                continue

            if in_cat:
                if line == "\n":
                    in_cat = False
                    continue

                installs.append(line.strip())

    return installs


@nox.session(reuse_venv=True)
def formatting(session: nox.Session) -> None:
    session.install(*fetch_installs("Formatting"))
    session.run("black", ".", "--check")


@nox.session(reuse_venv=True)
def imports(session: nox.Session) -> None:
    session.install(*fetch_installs("Imports"))
    # flake8 doesn't use the gitignore so we have to be explicit.
    session.run(
        "flake8",
        *CHECK_PATHS,
        "--select",
        "F4",
        "--extend-ignore",
        "E,F,W",
        "--extend-exclude",
        "__init__.py",
    )
    session.run("isort", *CHECK_PATHS, "-cq")


@nox.session(reuse_venv=True)
def typing(session: nox.Session) -> None:
    session.install(*fetch_installs("Typing"), "-r", "requirements.txt")
    session.run("mypy", CHECK_PATHS[0])


@nox.session(reuse_venv=True)
def line_lengths(session: nox.Session) -> None:
    session.install(*fetch_installs("Line lengths"))
    session.run("len8", *CHECK_PATHS)


@nox.session(reuse_venv=True)
def licensing(session: nox.Session) -> None:
    missing = []

    for p in [
        *(PROJECT_DIR / PROJECT_NAME).rglob("*.py"),
        *PROJECT_DIR.glob("*.py"),
    ]:
        with open(p) as f:
            header = f.read().split("\n")[0]
            if not (
                header.startswith("# Copyright (c) 2020-")
                or header.endswith(", Carberra\n")
            ):
                missing.append(p)

    if missing:
        session.error(
            f"\n{len(missing):,} file(s) are missing their licenses:\n"
            + "\n".join(f" - {file}" for file in missing)
        )


@nox.session(reuse_venv=True)
def spelling(session: nox.Session) -> None:
    session.install(*fetch_installs("Spelling"))
    session.run("codespell", *CHECK_PATHS, "-L", "nd")


@nox.session(reuse_venv=True)
def safety(session: nox.Session) -> None:
    # Needed due to https://github.com/pypa/pip/pull/9827.
    session.install("-U", "pip")
    session.install("-r", "requirements-dev.txt")
    session.run("safety", "check", "--full-report")


@nox.session(reuse_venv=True)
def security(session: nox.Session) -> None:
    session.install(*fetch_installs("Security"))
    session.run("bandit", "-qr", CHECK_PATHS[0], "-s", "B101")


@nox.session(reuse_venv=True)
def dependencies(session: nox.Session) -> None:
    session.install(*fetch_installs("Dependencies"))
    session.run("deputil", "update", "requirements*.txt")