GOATS-724: Add --ci flag for installing GOATS. (#323)

* GOATS-724: Add --ci flag for installing GOATS.

* Add towncrier entry.

Author: davner

docs/changes/323.new.rst

@@ -0,0 +1 @@
+Added `--ci` flag to allow installing GOATS bypassing the user prompts for a CI pipeline.

src/goats_cli/cli.py

@@ -78,12 +78,16 @@ def cli(ctx):
     ),
     callback=validate_addrport,
 )
+@click.option(
+    "--ci", is_flag=True, help="Run install in non-interactive CI mode (no prompts)."
+)
 def install(
     project_name: str,
     directory: Path,
     overwrite: bool,
     media_dir: Path | None,
     redis_addrport: str,
+    ci: bool,
 ) -> None:
     """Installs GOATS with a specified or default name in a specified or
     default directory and configures Redis server.
@@ -101,6 +105,8 @@ def install(
         The path to save media files.
     redis_addrport : `str`
         The host and port Redis is served on.
+    ci : `bool`
+        Run install in non-interactive CI mode (no prompts).
 
     Raises
     ------
@@ -159,6 +165,9 @@ def install(
                 )
             goats_setup_command.extend(["--media-dir", f"{resolved_media_dir}"])
 
+        if ci:
+            goats_setup_command.append("--ci")
+
         subprocess.run(goats_setup_command, check=True)
 
         # Migrate the webpage.

src/goats_setup/management/commands/goats_setup.py

@@ -1,5 +1,6 @@
 """Django command to install GOATS."""
 
+import os
 import re
 import sys
 from pathlib import Path
@@ -14,7 +15,7 @@
 from packaging import version
 from tom_setup.management.commands.tom_setup import Command as TOMCommand
 
-PYTHON_VERSION: str = "3.10"
+PYTHON_VERSION: str = "3.12"
 REDIS_HOST: str = "localhost"
 REDIS_PORT: int = 6379
 REDIS_ADDRPORT: str = f"{REDIS_HOST}:{REDIS_PORT}"
@@ -29,8 +30,12 @@ class Command(TOMCommand):
 
     help = "🐐 GOATS setup wizard."
 
-    def welcome_banner(self) -> None:
+    def welcome_banner(self, ci: bool = False) -> None:
         """Displays a welcome banner."""
+        if ci:
+            self.stdout.write("🐐 Running GOATS for CI, skipping prompts.")
+            return
+
         welcome_text = (
             "🐐 Welcome to the GOATS setup wizard. This will assist you with your "
             "new GOATS project.\n"
@@ -82,6 +87,13 @@ def add_arguments(self, parser):
                 "Providing only a port number (e.g., '6379') binds to localhost."
             ),
         )
+        # Argument to be used for CI.
+        parser.add_argument(
+            "--ci",
+            action="store_true",
+            default=False,
+            help="Run install in non-interactive CI mode (no prompts).",
+        )
 
     def check_python(self) -> None:
         """Checks the Python version, exits if not compatible."""
@@ -137,10 +149,11 @@ def generate_secret_key(self) -> None:
 
     def handle(self, *args, **options) -> None:
         """Handles the setup process."""
+        ci = options.get("ci", False)
         self.context["CREATE_DATE"] = timezone.now()
         self.context["PROJECT_NAME"] = settings.BASE_DIR.name
         self.context["HINTS_ENABLED"] = False
-        self.welcome_banner()
+        self.welcome_banner(ci=ci)
         self.stdout.write(self.style.MIGRATE_HEADING("Initial setup:"))
         self.check_python()
         self.setup_redis(redis_addrport=options.get("redis_addrport"))
@@ -153,7 +166,7 @@ def handle(self, *args, **options) -> None:
         self.generate_file("urls")
         self.generate_file("asgi")
         self.run_migrations()
-        self.create_pi()
+        self.create_pi(ci=ci)
         self.create_public_group()
         self.complete()
 
@@ -214,14 +227,35 @@ def get_target_type(self) -> None:
         """Gets the target type for the project."""
         self.context["TARGET_TYPE"] = "SIDEREAL"
 
-    def create_pi(self) -> None:
+    def create_pi(self, ci: bool = False) -> None:
         """Creates a Principal Investigator (PI) superuser."""
         self.stdout.write(
             self.style.MIGRATE_HEADING(
                 "Principal Investigator (PI) and public user creation:",
             )
         )
-        call_command("createsuperuser", verbosity=0)
+        if ci:
+            password = os.environ.get("DJANGO_SUPERUSER_PASSWORD")
+            if not password:
+                self.stdout.write(
+                    self.style.WARNING(
+                        "🐐 DJANGO_SUPERUSER_PASSWORD is not set; the superuser will "
+                        "not be able to log in until a password is manually set."
+                    )
+                )
+
+            call_command(
+                "createsuperuser",
+                verbosity=0,
+                username="goats",
+                email="goats@goats.com",
+                interactive=False,
+            )
+        else:
+            call_command(
+                "createsuperuser",
+                verbosity=0,
+            )
         self.status("  PI Superuser created... ")
         self.ok()