nextmv 1.0.0.dev2__py3-none-any.whl → 1.0.0.dev4__py3-none-any.whl

nextmv/cli/cloud/switchback/update.py

@@ -0,0 +1,96 @@
+"""
+This module defines the cloud switchback 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, SwitchbackTestIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    switchback_test_id: SwitchbackTestIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="Updated description of the switchback test.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="Updated name of the switchback test.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated switchback test information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Update a Nextmv Cloud switchback test.
+
+    Update the name and/or description of a switchback test. Any fields not
+    specified will remain unchanged.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the name of a switchback test.
+        $ [dim]nextmv cloud switchback update --app-id hare-app --switchback-test-id carrot-feast \\
+            --name "Spring Carrot Harvest"[/dim]
+
+    - Update the description of a switchback test.
+        $ [dim]nextmv cloud switchback update --app-id hare-app --switchback-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 switchback update --app-id hare-app --switchback-test-id lettuce-delivery \\
+            --name "Warren Lettuce Express" --description "Fast lettuce delivery to all burrows" \\
+            --output updated-switchback-test.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+
+    in_progress(msg="Updating switchback test...")
+    switchback_test = cloud_app.update_switchback_test(
+        switchback_test_id=switchback_test_id,
+        name=name,
+        description=description,
+    )
+
+    switchback_test_dict = switchback_test.to_dict()
+    success(
+        f"Switchback test [magenta]{switchback_test_id}[/magenta] updated successfully "
+        f"in application [magenta]{app_id}[/magenta]."
+    )
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(switchback_test_dict, f, indent=2)
+
+        success(msg=f"Updated switchback test information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(switchback_test_dict)

nextmv/cli/cloud/upload/create.py

@@ -23,10 +23,10 @@ def create(
     [bold][underline]Examples[/underline][/bold]
 
     - Create an upload URL for application [magenta]hare-app[/magenta].
-        $ [green]nextmv cloud upload create --app-id hare-app[/green]
+        $ [dim]nextmv cloud upload create --app-id hare-app[/dim]
 
     - Create an upload URL for application [magenta]hare-app[/magenta] using profile [magenta]hare[/magenta].
-        $ [green]nextmv cloud upload create --app-id hare-app --profile hare[/green]
+        $ [dim]nextmv cloud upload create --app-id hare-app --profile hare[/dim]
     """
 
     cloud_app = build_app(app_id=app_id, profile=profile)

nextmv/cli/cloud/version/create.py

