cloudsmith-cli 1.9.4__tar.gz → 1.10.1__tar.gz

{cloudsmith_cli-1.9.4/cloudsmith_cli.egg-info → cloudsmith_cli-1.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudsmith-cli
-Version: 1.9.4
+Version: 1.10.1
 Summary: Cloudsmith Command-Line Interface (CLI)
 Home-page: https://github.com/cloudsmith-io/cloudsmith-cli
 Author: Cloudsmith Ltd
@@ -27,7 +27,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: click!=8.3.0,>=8.2.0
+Requires-Dist: click!=8.3.0,>=8.1.8
 Requires-Dist: click-configfile>=0.2.3
 Requires-Dist: click-didyoumean>=0.0.3
 Requires-Dist: click-spinner>=0.1.7
@@ -36,7 +36,7 @@ Requires-Dist: keyring>=25.4.1
 Requires-Dist: requests>=2.18.4
 Requires-Dist: requests_toolbelt>=0.8.0
 Requires-Dist: semver>=2.7.9
-Requires-Dist: urllib3<2.0
+Requires-Dist: urllib3>=2.5
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -105,6 +105,7 @@ The CLI currently supports the following commands (and sub-commands):
   - `packages`:             Retrieve package usage for repository.
 - `move`|`mv`|`promote`:  Move (promote) a package to another repo.
 - `policy`:               Manage policies for an organization.
+  - `deny`:                 Manage deny policies for an organization.
   - `license`:              Manage license policies for an organization.
   - `vulnerability`:        Manage vulnerability policies for an organization.
 - `push`|`upload`:        Push (upload) a new package to a repository.

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/README.md

@@ -52,6 +52,7 @@ The CLI currently supports the following commands (and sub-commands):
   - `packages`:             Retrieve package usage for repository.
 - `move`|`mv`|`promote`:  Move (promote) a package to another repo.
 - `policy`:               Manage policies for an organization.
+  - `deny`:                 Manage deny policies for an organization.
   - `license`:              Manage license policies for an organization.
   - `vulnerability`:        Manage vulnerability policies for an organization.
 - `push`|`upload`:        Push (upload) a new package to a repository.

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/entitlements.py

@@ -6,6 +6,7 @@ from operator import itemgetter
 import click
 
 from ...core.api import entitlements as api
+from ...core.pagination import paginate_results
 from .. import command, decorators, utils, validators
 from ..exceptions import handle_api_exceptions
 from ..utils import fmt_datetime, maybe_spinner
@@ -72,7 +73,7 @@ def list_entitlements_options(f):
     return wrapper
 
 
-def list_entitlements(ctx, opts, owner_repo, page, page_size, show_tokens):
+def list_entitlements(ctx, opts, owner_repo, page, page_size, show_tokens, page_all):
     """
     List entitlements for a repository.
 
@@ -100,11 +101,13 @@ def list_entitlements(ctx, opts, owner_repo, page, page_size, show_tokens):
     context_msg = "Failed to get list of entitlements!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            entitlements_, page_info = api.list_entitlements(
-                owner=owner,
-                repo=repo,
+            entitlements_, page_info = paginate_results(
+                api.list_entitlements,
+                page_all=page_all,
                 page=page,
                 page_size=page_size,
+                owner=owner,
+                repo=repo,
                 show_tokens=show_tokens,
             )
 

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/list_.py

@@ -157,7 +157,7 @@ def entitlements_(*args, **kwargs):  # pylint: disable=missing-docstring
     help=("Sort packages by field. Prefix with '-' for descending order."),
 )
 @click.pass_context
-def packages(ctx, opts, owner_repo, page, page_size, query, sort, show_all):
+def packages(ctx, opts, owner_repo, page, page_size, query, sort, page_all):
     """
     List packages for a repository.
 
@@ -220,7 +220,7 @@ def packages(ctx, opts, owner_repo, page, page_size, query, sort, show_all):
         with maybe_spinner(opts):
             packages_, page_info = paginate_results(
                 list_packages,
-                show_all=show_all,
+                page_all=page_all,
                 page=page,
                 page_size=page_size,
                 owner=owner,
@@ -262,9 +262,9 @@ def packages(ctx, opts, owner_repo, page, page_size, query, sort, show_all):
     list_suffix = "package%s" % ("s" if num_results != 1 else "")
     utils.pretty_print_list_info(
         num_results=num_results,
-        page_info=None if show_all else page_info,
-        suffix=f"{list_suffix} retrieved" if show_all else f"{list_suffix} visible",
-        show_all=show_all,
+        page_info=None if page_all else page_info,
+        suffix=f"{list_suffix} retrieved" if page_all else f"{list_suffix} visible",
+        page_all=page_all,
     )
 
 
@@ -282,7 +282,7 @@ def packages(ctx, opts, owner_repo, page, page_size, query, sort, show_all):
     required=False,
 )
 @click.pass_context
-def repos(ctx, opts, owner_repo, page, page_size, show_all):
+def repos(ctx, opts, owner_repo, page, page_size, page_all):
     """
     List repositories for a namespace (owner).
 

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/metrics/entitlements.py

@@ -123,7 +123,9 @@ def usage(ctx, opts, owner_repo, tokens, start, finish):
         owner = owner_repo[0]
         repo = None
 
+    data = None
     context_msg = "Failed to get list of metrics!"
+    data = {}
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
             if owner and repo:

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/policy/__init__.py

@@ -1,2 +1,3 @@
+from .deny import deny_policy as policy_deny
 from .license import licence as policy_license
 from .vulnerability import vulnerability as policy_vulnerability

cloudsmith_cli-1.10.1/cloudsmith_cli/cli/commands/policy/deny.py

@@ -0,0 +1,246 @@
+"""Commands for deny policies."""
+
+import click
+
+from ....core.api import orgs
+from ....core.pagination import paginate_results
+from ... import command, decorators, utils
+from ...exceptions import handle_api_exceptions
+from ...utils import fmt_datetime, maybe_spinner
+from .command import policy
+
+
+def print_deny_policies(policies):
+    """Print deny policies as a table."""
+    headers = [
+        "Name",
+        "Description",
+        "Package Query",
+        "Enabled",
+        "Created",
+        "Updated",
+        "Identifier",
+    ]
+
+    rows = [
+        [
+            click.style(policy["name"], fg="cyan"),
+            click.style(policy["description"], fg="yellow"),
+            click.style(policy.get("package_query_string", ""), fg="yellow"),
+            click.style(
+                "Yes" if policy.get("enabled") else "No",
+                fg="green" if policy.get("enabled") else "red",
+            ),
+            click.style(fmt_datetime(policy["created_at"]), fg="blue"),
+            click.style(fmt_datetime(policy["updated_at"]), fg="blue"),
+            click.style(policy["slug_perm"], fg="green"),
+        ]
+        for policy in policies
+    ]
+
+    click.echo()
+    utils.pretty_print_table(headers, rows)
+    click.echo()
+
+
+@policy.group(cls=command.AliasGroup, name="deny", aliases=[])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.pass_context
+def deny_policy(*args, **kwargs):
+    """Manage deny policies for an organization."""
+
+
+@deny_policy.command(name="list", aliases=["ls"])
+@decorators.common_cli_config_options
+@decorators.common_cli_list_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument("owner")
+@click.pass_context
+def list_deny_policies(ctx, opts, owner, page, page_size, page_all):
+    """List deny policies for an organization."""
+    use_stderr = opts.output != "pretty"
+    click.echo("Getting deny policies ... ", nl=False, err=use_stderr)
+
+    context_msg = "Failed to get deny policies!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            data, page_info = paginate_results(
+                orgs.list_deny_policies, page_all, page, page_size, owner=owner
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, data, page_info):
+        return
+
+    print_deny_policies(data)
+
+    click.echo()
+
+    num_results = len(data)
+    list_suffix = "deny polic%s" % ("y" if num_results == 1 else "ies")
+    utils.pretty_print_list_info(
+        num_results=num_results,
+        page_info=None if page_all else page_info,
+        suffix=list_suffix,
+        page_all=page_all,
+    )
+
+
+@deny_policy.command(name="create", aliases=["new"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument("owner")
+@click.argument("policy_config_file", type=click.File("rb"))
+@click.pass_context
+def create_deny_policy(ctx, opts, owner, policy_config_file):
+    """Create a deny policy for an organization."""
+    import json
+
+    use_stderr = opts.output != "pretty"
+    policy_config = json.load(policy_config_file)
+
+    policy_name = policy_config.get("name")
+    if not policy_name:
+        raise click.BadParameter(
+            "Name is required for creating a deny policy.", param="name"
+        )
+
+    click.secho(
+        "Creating %(name)s deny policy for the %(owner)s namespace ..."
+        % {
+            "name": click.style(policy_name, bold=True),
+            "owner": click.style(owner, bold=True),
+        },
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed to create the deny policy!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            data = orgs.create_deny_policy(owner=owner, policy_config=policy_config)
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, [data]):
+        return
+
+    print_deny_policies([data])
+
+
+@deny_policy.command(name="get")
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument("owner")
+@click.argument("identifier")
+@click.pass_context
+def get_deny_policy(ctx, opts, owner, identifier):
+    """Get a deny policy for an organization."""
+    use_stderr = opts.output != "pretty"
+    click.echo("Getting deny policy ... ", nl=False, err=use_stderr)
+
+    context_msg = "Failed to get deny policy!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            data = orgs.get_deny_policy(owner=owner, slug_perm=identifier)
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, [data]):
+        return
+
+    print_deny_policies([data])
+
+
+@deny_policy.command(name="update", aliases=["set"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument("owner")
+@click.argument("identifier")
+@click.argument("policy_config_file", type=click.File("rb"))
+@click.pass_context
+def update_deny_policy(ctx, opts, owner, identifier, policy_config_file):
+    """Update a deny policy for an organization."""
+    import json
+
+    use_stderr = opts.output != "pretty"
+    policy_config = json.load(policy_config_file)
+
+    click.secho(
+        "Updating %(identifier)s deny policy in the %(owner)s namespace ..."
+        % {
+            "identifier": click.style(identifier, bold=True),
+            "owner": click.style(owner, bold=True),
+        },
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed to update the deny policy!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            data = orgs.update_deny_policy(
+                owner=owner, slug_perm=identifier, policy_config=policy_config
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, [data]):
+        return
+
+    print_deny_policies([data])
+
+
+@deny_policy.command(name="delete", aliases=["rm"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument("owner")
+@click.argument("identifier")
+@click.option(
+    "-y",
+    "--yes",
+    default=False,
+    is_flag=True,
+    help="Assume yes as default answer to questions (this is dangerous!)",
+)
+@click.pass_context
+def delete_deny_policy(ctx, opts, owner, identifier, yes):
+    """Delete a deny policy for an organization."""
+    delete_args = {
+        "namespace": click.style(owner, bold=True),
+        "identifier": click.style(identifier, bold=True),
+    }
+
+    prompt = (
+        "delete the %(identifier)s deny policy from the %(namespace)s namespace"
+        % delete_args
+    )
+
+    if not utils.confirm_operation(prompt, assume_yes=yes):
+        return
+
+    click.secho(
+        "Deleting %(identifier)s from the %(namespace)s namespace ... " % delete_args,
+        nl=False,
+    )
+
+    context_msg = "Failed to delete the deny policy!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            orgs.delete_deny_policy(owner=owner, slug_perm=identifier)
+
+    click.secho("OK", fg="green")

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/policy/license.py

@@ -82,7 +82,7 @@ def licence(*args, **kwargs):
     "owner", metavar="OWNER", callback=validators.validate_owner, required=True
 )
 @click.pass_context
-def ls(ctx, opts, owner, page, page_size, show_all):
+def ls(ctx, opts, owner, page, page_size, page_all):
     """
     List license policies.
 
@@ -108,7 +108,7 @@ def ls(ctx, opts, owner, page, page_size, show_all):
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
             policies, page_info = paginate_results(
-                api.list_license_policies, show_all, page, page_size, owner=owner
+                api.list_license_policies, page_all, page, page_size, owner=owner
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -124,9 +124,9 @@ def ls(ctx, opts, owner, page, page_size, show_all):
     list_suffix = "license polic%s" % ("y" if num_results == 1 else "ies")
     utils.pretty_print_list_info(
         num_results=num_results,
-        page_info=None if show_all else page_info,
+        page_info=None if page_all else page_info,
         suffix=list_suffix,
-        show_all=show_all,
+        page_all=page_all,
     )
 
 

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/policy/vulnerability.py

@@ -72,7 +72,7 @@ def vulnerability(*args, **kwargs):
     "owner", metavar="OWNER", callback=validators.validate_owner, required=True
 )
 @click.pass_context
-def ls(ctx, opts, owner, page, page_size, show_all):
+def ls(ctx, opts, owner, page, page_size, page_all):
     """
     List vulnerability policies.
 
@@ -98,7 +98,7 @@ def ls(ctx, opts, owner, page, page_size, show_all):
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
             policies, page_info = paginate_results(
-                api.list_vulnerability_policies, show_all, page, page_size, owner=owner
+                api.list_vulnerability_policies, page_all, page, page_size, owner=owner
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -114,9 +114,9 @@ def ls(ctx, opts, owner, page, page_size, show_all):
     list_suffix = "vulnerability polic%s" % ("y" if num_results == 1 else "ies")
     utils.pretty_print_list_info(
         num_results=num_results,
-        page_info=None if show_all else page_info,
+        page_info=None if page_all else page_info,
         suffix=list_suffix,
-        show_all=show_all,
+        page_all=page_all,
     )
 
 

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/quarantine.py

@@ -51,7 +51,7 @@ def quarantine(ctx, opts):  # pylint: disable=unused-argument
     """
 
 
-def add_quarantine(ctx, opts, owner_repo_package, page, page_size):
+def add_quarantine(ctx, opts, owner_repo_package, page, page_size, page_all):
     """
     Add a package to quarantine.
 
@@ -98,7 +98,7 @@ def add(*args, **kwargs):  # pylint: disable=missing-docstring
     return add_quarantine(*args, **kwargs)
 
 
-def remove_quarantine(ctx, opts, owner_repo_package, page, page_size):
+def remove_quarantine(ctx, opts, owner_repo_package, page, page_size, page_all):
     """
     Remove a package from quarantine.
 

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/repos.py

@@ -13,7 +13,7 @@ from ..utils import maybe_spinner
 from .main import main
 
 
-def print_repositories(opts, data, page_info=None, show_list_info=True, show_all=False):
+def print_repositories(opts, data, page_info=None, show_list_info=True, page_all=False):
     """Print repositories as a table or output in another format."""
     headers = [
         "Name",
@@ -56,9 +56,9 @@ def print_repositories(opts, data, page_info=None, show_list_info=True, show_all
     list_suffix = "repositor%s" % ("ies" if num_results != 1 else "y")
     utils.pretty_print_list_info(
         num_results=num_results,
-        page_info=None if show_all else page_info,
-        suffix=f"{list_suffix} retrieved" if show_all else f"{list_suffix} visible",
-        show_all=show_all,
+        page_info=None if page_all else page_info,
+        suffix=f"{list_suffix} retrieved" if page_all else f"{list_suffix} visible",
+        page_all=page_all,
     )
 
 
@@ -90,7 +90,7 @@ def repositories(ctx, opts):  # pylink: disable=unused-argument
     required=False,
 )
 @click.pass_context
-def get(ctx, opts, owner_repo, page, page_size, show_all):
+def get(ctx, opts, owner_repo, page, page_size, page_all):
     """
     List repositories for a namespace (owner).
 
@@ -119,9 +119,9 @@ def get(ctx, opts, owner_repo, page, page_size, show_all):
         owner = None
         repo = None
 
-    if show_all and repo:
+    if page_all and repo:
         raise click.UsageError(
-            "The --show-all option cannot be used when specifying a single repository (OWNER/REPO). Omit the repository slug or remove --show-all."
+            "The --page-all option cannot be used when specifying a single repository (OWNER/REPO). Omit the repository slug or remove --page-all."
         )
 
     click.echo("Getting list of repositories ... ", nl=False, err=use_stderr)
@@ -130,7 +130,7 @@ def get(ctx, opts, owner_repo, page, page_size, show_all):
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
             repos_, page_info = paginate_results(
-                api.list_repos, show_all, page, page_size, owner=owner, repo=repo
+                api.list_repos, page_all, page, page_size, owner=owner, repo=repo
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -143,7 +143,7 @@ def get(ctx, opts, owner_repo, page, page_size, show_all):
         data=repos_,
         show_list_info=True,
         page_info=page_info,
-        show_all=show_all,
+        page_all=page_all,
     )
 
 

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/commands/upstream.py

@@ -38,7 +38,7 @@ UPSTREAM_FORMATS = [
 ]
 
 
-def print_upstreams(upstreams, upstream_fmt, page_info=None, show_all=False):
+def print_upstreams(upstreams, upstream_fmt, page_info=None, page_all=False):
     """Print upstreams as a table or output in another format."""
 
     def build_row(u):
@@ -120,9 +120,9 @@ def print_upstreams(upstreams, upstream_fmt, page_info=None, show_all=False):
     list_suffix = "upstream%s" % ("" if num_results == 1 else "s")
     utils.pretty_print_list_info(
         num_results=num_results,
-        page_info=None if show_all else page_info,
+        page_info=None if page_all else page_info,
         suffix=list_suffix,
-        show_all=show_all,
+        page_all=page_all,
     )
 
 
@@ -170,7 +170,7 @@ def build_upstream_list_command(upstream_fmt):
         "owner_repo", metavar="OWNER/REPO", callback=validators.validate_owner_repo
     )
     @click.pass_context
-    def func(ctx, opts, owner_repo, page, page_size, show_all):
+    def func(ctx, opts, owner_repo, page, page_size, page_all):
         owner, repo = owner_repo
 
         # Use stderr for messages if the output is something else (e.g.  # JSON)
@@ -184,7 +184,7 @@ def build_upstream_list_command(upstream_fmt):
             with maybe_spinner(opts):
                 upstreams, page_info = paginate_results(
                     api.list_upstreams,
-                    show_all,
+                    page_all,
                     page,
                     page_size,
                     owner=owner,
@@ -198,7 +198,7 @@ def build_upstream_list_command(upstream_fmt):
         if utils.maybe_print_as_json(opts, upstreams, page_info):
             return
 
-        print_upstreams(upstreams, upstream_fmt, page_info, show_all)
+        print_upstreams(upstreams, upstream_fmt, page_info, page_all)
 
     func.__doc__ = f"""
         List {upstream_fmt} upstreams for a repository.

{cloudsmith_cli-1.9.4 → cloudsmith_cli-1.10.1}/cloudsmith_cli/cli/decorators.py

@@ -150,8 +150,8 @@ def common_cli_list_options(f):
         "-l",
         "--page-size",
         default=30,
-        type=int,
-        help="The amount of items to view per page for lists.",
+        type=validators.IntOrWildcard(),
+        help="The amount of items to view per page for lists. Use '*' to show all results.",
         callback=validators.validate_page_size,
     )
     @click.option(
@@ -163,6 +163,7 @@ def common_cli_list_options(f):
         callback=validators.validate_page,
     )
     @click.option(
+        "--page-all",
         "--show-all",
         default=False,
         is_flag=True,
@@ -173,10 +174,18 @@ def common_cli_list_options(f):
     def wrapper(ctx, *args, **kwargs):
         # pylint: disable=missing-docstring
         opts = config.get_or_create_options(ctx)
+
+        # Handle wildcard page_size (converts to page_all behavior)
+        page_size = kwargs.get("page_size")
+        if page_size == -1:
+            kwargs["page_all"] = True
+            # Validate that wildcard isn't used with explicit --page
+            validators.enforce_page_all_exclusive(ctx, wildcard_used=True)
+
         # Order-independent validation: perform after all options parsed.
-        show_all = kwargs.get("show_all")
-        if show_all:
-            validators.enforce_show_all_exclusive(ctx)
+        page_all = kwargs.get("page_all")
+        if page_all:
+            validators.enforce_page_all_exclusive(ctx)
         kwargs["opts"] = opts
         return ctx.invoke(f, *args, **kwargs)