nextmv 1.0.0.dev9__py3-none-any.whl → 1.1.0.dev0__py3-none-any.whl

nextmv/cli/cloud/sso/create.py

@@ -0,0 +1,97 @@
+"""
+This module defines the cloud sso create command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import in_progress, print_json
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.sso import SSOConfiguration
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    allow_non_domain_users: Annotated[
+        bool,
+        typer.Option(
+            "--allow-non-domain-users",
+            "-a",
+            help="Allow users who are not part of the SSO domain to access the Nextmv Cloud organization (account).",
+        ),
+    ] = False,
+    enabled: Annotated[
+        bool,
+        typer.Option(
+            "--enabled",
+            "-e",
+            help="Enable SSO for the Nextmv Cloud organization (account) at the time of creation. "
+            "Run [code]nextmv cloud sso enable[/code] to enable SSO after creation.",
+        ),
+    ] = False,
+    metadata_url: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-url",
+            "-u",
+            help="The URL to the SSO metadata document.",
+            metavar="METADATA_URL",
+        ),
+    ] = None,
+    metadata_document: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-document",
+            "-d",
+            help="The SSO metadata document as a string.",
+            metavar="METADATA_DOCUMENT",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new SSO configuration for your Nextmv Cloud organization.
+
+    SSO must be configured to enable managed accounts in your organization.
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link] for assistance.
+
+    You must provide either a metadata URL or a metadata document. The metadata
+    document contains the SAML configuration details from your identity provider.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create an SSO configuration using a metadata URL.
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.carrotexpress.com/saml/metadata"[/dim]
+
+    - Create and enable SSO configuration immediately.
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.bunnylogistics.io/metadata" \\
+            --enabled[/dim]
+
+    - Create SSO configuration allowing non-domain users.
+        $ [dim]nextmv cloud sso create --metadata-url "https://idp.hopmail.com/saml/metadata" \\
+            --allow-non-domain-users[/dim]
+
+    - Create SSO configuration using a metadata document string.
+        $ [dim]nextmv cloud sso create --metadata-document "<EntityDescriptor ...</EntityDescriptor>"[/dim]
+
+    - Create SSO configuration using the profile named [magenta]hare[/magenta].
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.cottontailcouriers.net/metadata" \\
+            --profile hare[/dim]
+    """
+
+    cloud_client = build_client(profile)
+    in_progress(msg="Creating configuration...")
+
+    configuration = SSOConfiguration.new(
+        client=cloud_client,
+        allow_non_domain_users=allow_non_domain_users,
+        enabled=enabled,
+        metadata_url=metadata_url,
+        metadata_document=metadata_document,
+    )
+    print_json(configuration.to_dict())

nextmv/cli/cloud/sso/delete.py

