Merge branch 'dev' of github.com:simvue-io/simvue-cli into dev

Author: kzscisoft

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Description of Bug
+A clear and concise description of what the bug is.
+
+## Steps To Reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Actual Behaviour
+A clear and concise description of what you actually see happen.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
+## Setup
+ - OS: [e.g. Windows 11]
+ - Python Version [e.g. v3.13.3]
+ - Simvue Python API Version: [e.g v1.2.0]
+
+## Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest a new feature or enhancement to the Simvue CLI
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Problem Statement
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Solution
+A clear and concise description of what you want to happen.
+
+## Alternatives Considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional Context
+Add any other context or screenshots about the feature request here.

.github/workflows/deploy.yaml

@@ -7,6 +7,8 @@ jobs:
   build:
     name: Build Wheels and Package 🛠️
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simvue-cli"
-version = "1.0.1"
+version = "1.0.2"
 description = "Command Line Interface for interaction with a Simvue v3 server"
 authors = [
     {name = "Simvue Development Team", email = "[email protected]"}
@@ -35,7 +35,7 @@ keywords = [
 dependencies = [
     "click-option-group>=0.5.7",
     "click>=8.1.8",
-    "simvue>=2.1.0",
+    "simvue>=2.1.1",
     "click-log>=0.4.0",
     "click-params>=0.5.0",
     "toml>=0.10.2",

src/simvue_cli/actions.py

@@ -436,6 +436,31 @@ def create_user_alert(
     return _alert
 
 
+def trigger_user_alert(
+    run_id: str, alert_id: str, status: typing.Literal["ok", "critical"]
+) -> None:
+    """Trigger a manually defined user alert.
+
+    Parameters
+    ----------
+    run_id: str
+        the unique identifier for the run to alert on
+    alert_id : str
+        the unique identifier for the alert
+    status: Literal['ok', 'critical']
+        the state to set the alert to
+
+    """
+    _alert = get_alert(alert_id=alert_id)
+
+    if not isinstance(_alert, UserAlert):
+        raise ValueError(f"Alert '{alert_id}' is not a user alert.")
+
+    _alert.read_only(False)
+    _alert.set_status(run_id=run_id, status=status)
+    _alert.commit()
+
+
 def create_simvue_user(
     username: str,
     email: str,

src/simvue_cli/cli/__init__.py

@@ -507,6 +507,31 @@ def simvue_alert(ctx) -> None:
     pass
 
 
+@simvue_alert.command("trigger")
+@click.pass_context
+@click.argument("run_id")
+@click.argument("alert_id")
+@click.option(
+    "--ok",
+    "is_ok",
+    is_flag=True,
+    help="Set alert to status 'ok' as opposed to critical.",
+    show_default=True,
+)
+def trigger_alert(ctx, is_ok: bool, **kwargs) -> None:
+    """Trigger a user alert"""
+    try:
+        simvue_cli.actions.trigger_user_alert(
+            status="ok" if is_ok else "critical", **kwargs
+        )
+    except ValueError as e:
+        if ctx.obj["plain"]:
+            print(e.args[0])
+        else:
+            click.secho(e.args[0], fg="red", bold=True)
+        sys.exit(1)
+
+
 @simvue_alert.command("list")
 @click.pass_context
 @click.option(
@@ -927,7 +952,6 @@ def simvue_tag(ctx) -> None:
 @click.option("--reverse", help="Reverse ordering", default=False, is_flag=True)
 def tag_list(
     ctx,
-    count: int,
     enumerate_: bool,
     created: bool,
     table_format: str | None,
@@ -1131,7 +1155,6 @@ def tenant_list(
     ctx,
     table_format: str,
     enumerate_: bool,
-    count: int,
     max_runs: bool,
     max_data_volume: bool,
     max_request_rate: bool,
@@ -1215,7 +1238,6 @@ def user(ctx) -> None:
 def list_user(
     ctx,
     enumerate_: bool,
-    count: int,
     table_format: str | None,
     username: bool,
     email: bool,
@@ -1521,6 +1543,7 @@ def delete_storage(ctx, storage_ids: list[str] | None, interactive: bool) -> Non
 @click.pass_context
 @click.option(
     "--format",
+    "table_format",
     type=click.Choice(list(tabulate._table_formats.keys())),
     help="Display as table with output format",
     default=None,
@@ -1548,7 +1571,7 @@ def delete_storage(ctx, storage_ids: list[str] | None, interactive: bool) -> Non
 @click.option("--enabled", is_flag=True, help="Show if storage is enabled")
 def list_storages(
     ctx,
-    format: str,
+    table_format: str,
     backend: bool,
     tenant_usable: bool,
     default: bool,
@@ -1578,7 +1601,7 @@ def list_storages(
         storages,
         plain_text=ctx.obj["plain"],
         enumerate_=enumerate_,
-        format=format,
+        format=table_format,
     )
     click.echo(table)
 
@@ -1622,6 +1645,7 @@ def simvue_artifact(ctx):
 @click.pass_context
 @click.option(
     "--format",
+    "table_format",
     type=click.Choice(list(tabulate._table_formats.keys())),
     help="Display as table with output format",
     default=None,
@@ -1669,10 +1693,9 @@ def simvue_artifact(ctx):
     show_default=True,
 )
 @click.option("--reverse", help="Reverse ordering", default=False, is_flag=True)
-@click.pass_context
 def artifact_list(
     ctx,
-    format_: str,
+    table_format: str | None,
     enumerate_: bool,
     original_path: bool,
     storage: bool,
@@ -1713,7 +1736,7 @@ def artifact_list(
         storages,
         plain_text=ctx.obj["plain"],
         enumerate_=enumerate_,
-        format=format,
+        format=table_format,
     )
     click.echo(table)
 

tests/test_command_line_interface.py

@@ -1,5 +1,7 @@
+from logging import critical
 import random
 import string
+import typing
 from uuid import uuid4
 from _pytest.compat import LEGACY_PATH
 from simvue.api.objects import Alert, Storage, Tenant, User
@@ -252,6 +254,31 @@ def test_user_alert() -> None:
         Alert(identifier=_alert)
 
 
+@pytest.mark.parametrize("status", ("ok", "critical"))
+def test_user_alert_trigger(create_plain_run: tuple[simvue.Run, dict], status: typing.Literal["ok", "critical"]) -> None:
+    run, _ = create_plain_run
+    _alert_id = run.create_user_alert(
+        name="test_user_alert_triggered_alert_cli",
+        description="Test alert for CLI triggering",
+        trigger_abort=True
+    )
+    _command = [
+        "alert",
+        "trigger",
+        run.id,
+        _alert_id
+    ]
+    runner = click.testing.CliRunner()
+    result = runner.invoke(
+        sv_cli.simvue,
+        _command + ([] if status == "critical" else ["--ok"])
+    )
+    assert result.exit_code == 0, result.output
+    _alert: UserAlert = Alert(_alert_id)
+    assert _alert.get_status(run.id) == status
+
+
+
 def test_server_ping() -> None:
     runner = click.testing.CliRunner()
     result = runner.invoke(
@@ -337,8 +364,9 @@ def test_artifact_list(create_test_run: tuple[simvue.Run, dict]) -> None:
             "--mime-type",
             "--count=20",
             "--enumerate",
-            f"--format=simple"
-        ]
+            "--format=simple"
+        ],
+        catch_exceptions=False
     )
     assert result.exit_code == 0, result.output
     assert run_data["file_1"] in result.output

tests/unit/test_cli_actions.py

@@ -2,12 +2,14 @@
 import time
 import re
 import pathlib
+import typing
 import pytest
 import uuid
 import os
 import simvue
 from simvue.api.objects import Alert, Run, Events, Storage, Tenant, User
 from simvue.exception import ObjectNotFoundError
+from simvue.run import UserAlert
 import simvue_cli.actions
 
 
@@ -162,3 +164,20 @@ def test_run_abort(create_test_run, monkeypatch) -> None:
     assert _run._status == "terminated"
 
 
+@pytest.mark.parametrize(
+    "status", ("ok", "critical")
+)
+def test_user_alert_triggered(create_plain_run: tuple[simvue.Run, dict], status: typing.Literal["ok", "critical"]) -> None:
+    run, _ = create_plain_run
+    _alert_id = run.create_user_alert(
+        name="test_user_alert_triggered_alert",
+        description="Test alert for CLI triggering",
+        trigger_abort=True
+    )
+    simvue_cli.actions.trigger_user_alert(
+        run.id,
+        _alert_id,
+        status
+    )
+    _alert: UserAlert = Alert(_alert_id)
+    assert _alert.get_status(run.id) == status