add run error tests for coverage

Author: bckohan

django_routines/management/commands/routine.py

@@ -35,7 +35,7 @@
 width = 80
 use_rich = find_spec("rich") is not None
 if use_rich:
-    from rich.console import Console
+    from rich.console import Console  # pyright: ignore[reportMissingImports]
 
     width = Console().width
 

tests/base_settings.py

@@ -0,0 +1,54 @@
+import os
+from pathlib import Path
+from django.utils.translation import gettext_lazy as _
+
+USE_TZ = True
+
+
+# Set default terminal width for help outputs - necessary for
+# testing help output in CI environments.
+os.environ["TERMINAL_WIDTH"] = "80"
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+# Application definition
+
+INSTALLED_APPS = [
+    "render_static",
+    "tests.django_routines_tests",
+    "django_routines",
+    "django_typer",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+        "TEST": {"NAME": BASE_DIR / "db.sqlite3"},
+    }
+}
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+DJANGO_ROUTINES = None
+
+DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+
+STATIC_URL = "static/"
+
+SECRET_KEY = "fake"

tests/settings.py

@@ -12,6 +12,7 @@
 )
 from tests import track_file, system_cmd
 from django.utils.translation import gettext_lazy as _
+from tests.base_settings import *
 
 track_file = str(track_file.relative_to(Path(os.getcwd())))
 system_cmd = ("python", str(system_cmd.relative_to(Path(os.getcwd()))))
@@ -23,50 +24,6 @@
 # testing help output in CI environments.
 os.environ["TERMINAL_WIDTH"] = "80"
 
-# Build paths inside the project like this: BASE_DIR / 'subdir'.
-BASE_DIR = Path(__file__).resolve().parent.parent
-
-# Application definition
-
-INSTALLED_APPS = [
-    "render_static",
-    "tests.django_routines_tests",
-    "django_routines",
-    "django_typer",
-    "django.contrib.auth",
-    "django.contrib.contenttypes",
-    "django.contrib.sessions",
-    "django.contrib.messages",
-    "django.contrib.staticfiles",
-]
-
-
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.sqlite3",
-        "NAME": BASE_DIR / "db.sqlite3",
-        "TEST": {"NAME": BASE_DIR / "db.sqlite3"},
-    }
-}
-
-MIDDLEWARE = [
-    "django.middleware.security.SecurityMiddleware",
-    "django.contrib.sessions.middleware.SessionMiddleware",
-    "django.middleware.common.CommonMiddleware",
-    "django.middleware.csrf.CsrfViewMiddleware",
-    "django.contrib.auth.middleware.AuthenticationMiddleware",
-    "django.contrib.messages.middleware.MessageMiddleware",
-    "django.middleware.clickjacking.XFrameOptionsMiddleware",
-]
-
-DJANGO_ROUTINES = None
-
-DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
-
-STATIC_URL = "static/"
-
-SECRET_KEY = "fake"
-
 routine(
     "deploy",
     _("Deploy the site application into production."),

tests/settings_subproc_error.py

@@ -0,0 +1,9 @@
+from .base_settings import *
+from django_routines import routine, SystemCommand
+
+
+routine(
+    "subproc_error",
+    "Test what happens when a subprocess throws an error.",
+    SystemCommand(("python", "tests/throw_error.py")),
+)

tests/settings_subproc_opt_error.py

@@ -0,0 +1,9 @@
+from .base_settings import *
+from django_routines import routine, RoutineCommand
+
+
+routine(
+    "subproc_opt_error",
+    "Test what happens when you can't convert an option to subprocess arg string.",
+    RoutineCommand(("collectstatic"), options={"not-an-option": False}),
+)

tests/test_deploy.py

@@ -0,0 +1,58 @@
+"""
+Miscellaneous tests - mostly for coverage
+"""
+
+from io import StringIO
+import sys
+import subprocess
+from django.core.management import call_command
+from django.test import TestCase
+
+
+class TestDeploy(TestCase):
+    def test_deploy_routine(self):
+        out = StringIO()
+        err = StringIO()
+        call_command("routine", "deploy", "--prepare", stdout=out, stderr=err)
+        self.assertTrue(out.getvalue())
+        self.assertFalse(err.getvalue().strip())
+
+
+def test_subprocess_error():
+    result = subprocess.run(
+        [
+            sys.executable,
+            "./manage.py",
+            "routine",
+            "--settings",
+            "tests.settings_subproc_error",
+            "subproc-error",
+            "--subprocess",
+        ],
+        text=True,
+        capture_output=True,
+    )
+
+    assert "panic!" in result.stderr
+    assert "Subprocess command failed" in result.stderr
+
+
+def test_subprocess_opt_error():
+    result = subprocess.run(
+        [
+            sys.executable,
+            "./manage.py",
+            "routine",
+            "--settings",
+            "tests.settings_subproc_opt_error",
+            "subproc-opt-error",
+            "--subprocess",
+        ],
+        text=True,
+        capture_output=True,
+    )
+
+    assert (
+        "CommandError: Failed to convert collectstatic options to CLI format: {'not-an-option': False}"
+        in result.stderr
+    )

tests/test_runs.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+import sys
+from pathlib import Path
+
+sys.path.append(str(Path(__file__).parent.parent))
+
+
+if __name__ == "__main__":
+    raise Exception("panic!")