cloudsmith-cli 1.20.0__py3-none-any.whl

cloudsmith_cli/cli/commands/tags.py

@@ -0,0 +1,375 @@
+"""CLI/Commands - List objects."""
+
+from operator import itemgetter
+
+import click
+
+from ...core.api.packages import (
+    get_package_tags as api_get_package_tags,
+    tag_package as api_tag_package,
+)
+from .. import command, decorators, utils, validators
+from ..exceptions import handle_api_exceptions
+from ..utils import maybe_spinner
+from .main import main
+
+
+def _parse_tags(tags):
+    """Parse tags from CSV into a list."""
+    return [x.strip() for x in (tags or "").split(",")]
+
+
+def _print_tags(opts, all_tags, all_immutable_tags):
+    """Print the tags for a package."""
+    all_combined_tags = {"tags": all_tags, "tags_immutable": all_immutable_tags}
+
+    if utils.maybe_print_as_json(opts, all_combined_tags):
+        return
+
+    headers = ["Tag", "Type", "Immutable"]
+
+    rows = []
+    for tag_type, tags in sorted(all_tags.items(), key=itemgetter(0)):
+        immutable_tags = all_immutable_tags.get(tag_type) or []
+        for tag in sorted(tags):
+            immutable = "Yes" if tag in immutable_tags else "No"
+            rows.append(
+                [
+                    click.style(tag, fg="cyan"),
+                    click.style(tag_type, fg="yellow"),
+                    click.style(immutable, fg="magenta"),
+                ]
+            )
+
+    if all_tags:
+        click.echo()
+        utils.pretty_print_table(headers, rows)
+
+    click.echo()
+
+    num_results = len(rows)
+    list_suffix = "tag%s" % ("s" if num_results != 1 else "")
+    utils.pretty_print_list_info(num_results=num_results, suffix=list_suffix)
+
+
+@main.group(name="tags", cls=command.AliasGroup, aliases=["tag"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.pass_context
+def tags_(ctx, opts):  # pylint: disable=unused-argument
+    """
+    Manage the tags for a package in a repository.
+
+    See the help for subcommands for more information on each.
+    """
+
+
+@tags_.command(name="list", aliases=["ls"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument(
+    "owner_repo_package",
+    metavar="OWNER/REPO/PACKAGE",
+    callback=validators.validate_owner_repo_package,
+)
+@click.pass_context
+def list_tags(ctx, opts, owner_repo_package):
+    """
+    List tags for a package in a repository.
+
+    This requires appropriate (read) permissions for the package.
+
+    - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
+    REPO name where the package is stored, and the PACKAGE identifier of the
+    package itself. All separated by a slash.
+
+      Example: 'your-org/awesome-repo/better-pkg'.
+
+    Full CLI example:
+
+      $ cloudsmith tags list your-org/awesome-repo/better-pkg
+    """
+    owner, repo, package = owner_repo_package
+
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo(
+        "Listing tags for the '%(package)s' package ... "
+        % {"package": click.style(package, bold=True)},
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed to list tags for the package!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            package_tags, package_tags_immutable = api_get_package_tags(
+                owner=owner, repo=repo, identifier=package
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    _print_tags(opts, package_tags, package_tags_immutable)
+
+
+@tags_.command(name="add")
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument(
+    "owner_repo_package",
+    metavar="OWNER/REPO/PACKAGE",
+    callback=validators.validate_owner_repo_package,
+)
+@click.argument("tags", metavar="TAGS")
+@click.option(
+    "--immutable",
+    default=False,
+    is_flag=True,
+    help=(
+        "If true, the tags created will be immutable (cannot be changed). In "
+        "practice, this means the tags cannot be (easily) deleted. A repository "
+        "admin can explicitly remove immutable tags."
+    ),
+)
+@click.pass_context
+def add_tags(ctx, opts, owner_repo_package, tags, immutable):
+    """
+    Add tags to a package in a repository.
+
+    This requires appropriate (write) permissions for the package.
+
+    - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
+    REPO name where the package is stored, and the PACKAGE identifier of the
+    package itself. All separated by a slash.
+
+      Example: 'your-org/awesome-repo/better-pkg'.
+
+    - TAGS: A comma-separated value list of the tags you want to add.
+
+      Example: foo,bar
+
+    Full CLI example:
+
+      $ cloudsmith tags add your-org/awesome-repo/better-pkg foo,bar
+    """
+    owner, repo, package = owner_repo_package
+    tags = _parse_tags(tags)
+
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo(
+        "Adding '%(tags)s' tag%(s)s to the '%(package)s' package ... "
+        % {
+            "package": click.style(package, bold=True),
+            "tags": click.style(", ".join(tags or [])),
+            "s": "s" if len(tags) != 1 else "",
+        },
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed to add tags to package!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            package_tags, package_tags_immutable = api_tag_package(
+                owner=owner,
+                repo=repo,
+                identifier=package,
+                data={"action": "add", "tags": tags, "is_immutable": immutable},
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    _print_tags(opts, package_tags, package_tags_immutable)
+
+
+@tags_.command(name="clear")
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument(
+    "owner_repo_package",
+    metavar="OWNER/REPO/PACKAGE",
+    callback=validators.validate_owner_repo_package,
+)
+@click.pass_context
+def clear_tags(ctx, opts, owner_repo_package):
+    """
+    Clear all existing (non-immutable) tags from a package in a repository.
+
+    This requires appropriate (write) permissions for the package.
+
+    - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
+    REPO name where the package is stored, and the PACKAGE identifier of the
+    package itself. All separated by a slash.
+
+      Example: 'your-org/awesome-repo/better-pkg'.
+
+    Full CLI example:
+
+      $ cloudsmith tags clear your-org/awesome-repo/better-pkg
+    """
+    owner, repo, package = owner_repo_package
+
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo(
+        "Clearing tags on the '%(package)s' package ... "
+        % {"package": click.style(package, bold=True)},
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed to clear tags on package!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            package_tags, package_tags_immutable = api_tag_package(
+                owner=owner, repo=repo, identifier=package, data={"action": "clear"}
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    _print_tags(opts, package_tags, package_tags_immutable)
+
+
+@tags_.command(name="remove", aliases=["rm"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument(
+    "owner_repo_package",
+    metavar="OWNER/REPO/PACKAGE",
+    callback=validators.validate_owner_repo_package,
+)
+@click.argument("tags", metavar="TAGS")
+@click.pass_context
+def remove_tags(ctx, opts, owner_repo_package, tags):
+    """
+    Remove tags from a package in a repository.
+
+    This requires appropriate (write) permissions for the package.
+
+    - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
+    REPO name where the package is stored, and the PACKAGE identifier of the
+    package itself. All separated by a slash.
+
+      Example: 'your-org/awesome-repo/better-pkg'.
+
+    - TAGS: A comma-separated value list of the tags you want to remove.
+
+      Example: foo,bar
+
+    Full CLI example:
+
+      $ cloudsmith tags remove your-org/awesome-repo/better-pkg foo,bar
+    """
+    owner, repo, package = owner_repo_package
+    tags = _parse_tags(tags)
+
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo(
+        "Removing '%(tags)s' tag%(s)s from the '%(package)s' package ... "
+        % {
+            "package": click.style(package, bold=True),
+            "tags": click.style(", ".join(tags or [])),
+            "s": "s" if len(tags) != 1 else "",
+        },
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed to remove tags from package!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            package_tags, package_tags_immutable = api_tag_package(
+                owner=owner,
+                repo=repo,
+                identifier=package,
+                data={"action": "remove", "tags": tags},
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    _print_tags(opts, package_tags, package_tags_immutable)
+
+
+@tags_.command(name="replace")
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument(
+    "owner_repo_package",
+    metavar="OWNER/REPO/PACKAGE",
+    callback=validators.validate_owner_repo_package,
+)
+@click.argument("tags", metavar="TAGS")
+@click.option(
+    "--immutable",
+    default=False,
+    is_flag=True,
+    help=(
+        "If true, the tags created will be immutable (cannot be changed). In "
+        "practice, this means the tags cannot be (easily) deleted. A repository "
+        "admin can explicitly remove immutable tags."
+    ),
+)
+@click.pass_context
+def replace_tags(ctx, opts, owner_repo_package, tags, immutable):
+    """
+    Replace all existing (non-immutable) tags on a package in a repository.
+
+    This requires appropriate (write) permissions for the package.
+
+    - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
+    REPO name where the package is stored, and the PACKAGE identifier of the
+    package itself. All separated by a slash.
+
+      Example: 'your-org/awesome-repo/better-pkg'.
+
+    - TAGS: A comma-separated value list of the tags you want to replace existing with.
+
+      Example: foo,bar
+
+    Full CLI example:
+
+      $ cloudsmith tags replace your-org/awesome-repo/better-pkg foo,bar
+    """
+    owner, repo, package = owner_repo_package
+    tags = _parse_tags(tags)
+
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo(
+        "Replacing existing with '%(tags)s' tag%(s)s on the '%(package)s' package ... "
+        % {
+            "package": click.style(package, bold=True),
+            "tags": click.style(", ".join(tags or [])),
+            "s": "s" if len(tags) != 1 else "",
+        },
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed to replace tags on package!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            package_tags, package_tags_immutable = api_tag_package(
+                owner=owner,
+                repo=repo,
+                identifier=package,
+                data={"action": "replace", "tags": tags, "is_immutable": immutable},
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    _print_tags(opts, package_tags, package_tags_immutable)

cloudsmith_cli/cli/commands/tokens.py

@@ -0,0 +1,318 @@
+import click
+
+from ...core.api import exceptions, user as api
+from ...core.config import create_config_files, new_config_messaging
+from .. import command, decorators, utils
+from ..exceptions import handle_api_exceptions
+from .main import main
+
+
+def handle_duplicate_token_error(exc, ctx, opts, save_config, force, json):
+    """
+    Handle the case where user already has a token.
+
+    Returns the token from refresh if user confirms, otherwise exits.
+    """
+    if (
+        exc.status == 400
+        and exc.detail
+        and "User has already created an API key" in exc.detail
+    ):
+        if not force:
+            if not click.confirm(
+                "User already has a token. Would you like to recreate it?",
+                abort=False,
+                err=json,
+            ):
+                return None
+        return refresh_existing_token_interactive(
+            ctx, opts, save_config=save_config, force=force, json=json
+        )
+    raise exc
+
+
+def request_api_key(ctx, opts, save_config=False):
+    """
+    Request an API key non-interactively.
+
+    This function creates a new token or rotates an existing one without any prompts.
+    Used by the --request-api-key flag in the auth command.
+
+    Returns the token object on success.
+    Raises ApiException on failure.
+    """
+    context_msg = "Failed to retrieve API token!"
+
+    try:
+        # Don't use handle_api_exceptions here so we can catch and handle
+        # the "already has token" error ourselves
+        with utils.maybe_spinner(opts):
+            new_token = api.create_user_token_saml()
+
+        if save_config:
+            create, has_errors = create_config_files(
+                ctx, opts, api_key=new_token.key, force=True
+            )
+            new_config_messaging(has_errors, opts, create, api_key=new_token.key)
+
+        return new_token
+
+    except exceptions.ApiException as exc:
+        if exc.status == 401:
+            # Unauthorized - re-raise with handler
+            with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+                raise
+
+        if (
+            exc.status == 400
+            and exc.detail
+            and "User has already created an API key" in exc.detail
+        ):
+            # Token exists - rotate it automatically
+            click.echo(
+                "Warning: Rotating existing API token. Your old key will be invalidated.",
+                err=True,
+            )
+
+            # List tokens and select the first one
+            with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+                with utils.maybe_spinner(opts):
+                    api_tokens = api.list_user_tokens()
+
+            if not api_tokens:
+                raise click.ClickException("No existing tokens found to rotate.")
+
+            token_slug = api_tokens[0].slug_perm
+
+            # Refresh the token
+            with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+                with utils.maybe_spinner(opts):
+                    new_token = api.refresh_user_token(token_slug)
+
+            if save_config:
+                create, has_errors = create_config_files(
+                    ctx, opts, api_key=new_token.key, force=True
+                )
+                new_config_messaging(has_errors, opts, create, api_key=new_token.key)
+
+            return new_token
+
+        # Other errors - use the handler
+        with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+            raise exc
+
+
+@main.group(cls=command.AliasGroup, name="tokens")
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@click.pass_context
+def tokens(ctx, opts):
+    """Manage your user API tokens."""
+
+
+@tokens.command(name="list", aliases=["ls"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.pass_context
+def list_tokens(ctx, opts):
+    """List all user API tokens."""
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo("Retrieving API tokens... ", nl=False, err=use_stderr)
+
+    context_msg = "Failed to retrieve API tokens!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with utils.maybe_spinner(opts):
+            tokens = api.list_user_tokens()
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, tokens):
+        return
+
+    print_tokens(tokens)
+
+
+@tokens.command()
+@click.option(
+    "--save-config",
+    default=False,
+    is_flag=True,
+    help="Save the new API key to your configuration files.",
+)
+@click.option(
+    "-f",
+    "--force",
+    default=False,
+    is_flag=True,
+    help="Force creation of user API token without prompts.",
+)
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.pass_context
+def create(ctx, opts, save_config, force=False, json=False):
+    """Create a new API token."""
+    new_token = _create(ctx, opts, save_config, force, json)
+
+    if save_config:
+        create, has_errors = create_config_files(
+            ctx, opts, api_key=new_token.key, force=force
+        )
+        new_config_messaging(has_errors, opts, create, api_key=new_token.key)
+
+
+@tokens.command()
+@click.argument(
+    "token_slug",
+    required=False,
+)
+@click.option(
+    "--save-config",
+    default=False,
+    is_flag=True,
+    help="Save the new API key to your configuration files.",
+)
+@click.option(
+    "-f",
+    "--force",
+    default=False,
+    is_flag=True,
+    help="Force refresh of user API token without prompts.",
+)
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.pass_context
+def refresh(ctx, opts, token_slug, force, save_config):
+    """Refresh a specific API token by its slug."""
+    new_token = refresh_existing_token_interactive(
+        ctx, opts, token_slug, save_config, force
+    )
+
+    if new_token:
+        if utils.maybe_print_as_json(opts, new_token):
+            return new_token
+
+
+def print_tokens(tokens):
+    for token in tokens:
+        click.echo(
+            f"Token: {click.style(token.key, fg='magenta')}, "
+            f"Created: {click.style(token.created, fg='green')}, "
+            f"slug_perm: {click.style(token.slug_perm, fg='cyan')}"
+        )
+
+
+def refresh_existing_token_interactive(
+    ctx, opts, token_slug=None, save_config=False, force=False, json=False
+):
+    """Refresh an existing API token with interactive token selection, or create new if none exist."""
+    json = json or utils.should_use_stderr(opts)
+    use_stderr = json
+    context_msg = "Failed to refresh the token!"
+
+    if not token_slug:
+        try:
+            with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+                api_tokens = api.list_user_tokens()
+        except exceptions.ApiException as exc:
+            # If we can't list tokens due to API error, fall back to creating a new one
+            if opts.debug:
+                click.echo(f"Debug: Failed to list tokens with error: {exc}", err=True)
+            click.echo(
+                "Unable to list existing tokens. Creating a new token instead...",
+                err=use_stderr,
+            )
+            return _create(ctx, opts, save_config=save_config, force=force, json=json)
+
+        if not api_tokens:
+            click.echo(
+                "No existing tokens found. Creating a new token instead...",
+                err=use_stderr,
+            )
+            return _create(ctx, opts, save_config=save_config, force=force, json=json)
+
+        if not json:
+            click.echo("Current tokens:")
+            print_tokens(api_tokens)
+
+        if not force:
+            token_slug = click.prompt(
+                "Please enter the slug_perm of the token you would like to refresh",
+                err=use_stderr,
+            )
+        else:
+            # Use the first available slug_perm when force is enabled
+            token_slug = api_tokens[0].slug_perm
+            if not json:
+                click.echo(f"Using token {token_slug} (first available)")
+
+    if not json:
+        click.echo(f"Refreshing token {token_slug}... ", nl=False)
+    else:
+        # In JSON mode, print info to stderr
+        click.echo(f"Refreshing token {token_slug}... ", nl=False, err=json)
+
+    try:
+        with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+            with utils.maybe_spinner(opts):
+                new_token = api.refresh_user_token(token_slug)
+
+        if save_config:
+            create, has_errors = create_config_files(
+                ctx, opts, api_key=new_token.key, force=force
+            )
+            new_config_messaging(has_errors, opts, create, api_key=new_token.key)
+
+        if utils.maybe_print_as_json(opts, new_token):
+            return
+
+        if not json:
+            click.secho("OK", fg="green")
+            click.echo(f"New token value: {click.style(new_token.key, fg='magenta')}")
+
+        return new_token
+    except exceptions.ApiException as exc:
+        # If refresh fails due to API error, offer to create a new token instead
+        if opts.debug:
+            click.echo(f"\nDebug: Refresh failed with error: {exc}", err=True)
+        click.echo("\nRefresh failed. Creating a new token instead...", err=use_stderr)
+        return _create(ctx, opts, save_config=save_config, force=force, json=json)
+
+
+def _create(ctx, opts, save_config=False, force=False, json=False):
+    """Create a new API token."""
+    json = json or utils.should_use_stderr(opts)
+
+    try:
+        new_token = api.create_user_token_saml()
+
+        if new_token:
+            # NOTE: This mutation is necessary during the deprecation period of the --json flag.
+            if json and opts.output not in ("json", "pretty_json"):
+                opts.output = "json"
+
+            if utils.maybe_print_as_json(opts, new_token):
+                return
+
+            click.echo(f"New token value: {click.style(new_token.key, fg='magenta')}")
+            return new_token
+
+        return new_token
+
+    except exceptions.ApiException as exc:
+        if exc.status == 401:
+            click.echo(f"{exc.detail}", err=True)
+            return
+        # NOTE: This mutation is necessary during the deprecation period of the --json flag.
+        if json and opts.output not in ("json", "pretty_json"):
+            opts.output = "json"
+        if exc.status == 400:
+            new_token = handle_duplicate_token_error(
+                exc, ctx, opts, save_config=save_config, force=force, json=json
+            )
+            return new_token