@@ -0,0 +1,58 @@
+"""
+This module defines the cloud sso delete command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to deletion confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Deletes the SSO configuration.
+
+    You must have the [magenta]administrator[/magenta] role on the organization in order to delete it.
+
+    This action is permanent and cannot be undone. Use the --yes
+    flag to skip the confirmation prompt.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Delete the SSO configuration.
+        $ [dim]nextmv cloud sso delete[/dim]
+
+    - Delete the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso delete --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to delete the sso configuration? This action cannot be undone.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be deleted.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.delete()
+    success("SSO configuration has been deleted.")

nextmv/cli/cloud/sso/disable.py

@@ -0,0 +1,56 @@
+"""
+This module defines the cloud sso disable command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def disable(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to disable confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Disables the SSO configuration.
+
+    Use the --yes flag to skip the confirmation prompt. Use the [code]nextmv
+    cloud sso enable[/code] command to re-enable SSO.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Disable the SSO configuration.
+        $ [dim]nextmv cloud sso disable[/dim]
+
+    - Disable the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso disable --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to disable the sso configuration?.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be disabled.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.disable()
+    success("SSO configuration has been disabled.")

nextmv/cli/cloud/sso/enable.py

@@ -0,0 +1,56 @@
+"""
+This module defines the cloud sso enable command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def enable(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to enable confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Enables the SSO configuration.
+
+    Use the --yes flag to skip the confirmation prompt. Use the [code]nextmv
+    cloud sso disable[/code] command to disable SSO.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Enable the SSO configuration.
+        $ [dim]nextmv cloud sso enable[/dim]
+
+    - Enable the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso enable --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to enable the sso configuration?.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be enabled.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.enable()
+    success("SSO configuration has been enabled.")

nextmv/cli/cloud/sso/get.py

@@ -0,0 +1,61 @@
+"""
+This module defines the cloud sso get command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.sso import SSOConfiguration
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def get(
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the SSO configuration information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Get the information of a Nextmv Cloud SSO configuration.
+
+    This command is useful to get the attributes of an existing Nextmv Cloud
+    SSO configuration.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Get the SSO configuration.
+        $ [dim]nextmv cloud sso get[/dim]
+
+    - Get the SSO configuration and save the information to an [magenta]sso_config.json[/magenta] file.
+        $ [dim]nextmv cloud sso get --output sso_config.json[/dim]
+    """
+
+    client = build_client(profile)
+    in_progress(msg="Getting SSO configuration...")
+
+    sso_config = SSOConfiguration.get(client)
+    sso_config_dict = sso_config.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(sso_config_dict, f, indent=2)
+
+        success(msg=f"SSO configuration information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(sso_config_dict)

nextmv/cli/cloud/sso/update.py

@@ -0,0 +1,78 @@
+"""
+This module defines the cloud sso update command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.message import print_json, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    metadata_url: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-url",
+            "-u",
+            help="The URL to the SSO metadata document to update.",
+            metavar="METADATA_URL",
+        ),
+    ] = None,
+    metadata_document: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-document",
+            "-d",
+            help="The SSO metadata document as a string to update.",
+            metavar="METADATA_DOCUMENT",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated SSO configuration information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates information of a Nextmv Cloud SSO configuration.
+
+    This command allows you to update the metadata URL or metadata document of
+    an existing SSO configuration.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the SSO configuration with a new metadata URL.
+        $ [dim]nextmv cloud sso update --metadata-url "https://example.com/metadata.xml"[/dim]
+
+    - Update the SSO configuration with a new metadata document and save the updated information to an
+        [magenta]updated_sso_config.json[/magenta] file.
+        $ [dim]nextmv cloud sso update --metadata-document "<xml>...</xml>" --output updated_sso_config.json[/dim]
+    """
+
+    sso_config = build_sso_config(profile)
+    updated_config = sso_config.update(metadata_url=metadata_url, metadata_document=metadata_document)
+    success("SSO configuration updated successfully.")
+    updated_config_dict = updated_config.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_config_dict, f, indent=2)
+
+        success(msg=f"Updated SSO configuration information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_config_dict)

nextmv/cli/cloud/switchback/delete.py

@@ -53,10 +53,7 @@ def delete(
         )
 
         if not confirm:
-            info(
-                msg=f"Switchback test [magenta]{switchback_test_id}[/magenta] will not be deleted.",
-                emoji=":bulb:",
-            )
+            info(f"Switchback test [magenta]{switchback_test_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

nextmv/cli/cloud/switchback/stop.py

@@ -2,11 +2,14 @@
 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 in_progress, success
+from nextmv.cli.message import enum_values, in_progress, success
 from nextmv.cli.options import AppIDOption, ProfileOption, SwitchbackTestIDOption
+from nextmv.cloud.shadow import StopIntent
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -15,6 +18,15 @@ 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:
@@ -34,7 +46,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)
+    cloud_app.stop_switchback_test(switchback_test_id=switchback_test_id, intent=StopIntent(intent))
     success(
         f"Switchback test [magenta]{switchback_test_id}[/magenta] stopped successfully "
         f"in application [magenta]{app_id}[/magenta]."

nextmv/cli/cloud/version/delete.py

@@ -51,7 +51,7 @@ def delete(
         )
 
         if not confirm:
-            info(msg=f"Version [magenta]{version_id}[/magenta] will not be deleted.", emoji=":bulb:")
+            info(f"Version [magenta]{version_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

nextmv/cli/community/__init__.py

@@ -9,8 +9,8 @@ from nextmv.cli.community.list import app as list_app
 
 # Set up subcommand application.
 app = typer.Typer()
-app.add_typer(list_app)
 app.add_typer(clone_app)
+app.add_typer(list_app)
 
 
 @app.callback()