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

nextmv/cli/main.py

@@ -13,22 +13,25 @@ about the features used here. An example of Rich markup can be found in the
 epilog of the Typer application defined below.
 """
 
-import os
 import sys
 from typing import Annotated
 
 import rich
 import typer
-from rich.prompt import Confirm
+from typer import rich_utils
 
 from nextmv.cli.cloud import app as cloud_app
 from nextmv.cli.community import app as community_app
 from nextmv.cli.configuration import app as configuration_app
 from nextmv.cli.configuration.config import CONFIG_DIR, GO_CLI_PATH, load_config
+from nextmv.cli.confirm import get_confirmation
 from nextmv.cli.message import error, info, success, warning
 from nextmv.cli.version import app as version_app
 from nextmv.cli.version import version_callback
 
+# Disable dim text for the extended help of commands.
+rich_utils.STYLE_HELPTEXT = ""
+
 # Main CLI application.
 app = typer.Typer(
     help="The Nextmv Command Line Interface (CLI).",
@@ -66,6 +69,15 @@ def callback(
     environment.
     """
 
+    # Skip checks for help commands.
+    if "--help" in sys.argv or "-h" in sys.argv:
+        return
+
+    # Skip checks for certain commands.
+    ignored_commands = {"configuration", "version"}
+    if ctx.invoked_subcommand in ignored_commands:
+        return
+
     handle_go_cli()
     handle_config_existence(ctx)
 
@@ -80,19 +92,21 @@ def handle_go_cli() -> None:
 
     exists = go_cli_exists()
     if exists:
