nextmv 1.0.0__py3-none-any.whl → 1.0.0.dev0__py3-none-any.whl

nextmv/cli/cloud/shadow/list.py

@@ -1,63 +0,0 @@
-"""
-This module defines the cloud shadow 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 list of shadow tests to this location.",
-            metavar="OUTPUT_PATH",
-        ),
-    ] = None,
-    profile: ProfileOption = None,
-) -> None:
-    """
-    List all Nextmv Cloud shadow tests for an application.
-
-    This command retrieves all shadow tests associated with the specified
-    application.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - List all shadow tests for application [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud shadow list --app-id hare-app[/dim]
-
-    - List all shadow tests and save to a file.
-        $ [dim]nextmv cloud shadow list --app-id hare-app --output tests.json[/dim]
-
-    - List all shadow tests using a specific profile.
-        $ [dim]nextmv cloud shadow list --app-id hare-app --profile prod[/dim]
-    """
-
-    cloud_app = build_app(app_id=app_id, profile=profile)
-    in_progress(msg="Listing shadow tests...")
-    shadow_tests = cloud_app.list_shadow_tests()
-    shadow_tests_dict = [test.to_dict() for test in shadow_tests]
-
-    if output is not None and output != "":
-        with open(output, "w") as f:
-            json.dump(shadow_tests_dict, f, indent=2)
-
-        success(msg=f"Shadow tests list saved to [magenta]{output}[/magenta].")
-
-        return
-
-    print_json(shadow_tests_dict)

nextmv/cli/cloud/shadow/metadata.py

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

nextmv/cli/cloud/shadow/start.py

@@ -1,43 +0,0 @@
-"""
-This module defines the cloud shadow start command for the Nextmv CLI.
-"""
-
-import typer
-
-from nextmv.cli.configuration.config import build_app
-from nextmv.cli.message import in_progress, success
-from nextmv.cli.options import AppIDOption, ProfileOption, ShadowTestIDOption
-
-# Set up subcommand application.
-app = typer.Typer()
-
-
-@app.command()
-def start(
-    app_id: AppIDOption,
-    shadow_test_id: ShadowTestIDOption,
-    profile: ProfileOption = None,
-) -> None:
-    """
-    Starts a Nextmv Cloud shadow test.
-
-    Before starting a shadow test, it must be created in draft state. You may
-    use the [code]nextmv cloud shadow create[/code] command to create a new
-    shadow test. Alternatively, define a --start-time when using the
-    [code]nextmv cloud shadow create[/code] command to have the shadow test
-    start automatically at a specific time.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - Start the shadow test with the ID [magenta]hop-analysis[/magenta] from application
-      [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud shadow start --app-id hare-app --shadow-test-id hop-analysis[/dim]
-    """
-
-    in_progress(msg="Starting shadow test...")
-    cloud_app = build_app(app_id=app_id, profile=profile)
-    cloud_app.start_shadow_test(shadow_test_id=shadow_test_id)
-    success(
-        f"Shadow test [magenta]{shadow_test_id}[/magenta] started successfully "
-        f"in application [magenta]{app_id}[/magenta]."
-    )

nextmv/cli/cloud/shadow/stop.py

@@ -1,53 +0,0 @@
-"""
-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.options import AppIDOption, ProfileOption, ShadowTestIDOption
-from nextmv.cloud.shadow import StopIntent
-
-# Set up subcommand application.
-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:
-    """
-    Stops a Nextmv Cloud shadow test.
-
-    Before stopping a shadow test, it must be in a started state. Experiments
-    in a [magenta]draft[/magenta] state, that haven't started, can be deleted
-    with the [code]nextmv cloud shadow delete[/code] command.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - Stop the shadow test with the ID [magenta]hop-analysis[/magenta] from application
-      [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud shadow stop --app-id hare-app --shadow-test-id hop-analysis[/dim]
-    """
-
-    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))
-    success(
-        f"Shadow test [magenta]{shadow_test_id}[/magenta] stopped successfully "
-        f"in application [magenta]{app_id}[/magenta]."
-    )

nextmv/cli/cloud/shadow/update.py

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

nextmv/cli/cloud/switchback/__init__.py

