splent-cli 1.12.0__tar.gz → 1.13.0__tar.gz

{splent_cli-1.12.0/src/splent_cli.egg-info → splent_cli-1.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.12.0
+Version: 1.13.0
 Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
 Author-email: DiversoLab <diversolab@us.es>
 Project-URL: Homepage, https://github.com/diverso-lab/splent_cli

{splent_cli-1.12.0 → splent_cli-1.13.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splent_cli"
-version = "1.12.0"
+version = "1.13.0"
 description = "SPLENT-CLI is a CLI to be able to work on your development more easily."
 readme = "README.md"
 requires-python = ">=3.13"

{splent_cli-1.12.0 → splent_cli-1.13.0}/src/splent_cli/commands/database/db_reset.py

@@ -220,18 +220,32 @@ def _reset_everything(app, yes, product_path, product_name):
         raise SystemExit(1)
 
     click.echo(click.style("📋 Recreating splent_migrations table...", fg="cyan"))
-    with db.engine.begin() as conn:
-        conn.execute(
-            text(
-                f"""
-                CREATE TABLE IF NOT EXISTS `{SPLENT_MIGRATIONS_TABLE}` (
-                    `feature`        VARCHAR(255) NOT NULL,
-                    `last_migration` VARCHAR(255) DEFAULT NULL,
-                    PRIMARY KEY (`feature`)
-                ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
-                """
+    try:
+        with db.engine.begin() as conn:
+            conn.execute(
+                text(
+                    f"""
+                    CREATE TABLE IF NOT EXISTS `{SPLENT_MIGRATIONS_TABLE}` (
+                        `feature`        VARCHAR(255) NOT NULL,
+                        `last_migration` VARCHAR(255) DEFAULT NULL,
+                        PRIMARY KEY (`feature`)
+                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
+                    """
+                )
+            )
+    except Exception as exc:
+        # The drop above succeeded, so the schema is empty but the migration
+        # tracking table is gone: surface the partial state instead of a raw
+        # traceback, and tell the operator how to converge.
+        click.echo(
+            click.style(
+                f"Failed to recreate the migration tracking table `{SPLENT_MIGRATIONS_TABLE}`: {exc}\n"
+                "The database is empty but untracked. Re-run 'splent db:reset' once the "
+                "database connection is back.",
+                fg="red",
             )
         )
+        raise SystemExit(1)
 
     ctx = click.get_current_context()
     ctx.invoke(clear_uploads)

splent_cli-1.13.0/src/splent_cli/commands/locust.py

@@ -0,0 +1,140 @@
+"""splent locust — load testing for the active product.
+
+Locust runs inside the product's web container, which already has
+splent_framework and every installed feature importable, so no extra image is
+built. Discovery is done by splent_framework's locustfile bootstrap (1.7.1+),
+which finds each feature's locustfile on its own; a feature argument narrows it
+through SPLENT_LOCUSTFILES.
+
+The web interface listens on port 8089 inside the container. Products
+scaffolded by this CLI publish that port; for an older product add
+"8089:8089" to the web service's ports and recreate the container.
+"""
+
+import os
+import shlex
+
+import click
+
+from splent_cli.services import context
+from splent_cli.utils.proc import require_docker, run
+
+# Feature locustfile locations, relative to the workspace. Kept in sync with
+# splent_framework.bootstraps.locustfile_bootstrap.DEFAULT_PATTERNS.
+FEATURE_LOCUSTFILE_PATTERNS = (
+    "features/*/{feature}/tests/load/locustfile.py",
+    "features/*/{feature}/tests/locustfile.py",
+    "features/*/{feature}/src/*/*/tests/load/locustfile.py",
+    "app/features/{feature}/tests/locustfile.py",
+)
+
+# Resolved inside the container: the framework bootstrap that discovers and
+# re-exports every feature's HttpUser classes.
+BOOTSTRAP_SNIPPET = (
+    "locust -f \"$(python -c 'import splent_framework.bootstraps.locustfile_bootstrap as m; "
+    "print(m.__file__)')\" --web-host 0.0.0.0"
+)
+
+
+def _web_container() -> str:
+    return f"{context.require_app()}_web"
+
+
+def _container_running(name: str) -> bool:
+    result = run(
+        ["docker", "ps", "-q", "-f", f"name=^{name}$"], check=False, capture=True
+    )
+    return result.returncode == 0 and bool(result.stdout.strip())
+
+
+def _locust_installed(name: str) -> bool:
+    result = run(
+        ["docker", "exec", name, "python", "-c", "import locust"],
+        check=False,
+        capture=True,
+    )
+    return result.returncode == 0
+
+
+def _feature_patterns(feature: str) -> str:
+    return ",".join(p.format(feature=feature) for p in FEATURE_LOCUSTFILE_PATTERNS)
+
+
+def _feature_has_locustfile(workspace: str, feature: str) -> bool:
+    import glob
+
+    for pattern in FEATURE_LOCUSTFILE_PATTERNS:
+        if glob.glob(os.path.join(workspace, pattern.format(feature=feature))):
+            return True
+    return False
+
+
+@click.command(
+    "locust", short_help="Run Locust load tests inside the product web container."
+)
+@click.argument("feature", required=False)
+@context.requires_product
+def locust(feature):
+    require_docker()
+    container = _web_container()
+
+    if not _container_running(container):
+        raise click.ClickException(
+            f"Container '{container}' is not running. Start the product first: splent product:up"
+        )
+
+    if not _locust_installed(container):
+        raise click.ClickException(
+            f"locust is not installed in '{container}'.\n"
+            'Add "locust" to [project.optional-dependencies].dev in the product\'s '
+            "pyproject.toml and rebuild (splent product:derive), or install it once "
+            f"with: docker exec {container} pip install locust"
+        )
+
+    workspace = str(context.workspace())
+    env_args = ["-e", "WORKING_DIR=/workspace"]
+    if feature:
+        if not _feature_has_locustfile(workspace, feature):
+            raise click.ClickException(
+                f"No locustfile found for feature '{feature}'. Looked under: "
+                + ", ".join(FEATURE_LOCUSTFILE_PATTERNS)
+            )
+        env_args += ["-e", f"SPLENT_LOCUSTFILES={_feature_patterns(feature)}"]
+
+    check = run(
+        ["docker", "exec", container, "sh", "-c", "pgrep -f 'locust' >/dev/null"],
+        check=False,
+        capture=True,
+    )
+    if check.returncode == 0:
+        click.echo("Locust is already running in the product container.")
+        return
+
+    cmd = ["docker", "exec", "-d", *env_args, container, "sh", "-c", BOOTSTRAP_SNIPPET]
+    click.echo(f"Command: {' '.join(shlex.quote(c) for c in cmd)}")
+    run(cmd)
+    click.echo(click.style("Locust is running at http://localhost:8089", fg="green"))
+    click.echo("Stop it with: splent locust:stop")
+
+
+@click.command(
+    "locust:stop", short_help="Stop the Locust process in the product web container."
+)
+@context.requires_product
+def locust_stop():
+    require_docker()
+    container = _web_container()
+
+    if not _container_running(container):
+        click.echo(f"Container '{container}' is not running; nothing to stop.")
+        return
+
+    result = run(
+        ["docker", "exec", container, "sh", "-c", "pkill -f 'locust' || true"],
+        check=False,
+        capture=True,
+    )
+    if result.returncode == 0:
+        click.echo("Locust stopped.")
+    else:
+        click.echo("No Locust process was running.")

{splent_cli-1.12.0 → splent_cli-1.13.0}/src/splent_cli/utils/dynamic_imports.py

@@ -10,6 +10,10 @@ from splent_framework.utils.path_utils import PathUtils
 from splent_cli.utils.io_utils import load_toml
 from splent_cli.utils.proc import run
 
+# What the operator actually exported, captured before any .env is applied.
+# Precedence from here on: shell environment > product .env > workspace .env.
+_shell_env = dict(os.environ)
+
 load_dotenv()
 
 _app_instance = None
@@ -21,7 +25,13 @@ dotenv_path = None
 if module_name:
     dotenv_path = PathUtils.get_app_env_file()
     if os.path.exists(dotenv_path):
+        # The product's .env beats the workspace .env, hence override=True.
+        # But it must never beat the process environment: a product .env
+        # carries container paths (WORKING_DIR=/workspace/), and blindly
+        # overriding made the CLI unusable from the host, because whatever
+        # WORKING_DIR the operator exported was clobbered on import.
         load_dotenv(dotenv_path, override=True)
+        os.environ.update(_shell_env)
 
 
 def install_features_if_needed():

{splent_cli-1.12.0 → splent_cli-1.13.0/src/splent_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.12.0
+Version: 1.13.0
 Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
 Author-email: DiversoLab <diversolab@us.es>
 Project-URL: Homepage, https://github.com/diverso-lab/splent_cli

splent_cli-1.12.0/src/splent_cli/commands/locust.py

@@ -1,271 +0,0 @@
-import os
-import subprocess
-import click
-import docker
-import signal
-import psutil
-
-from splent_cli.services import context
-from splent_cli.utils.proc import run, require_docker, require_tool
-
-
-@click.command("locust", short_help="Launch the Locust load testing container.")
-@click.argument("module", required=False)
-@context.requires_product
-def locust(module):
-    # Absolute paths
-    working_dir = os.getenv("WORKING_DIR", "")
-    core_dir = os.path.join(working_dir, "core")
-    docker_dir = os.path.join(working_dir, "docker/")
-    modules_dir = os.path.join(working_dir, "app/modules")
-
-    def validate_module(module):
-        """Check if the module exists."""
-        if module:
-            module_path = os.path.join(modules_dir, module)
-            if not os.path.exists(module_path):
-                raise click.UsageError(f"module '{module}' does not exist.")
-            locustfile_path = os.path.join(module_path, "tests", "locustfile.py")
-            if not os.path.exists(locustfile_path):
-                raise click.UsageError(
-                    f"Locustfile for module '{module}' does not exist at path "
-                    f"'{locustfile_path}'."
-                )
-
-    def run_docker_locust(volume_name, module):
-        """Build and run the Locust container with the specified volume."""
-
-        try:
-            # Check if the container already exists
-            client.containers.get("locust_container")
-            click.echo("Locust container is already running.")
-            return
-        except docker.errors.NotFound:
-            pass  # Container does not exist, proceed to create it
-
-        click.echo(
-            f"Starting Locust in Docker environment on port 8089 with volume: {volume_name}..."
-        )
-
-        # Build Locust's image
-        build_command = [
-            "docker",
-            "build",
-            "-f",
-            os.path.join(docker_dir, "images/Dockerfile.locust"),
-            "-t",
-            "locust-image",
-            ".",
-        ]
-        click.echo(f"Build command: {' '.join(build_command)}")
-        run(build_command)
-
-        # Define the locustfile path
-        locustfile_path = os.path.join(core_dir, "bootstraps/locustfile_bootstrap.py")
-        if module:
-            locustfile_path = f"{modules_dir}/{module}/tests/locustfile.py"
-
-        # Only attach to docker_flasky_network if it actually exists; otherwise
-        # the container would fail to start with an unhelpful docker error.
-        network_name = "docker_flasky_network"
-        network_args = []
-        network_check = run(
-            ["docker", "network", "inspect", network_name],
-            check=False,
-            capture=True,
-        )
-        if network_check.returncode == 0:
-            network_args = ["--network", network_name]
-        else:
-            click.secho(
-                f"⚠️  Network '{network_name}' not found; starting Locust without it.",
-                fg="yellow",
-            )
-
-        # Run the Locust container
-        up_command = [
-            "docker",
-            "run",
-            "-d",
-            "-p",
-            "8089:8089",
-            "-v",
-            f"{volume_name}:/workspace",
-            "--name",
-            "locust_container",
-            *network_args,
-            "locust-image",
-            "-f",
-            locustfile_path,
-        ]
-
-        click.echo(f"Docker Run command: {' '.join(up_command)}")
-        run(up_command)
-        click.echo(
-            click.style("Locust is running at http://localhost:8089", fg="green")
-        )
-
-    def _is_our_locust(proc):
-        """True only for a locust process started from this working dir."""
-        try:
-            info = proc.as_dict(attrs=["name", "cmdline", "cwd"])
-        except (psutil.NoSuchProcess, psutil.AccessDenied):
-            return False
-        name = info.get("name") or ""
-        cmdline = info.get("cmdline") or []
-        is_locust = name == "locust" or any(
-            os.path.basename(part) == "locust" for part in cmdline[:1]
-        )
-        if not is_locust:
-            return False
-        # Scope to processes launched from this working dir so we don't match
-        # an unrelated locust running elsewhere on the machine.
-        cwd = info.get("cwd")
-        if cwd and working_dir:
-            return os.path.normpath(cwd).startswith(os.path.normpath(working_dir))
-        return cwd is None or not working_dir
-
-    def is_locust_running():
-        """Check if Locust is already running for this working dir."""
-        for proc in psutil.process_iter(["pid", "name"]):
-            if _is_our_locust(proc):
-                return True
-        return False
-
-    def run_in_console(module):
-        if is_locust_running():
-            click.echo("Locust is already running.")
-            return
-
-        locustfile_path = os.path.join(core_dir, "bootstraps/locustfile_bootstrap.py")
-        if module:
-            locustfile_path = os.path.join(
-                modules_dir, module, "tests", "locustfile.py"
-            )
-        require_tool(
-            "locust",
-            "Install it with: pip install locust",
-        )
-        locust_command = ["locust", "-f", locustfile_path]
-        click.echo(f"Locust command: {' '.join(locust_command)}")
-        subprocess.Popen(
-            locust_command,
-            stdin=subprocess.PIPE,
-            stdout=subprocess.DEVNULL,
-            stderr=subprocess.DEVNULL,
-        )
-        click.echo(
-            click.style("Locust is running at http://localhost:8089", fg="green")
-        )
-
-    def run_local_locust(module):
-        """Run Locust in the local environment."""
-        click.echo("Starting Locust in local environment on port 8089...")
-        run_in_console(module)
-
-    def run_vagrant_locust(module):
-        """Run Locust in the Vagrant environment."""
-        click.echo("Starting Locust in Vagrant environment on port 8089...")
-        run_in_console(module)
-
-    # Validate module if provided
-    if module:
-        validate_module(module)
-
-    if working_dir == "/workspace/":
-        # Ensure docker is installed and the daemon is reachable before we try
-        # to talk to it, so a broken setup yields an actionable message.
-        require_docker()
-        try:
-            client = docker.from_env()
-        except docker.errors.DockerException as e:
-            raise click.ClickException(f"Could not connect to the Docker daemon: {e}")
-
-        try:
-            web_container = client.containers.get("web_app_container")
-            volume_name = next(
-                (
-                    mount.get("Name") or mount.get("Source")
-                    for mount in web_container.attrs.get("Mounts", [])
-                    if mount.get("Destination") == "/app"
-                ),
-                None,
-            )
-
-            if not volume_name:
-                raise ValueError("No volume or bind mount found mounted on /app")
-
-            run_docker_locust(volume_name, module)
-
-        except docker.errors.NotFound:
-            click.echo(click.style("Web container not found.", fg="red"))
-        except click.ClickException:
-            raise
-        except Exception as e:
-            click.echo(click.style(f"An error occurred: {str(e)}", fg="red"))
-
-    elif working_dir == "":
-        run_local_locust(module)
-
-    elif working_dir == "/vagrant/":
-        run_vagrant_locust(module)
-
-    else:
-        click.echo(click.style(f"Unrecognized WORKING_DIR: {working_dir}", fg="red"))
-
-
-@click.command("locust:stop", short_help="Stop the Locust load testing container.")
-def stop():
-    working_dir = os.getenv("WORKING_DIR", "")
-
-    def _is_our_locust(proc):
-        """True only for a locust process started from this working dir."""
-        try:
-            info = proc.as_dict(attrs=["name", "cmdline", "cwd"])
-        except (psutil.NoSuchProcess, psutil.AccessDenied):
-            return False
-        name = info.get("name") or ""
-        cmdline = info.get("cmdline") or []
-        is_locust = name == "locust" or any(
-            os.path.basename(part) == "locust" for part in cmdline[:1]
-        )
-        if not is_locust:
-            return False
-        cwd = info.get("cwd")
-        if cwd and working_dir:
-            return os.path.normpath(cwd).startswith(os.path.normpath(working_dir))
-        return cwd is None or not working_dir
-
-    def stop_local_locust():
-        """Stop Locust process in the local environment."""
-        click.echo("Stopping Locust in local environment...")
-        for proc in psutil.process_iter(["pid", "name"]):
-            if _is_our_locust(proc):
-                click.echo(f"Stopping Locust process with PID {proc.pid}...")
-                try:
-                    os.kill(proc.pid, signal.SIGTERM)
-                except (ProcessLookupError, PermissionError) as e:
-                    click.secho(f"⚠️  Could not stop PID {proc.pid}: {e}", fg="yellow")
-
-    def stop_docker_locust():
-        click.echo("Stopping Locust container if it is running...")
-        require_docker()
-        stop_command = ["docker", "stop", "locust_container"]
-        rm_command = ["docker", "rm", "locust_container"]
-
-        result = run(stop_command, check=False, capture=True)
-        if result.returncode != 0:
-            click.secho("⚠️  Could not stop Locust container.", fg="yellow")
-
-        result = run(rm_command, check=False, capture=True)
-        if result.returncode != 0:
-            click.secho("⚠️  Could not remove Locust container.", fg="yellow")
-
-    if working_dir == "/workspace/":
-        stop_docker_locust()
-
-    elif working_dir == "" or working_dir == "/vagrant/":
-        stop_local_locust()
-
-    else:
-        click.echo(click.style(f"Unrecognized WORKING_DIR: {working_dir}", fg="red"))