nextmv 0.39.0.dev1__py3-none-any.whl → 1.0.0__py3-none-any.whl

nextmv/cli/cloud/scenario/metadata.py

@@ -0,0 +1,67 @@
+"""
+This module defines the cloud scenario metadata command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import AppIDOption, ProfileOption, ScenarioTestIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def metadata(
+    app_id: AppIDOption,
+    scenario_test_id: ScenarioTestIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the scenario test metadata to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Get metadata for a Nextmv Cloud scenario test.
+
+    This command retrieves metadata for a specific scenario test, including
+    status, creation date, and other high-level information without the full
+    run details.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Get metadata for scenario test [magenta]bunny-warren-optimization[/magenta] from application
+      [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud scenario metadata --app-id hare-app --scenario-test-id bunny-warren-optimization[/dim]
+
+    - Get metadata and save to a file.
+        $ [dim]nextmv cloud scenario metadata --app-id hare-app --scenario-test-id lettuce-delivery \\
+            --output metadata.json[/dim]
+
+    - Get metadata using a specific profile.
+        $ [dim]nextmv cloud scenario metadata --app-id hare-app --scenario-test-id hop-schedule --profile prod[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Getting scenario test metadata...")
+    scenario_metadata = cloud_app.scenario_test_metadata(scenario_test_id=scenario_test_id)
+    scenario_metadata_dict = scenario_metadata.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(scenario_metadata_dict, f, indent=2)
+
+        success(msg=f"Scenario test metadata saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(scenario_metadata_dict)

nextmv/cli/cloud/scenario/update.py

@@ -0,0 +1,93 @@
+"""
+This module defines the cloud scenario update command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import AppIDOption, ProfileOption, ScenarioTestIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    scenario_test_id: ScenarioTestIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="Updated description of the scenario test.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="Updated name of the scenario test.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated scenario test information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Update a Nextmv Cloud scenario test.
+
+    Update the name and/or description of a scenario test. Any fields not
+    specified will remain unchanged.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the name of a scenario test.
+        $ [dim]nextmv cloud scenario update --app-id hare-app --scenario-test-id carrot-feast \\
+            --name "Spring Carrot Harvest"[/dim]
+
+    - Update the description of a scenario test.
+        $ [dim]nextmv cloud scenario update --app-id hare-app --scenario-test-id bunny-hop-routes \\
+            --description "Optimizing hop paths through the meadow"[/dim]
+
+    - Update both name and description and save the result.
+        $ [dim]nextmv cloud scenario update --app-id hare-app --scenario-test-id lettuce-delivery \\
+            --name "Warren Lettuce Express" --description "Fast lettuce delivery to all burrows" \\
+            --output updated-scenario.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Updating scenario test...")
+    scenario_info = cloud_app.update_scenario_test(
+        scenario_test_id=scenario_test_id,
+        name=name,
+        description=description,
+    )
+    success(
+        f"Scenario test [magenta]{scenario_test_id}[/magenta] updated successfully "
+        f"in application [magenta]{app_id}[/magenta]."
+    )
+    scenario_info_dict = scenario_info.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(scenario_info_dict, f, indent=2)
+
+        success(msg=f"Scenario test information saved to [magenta]{output}[/magenta].")
+        return
+
+    print_json(scenario_info_dict)

nextmv/cli/cloud/secrets/__init__.py

@@ -0,0 +1,33 @@
+"""
+This module defines the cloud secrets command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.secrets.create import app as create_app
+from nextmv.cli.cloud.secrets.delete import app as delete_app
+from nextmv.cli.cloud.secrets.get import app as get_app
+from nextmv.cli.cloud.secrets.list import app as list_app
+from nextmv.cli.cloud.secrets.update import app as update_app
+
+# Set up subcommand application.
+app = typer.Typer()
+app.add_typer(create_app)
+app.add_typer(delete_app)
+app.add_typer(get_app)
+app.add_typer(list_app)
+app.add_typer(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Create and manage Nextmv Cloud secrets collections.
+
+    A secret collection defines one or more secrets used by your optimization
+    model during execution. You can reference a secret collection either in an
+    application instance configuration, or directly when starting a run. The
+    platform then injects the secrets into the container during the
+    optimization run as environment variables and files.
+    """
+    pass

nextmv/cli/cloud/secrets/create.py

