create preflight scripts for local CI

Author: AbstractUmbra

.gitignore

@@ -12,9 +12,11 @@ docs/build
 docs/_build
 
 # local testing
-_api*.ya?ml
+_*.yaml
+_*.yml
 _*.py
 _*.json
+preflight.log
 .vscode/settings.json
 
 # media files

_preflight.py

@@ -4,30 +4,73 @@
 It is NOT part of the Hondana API or for public use. No support will be provided for this file. Use at your own risk.
 """
 
+import argparse
 import asyncio
 import pathlib
-import subprocess
+import subprocess  # noqa: S404
 import sys
 
 import hondana
 
 TAG_PATH = pathlib.Path("./hondana/extras/tags.json")
 REPORT_PATH = pathlib.Path("./hondana/extras/report_reasons.json")
 
-client = hondana.Client()
 
+class ProgramNamespace(argparse.Namespace):
+    tags: bool
+    reports: bool
 
-def __update_tags() -> None:
-    asyncio.run(client.update_tags())
-    asyncio.run(client.close())
+    def _parsed(self) -> bool:
+        return any([self.tags, self.reports])
 
-    diff = subprocess.run(["git", "diff", "--exit-code", str(TAG_PATH)], capture_output=False)
-    sys.exit(diff.returncode)
 
+parser = argparse.ArgumentParser(description="Small pre-flight CI script for hondana")
+parser.add_argument("-t", "--tags", action="store_true", dest="tags", help="Whether to run the 'update tags' action.")
+parser.add_argument(
+    "-r", "--reports", action="store_true", dest="reports", help="Whether to run the 'update report reasons' action."
+)
 
-def __update_report_reasons() -> None:
-    asyncio.run(client.update_report_reasons())
-    asyncio.run(client.close())
 
-    diff = subprocess.run(["git", "diff", "--exit-code", str(REPORT_PATH)], capture_output=False)
-    sys.exit(diff.returncode)
+async def __update_tags(client: hondana.Client, /) -> int:
+    await client.update_tags()
+
+    prog: asyncio.subprocess.Process = await asyncio.create_subprocess_exec("git", "diff", "--exit-code", str(REPORT_PATH))
+    return await prog.wait()
+
+
+async def __update_report_reasons(client: hondana.Client, /) -> int:
+    await client.update_report_reasons()
+
+    prog: asyncio.subprocess.Process = await asyncio.create_subprocess_exec(
+        "git",
+        "diff",
+        "--exit-code",
+        str(REPORT_PATH),
+    )
+    return await prog.wait()
+
+
+async def main(args: ProgramNamespace) -> None:
+    if not args._parsed():
+        msg = "At least one argument must be specified."
+        raise RuntimeError(msg)
+
+    client = hondana.Client()
+
+    if args.tags:
+        ret = await __update_tags(client)
+        if ret == 1:
+            msg = "Tags updated."
+            raise RuntimeError(msg)
+    if args.reports:
+        ret = await __update_report_reasons(client)
+        if ret == 1:
+            msg = "Reports updated."
+            raise RuntimeError(msg)
+
+    await client.close()
+
+
+if __name__ == "__main__":
+    args = parser.parse_args(namespace=ProgramNamespace())
+    asyncio.run(main(args))

_preflight.sh

@@ -0,0 +1,80 @@
+#!/bin/bash
+
+set -eux -o pipefail
+
+VENV_PATH=${VENV_PATH:-".venv/"}
+STRICT_DOCS=${STRICT_DOCS:-"false"}
+PROJECT=${PROJECT:-"hondana"}
+API_YAML="_api.yaml"
+OLD_API_YAML="_api.old.yaml"
+
+die() { echo "$*" 1>&2; exit 1; }
+
+if [[ ! -d "${VENV_PATH}" ]]; then
+    die "virtualenvironment does not exist."
+fi
+
+# activate the venv to get proper env vars
+source .venv/bin/activate
+
+run_ruff(){
+    if ! command -v ruff > /dev/null 2>&1; then
+        die "ruff is not installed."
+    fi
+
+    if ! ruff check .; then
+        die "Ruff check failed."
+    fi
+    if ! ruff format --check .; then
+        die "Ruff format failed."
+    fi
+}
+
+api_diff(){
+    if [[ -f "${API_YAML}" ]]; then
+        mv "${API_YAML}" "${OLD_API_YAML}"
+    else
+        echo "No API file, skipping to downloading new one."
+    fi
+
+    curl -SsL "https://api.mangadex.org/docs/static/api.yaml" -o _api.yaml
+
+    if ! cmp -s "${API_YAML}" "${OLD_API_YAML}"; then
+        die "There's an API change, check the diff: \`diff ${API_YAML} ${OLD_API_YAML}\`"
+    fi
+}
+
+preflight_tags() {
+    python _preflight.py -t
+}
+
+preflight_reports() {
+    python _preflight.py -r
+}
+
+run_pyright(){
+    pyright
+    pyright --ignoreexternal --verifytypes "${PROJECT}"
+}
+
+build_docs() {
+    if [[ "${STRICT_DOCS}" != "false" ]]; then
+        sphinx-build -anEWT --keep-going docs/ docs/build
+    else
+        sphinx-build -aEWT --keep-going docs/ docs/build
+    fi
+}
+
+run_tests() {
+    pytest
+}
+
+{
+    run_ruff
+    api_diff
+    preflight_tags
+    preflight_reports
+    run_pyright
+    build_docs
+    run_tests
+} 2>&1 | tee preflight.log