-        delete = Confirm.ask(
+        delete = get_confirmation(
             "Do you want to delete the [italic red]deprecated[/italic red] Nextmv CLI "
-            f"at [magenta]{GO_CLI_PATH}[/magenta] now?",
-            default=False,
+            f"at [magenta]{GO_CLI_PATH}[/magenta] now?"
         )
         if delete:
             remove_go_cli()
-        else:
-            info(
-                msg="You can delete the [italic red]deprecated[/italic red] Nextmv CLI later by removing "
-                f"[magenta]{GO_CLI_PATH}[/magenta]. Make sure you also clean up your [code]PATH[/code].",
-                emoji=":bulb:",
-            )
+            return
+
+        info(
+            msg="You can delete the [italic red]deprecated[/italic red] Nextmv CLI later by removing "
+            f"[magenta]{GO_CLI_PATH}[/magenta]. "
+            "Make sure you also clean up your [code]PATH[/code], "
+            f"by removing references to [magenta]{CONFIG_DIR}[/magenta] from it.",
+            emoji=":bulb:",
+        )
 
 
 def handle_config_existence(ctx: typer.Context) -> None:
@@ -105,10 +119,6 @@ def handle_config_existence(ctx: typer.Context) -> None:
         The Typer context object.
     """
 
-    ignored_commands = {"configuration", "version"}
-    if ctx.invoked_subcommand in ignored_commands:
-        return
-
     config = load_config()
     if config == {}:
         error("No configuration found. Please run [code]nextmv configuration create[/code].")
@@ -130,11 +140,9 @@ def go_cli_exists() -> bool:
     if exists:
         warning(
             "A [italic red]deprecated[/italic red] Nextmv CLI is installed at "
-            f"[magenta]{GO_CLI_PATH}[/magenta]. You must delete it to avoid conflicts."
+            f"[magenta]{GO_CLI_PATH}[/magenta]. You should delete it to avoid conflicts."
         )
 
-    check_config_in_path()
-
     return exists
 
 
@@ -145,24 +153,7 @@ def remove_go_cli() -> None:
 
     if GO_CLI_PATH.exists():
         GO_CLI_PATH.unlink()
-        success(f"Deleted deprecated [magenta]{GO_CLI_PATH}[/magenta].")
-
-    check_config_in_path()
-
-
-def check_config_in_path() -> None:
-    """
-    Check if the configuration directory is in the PATH and notify the user.
-    """
-
-    path_dirs = os.environ.get("PATH", "").split(os.pathsep)
-    config_dir_str = str(CONFIG_DIR)
-
-    if config_dir_str in path_dirs:
-        warning(
-            f"[magenta]{CONFIG_DIR}[/magenta] was found in your [code]PATH[/code]. "
-            f"You should remove any entries related to [magenta]{CONFIG_DIR}[/magenta] from your [code]PATH[/code]."
-        )
+        success(f"Deleted [italic red]deprecated[/italic red] [magenta]{GO_CLI_PATH}[/magenta].")
 
 
 def main() -> None:

nextmv/cli/message.py

@@ -31,7 +31,7 @@ def error(msg: str) -> None:
     if not msg.endswith("."):
         msg += "."
 
-    rich.print(f"[red]Error:[/red] {msg}", file=sys.stderr)
+    rich.print(f":x: [red]Error:[/red] {msg}", file=sys.stderr)
 
     raise typer.Exit(code=1)
 
@@ -67,7 +67,7 @@ def warning(msg: str) -> None:
     if not msg.endswith("."):
         msg += "."
 
-    rich.print(f":construction: {msg}", file=sys.stderr)
+    rich.print(f":construction: [yellow] Warning:[/yellow] {msg}", file=sys.stderr)
 
 
 def info(msg: str, emoji: str | None = None) -> None:

nextmv/cli/options.py

@@ -204,3 +204,17 @@ ShadowTestIDOption = Annotated[
         metavar="SHADOW_TEST_ID",
     ),
 ]
+
+# switchback_test_id option - can be used in any command that requires a switchback test ID.
+# Define it as follows in commands or callbacks, as necessary:
+# switchback_test_id: SwitchbackTestIDOption
+SwitchbackTestIDOption = Annotated[
+    str,
+    typer.Option(
+        "--switchback-test-id",
+        "-s",
+        help="The Nextmv Cloud switchback test ID to use for this action.",
+        envvar="NEXTMV_SWITCHBACK_TEST_ID",
+        metavar="SWITCHBACK_TEST_ID",
+    ),
+]

nextmv/cli/version.py

@@ -18,7 +18,7 @@ def version() -> None:
     [bold][underline]Examples[/underline][/bold]
 
     - Show the version.
-        $ [green]nextmv version[/green]
+        $ [dim]nextmv version[/dim]
     """
 
     version_callback(True)

nextmv/cloud/__init__.py

@@ -95,6 +95,11 @@ from .shadow import ShadowTestMetadata as ShadowTestMetadata
 from .shadow import StartEvents as StartEvents
 from .shadow import TerminationEvents as TerminationEvents
 from .shadow import TestComparison as TestComparison
+from .switchback import SwitchbackPlan as SwitchbackPlan
+from .switchback import SwitchbackPlanUnit as SwitchbackPlanUnit
+from .switchback import SwitchbackTest as SwitchbackTest
+from .switchback import SwitchbackTestMetadata as SwitchbackTestMetadata
+from .switchback import TestComparisonSingle as TestComparisonSingle
 from .url import DownloadURL as DownloadURL
 from .url import UploadURL as UploadURL
 from .version import Version as Version

nextmv/cloud/application/__init__.py

@@ -42,10 +42,13 @@ from nextmv.cloud.application._managed_input import ApplicationManagedInputMixin
 from nextmv.cloud.application._run import ApplicationRunMixin
 from nextmv.cloud.application._secrets import ApplicationSecretsMixin
 from nextmv.cloud.application._shadow import ApplicationShadowMixin
+from nextmv.cloud.application._switchback import ApplicationSwitchbackMixin
 from nextmv.cloud.application._utils import _is_not_exist_error
 from nextmv.cloud.application._version import ApplicationVersionMixin
 from nextmv.cloud.client import Client
+from nextmv.cloud.instance import Instance
 from nextmv.cloud.url import UploadURL
+from nextmv.cloud.version import Version
 from nextmv.logger import log
 from nextmv.manifest import Manifest
 from nextmv.model import Model, ModelConfiguration
@@ -102,6 +105,7 @@ class Application(
     ApplicationInputSetMixin,
     ApplicationManagedInputMixin,
     ApplicationShadowMixin,
+    ApplicationSwitchbackMixin,
 ):
     """
     A published decision model that can be executed.
@@ -248,7 +252,7 @@ class Application(
     def new(
         cls,
         client: Client,
-        name: str,
+        name: str | None = None,
         id: str | None = None,
         description: str | None = None,
         is_workflow: bool | None = None,
@@ -266,13 +270,13 @@ class Application(
         ----------
         client : Client
             Client to use for interacting with the Nextmv Cloud API.
-        name : str
-            Name of the application.
-        id : str, optional
+        name : str | None = None
+            Name of the application. Uses the ID as the name if not provided.
+        id : str | None = None
             ID of the application. Will be generated if not provided.
-        description : str, optional
+        description : str | None = None
             Description of the application.
-        is_workflow : bool, optional
+        is_workflow : bool | None = None
             Whether the application is a Decision Workflow.
         exist_ok : bool, default=False
             If True and an application with the same ID already exists,
@@ -294,7 +298,10 @@ class Application(
         >>> app = Application.new(client=client, name="My New App", id="my-app")
         """
 
-        if id is None:
+        if exist_ok and (id is None or id == ""):
+            raise ValueError("If exist_ok is True, id must be provided")
+
+        if id is None or id == "":
             id = safe_id("app")
 
         if exist_ok and cls.exists(client=client, id=id):
@@ -305,6 +312,9 @@ class Application(
 
             return cls.from_dict({"client": client} | response.json())
 
+        if name is None or name == "":
+            name = id
+
         payload = {
             "name": name,
             "id": id,
@@ -397,10 +407,14 @@ class Application(
         model: Model | None = None,
         model_configuration: ModelConfiguration | None = None,
         rich_print: bool = False,
-        no_version: bool = False,
+        auto_create: bool = False,
         version_id: str | None = None,
         version_name: str | None = None,
         version_description: str | None = None,
+        instance_id: str | None = None,
+        instance_name: str | None = None,
+        instance_description: str | None = None,
+        update_default_instance: bool = False,
     ) -> None:
         """
         Push an app to Nextmv Cloud.
@@ -418,14 +432,16 @@ class Application(
         `nextmv.Model`. The model is encoded, some dependencies and
         accompanying files are packaged, and the app is pushed to Nextmv Cloud.
 
-        The default behavior of this function is to create a new application
-        version _after_ the app has been pushed. You can set the `no_version`
-        argument to `True` to skip this step. The `version_id`, `version_name`,
-        and `version_description` arguments can be used to customize the version
-        that is created. If the `version_id` is not specified, a randomly
-        generated ID will be used. If the `version_name` is not specified, a
-        generic name with a timestamp will be used. Lastly, if no description is
-        specified, then a generic description will also be used.
+        By default, this function only pushes the app. If you want to
+        automatically create a new version and instance after pushing, set
+        `auto_create=True`. The `version_id`, `version_name`, and
+        `version_description` arguments allow you to customize the new version
+        that is created. If not specified, defaults will be generated (random
+        ID, timestamped name/description). Similarly, `instance_id`,
+        `instance_name`, and `instance_description` can be used to customize
+        the new instance. If `update_default_instance` is True, the
+        application's default instance will be updated to the newly created
+        instance.
 
         Parameters
         ----------
@@ -445,21 +461,30 @@ class Application(
             with `model`.
         rich_print : bool, default=False
             Whether to use rich printing when verbose output is enabled.
-        no_version : bool, default=False
-            If True, do not create a new version after pushing the app.
+        auto_create : bool, default=False
+            If True, automatically create a new version and instance after
+            pushing the app.
         version_id : Optional[str], default=None
             ID of the version to create after pushing the app. If None, a unique
             ID will be generated.
         version_name : Optional[str], default=None
-            Name of the version to create after pushing the app. If None, a name
-            with a timestamp will be generated.
+            Name of the version to create after pushing the app. If None, a
+            name will be generated.
         version_description : Optional[str], default=None
             Description of the version to create after pushing the app. If None, a
             generic description with a timestamp will be generated.
-
-        Returns
-        -------
-        None
+        instance_id : Optional[str], default=None
+            ID of the instance to create after pushing the app. If None, a unique
+            ID will be generated.
+        instance_name : Optional[str], default=None
+            Name of the instance to create after pushing the app. If None, a
+            name will be generated.
+        instance_description : Optional[str], default=None
+            Description of the instance to create after pushing the app. If None,
+            a generic description with a timestamp will be generated.
+        update_default_instance : bool, default=False
+            If True, update the application's default instance to the newly
+            created instance.
 
         Raises
         ------
@@ -563,44 +588,43 @@ class Application(
         except OSError as e:
             raise Exception(f"error deleting output directory: {e}") from e
 
-        if no_version:
-            if verbose:
-                if rich_print:
-                    rich.print(
-                        f":white_check_mark: Push completed for Nextmv application [magenta]{self.id}[/magenta] "
-                        "without creating a new version.",
-                        file=sys.stderr,
-                    )
-                else:
-                    log("✅ Push completed without creating a new version for Nextmv application.")
-
+        if not auto_create:
             return
 
-        now = datetime.now(timezone.utc)
-        if version_id is None:
-            version_id = safe_id(prefix="version") + f"-{now.strftime('%Y%m%d-%H%M%S')}"
-        if version_name is None:
-            version_name = f"Version {version_id}"
-        if version_description is None:
-            version_description = f"Version created automatically from push at {now.strftime('%Y-%m-%dT%H:%M:%SZ')}"
-
-        version = self.new_version(
-            id=version_id,
-            name=version_name,
-            description=version_description,
-        )
-        version_dict = version.to_dict()
-
         if verbose:
             if rich_print:
                 rich.print(
-                    f":white_check_mark: Automatically created new version [magenta]{version.id}[/magenta].",
+                    f":hourglass_flowing_sand: Push completed for Nextmv application [magenta]{self.id}[/magenta], "
+                    "creating a new version and instance...",
                     file=sys.stderr,
                 )
-                rich.print_json(data=version_dict)
             else:
-                log(f'✅ Automatically created new version "{version.id}".')
-                log(json.dumps(version_dict, indent=2))
+                log("⌛️ Push completed for the Nextmv application, creating a new version and instance...")
+
+        now = datetime.now(timezone.utc)
+        version = self.__version_on_push(
+            now=now,
+            version_id=version_id,
+            version_name=version_name,
+            version_description=version_description,
+            verbose=verbose,
+            rich_print=rich_print,
+        )
+        instance = self.__instance_on_push(
+            now=now,
+            version_id=version.id,
+            instance_id=instance_id,
+            instance_name=instance_name,
+            instance_description=instance_description,
+            verbose=verbose,
+            rich_print=rich_print,
+        )
+        self.__update_on_push(
+            instance=instance,
+            update_default_instance=update_default_instance,
+            verbose=verbose,
+            rich_print=rich_print,
+        )
 
     def update(
         self,
@@ -917,6 +941,120 @@ class Application(
                 log(f'💥️ Successfully pushed to application: "{self.id}".')
                 log(json.dumps(data, indent=2))
 
+    def __version_on_push(
+        self,
+        now: datetime,
+        version_id: str | None = None,
+        version_name: str | None = None,
+        version_description: str | None = None,
+        verbose: bool = False,
+        rich_print: bool = False,
+    ) -> Version:
+        if version_description is None or version_description == "":
+            version_description = f"Version created automatically from push at {now.strftime('%Y-%m-%dT%H:%M:%SZ')}"
+
+        version = self.new_version(
+            id=version_id,
+            name=version_name,
+            description=version_description,
+        )
+        version_dict = version.to_dict()
+
+        if not verbose:
+            return version
+
+        if rich_print:
+            rich.print(
+                f":white_check_mark: Automatically created new version [magenta]{version.id}[/magenta].",
+                file=sys.stderr,
+            )
+            rich.print_json(data=version_dict)
+
+            return version
+
+        log(f'✅ Automatically created new version "{version.id}".')
+        log(json.dumps(version_dict, indent=2))
+
+        return version
+
+    def __instance_on_push(
+        self,
+        now: datetime,
+        version_id: str,
+        instance_id: str | None = None,
+        instance_name: str | None = None,
+        instance_description: str | None = None,
+        verbose: bool = False,
+        rich_print: bool = False,
+    ) -> Instance:
+        if instance_description is None or instance_description == "":
+            instance_description = f"Instance created automatically from push at {now.strftime('%Y-%m-%dT%H:%M:%SZ')}"
+
+        instance = self.new_instance(
+            version_id=version_id,
+            id=instance_id,
+            name=instance_name,
+            description=instance_description,
+        )
+        instance_dict = instance.to_dict()
+
+        if not verbose:
+            return instance
+
+        if rich_print:
+            rich.print(
+                f":white_check_mark: Automatically created new instance [magenta]{instance.id}[/magenta] "
+                f"using version [magenta]{version_id}[/magenta].",
+                file=sys.stderr,
+            )
+            rich.print_json(data=instance_dict)
+
+            return instance
+
+        log(f'✅ Automatically created new instance "{instance.id}" using version "{version_id}".')
+        log(json.dumps(instance_dict, indent=2))
+
+        return instance
+
+    def __update_on_push(
+        self,
+        instance: Instance,
+        update_default_instance: bool = False,
+        verbose: bool = False,
+        rich_print: bool = False,
+    ) -> None:
+        if not update_default_instance:
+            return
+
+        if verbose:
+            if rich_print:
+                rich.print(
+                    f":hourglass_flowing_sand: Updating default instance for app [magenta]{self.id}[/magenta]...",
+                    file=sys.stderr,
+                )
+            else:
+                log("⌛️ Updating default instance for the Nextmv application...")
+
+        updated_app = self.update(default_instance_id=instance.id)
+        if not verbose:
+            return
+
+        if rich_print:
+            rich.print(
+                f":white_check_mark: Updated default instance to "
+                f"[magenta]{updated_app.default_instance_id}[/magenta] for application "
+                f"[magenta]{self.id}[/magenta].",
+                file=sys.stderr,
+            )
+            rich.print_json(data=updated_app.to_dict())
+
+            return
+
+        log(
+            f'✅ Updated default instance to "{updated_app.default_instance_id}" for application "{self.id}".',
+        )
+        log(json.dumps(updated_app.to_dict(), indent=2))
+
 
 def list_applications(client: Client) -> list[Application]:
     """

nextmv/cloud/application/_batch_scenario.py

@@ -304,7 +304,7 @@ class ApplicationBatchMixin:
         """
 
         # Generate ID if not provided
-        if id is None:
+        if id is None or id == "":
             id = safe_id("batch")
 
         # Use ID as name if name not provided
@@ -481,7 +481,7 @@ class ApplicationBatchMixin:
             raise ValueError("At least one scenario must be provided")
 
         # Generate ID if not provided
-        if id is None:
+        if id is None or id == "":
             id = safe_id("scenario")
 
         # Use ID as name if name not provided

nextmv/cloud/application/_instance.py

@@ -194,13 +194,13 @@ class ApplicationInstanceMixin:
         'Production Instance'
         """
 
-        if exist_ok and id is None:
+        if exist_ok and (id is None or id == ""):
             raise ValueError("If exist_ok is True, id must be provided")
 
         if exist_ok and self.instance_exists(instance_id=id):
             return self.instance(instance_id=id)
 
-        if id is None:
+        if id is None or id == "":
             id = safe_id(prefix="instance")
         if name is None:
             name = id

nextmv/cloud/application/_managed_input.py

@@ -147,7 +147,7 @@ class ApplicationManagedInputMixin:
         if upload_id is None and run_id is None:
             raise ValueError("Either upload_id or run_id must be specified")
 
-        if id is None:
+        if id is None or id == "":
             id = safe_id(prefix="managed-input")
         if name is None:
             name = id

nextmv/cloud/application/_shadow.py

@@ -208,7 +208,7 @@ class ApplicationShadowMixin:
             name = shadow_test_id
 
         payload = {
-            "id": id,
+            "id": shadow_test_id,
             "name": name,
             "comparisons": comparisons,
             "termination_events": termination_events.to_dict(),