nextmv 1.0.0.dev6__py3-none-any.whl → 1.0.0.dev8__py3-none-any.whl

nextmv/__about__.py

@@ -1 +1 @@
-__version__ = "v1.0.0.dev6"
+__version__ = "v1.0.0.dev8"

nextmv/_serialization.py

@@ -90,7 +90,7 @@ def _custom_serial(obj: Any) -> str:
         If the object type is not supported for serialization.
     """
 
-    if isinstance(obj, (datetime.datetime, datetime.date)):
+    if isinstance(obj, datetime.datetime | datetime.date):
         return obj.isoformat()
 
     raise TypeError(f"Type {type(obj)} not serializable")

nextmv/cli/cloud/acceptance/create.py

@@ -45,7 +45,7 @@ app = typer.Typer()
     - Multiple metrics as a [magenta]json[/magenta] array in a single --metrics flag.
 
     Each metric must have the following fields:
-    - [magenta]field[/magenta]: Field of the metric to measure (e.g., "solution.objective").
+    - [magenta]field[/magenta]: Field of the metric to measure (e.g., "result.custom.unassigned").
     - [magenta]metric_type[/magenta]: Type of metric comparison. Allowed values: {enum_values(MetricType)}.
     - [magenta]params[/magenta]: Parameters of the metric comparison.
         - [magenta]operator[/magenta]: Comparison operator. Allowed values: {enum_values(Comparison)}.
@@ -71,8 +71,8 @@ app = typer.Typer()
     [bold][underline]Examples[/underline][/bold]
 
     - Create an acceptance test with a single metric.
-        $ [dim]METRIC='{{
-            "field": "solution.objective",
+        $ [green]METRIC='{{
+            "field": "result.custom.unassigned",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",
@@ -85,8 +85,8 @@ app = typer.Typer()
             --metrics "$METRIC" --input-set-id input-set-123[/dim]
 
     - Create with multiple metrics by repeating the flag.
-        $ [dim]METRIC1='{{
-            "field": "solution.objective",
+        $ [green]METRIC1='{{
+            "field": "result.custom.unassigned",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",
@@ -95,7 +95,7 @@ app = typer.Typer()
             "statistic": "mean"
         }}'
         METRIC2='{{
-            "field": "statistics.run.duration",
+            "field": "run.duration",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "le",
@@ -110,7 +110,7 @@ app = typer.Typer()
     - Create with multiple metrics in a single [magenta]json[/magenta] array.
         $ [dim]METRICS='[
             {{
-                "field": "solution.objective",
+                "field": "result.custom.unassigned",
                 "metric_type": "direct-comparison",
                 "params": {{
                     "operator": "lt",
@@ -119,7 +119,7 @@ app = typer.Typer()
                 "statistic": "mean"
             }},
             {{
-                "field": "statistics.run.duration",
+                "field": "run.duration",
                 "metric_type": "direct-comparison",
                 "params": {{
                     "operator": "le",
@@ -133,8 +133,8 @@ app = typer.Typer()
             --metrics "$METRICS" --input-set-id input-set-123[/dim]
 
     - Create an acceptance test and wait for it to complete.
-        $ [dim]METRIC='{{
-            "field": "solution.objective",
+        $ [green]METRIC='{{
+            "field": "result.custom.unassigned",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",
@@ -147,8 +147,8 @@ app = typer.Typer()
             --metrics "$METRIC" --input-set-id input-set-123 --wait[/dim]
 
     - Create an acceptance test and save the results to a file, waiting for completion.
-        $ [dim]METRIC='{{
-            "field": "solution.objective",
+        $ [green]METRIC='{{
+            "field": "result.custom.unassigned",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",

nextmv/cli/cloud/app/push.py

@@ -129,34 +129,26 @@ def push(
         $ [dim]nextmv cloud app push --app-id hare-app --version-yes --update-instance-id inst-1[/dim]
     """
 
-    cloud_app = build_app(app_id=app_id, profile=profile)
-
-    # If a version already exists, we cannot create it.
-    if version_id is not None and version_id != "":
-        exists = cloud_app.version_exists(version_id=version_id)
-        if exists:
-            error(
-                f"Version [magenta]{version_id}[/magenta] already exists for application [magenta]{app_id}[/magenta]."
-            )
-
     # We cannot create and update an instance at the same time.
     update_defined = update_instance_id is not None and update_instance_id != ""
     create_defined = create_instance_id is not None and create_instance_id != ""
     if update_defined and create_defined:
         error("Cannot use --update-instance-id and --create-instance-id at the same time.")
 