@@ -1,33 +0,0 @@
-"""
-This module defines the cloud switchback command tree for the Nextmv CLI.
-"""
-
-import typer
-
-from nextmv.cli.cloud.switchback.create import app as create_app
-from nextmv.cli.cloud.switchback.delete import app as delete_app
-from nextmv.cli.cloud.switchback.get import app as get_app
-from nextmv.cli.cloud.switchback.list import app as list_app
-from nextmv.cli.cloud.switchback.metadata import app as metadata_app
-from nextmv.cli.cloud.switchback.start import app as start_app
-from nextmv.cli.cloud.switchback.stop import app as stop_app
-from nextmv.cli.cloud.switchback.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(metadata_app)
-app.add_typer(start_app)
-app.add_typer(stop_app)
-app.add_typer(update_app)
-
-
-@app.callback()
-def callback() -> None:
-    """
-    Create and manage Nextmv Cloud switchback tests.
-    """
-    pass

nextmv/cli/cloud/switchback/create.py

@@ -1,151 +0,0 @@
-"""
-This module defines the cloud switchback create command for the Nextmv CLI.
-"""
-
-from datetime import datetime
-from typing import Annotated
-
-import typer
-
-from nextmv.cli.configuration.config import build_app
-from nextmv.cli.message import in_progress, print_json
-from nextmv.cli.options import AppIDOption, ProfileOption
-from nextmv.cloud.switchback import TestComparisonSingle
-
-# Set up subcommand application.
-app = typer.Typer()
-
-
-@app.command()
-def create(
-    app_id: AppIDOption,
-    baseline_instance_id: Annotated[
-        str,
-        typer.Option(
-            "--baseline-instance-id",
-            "-b",
-            help="ID of the baseline instance for the switchback test.",
-            metavar="BASELINE_INSTANCE_ID",
-        ),
-    ],
-    candidate_instance_id: Annotated[
-        str,
-        typer.Option(
-            "--candidate-instance-id",
-            "-c",
-            help="ID of the candidate instance for the switchback test.",
-            metavar="CANDIDATE_INSTANCE_ID",
-        ),
-    ],
-    unit_duration_minutes: Annotated[
-        float,
-        typer.Option(
-            "--unit-duration-minutes",
-            "-u",
-            help="Duration of each interval in minutes.",
-            metavar="UNIT_DURATION_MINUTES",
-            min=1,
-            max=10080,
-        ),
-    ],
-    units: Annotated[
-        int,
-        typer.Option(
-            "--units",
-            "-t",
-            help="Total number of intervals in the switchback test.",
-            metavar="UNITS",
-            min=1,
-            max=1000,
-        ),
-    ],
-    description: Annotated[
-        str | None,
-        typer.Option(
-            "--description",
-            "-d",
-            help="Description of the switchback test.",
-            metavar="DESCRIPTION",
-        ),
-    ] = None,
-    name: Annotated[
-        str | None,
-        typer.Option(
-            "--name",
-            "-n",
-            help="Name of the switchback test. If not provided, the ID will be used as the name.",
-            metavar="NAME",
-        ),
-    ] = None,
-    switchback_test_id: Annotated[
-        str | None,
-        typer.Option(
-            "--switchback-test-id",
-            "-s",
-            help="ID for the switchback test. Will be generated if not provided.",
-            envvar="NEXTMV_SWITCHBACK_TEST_ID",
-            metavar="SWITCHBACK_TEST_ID",
-        ),
-    ] = None,
-    start: Annotated[
-        datetime | None,
-        typer.Option(
-            "--start",
-            "-r",
-            formats=["%Y-%m-%dT%H:%M:%S%z"],
-            help="Scheduled time for switchback test start in [magenta]RFC 3339[/magenta] format. "
-            "Object format: [dim]'2024-01-01T00:00:00Z'[/dim]",
-            metavar="START",
-        ),
-    ] = None,
-    profile: ProfileOption = None,
-) -> None:
-    """
-    Create a new Nextmv Cloud switchback test in draft mode.
-
-    The test will alternate between the --baseline-instance-id and
-    --candidate-instance-id over specified time intervals.
-
-    You may specify the --start option to make the switchback test start at a
-    specific time. Alternatively, you may use the [code]nextmv cloud switchback
-    start[/code] command to start the test.
-
-    Use the [code]nextmv cloud switchback stop[/code] command to stop the test.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - Create a switchback test alternating between two bunny instances.
-        $ [dim]nextmv cloud switchback create --app-id hare-app --switchback-test-id bunny-switch-hop \\
-            --name "Bunny Switch Hop" --baseline-instance-id fluffy-bunny-baseline \\
-            --candidate-instance-id speedy-cottontail --unit-duration-minutes 15 --units 10[/dim]
-
-    - Create a switchback test with a scheduled start time.
-        $ [dim]nextmv cloud switchback create --app-id hare-app --switchback-test-id sunrise-switch \\
-            --name "Sunrise Switch Test" --baseline-instance-id wise-old-rabbit \\
-            --candidate-instance-id burrow-master --unit-duration-minutes 30 --units 8 \\
-            --start '2026-01-23T10:00:00Z'[/dim]
-
-    - Create a switchback test with a description.
-        $ [dim]nextmv cloud switchback create --app-id hare-app --switchback-test-id carrot-switch \\
-            --name "Carrot Switch" --baseline-instance-id fluffy-bunny-baseline \\
-            --candidate-instance-id hopping-candidate-ears --unit-duration-minutes 20 --units 12 \\
-            --description "Which bunny hops best for carrots?"[/dim]
-    """
-
-    cloud_app = build_app(app_id=app_id, profile=profile)
-
-    in_progress(msg="Creating switchback test in draft mode...")
-    switchback_test = cloud_app.new_switchback_test(
-        comparison=TestComparisonSingle(
-            baseline_instance_id=baseline_instance_id,
-            candidate_instance_id=candidate_instance_id,
-        ),
-        unit_duration_minutes=unit_duration_minutes,
-        units=units,
-        switchback_test_id=switchback_test_id,
-        name=name,
-        description=description,
-        start=start,
-    )
-
-    print_json(switchback_test.to_dict())

