noxfile.py

"""Nox tool configuration file.

Nox is Tox tool replacement.
"""

import shutil
from pathlib import Path

import nox

nox.options.sessions = "latest", "lint", "documentation_tests"


def base_install(session, flask, mongoengine, toolbar, wtf):
    """Create basic environment setup for tests and linting."""
    session.run("python", "-m", "pip", "install", "--upgrade", "pip")
    session.run("python", "-m", "pip", "install", "setuptools_scm[toml]>=6.3.1")

    if toolbar and wtf:
        extra = "wtf,toolbar,"
    elif toolbar:
        extra = "toolbar,"
    elif wtf:
        extra = "wtf,"
    else:
        extra = ""

    if flask == "==1.1.4":
        session.install(
            f"Flask{flask}",
            f"mongoengine{mongoengine}",
            "-e",
            f".[{extra}legacy,legacy-dev]",
        )
    elif flask == "==2.0.3":
        session.install(
            f"Flask{flask}",
            f"mongoengine{mongoengine}",
            "werkzeug==2.2.3",
            "-e",
            f".[{extra}dev]",
        )
    else:
        session.install(
            f"Flask{flask}",
            f"mongoengine{mongoengine}",
            "-e",
            f".[{extra}dev]",
        )
    return session


@nox.session(python="3.10")
def lint(session):
    """Run linting check locally."""
    session.install("pre-commit")
    session.run("pre-commit", "run", "-a")


@nox.session(python=["3.8", "3.9", "3.10", "3.11"])
@nox.parametrize("flask", ["==1.1.4", "==2.0.3", "==2.3.3", ">=3.0.0"])
@nox.parametrize("mongoengine", ["==0.21.0", "==0.22.1", "==0.23.1", ">=0.24.1"])
@nox.parametrize("toolbar", [True, False])
@nox.parametrize("wtf", [True, False])
def ci_cd_tests(session, flask, mongoengine, toolbar, wtf):
    """Run test suite with pytest into ci_cd (no docker)."""
    session = base_install(session, flask, mongoengine, toolbar, wtf)
    session.run("pytest", *session.posargs)


def _run_in_docker(session, db_version="5.0"):
    session.run(
        "docker",
        "run",
        "--name",
        "nox_docker_test",
        "-p",
        "27017:27017",
        "-d",
        f"mongo:{db_version}",
        external=True,
    )
    try:
        session.run("pytest", *session.posargs)
    finally:
        session.run_always("docker", "rm", "-fv", "nox_docker_test", external=True)


@nox.session(python=["3.8", "3.9", "3.10", "3.11"])
@nox.parametrize("flask", ["==1.1.4", "==2.0.3", "==2.3.3", ">=3.0.0"])
@nox.parametrize("mongoengine", ["==0.21.0", "==0.22.1", "==0.23.1", ">=0.24.1"])
@nox.parametrize("toolbar", [True, False])
@nox.parametrize("wtf", [True, False])
@nox.parametrize("db_version", ["5.0", "6.0", "7.0"])
def full_tests(session, flask, mongoengine, toolbar, wtf, db_version):
    """Run tests locally with docker and complete support matrix."""
    session = base_install(session, flask, mongoengine, toolbar, wtf)
    _run_in_docker(session, db_version)


@nox.session(python=["3.8", "3.9", "3.10", "3.11"])
@nox.parametrize("toolbar", [True, False])
@nox.parametrize("wtf", [True, False])
@nox.parametrize("db_version", ["5.0", "6.0", "7.0"])
def latest(session, toolbar, wtf, db_version):
    """Run minimum tests for checking minimum code quality."""
    flask = ">=3.0.0"
    mongoengine = ">=0.24.1"
    session = base_install(session, flask, mongoengine, toolbar, wtf)
    if session.interactive:
        _run_in_docker(session, db_version)
    else:
        session.run("pytest", *session.posargs)


@nox.session(python="3.10")
def documentation_tests(session):
    """Run documentation tests."""
    return docs(session, batch_run=True)


@nox.session(python="3.10")
def docs(session, batch_run: bool = False):
    """Build the documentation or serve documentation interactively."""
    shutil.rmtree(Path("docs").joinpath("_build"), ignore_errors=True)
    session.install("-r", "docs/requirements.txt")
    session.install("-e", ".[wtf,toolbar]")
    session.cd("docs")
    sphinx_args = ["-b", "html", "-W", ".", "_build/html"]

    if not session.interactive or batch_run:
        sphinx_cmd = "sphinx-build"
    else:
        sphinx_cmd = "sphinx-autobuild"
        sphinx_args.extend(
            [
                "--open-browser",
                "--port",
                "9812",
                "--watch",
                "../*.md",
                "--watch",
                "../*.rst",
                "--watch",
                "../*.py",
                "--watch",
                "../flask_mongoengine",
            ]
        )

    session.run(sphinx_cmd, *sphinx_args)