@@ -58,28 +58,27 @@ def create(
     """
     Create a new Nextmv Cloud application version.
 
-    Use the [code]--exist-ok[/code] flag to avoid errors when creating a
-    version with an ID that already exists. This is useful for scripts that
-    need to ensure a version exists without worrying about whether it was
-    created previously.
+    Use the --exist-ok flag to avoid errors when creating a version with an ID
+    that already exists. This is useful for scripts that need to ensure a
+    version exists without worrying about whether it was created previously.
 
     [bold][underline]Examples[/underline][/bold]
 
     - Create a version for application [magenta]hare-app[/magenta]. A random ID will be generated.
-        $ [green]nextmv cloud version create --app-id hare-app[/green]
+        $ [dim]nextmv cloud version create --app-id hare-app[/dim]
 
     - Create a version with a specific name.
-        $ [green]nextmv cloud version create --app-id hare-app --name "v1.0.0"[/green]
+        $ [dim]nextmv cloud version create --app-id hare-app --name "v1.0.0"[/dim]
 
     - Create a version with a specific ID.
-        $ [green]nextmv cloud version create --app-id hare-app --version-id v1[/green]
+        $ [dim]nextmv cloud version create --app-id hare-app --version-id v1[/dim]
 
     - Create a version with a name and description.
-        $ [green]nextmv cloud version create --app-id hare-app --name "v1.0.0" \\
-            --description "Initial release with routing optimization"[/green]
+        $ [dim]nextmv cloud version create --app-id hare-app --name "v1.0.0" \\
+            --description "Initial release with routing optimization"[/dim]
 
     - Create a version, or get it if it already exists.
-        $ [green]nextmv cloud version create --app-id hare-app --version-id v1 --exist-ok[/green]
+        $ [dim]nextmv cloud version create --app-id hare-app --version-id v1 --exist-ok[/dim]
     """
 
     cloud_app = build_app(app_id=app_id, profile=profile)

nextmv/cli/cloud/version/delete.py

@@ -5,9 +5,9 @@ This module defines the cloud version delete command for the Nextmv CLI.
 from typing import Annotated
 
 import typer
-from rich.prompt import Confirm
 
 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, VersionIDOption
 
@@ -32,23 +32,22 @@ def delete(
     """
     Deletes a Nextmv Cloud application version.
 
-    This action is permanent and cannot be undone. Use the [code]--yes[/code]
+    This action is permanent and cannot be undone. Use the --yes
     flag to skip the confirmation prompt.
 
     [bold][underline]Examples[/underline][/bold]
 
     - Delete the version with the ID [magenta]v1[/magenta] from application [magenta]hare-app[/magenta].
-        $ [green]nextmv cloud version delete --app-id hare-app --version-id v1[/green]
+        $ [dim]nextmv cloud version delete --app-id hare-app --version-id v1[/dim]
 
     - Delete the version without confirmation prompt.
-        $ [green]nextmv cloud version delete --app-id hare-app --version-id v1 --yes[/green]
+        $ [dim]nextmv cloud version delete --app-id hare-app --version-id v1 --yes[/dim]
     """
 
     if not yes:
-        confirm = Confirm.ask(
+        confirm = get_confirmation(
             f"Are you sure you want to delete version [magenta]{version_id}[/magenta] "
             f"from application [magenta]{app_id}[/magenta]? This action cannot be undone.",
-            default=False,
         )
 
         if not confirm:

nextmv/cli/cloud/version/exists.py

@@ -27,10 +27,10 @@ def exists(
     [bold][underline]Examples[/underline][/bold]
 
     - Check if the version with the ID [magenta]v1[/magenta] exists in application [magenta]hare-app[/magenta].
-        $ [green]nextmv cloud version exists --app-id hare-app --version-id v1[/green]
+        $ [dim]nextmv cloud version exists --app-id hare-app --version-id v1[/dim]
 
     - Check if the version exists using the profile named [magenta]hare[/magenta].
-        $ [green]nextmv cloud version exists --app-id hare-app --version-id v1 --profile hare[/green]
+        $ [dim]nextmv cloud version exists --app-id hare-app --version-id v1 --profile hare[/dim]
     """
 
     cloud_app = build_app(app_id=app_id, profile=profile)

nextmv/cli/cloud/version/get.py

@@ -39,11 +39,11 @@ def get(
     [bold][underline]Examples[/underline][/bold]
 
     - Get the version with the ID [magenta]v1[/magenta] from application [magenta]hare-app[/magenta].
-        $ [green]nextmv cloud version get --app-id hare-app --version-id v1[/green]
+        $ [dim]nextmv cloud version get --app-id hare-app --version-id v1[/dim]
 
     - Get the version with the ID [magenta]v1[/magenta] and save the information to a
       [magenta]version.json[/magenta] file.
-        $ [green]nextmv cloud version get --app-id hare-app --version-id v1 --output version.json[/green]
+        $ [dim]nextmv cloud version get --app-id hare-app --version-id v1 --output version.json[/dim]
     """
 
     cloud_app = build_app(app_id=app_id, profile=profile)

nextmv/cli/cloud/version/list.py

@@ -35,13 +35,13 @@ def list(
     [bold][underline]Examples[/underline][/bold]
 
     - List all versions of application [magenta]hare-app[/magenta].
-        $ [green]nextmv cloud version list --app-id hare-app[/green]
+        $ [dim]nextmv cloud version list --app-id hare-app[/dim]
 
     - List all versions using the profile named [magenta]hare[/magenta].
-        $ [green]nextmv cloud version list --app-id hare-app --profile hare[/green]
+        $ [dim]nextmv cloud version list --app-id hare-app --profile hare[/dim]
 
     - List all versions and save the information to a [magenta]versions.json[/magenta] file.
-        $ [green]nextmv cloud version list --app-id hare-app --output versions.json[/green]
+        $ [dim]nextmv cloud version list --app-id hare-app --output versions.json[/dim]
     """
 
     cloud_app = build_app(app_id=app_id, profile=profile)

nextmv/cli/cloud/version/update.py

@@ -54,23 +54,23 @@ def update(
     [bold][underline]Examples[/underline][/bold]
 
     - Update a version's name.
-        $ [green]nextmv cloud version update --app-id hare-app --version-id v1 --name "Version 1.0"[/green]
+        $ [dim]nextmv cloud version update --app-id hare-app --version-id v1 --name "Version 1.0"[/dim]
 
     - Update a version's description.
-        $ [green]nextmv cloud version update --app-id hare-app --version-id v1 \\
-            --description "Initial stable release"[/green]
+        $ [dim]nextmv cloud version update --app-id hare-app --version-id v1 \\
+            --description "Initial stable release"[/dim]
 
     - Update a version's name and description at once.
-        $ [green]nextmv cloud version update --app-id hare-app --version-id v1 \\
-            --name "Version 1.0" --description "Initial stable release"[/green]
+        $ [dim]nextmv cloud version update --app-id hare-app --version-id v1 \\
+            --name "Version 1.0" --description "Initial stable release"[/dim]
 
     - Update a version and save the updated information to a [magenta]updated_version.json[/magenta] file.
-        $ [green]nextmv cloud version update --app-id hare-app --version-id v1 \\
-            --name "Version 1.0" --output updated_version.json[/green]
+        $ [dim]nextmv cloud version update --app-id hare-app --version-id v1 \\
+            --name "Version 1.0" --output updated_version.json[/dim]
     """
 
     if name is None and description is None:
-        error("Provide at least one option to update: [code]--name[/code] or [code]--description[/code].")
+        error("Provide at least one option to update: --name or --description.")
 
     cloud_app = build_app(app_id=app_id, profile=profile)
     updated_version = cloud_app.update_version(

nextmv/cli/community/clone.py

@@ -53,35 +53,35 @@ def clone(
     Clone a community app locally.
 
     By default, the [magenta]latest[/magenta] version will be used. You can
-    specify a version with the [code]--version[/code] flag, and customize the
-    output directory with the [code]--directory[/code] flag. If you want to
-    list the available apps, use the [code]nextmv community list[/code] command.
+    specify a version with the --version flag, and customize the output
+    directory with the --directory flag. If you want to list the available
+    apps, use the [code]nextmv community list[/code] command.
 
     [bold][underline]Examples[/underline][/bold]
 
     - Clone the [magenta]go-nextroute[/magenta] community app (under the
       [magenta]"go-nextroute"[/magenta] directory), using the [magenta]latest[/magenta] version.
-        $ [green]nextmv community clone --app go-nextroute[/green]
+        $ [dim]nextmv community clone --app go-nextroute[/dim]
 
     - Clone the [magenta]go-nextroute[/magenta] community app under the
       [magenta]"~/sample/my_app"[/magenta] directory, using the [magenta]latest[/magenta] version.
-        $ [green]nextmv community clone --app go-nextroute --directory ~/sample/my_app[/green]
+        $ [dim]nextmv community clone --app go-nextroute --directory ~/sample/my_app[/dim]
 
     - Clone the [magenta]go-nextroute[/magenta] community app (under the
       [magenta]"go-nextroute"[/magenta] directory), using version [magenta]v1.2.0[/magenta].
-        $ [green]nextmv community clone --app go-nextroute --version v1.2.0[/green]
+        $ [dim]nextmv community clone --app go-nextroute --version v1.2.0[/dim]
 
     - Clone the [magenta]go-nextroute[/magenta] community app (under the
       [magenta]"go-nextroute"[/magenta] directory), using the [magenta]latest[/magenta] version
       and a profile named [magenta]hare[/magenta].
-        $ [green]nextmv community clone --app go-nextroute --profile hare[/green]
+        $ [dim]nextmv community clone --app go-nextroute --profile hare[/dim]
     """
 
     manifest = download_manifest(profile=profile)
     app_obj = find_app(manifest, app)
 
     if version is not None and version == "":
-        error("The [code]--version[/code] flag cannot be an empty string.")
+        error("The --version flag cannot be an empty string.")
 
     if not app_has_version(app_obj, version):
         # We don't use error() here to allow printing something before exiting.
@@ -97,8 +97,10 @@ def clone(
     if version == LATEST_VERSION:
         version = app_obj.get("latest_app_version")
 
-    destination = directory
-    if directory is None or directory == "":
+    # Clean and normalize directory path in an OS-independent way
+    if directory is not None and directory != "":
+        destination = os.path.normpath(directory)
+    else:
         destination = app
 
     full_destination = get_valid_path(destination, os.stat)

nextmv/cli/community/list.py

@@ -37,30 +37,30 @@ def list(
     """
     List the available community apps
 
-    Use the [code]--app[/code] flag to list that app's versions. Use the
-    [code]--flat[/code] flag to flatten the list of names/versions. If you
-    want to clone a community app locally, use the [code]nextmv community clone[/code] command.
+    Use the --app flag to list that app's versions. Use the --flat flag to
+    flatten the list of names/versions. If you want to clone a community app
+    locally, use the [code]nextmv community clone[/code] command.
 
     [bold][underline]Examples[/underline][/bold]
 
     - List the available community apps.
-        $ [green]nextmv community list[/green]
+        $ [dim]nextmv community list[/dim]
 
     - List the available versions of the [magenta]go-nextroute[/magenta] community app.
-        $ [green]nextmv community list --app go-nextroute[/green]
+        $ [dim]nextmv community list --app go-nextroute[/dim]
 
     - List the names of the available community apps as a flat list.
-        $ [green]nextmv community list --flat[/green]
+        $ [dim]nextmv community list --flat[/dim]
 
     - List the available versions of the [magenta]go-nextroute[/magenta] community app as a flat list.
-        $ [green]nextmv community list --app go-nextroute --flat[/green]
+        $ [dim]nextmv community list --app go-nextroute --flat[/dim]
 
     - List the available community apps using a profile named [magenta]hare[/magenta].
-        $ [green]nextmv community list --profile hare[/green]
+        $ [dim]nextmv community list --profile hare[/dim]
     """
 
     if app is not None and app == "":
-        error("The [code]--app[/code] flag cannot be an empty string.")
+        error("The --app flag cannot be an empty string.")
 
     manifest = download_manifest(profile=profile)
     if flat and app is None:

nextmv/cli/configuration/config.py

@@ -7,7 +7,8 @@ from typing import Any
 
 import yaml
 
-from nextmv.cli.message import error
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import error, success, warning
 from nextmv.cloud.account import Account
 from nextmv.cloud.application import Application
 from nextmv.cloud.client import Client
@@ -59,6 +60,18 @@ def save_config(config: dict[str, Any]) -> None:
         yaml.safe_dump(config, file)
 
 
+def non_profile_keys() -> set[str]:
+    """
+    Returns the set of keys that are not profile names in the configuration.
+
+    Returns
+    -------
+    set[str]
+        The set of non-profile keys.
+    """
+    return {API_KEY_KEY, ENDPOINT_KEY}
+
+
 def build_client(profile: str | None = None) -> Client:
     """
     Builds a `cloud.Client` using the API key and endpoint for the given
@@ -91,23 +104,35 @@ def build_client(profile: str | None = None) -> Client:
 
     if profile is not None:
         if profile not in config:
-            error(f"Profile [magenta]{profile}[/magenta] does not exist.")
+            error(
+                f"Profile [magenta]{profile}[/magenta] does not exist. "
+                "Create it using [code]nextmv configuration create[/code] with the --profile option."
+            )
 
         api_key = config[profile].get(API_KEY_KEY)
         if api_key is None or api_key == "":
-            error(f"API key for profile [magenta]{profile}[/magenta] is not set or is empty.")
+            error(
+                f"API key for profile [magenta]{profile}[/magenta] is not set or is empty. "
+                "Set it using [code]nextmv configuration create[/code] with the --profile and --api-key options."
+            )
 
         endpoint = config[profile].get(ENDPOINT_KEY)
         if endpoint is None or endpoint == "":
-            error(f"Endpoint for profile [magenta]{profile}[/magenta] is not set or is empty.")
+            error(
+                f"Endpoint for profile [magenta]{profile}[/magenta] is not set or is empty. "
+                "Please run [code]nextmv configuration create[/code]."
+            )
     else:
         api_key = config.get(API_KEY_KEY)
         if api_key is None or api_key == "":
-            error("Default API key is not set or is empty.")
+            error(
+                "Default API key is not set or is empty. "
+                "Please run [code]nextmv configuration create[/code] with the --api-key option."
+            )
 
         endpoint = config.get(ENDPOINT_KEY)
         if endpoint is None or endpoint == "":
-            error("Default endpoint is not set or is empty.")
+            error("Default endpoint is not set or is empty. Please run [code]nextmv configuration create[/code].")
 
     return Client(api_key=api_key, url=f"https://{endpoint}")
 
@@ -137,13 +162,21 @@ def build_app(app_id: str, profile: str | None = None) -> Application:
     """
     client = build_client(profile)
     exists = Application.exists(client=client, id=app_id)
-    if not exists:
+    if exists:
+        return Application(client=client, id=app_id)
+
+    warning(f"Application with ID [magenta]{app_id}[/magenta] does not exist.")
+    should_create = get_confirmation(f"Do you want to create a new application with ID [magenta]{app_id}[/magenta]?")
+    if not should_create:
         error(
-            f"Application with ID [magenta]{app_id}[/magenta] does not exist. "
-            "Use [code]nextmv cloud app create[/code] to create a new application."
+            f"Application with ID [magenta]{app_id}[/magenta] was not created and does not exist. "
+            "Use [code]nextmv cloud app create[/code] to create a new app."
         )
 
-    return Application(client=client, id=app_id)
+    app = Application.new(client=client, id=app_id, name=app_id)
+    success(f"Application with ID and name [magenta]{app_id}[/magenta] created successfully.")
+
+    return app
 
 
 def build_account(account_id: str | None = None, profile: str | None = None) -> Account:

nextmv/cli/configuration/create.py

@@ -58,14 +58,14 @@ def create(
     [bold][underline]Examples[/underline][/bold]
 
     - Default configuration.
-        $ [green]nextmv configuration create --api-key NEXTMV_API_KEY[/green]
+        $ [dim]nextmv configuration create --api-key NEXTMV_API_KEY[/dim]
 
     - Configure a profile named [magenta]hare[/magenta].
-        $ [green]nextmv configuration create --api-key NEXTMV_API_KEY --profile hare[/green]
+        $ [dim]nextmv configuration create --api-key NEXTMV_API_KEY --profile hare[/dim]
     """
 
     if profile is not None and profile.strip().lower() == "default":
-        error("[code]default[/code] is a reserved profile name.")
+        error("[magenta]default[/magenta] is a reserved profile name.")
 
     endpoint = str(endpoint)
     if endpoint.startswith("https://"):

nextmv/cli/configuration/delete.py

@@ -5,9 +5,9 @@ This module defines the configuration delete command for the Nextmv CLI.
 from typing import Annotated
 
 import typer
-from rich.prompt import Confirm
 
 from nextmv.cli.configuration.config import load_config, save_config
+from nextmv.cli.confirm import get_confirmation
 from nextmv.cli.message import error, info, success
 
 # Set up subcommand application.
@@ -36,25 +36,25 @@ def delete(
     ] = False,
 ) -> None:
     """
-    Delete a profile from the configuration. Use the [code]--yes[/code]
-    flag to skip the confirmation prompt.
+    Delete a profile from the configuration.
+
+    Use the --yes flag to skip the confirmation prompt.
 
     [bold][underline]Examples[/underline][/bold]
 
     - Delete a profile named [magenta]hare[/magenta].
-        $ [green]nextmv configuration delete --profile hare[/green]
+        $ [dim]nextmv configuration delete --profile hare[/dim]
 
     - Delete a profile named [magenta]hare[/magenta] without confirmation prompt.
-        $ [green]nextmv configuration delete --profile hare --yes[/green]
+        $ [dim]nextmv configuration delete --profile hare --yes[/dim]
     """
     config = load_config()
     if profile not in config:
         error(f"Profile [magenta]{profile}[/magenta] does not exist.")
 
     if not yes:
-        confirm = Confirm.ask(
+        confirm = get_confirmation(
             f"Are you sure you want to delete profile [magenta]{profile}[/magenta]? This action cannot be undone.",
-            default=False,
         )
 
         if not confirm:

nextmv/cli/configuration/list.py

@@ -6,7 +6,7 @@ import typer
 from rich.console import Console
 from rich.table import Table
 
-from nextmv.cli.configuration.config import API_KEY_KEY, ENDPOINT_KEY, load_config, obscure_api_key
+from nextmv.cli.configuration.config import API_KEY_KEY, ENDPOINT_KEY, load_config, non_profile_keys, obscure_api_key
 from nextmv.cli.message import error
 
 # Set up subcommand application.
@@ -22,7 +22,7 @@ def list() -> None:
     [bold][underline]Examples[/underline][/bold]
 
     - Show current configuration and all profiles.
-        $ [green]nextmv configuration list[/green]
+        $ [dim]nextmv configuration list[/dim]
     """
 
     config = load_config()
@@ -38,7 +38,7 @@ def list() -> None:
 
     for k, v in config.items():
         # Skip default configuration.
-        if k in {API_KEY_KEY, ENDPOINT_KEY}:
+        if k in non_profile_keys():
             continue
 
         profile = {

nextmv/cli/confirm.py

@@ -0,0 +1,32 @@
+import sys
+
+from rich.prompt import Confirm
+
+
+def get_confirmation(msg: str) -> bool:
+    """
+    Method to get a yes/no confirmation from the user.
+
+    Parameters
+    ----------
+    msg : str
+        The message to display to the user.
+
+    Returns
+    -------
+    bool
+        True if the user confirmed, False otherwise.
+    """
+
+    # If this is not an interactive terminal, do not ask for confirmation, to
+    # avoid hanging indefinitely waiting for a user response.
+    if not sys.stdin.isatty():
+        return False
+
+    return Confirm.ask(
+        msg,
+        default=False,
+        case_sensitive=False,
+        show_default=True,
+        show_choices=True,
+    )