nextmv/cli/cloud/switchback/delete.py

@@ -1,64 +0,0 @@
-"""
-This module defines the cloud switchback 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, SwitchbackTestIDOption
-
-# Set up subcommand application.
-app = typer.Typer()
-
-
-@app.command()
-def delete(
-    app_id: AppIDOption,
-    switchback_test_id: SwitchbackTestIDOption,
-    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 switchback test.
-
-    This action is permanent and cannot be undone. The switchback test and all
-    associated data, including runs, will be deleted. Use the --yes
-    flag to skip the confirmation prompt.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - Delete the switchback test with the ID [magenta]hop-analysis[/magenta] from application
-      [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud switchback delete --app-id hare-app --switchback-test-id hop-analysis[/dim]
-
-    - Delete the switchback test without confirmation prompt.
-        $ [dim]nextmv cloud switchback delete --app-id hare-app --switchback-test-id carrot-routes --yes[/dim]
-    """
-
-    if not yes:
-        confirm = get_confirmation(
-            f"Are you sure you want to delete switchback test [magenta]{switchback_test_id}[/magenta] "
-            f"from application [magenta]{app_id}[/magenta]? This action cannot be undone.",
-        )
-
-        if not confirm:
-            info(f"Switchback test [magenta]{switchback_test_id}[/magenta] will not be deleted.")
-            return
-
-    cloud_app = build_app(app_id=app_id, profile=profile)
-    cloud_app.delete_switchback_test(switchback_test_id=switchback_test_id)
-    success(
-        f"Switchback test [magenta]{switchback_test_id}[/magenta] deleted successfully "
-        f"from application [magenta]{app_id}[/magenta]."
-    )

nextmv/cli/cloud/switchback/get.py

@@ -1,62 +0,0 @@
-"""
-This module defines the cloud switchback 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, SwitchbackTestIDOption
-
-# Set up subcommand application.
-app = typer.Typer()
-
-
-@app.command()
-def get(
-    app_id: AppIDOption,
-    switchback_test_id: SwitchbackTestIDOption,
-    output: Annotated[
-        str | None,
-        typer.Option(
-            "--output",
-            "-o",
-            help="Saves the results to this location.",
-            metavar="OUTPUT_PATH",
-        ),
-    ] = None,
-    profile: ProfileOption = None,
-) -> None:
-    """
-    Get a Nextmv Cloud switchback test, including its runs.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - Get the switchback test with ID [magenta]carrot-optimization[/magenta] from application
-      [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud switchback get --app-id hare-app --switchback-test-id carrot-optimization[/dim]
-
-    - Get the switchback test using a specific profile.
-        $ [dim]nextmv cloud switchback get --app-id hare-app --switchback-test-id lettuce-routes \\
-            --profile prod[/dim]
-    """
-
-    cloud_app = build_app(app_id=app_id, profile=profile)
-    in_progress(msg="Getting switchback test...")
-    switchback_test = cloud_app.switchback_test(switchback_test_id=switchback_test_id)
-
-    switchback_test_dict = switchback_test.to_dict()
-
-    # Handle output
-    if output is not None and output != "":
-        with open(output, "w") as f:
-            json.dump(switchback_test_dict, f, indent=2)
-
-        success(msg=f"Switchback test output saved to [magenta]{output}[/magenta].")
-
-        return
-
-    print_json(switchback_test_dict)