@@ -0,0 +1,206 @@
+"""
+This module defines the cloud secrets create command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import enum_values, error, in_progress, print_json
+from nextmv.cli.options import AppIDOption, ProfileOption
+from nextmv.cloud.secrets import Secret, SecretType
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    app_id: AppIDOption,
+    secrets: Annotated[
+        list[str],
+        typer.Option(
+            "--secrets",
+            "-e",
+            help="Secrets to configure in the app. Data should be valid [magenta]json[/magenta]. "
+            "Pass multiple secrets by repeating the flag, or providing a list of objects. "
+            "Allowed values for [magenta]type[/magenta] are: "
+            f"{enum_values(SecretType)}. "
+            "Object format: [dim]{'type': type, 'location': location, 'value': value}[/dim].",
+            metavar="SECRETS",
+        ),
+    ],
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="An optional description for the secrets collection.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A name for the secrets collection.",
+            metavar="NAME",
+        ),
+    ] = None,
+    secrets_collection_id: Annotated[
+        str | None,
+        typer.Option(
+            "--secrets-collection-id",
+            "-s",
+            help="The ID to assign to the new secrets collection. If not provided, a random ID will be generated.",
+            envvar="NEXTMV_SECRETS_COLLECTION_ID",
+            metavar="SECRETS_COLLECTION_ID",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new Nextmv Cloud secrets collection.
+
+    A secrets collection is a group of key-value pairs that can be used by
+    your application instances during execution. Each collection can contain
+    up to 20 secrets. Secrets are provided as JSON objects using the
+    --secrets flag.
+
+    Each secret must include three fields:
+    - [magenta]type[/magenta]: Either [magenta]env[/magenta] or [magenta]file[/magenta],
+      which determines how the secret is injected into the runtime.
+    - [magenta]location[/magenta]: Where to place the secret.
+      - [magenta]env[/magenta]: the environment variable name. E.g.: [magenta]BURROW_ENTRANCE[/magenta].
+      - [magenta]file[/magenta]: the relative path from the execution
+        directory. E.g.: [magenta]licenses/burrow.entr[/magenta].
+    - [magenta]value[/magenta]: The secret value as text (limited to 1 KB).
+
+    You can provide secrets in three ways:
+    - A single secret as a [magenta]json[/magenta] object.
+    - Multiple secrets by repeating the --secrets flag.
+    - Multiple secrets as a [magenta]json[/magenta] array in a single --secrets flag.
+
+    The --secrets-collection-id and --name are optional.
+    If not provided, they will be automatically generated.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create a secrets collection with a single environment variable secret.
+        $ [dim]nextmv cloud secrets create --app-id hare-app \\
+            --secrets '{"type": "env", "location": "API_KEY", "value": "secret-value"}'[/dim]
+
+    - Create a secrets collection with multiple secrets by repeating the flag.
+        $ [dim]nextmv cloud secrets create --app-id hare-app \\
+            --secrets '{"type": "env", "location": "API_KEY", "value": "secret-value"}' \\
+            --secrets '{"type": "env", "location": "DATABASE_URL", "value": "postgres://localhost"}'[/dim]
+
+    - Create a secrets collection with multiple secrets in a single JSON array.
+        $ [dim]nextmv cloud secrets create --app-id hare-app \\
+            --secrets '[{"type": "env", "location": "DB_USER", "value": "admin"}, {...}]'[/dim]
+
+    - Create a secrets collection with custom ID, name, and description.
+        $ [dim]nextmv cloud secrets create --app-id hare-app \\
+            --secrets-collection-id db-creds --name "Database Credentials" \\
+            --description "Production database credentials" \\
+            --secrets '{"type": "env", "location": "DB_USER", "value": "admin"}' \\
+            --secrets '{"type": "env", "location": "DB_PASS", "value": "secure123"}'[/dim]
+
+    - Create a secrets collection with file-based secrets.
+        $ [dim]nextmv cloud secrets create --app-id hare-app \\
+            --secrets-collection-id certs --name "Certificates" \\
+            --secrets '{"type": "file", "location": "licenses/acme.lic", "value": "LICENSE_CONTENT_HERE"}'[/dim]
+
+    - Mix environment and file-based secrets.
+        $ [dim]nextmv cloud secrets create --app-id hare-app \\
+            --secrets '{"type": "env", "location": "ACME_LICENSE_KEY", "value": "abc123"}' \\
+            --secrets '{"type": "file", "location": "config/app.conf", "value": "server=prod\\nport=8080"}'[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Creating secrets collection...")
+
+    # Build the secrets list from the CLI options
+    secrets_list = build_secrets(secrets)
+
+    collection = cloud_app.new_secrets_collection(
+        secrets=secrets_list,
+        id=secrets_collection_id,
+        name=name,
+        description=description,
+    )
+    print_json(collection.to_dict())
+
+
+def build_secrets(secrets: list[str]) -> list[Secret]:
+    """
+    Builds the secrets list from the CLI option(s).
+
+    Parameters
+    ----------
+    secrets : list[str]
+        List of secrets provided via the CLI.
+
+    Returns
+    -------
+    list[Secret]
+        The built secrets list.
+    """
+    import json
+
+    secrets_list = []
+
+    for secret_str in secrets:
+        try:
+            secret_data = json.loads(secret_str)
+
+            # Handle the case where the value is a list of secrets.
+            if isinstance(secret_data, list):
+                for ix, item in enumerate(secret_data):
+                    if item.get("type") is None or item.get("location") is None or item.get("value") is None:
+                        error(
+                            f"Invalid secret format at index [magenta]{ix}[/magenta] in "
+                            f"[magenta]{secret_str}[/magenta]. Each secret must have "
+                            "[magenta]type[/magenta], [magenta]location[/magenta], "
+                            "and [magenta]value[/magenta] fields."
+                        )
+
+                    secret = Secret(
+                        type=SecretType(item["type"]),
+                        location=item["location"],
+                        value=item["value"],
+                    )
+                    secrets_list.append(secret)
+
+            # Handle the case where the value is a single secret.
+            elif isinstance(secret_data, dict):
+                if (
+                    secret_data.get("type") is None
+                    or secret_data.get("location") is None
+                    or secret_data.get("value") is None
+                ):
+                    error(
+                        f"Invalid secret format in [magenta]{secret_str}[/magenta]. "
+                        "Each secret must have [magenta]type[/magenta], [magenta]location[/magenta], "
+                        "and [magenta]value[/magenta] fields."
+                    )
+
+                secret = Secret(
+                    type=SecretType(secret_data["type"]),
+                    location=secret_data["location"],
+                    value=secret_data["value"],
+                )
+                secrets_list.append(secret)
+
+            else:
+                error(
+                    f"Invalid secret format: [magenta]{secret_str}[/magenta]. "
+                    "Expected [magenta]json[/magenta] object or array."
+                )
+
+        except (json.JSONDecodeError, KeyError, ValueError) as e:
+            error(f"Invalid secret format: [magenta]{secret_str}[/magenta]. Error: {e}")
+
+    return secrets_list

nextmv/cli/cloud/secrets/delete.py

@@ -0,0 +1,63 @@
+"""
+This module defines the cloud secrets delete command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import AppIDOption, ProfileOption, SecretsCollectionIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    app_id: AppIDOption,
+    secrets_collection_id: SecretsCollectionIDOption,
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to deletion confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Deletes a Nextmv Cloud secrets collection.
+
+    This action is permanent and cannot be undone. Use the --yes
+    flag to skip the confirmation prompt.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Delete the secrets collection with the ID [magenta]api-keys[/magenta] from application
+      [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud secrets delete --app-id hare-app --secrets-collection-id api-keys[/dim]
+
+    - Delete the secrets collection without confirmation prompt.
+        $ [dim]nextmv cloud secrets delete --app-id hare-app --secrets-collection-id api-keys --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            f"Are you sure you want to delete secrets collection [magenta]{secrets_collection_id}[/magenta] "
+            f"from application [magenta]{app_id}[/magenta]? This action cannot be undone.",
+        )
+
+        if not confirm:
+            info(f"Secrets collection [magenta]{secrets_collection_id}[/magenta] will not be deleted.")
+            return
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    cloud_app.delete_secrets_collection(secrets_collection_id=secrets_collection_id)
+    success(
+        f"Secrets collection [magenta]{secrets_collection_id}[/magenta] deleted successfully "
+        f"from application [magenta]{app_id}[/magenta]."
+    )

