noxfile.py

import os
import sys
import tempfile
import nox

# Create virtual environments in a temporary directory somewhere else because
# meson-python does not like local virtualenvironments
# (https://github.com/capytaine/capytaine/issues/396)
tempdir = tempfile.mkdtemp(prefix="nox-capytaine-")
nox.options.envdir = os.path.join(tempdir, "venvs")

ENV = {
        'MPLBACKEND': 'pdf',
        'CAPYTAINE_CACHE_DIR': os.path.join(tempdir, "capytaine_cache")
        }

EXAMPLE_FILES = [
        "compare_Green_functions.py",
        "convergence_study.py",
        "custom_dofs.py",
        "custom_Green_function.py",
        "finite_depth_cylinder.py",
        "free_surface_elevation.py",
        "haskind.py",
        "kochin.py",
        "multibody.py",
        "plot_influence_matrix.py",
        "plot_velocity_in_domain.py",
        "radiation_cylinder.py"
        ]

NOXFILE_DIR = os.path.dirname(__file__)

NEMOH_CASES = os.path.join(NOXFILE_DIR, "pytest", "Nemoh_verification_cases", "Cylinder")

def run_tests(session):
    with session.chdir(session.create_tmp()):
        session.run("python", "-m", "pytest", os.path.join(NOXFILE_DIR, "pytest"), env=ENV)
        session.run('python', '-c', '"import capytaine; print(capytaine.__version__)"')
        session.run('capytaine', '--help')
        session.run('capytaine', os.path.join(NEMOH_CASES, "Nemoh.cal"), env=ENV)
        session.run('capytaine', os.path.join(NEMOH_CASES, "Nemoh_v3.cal"), env=ENV)
        for example_file in EXAMPLE_FILES:
            session.run('python', os.path.join(NOXFILE_DIR, "examples", example_file), env=ENV)


@nox.session
def build_and_test_on_latest_env(session):
    # By default, pip will install the latest dependencies compatible with the
    # constraints in pyproject.toml.
    session.install(".[test,optional]")
    run_tests(session)


@nox.session
def editable_build_and_test_on_latest_env(session):
    session.install("-r", "editable_install_requirements.txt")
    session.install("--no-build-isolation", "--editable", ".[test,optional]")
    run_tests(session)


@nox.session
def build_and_test_on_locked_env(session):
    if sys.version.startswith("3.8."):
        env_file = "2023-08-01-py3.8.txt"
        # Lock file was created with the following command
        # PY=3.8 DATE=2023-08-01 uv pip compile \
        # pyproject.toml editable_install_requirements.txt \
        # --python-version $PY --exclude-newer $DATE \
        # --extra optional --extra test \
        # -o pytest/envs/$DATE-py$PY.txt
        # Older date where not possible to reach because of the joblib>=1.3 requirement.
    elif sys.version.startswith("3.12."):
        env_file = "2024-04-08-py3.12.txt"
        # PY=3.12 DATE=2024-04-08 uv pip compile \
        # pyproject.toml editable_install_requirements.txt \
        # --python-version $PY --exclude-newer $DATE \
        # --extra optional --extra test \
        # -o pytest/envs/$DATE-py$PY.txt
    else:
        # On CI, this session is only run on Python 3.8 and 3.12
        # (see .github/workflows/test_new_commits.yaml)
        # This fallback might be useful for local tests:
        env_file = "2024-04-08-py3.12.txt"

    session.install('-r', f"pytest/envs/{env_file}")

    # We install without build isolation in order to control also the build environment.
    # There might be other ways to do that.
    session.install("--no-deps", "--no-build-isolation", ".")

    run_tests(session)


@nox.session
def build_and_test_on_nightly_builds(session):
    # https://scientific-python.org/specs/spec-0004/
    session.install("--pre", "--upgrade",
                    "--extra-index-url", "https://pypi.anaconda.org/scientific-python-nightly-wheels/simple",
                    "numpy", "scipy", "pandas", "xarray", "rich")
    session.install("meson-python", "ninja", "charset-normalizer")
    session.install("--no-deps", "--no-build-isolation", ".")
    session.install("pytest", "matplotlib")
    run_tests(session)