tasks.py

# Use with https://www.pyinvoke.org/

from invoke import call, task

import os
import pathlib
import sys


os.chdir(pathlib.Path(__file__).parent)


VENV_DIR = pathlib.Path(".venv")
REQ_TXT = pathlib.Path("requirements.txt")

PRIV_DIR = pathlib.Path("~/private").expanduser()
STAGING_CREDENTIALS = PRIV_DIR / "gcloud-creds/vimhelp-staging-owner.json"

PROJECT_STAGING = "vimhelp-staging"
PROJECT_PROD = "vimhelp-hrd"

DEV_ENV = {
    "PYTHONDEVMODE": "1",
    "PYTHONWARNINGS": (
        "default,"
        "ignore:unclosed:ResourceWarning:sys,"
        "ignore:pkg_resources is deprecated as an API:DeprecationWarning:google.cloud.ndb,"  # noqa: E501
        "ignore:Deprecated call to `pkg_resources.:DeprecationWarning:pkg_resources,"
        "ignore:Deprecated call to `pkg_resources.:DeprecationWarning:google.rpc,"
        "ignore:ssl.match_hostname():DeprecationWarning:geventhttpclient.connectionpool"
    ),
    "VIMHELP_ENV": "dev",
    "FLASK_DEBUG": "1",
    "GOOGLE_CLOUD_PROJECT": PROJECT_STAGING,
    "GOOGLE_APPLICATION_CREDENTIALS": str(STAGING_CREDENTIALS),
}


@task(help={"lazy": "Only update venv if out-of-date wrt requirements.txt"})
def venv(c, lazy=False):
    """Populate virtualenv."""
    if not VENV_DIR.exists():
        c.run(f"python -m venv --upgrade-deps {VENV_DIR}")
        c.run(f"{VENV_DIR}/bin/pip install -U wheel")
        print("Created venv.")
        lazy = False
    if not lazy or REQ_TXT.stat().st_mtime > VENV_DIR.stat().st_mtime:
        c.run(f"{VENV_DIR}/bin/pip install -U --upgrade-strategy eager -r {REQ_TXT}")
        c.run(f"touch {VENV_DIR}")
        print("Updated venv.")
    else:
        print("venv was already up-to-date.")


venv_lazy = call(venv, lazy=True)


@task
def lint(c):
    """Run linters (ruff, black)."""
    c.run("ruff check .")
    c.run("black --check .")


@task(
    pre=[venv_lazy],
    help={
        "gunicorn": "Run using gunicorn instead of 'flask run'",
        "tracemalloc": "Run with tracemalloc enabled",
    },
)
def run(c, gunicorn=False, tracemalloc=False):
    """Run app locally against staging database."""
    _ensure_private_mount(c)
    if gunicorn:
        cmd = f"{VENV_DIR}/bin/gunicorn -c gunicorn.conf.dev.py"
    else:
        cmd = f"{VENV_DIR}/bin/flask --app vimhelp.webapp --debug run"
    if tracemalloc:
        env = DEV_ENV | {"PYTHONTRACEMALLOC": "1"}
    else:
        env = DEV_ENV
    c.run(cmd, env=env)


@task(pre=[venv_lazy])
def show_routes(c):
    """Show Flask routes."""
    _ensure_private_mount(c)
    c.run(f"{VENV_DIR}/bin/flask --app vimhelp.webapp --debug routes", env=DEV_ENV)


@task(
    pre=[lint],
    help={
        # fmt: off
        "target": "Target environment: 'staging' (default), 'prod', "
                  "'all' (= staging + prod)",
        "cron":   "Deploy cron.yaml instead of main app"
        # fmt: on
    },
)
def deploy(c, target="staging", cron=False):
    """Deploy app."""
    _ensure_private_mount(c)
    if target == "all":
        targets = "staging", "prod"
    else:
        targets = (target,)
    for t in targets:
        if t == "staging":
            cmd = f"gcloud app deploy --quiet --project={PROJECT_STAGING}"
        elif t == "prod":
            cmd = f"gcloud app deploy --project={PROJECT_PROD}"
        else:
            sys.exit(f"Invalid target name: '{t}'")
        if cron:
            cmd += " cron.yaml"
        c.run(cmd, pty=True)


@task
def clean(c):
    """Clean up build artefacts."""
    for d in VENV_DIR, "__pycache__", "vimhelp/__pycache__", ".ruff_cache":
        if pathlib.Path(d).exists():
            c.run(f"rm -rf {d}")


@task()
def sh(c):
    """Interactive shell with virtualenv and datastore available."""
    _ensure_private_mount(c)
    with c.prefix(f". {VENV_DIR}/bin/activate"):
        c.run(os.getenv("SHELL", "bash"), env=DEV_ENV, pty=True)
    print("Exited vimhelp shell")


def _ensure_private_mount(c):
    if PRIV_DIR.stat().st_dev == PRIV_DIR.parent.stat().st_dev:
        c.run(f"sudo systemctl start {PRIV_DIR}", pty=True)