+    cloud_app = build_app(app_id=app_id, profile=profile)
+
     # We cannot update an instance that does not exist.
     if update_defined and not cloud_app.instance_exists(instance_id=update_instance_id):
         error(
-            f"Used option --update-instance-id but the instance [magenta]{update_instance_id}[/magenta] "
-            "does not exist. Use --create-instance-id instead."
+            f"Used option --update-instance-id but the instance {update_instance_id} does not exist. "
+            "Use --create-instance-id instead."
         )
 
     # We cannot create an instance that already exists.
     if create_defined and cloud_app.instance_exists(instance_id=create_instance_id):
         error(
-            f"Used option --create-instance-id but the instance [magenta]{create_instance_id}[/magenta] "
-            "already exists. Use --update-instance-id instead."
+            f"Used option --create-instance-id but the instance {create_instance_id} already exists. "
+            "Use --update-instance-id instead."
         )
 
     # Do the normal push first.
@@ -251,6 +243,14 @@ def _handle_version_creation(
     # If the user provides a version, and it exists, we use it directly and we
     # are done.
     if version_id is not None and version_id != "":
+        exists = cloud_app.version_exists(version_id=version_id)
+        if exists:
+            error(
+                f"Version [magenta]{version_id}[/magenta] already exists for application [magenta]{app_id}[/magenta]."
+            )
+
+            return "", False
+
         info(
             msg=f"Version [magenta]{version_id}[/magenta] does not exist. A new version will be created.",
             emoji=":bulb:",
@@ -261,7 +261,7 @@ def _handle_version_creation(
     # If we are not auto-confirming version creation, ask the user.
     if not version_yes:
         should_create = get_confirmation(
-            msg=f"Do you want to create a new version for application [magenta]{app_id}[/magenta] now?",
+            msg=f"Do you want to create a new version [magenta]{app_id}[/magenta] now?",
             default=True,
         )
 

nextmv/cli/cloud/input_set/__init__.py

@@ -5,7 +5,6 @@ This module defines the cloud input-set command tree for the Nextmv CLI.
 import typer
 
 from nextmv.cli.cloud.input_set.create import app as create_app
-from nextmv.cli.cloud.input_set.delete import app as delete_app
 from nextmv.cli.cloud.input_set.get import app as get_app
 from nextmv.cli.cloud.input_set.list import app as list_app
 from nextmv.cli.cloud.input_set.update import app as update_app
@@ -13,7 +12,6 @@ from nextmv.cli.cloud.input_set.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)

nextmv/cli/cloud/run/create.py

@@ -129,7 +129,7 @@ def create(
             metavar="INSTANCE_ID",
             rich_help_panel="Run configuration",
         ),
-    ] = None,
+    ] = "latest",
     integration_id: Annotated[
         str | None,
         typer.Option(
@@ -240,11 +240,12 @@ def create(
     specify the instance with the --instance-id flag. These are the possible
     values for this flag:
 
-    - [yellow]unspecified[/yellow]: Run against the default instance of the
-      application. When an application is created, the default instance is [magenta]latest[/magenta].
     - [yellow]latest[/yellow]: uses the special [magenta]latest[/magenta]
       instance of the application. This corresponds to the latest pushed
-      executable.
+      executable. This is the default behavior.
+    - [yellow]default[/yellow]: if the application has a [italic]default[/italic]
+      instance configured, then it uses that instance. Setting the flag's value
+      to [magenta]''[/magenta] (empty string) has the same effect.
     - [yellow]<INSTANCE_ID>[/yellow]: uses the instance with the given ID.
 
     [bold][underline]Examples[/underline][/bold]
@@ -318,6 +319,10 @@ def create(
     )
     run_options = build_run_options(options)
 
+    # Handles the default instance.
+    if instance_id == "default":
+        instance_id = ""
+
     # Start the run before deciding if we should poll or not.
     input_kwarg = resolve_input_kwarg(
         stdin=stdin,

nextmv/cli/cloud/shadow/stop.py

@@ -2,14 +2,11 @@
 This module defines the cloud shadow stop 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, in_progress, success
+from nextmv.cli.message import in_progress, success
 from nextmv.cli.options import AppIDOption, ProfileOption, ShadowTestIDOption
-from nextmv.cloud.shadow import StopIntent
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -18,15 +15,6 @@ app = typer.Typer()
 @app.command()
 def stop(
     app_id: AppIDOption,
-    intent: Annotated[
-        StopIntent,
-        typer.Option(
-            "--intent",
-            "-i",
-            help=f"Intent for stopping the shadow test. Allowed values are: {enum_values(StopIntent)}.",
-            metavar="INTENT",
-        ),
-    ],
     shadow_test_id: ShadowTestIDOption,
     profile: ProfileOption = None,
 ) -> None:
@@ -46,7 +34,7 @@ def stop(
 
     in_progress(msg="Stopping shadow test...")
     cloud_app = build_app(app_id=app_id, profile=profile)
-    cloud_app.stop_shadow_test(shadow_test_id=shadow_test_id, intent=StopIntent(intent))
+    cloud_app.stop_shadow_test(shadow_test_id=shadow_test_id)
     success(
         f"Shadow test [magenta]{shadow_test_id}[/magenta] stopped successfully "
         f"in application [magenta]{app_id}[/magenta]."

nextmv/cli/cloud/switchback/stop.py

@@ -2,14 +2,11 @@
 This module defines the cloud switchback stop 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, in_progress, success
+from nextmv.cli.message import in_progress, success
 from nextmv.cli.options import AppIDOption, ProfileOption, SwitchbackTestIDOption
-from nextmv.cloud.shadow import StopIntent
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -18,15 +15,6 @@ app = typer.Typer()
 @app.command()
 def stop(
     app_id: AppIDOption,
-    intent: Annotated[
-        StopIntent,
-        typer.Option(
-            "--intent",
-            "-i",
-            help=f"Intent for stopping the switchback test. Allowed values are: {enum_values(StopIntent)}.",
-            metavar="INTENT",
-        ),
-    ],
     switchback_test_id: SwitchbackTestIDOption,
     profile: ProfileOption = None,
 ) -> None:
@@ -46,7 +34,7 @@ def stop(
 
     in_progress(msg="Stopping switchback test...")
     cloud_app = build_app(app_id=app_id, profile=profile)
-    cloud_app.stop_switchback_test(switchback_test_id=switchback_test_id, intent=StopIntent(intent))
+    cloud_app.stop_switchback_test(switchback_test_id=switchback_test_id)
     success(
         f"Switchback test [magenta]{switchback_test_id}[/magenta] stopped successfully "
         f"in application [magenta]{app_id}[/magenta]."

nextmv/cli/community/clone.py

@@ -2,14 +2,19 @@
 This module defines the community clone command for the Nextmv CLI.
 """
 
+import os
+import shutil
+import tarfile
+import tempfile
+from collections.abc import Callable
 from typing import Annotated
 
+import rich
 import typer
 
-from nextmv.cli.configuration.config import build_client
-from nextmv.cli.message import error
+from nextmv.cli.community.list import download_file, download_manifest, find_app, versions_table
+from nextmv.cli.message import error, success
 from nextmv.cli.options import ProfileOption
-from nextmv.cloud.community import clone_community_app
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -72,15 +77,196 @@ def clone(
         $ [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 --version flag cannot be an empty string.")
 
-    client = build_client(profile)
-    clone_community_app(
-        client=client,
-        app=app,
-        directory=directory,
-        version=version,
-        verbose=True,
-        rich_print=True,
+    if not app_has_version(app_obj, version):
+        # We don't use error() here to allow printing something before exiting.
+        rich.print(
+            f"[red]Error:[/red] Version [magenta]{version}[/magenta] not found "
+            f"for community app [magenta]{app}[/magenta]. Available versions are:"
+        )
+        versions_table(manifest, app)
+
+        raise typer.Exit(code=1)
+
+    original_version = version
+    if version == LATEST_VERSION:
+        version = app_obj.get("latest_app_version")
+
+    # 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)
+    os.makedirs(full_destination, exist_ok=True)
+
+    tarball = f"{app}_{version}.tar.gz"
+    s3_file_path = f"{app}/{version}/{tarball}"
+    downloaded_object = download_object(
+        file=s3_file_path,
+        path="community-apps",
+        output_dir=full_destination,
+        output_file=tarball,
+        profile=profile,
+    )
+
+    # Extract the tarball to a temporary directory to handle nested structure
+    with tempfile.TemporaryDirectory() as temp_dir:
+        with tarfile.open(downloaded_object, "r:gz") as tar:
+            tar.extractall(path=temp_dir)
+
+        # Find the extracted directory (typically the app name)
+        extracted_items = os.listdir(temp_dir)
+        if len(extracted_items) == 1 and os.path.isdir(os.path.join(temp_dir, extracted_items[0])):
+            # Move contents from the extracted directory to full_destination
+            extracted_dir = os.path.join(temp_dir, extracted_items[0])
+            for item in os.listdir(extracted_dir):
+                shutil.move(os.path.join(extracted_dir, item), full_destination)
+        else:
+            # If structure is unexpected, move everything directly
+            for item in extracted_items:
+                shutil.move(os.path.join(temp_dir, item), full_destination)
+
+    # Remove the tarball after extraction
+    os.remove(downloaded_object)
+
+    success(
+        f"Successfully cloned the [magenta]{app}[/magenta] community app, "
+        f"using version [magenta]{original_version}[/magenta] in path: [magenta]{full_destination}[/magenta]."
     )
+
+
+def app_has_version(app_obj: dict, version: str) -> bool:
+    """
+    Check if the given app object has the specified version.
+
+    Parameters
+    ----------
+    app_obj : dict
+        The community app object.
+    version : str
+        The version to check.
+
+    Returns
+    -------
+    bool
+        True if the app has the specified version, False otherwise.
+    """
+
+    if version == LATEST_VERSION:
+        version = app_obj.get("latest_app_version")
+
+    if version in app_obj.get("app_versions", []):
+        return True
+
+    return False
+
+
+def get_valid_path(path: str, stat_fn: Callable[[str], os.stat_result], ending: str = "") -> str:
+    """
+    Validates and returns a non-existing path. If the path exists,
+    it will append a number to the path and return it. If the path does not
+    exist, it will return the path as is.
+
+    The ending parameter is used to check if the path ends with a specific
+    string. This is useful to specify if it is a file (like foo.json, in which
+    case the next iteration is foo-1.json) or a directory (like foo, in which
+    case the next iteration is foo-1).
+
+    Parameters
+    ----------
+    path : str
+        The initial path to validate.
+    stat_fn : Callable[[str], os.stat_result]
+        A function that takes a path and returns its stat result.
+    ending : str, optional
+        The expected ending of the path (e.g., file extension), by default "".
+
+    Returns
+    -------
+    str
+        A valid, non-existing path.
+
+    Raises
+    ------
+    Exception
+        If an unexpected error occurs during path validation
+    """
+    base_name = os.path.basename(path)
+    name_without_ending = base_name.removesuffix(ending) if ending else base_name
+
+    while True:
+        try:
+            stat_fn(path)
+            # If we get here, the path exists
+            # Get folder/file name number, increase it and create new path
+            name = os.path.basename(path)
+
+            # Get folder/file name number
+            parts = name.split("-")
+            last = parts[-1].removesuffix(ending) if ending else parts[-1]
+
+            # Save last folder name index to be changed
+            i = path.rfind(name)
+
+            try:
+                num = int(last)
+                # Increase number and create new path
+                if ending:
+                    temp_path = path[:i] + f"{name_without_ending}-{num + 1}{ending}"
+                else:
+                    temp_path = path[:i] + f"{base_name}-{num + 1}"
+                path = temp_path
+            except ValueError:
+                # If there is no number, add it
+                if ending:
+                    temp_path = path[:i] + f"{name_without_ending}-1{ending}"
+                else:
+                    temp_path = path[:i] + f"{name}-1"
+                path = temp_path
+
+        except FileNotFoundError:
+            # Path doesn't exist, we can use it
+            return path
+        except Exception:
+            # Re-raise unexpected errors
+            error(f"An unexpected error occurred while validating the path: {path}")
+
+
+def download_object(file: str, path: str, output_dir: str, output_file: str, profile: str | None = None) -> str:
+    """
+    Downloads an object from the internal bucket and saves it to the specified
+    output directory.
+
+    Parameters
+    ----------
+    file : str
+        The name of the file to download.
+    path : str
+        The directory in the bucket where the file is located.
+    output_dir : str
+        The local directory where the file will be saved.
+    output_file : str
+        The name of the output file.
+    profile : str | None
+        The profile name to use. If None, the default profile is used.
+
+    Returns
+    -------
+    str
+        The path to the downloaded file.
+    """
+
+    response = download_file(directory=path, file=file, profile=profile)
+    file_name = os.path.join(output_dir, output_file)
+
+    with open(file_name, "wb") as f:
+        f.write(response.content)
+
+    return file_name