nextmv/cli/cloud/secrets/get.py

@@ -0,0 +1,66 @@
+"""
+This module defines the cloud secrets get command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import AppIDOption, ProfileOption, SecretsCollectionIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def get(
+    app_id: AppIDOption,
+    secrets_collection_id: SecretsCollectionIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the secrets collection information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Get a Nextmv Cloud secrets collection.
+
+    This command is useful to get the attributes of an existing Nextmv Cloud
+    secrets collection by its ID. :construction: [yellow bold]Warning:
+    secret values will be included in the output.[/yellow bold]
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Get the secrets collection with the ID [magenta]api-keys[/magenta] from
+      application [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud secrets get --app-id hare-app \\
+        --secrets-collection-id api-keys[/dim]
+
+    - Get the secrets collection with the ID [magenta]api-keys[/magenta] and
+      save the information to a [magenta]secrets.json[/magenta] file.
+        $ [dim]nextmv cloud secrets get --app-id hare-app \\
+            --secrets-collection-id api-keys --output secrets.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Getting secrets collection...")
+    collection = cloud_app.secrets_collection(secrets_collection_id=secrets_collection_id)
+    collection_dict = collection.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(collection_dict, f, indent=2)
+
+        success(msg=f"Secrets collection information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(collection_dict)

nextmv/cli/cloud/secrets/list.py

@@ -0,0 +1,60 @@
+"""
+This module defines the cloud secrets list command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import AppIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def list(
+    app_id: AppIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the secrets collections list information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    List all secrets collections of a Nextmv Cloud application.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - List all secrets collections of application [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud secrets list --app-id hare-app[/dim]
+
+    - List all secrets collections using the profile named [magenta]hare[/magenta].
+        $ [dim]nextmv cloud secrets list --app-id hare-app --profile hare[/dim]
+
+    - List all secrets collections and save the information to a [magenta]secrets.json[/magenta] file.
+        $ [dim]nextmv cloud secrets list --app-id hare-app --output secrets.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Listing secrets collections...")
+    collections = cloud_app.list_secrets_collections()
+    collections_dicts = [collection.to_dict() for collection in collections]
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(collections_dicts, f, indent=2)
+
+        success(msg=f"Secrets collections list information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(collections_dicts)