Merge branch 'main' into 163-rate-limiting-fix

Author: jeff-schnitter

.github/workflows/publish.yml

@@ -53,7 +53,7 @@ jobs:
 
     - name: Generate HISTORY.md
       run: |
-        git-changelog > HISTORY.md
+        git-changelog -c angular > HISTORY.md
         cat HISTORY.md
 
     - name: Commit and Push

HISTORY.md

@@ -38,6 +38,7 @@
 import cortexapps_cli.commands.rest as rest
 import cortexapps_cli.commands.scim as scim
 import cortexapps_cli.commands.scorecards as scorecards
+import cortexapps_cli.commands.secrets as secrets
 import cortexapps_cli.commands.teams as teams
 import cortexapps_cli.commands.workflows as workflows
 
@@ -74,6 +75,7 @@
 app.add_typer(rest.app, name="rest")
 app.add_typer(scim.app, name="scim")
 app.add_typer(scorecards.app, name="scorecards")
+app.add_typer(secrets.app, name="secrets")
 app.add_typer(teams.app, name="teams")
 app.add_typer(workflows.app, name="workflows")
 

cortexapps_cli/cli.py

@@ -0,0 +1,105 @@
+import typer
+import json
+from typing_extensions import Annotated
+from cortexapps_cli.utils import print_output_with_context
+from cortexapps_cli.command_options import ListCommandOptions
+
+app = typer.Typer(
+    help="Secrets commands",
+    no_args_is_help=True
+)
+
+@app.command()
+def list(
+    ctx: typer.Context,
+    page: ListCommandOptions.page = None,
+    page_size: ListCommandOptions.page_size = 250,
+    table_output: ListCommandOptions.table_output = False,
+    csv_output: ListCommandOptions.csv_output = False,
+    columns: ListCommandOptions.columns = [],
+    no_headers: ListCommandOptions.no_headers = False,
+    filters: ListCommandOptions.filters = [],
+    sort: ListCommandOptions.sort = [],
+):
+    """
+    List secrets
+    """
+    client = ctx.obj["client"]
+
+    params = {
+       "page": page,
+       "pageSize": page_size
+    }
+
+    if (table_output or csv_output) and not ctx.params.get('columns'):
+        ctx.params['columns'] = [
+            "ID=id",
+            "Name=name",
+            "Tag=tag",
+        ]
+
+    # remove any params that are None
+    params = {k: v for k, v in params.items() if v is not None}
+
+    if page is None:
+        r = client.fetch("api/v1/secrets", params=params)
+    else:
+        r = client.get("api/v1/secrets", params=params)
+    print_output_with_context(ctx, r)
+
+@app.command()
+def get(
+    ctx: typer.Context,
+    tag_or_id: str = typer.Option(..., "--tag-or-id", "-t", help="Secret tag or ID"),
+):
+    """
+    Get a secret by tag or ID
+    """
+    client = ctx.obj["client"]
+    r = client.get(f"api/v1/secrets/{tag_or_id}")
+    print_output_with_context(ctx, r)
+
+@app.command()
+def create(
+    ctx: typer.Context,
+    file_input: Annotated[typer.FileText, typer.Option("--file", "-f", help="File containing secret definition (name, secret, tag); can be passed as stdin with -, example: -f-")] = ...,
+):
+    """
+    Create a secret
+
+    Provide a JSON file with the secret definition including required fields:
+    - name: human-readable label for the secret
+    - secret: the actual secret value
+    - tag: unique identifier for the secret
+    """
+    client = ctx.obj["client"]
+    data = json.loads("".join([line for line in file_input]))
+    r = client.post("api/v1/secrets", data=data)
+    print_output_with_context(ctx, r)
+
+@app.command()
+def update(
+    ctx: typer.Context,
+    tag_or_id: str = typer.Option(..., "--tag-or-id", "-t", help="Secret tag or ID"),
+    file_input: Annotated[typer.FileText, typer.Option("--file", "-f", help="File containing fields to update (name, secret); can be passed as stdin with -, example: -f-")] = ...,
+):
+    """
+    Update a secret
+
+    Provide a JSON file with the fields to update (name and/or secret are optional).
+    """
+    client = ctx.obj["client"]
+    data = json.loads("".join([line for line in file_input]))
+    r = client.put(f"api/v1/secrets/{tag_or_id}", data=data)
+    print_output_with_context(ctx, r)
+
+@app.command()
+def delete(
+    ctx: typer.Context,
+    tag_or_id: str = typer.Option(..., "--tag-or-id", "-t", help="Secret tag or ID"),
+):
+    """
+    Delete a secret
+    """
+    client = ctx.obj["client"]
+    client.delete(f"api/v1/secrets/{tag_or_id}")

cortexapps_cli/commands/secrets.py

@@ -0,0 +1,5 @@
+{
+  "tag": "cli_test_secret",
+  "name": "CLI Test Secret",
+  "secret": "test-secret-value-12345"
+}

data/run-time/secret-create.json

@@ -0,0 +1,4 @@
+{
+  "name": "Updated CLI Test Secret",
+  "secret": "updated-secret-value-67890"
+}

data/run-time/secret-update.json

@@ -0,0 +1,42 @@
+from tests.helpers.utils import *
+import pytest
+
+def test():
+    # Skip test if API key doesn't have secrets permissions
+    # The Secrets API may require special permissions or may not be available in all environments
+    try:
+        # Try to list secrets first to check if we have permission
+        response = cli(["secrets", "list"], return_type=ReturnType.RAW)
+        if response.exit_code != 0 and "403" in response.stdout:
+            pytest.skip("API key does not have permission to access Secrets API")
+    except Exception as e:
+        if "403" in str(e) or "Forbidden" in str(e):
+            pytest.skip("API key does not have permission to access Secrets API")
+
+    # Create a secret
+    response = cli(["secrets", "create", "-f", "data/run-time/secret-create.json"])
+    assert response['tag'] == 'cli_test_secret', "Should create secret with tag cli_test_secret"
+    assert response['name'] == 'CLI Test Secret', "Should have correct name"
+
+    # List secrets and verify it exists
+    response = cli(["secrets", "list"])
+    assert any(secret['tag'] == 'cli_test_secret' for secret in response['secrets']), "Should find secret with tag cli_test_secret"
+
+    # Get the secret
+    response = cli(["secrets", "get", "-t", "cli_test_secret"])
+    assert response['tag'] == 'cli_test_secret', "Should get secret with correct tag"
+    assert response['name'] == 'CLI Test Secret', "Should have correct name"
+
+    # Update the secret
+    cli(["secrets", "update", "-t", "cli_test_secret", "-f", "data/run-time/secret-update.json"])
+
+    # Verify the update
+    response = cli(["secrets", "get", "-t", "cli_test_secret"])
+    assert response['name'] == 'Updated CLI Test Secret', "Should have updated name"
+
+    # Delete the secret
+    cli(["secrets", "delete", "-t", "cli_test_secret"])
+
+    # Verify deletion by checking list
+    response = cli(["secrets", "list"])
+    assert not any(secret['tag'] == 'cli_test_secret' for secret in response['secrets']), "Should not find deleted secret"