CENG-355: Add --show-all flag to display all results from repo/package list

.github/workflows/release.yml

@@ -43,3 +43,10 @@ jobs:
                   asset_path: ./cloudsmith-${{ env.VERSION }}.pyz
                   asset_name: cloudsmith-${{ env.VERSION }}.pyz
                   asset_content_type: application/zip
+            - name: Rename asset to cloudsmith.pyz
+              run: mv ./cloudsmith-${{ env.VERSION }}.pyz cloudsmith.pyz
+            - name: Upload to Cloudsmith
+              run: ./cloudsmith.pyz push raw ${{ vars.CLOUDSMITH_NAMESPACE }}/${{ vars.CLOUDSMITH_REPO }} cloudsmith.pyz --name "cloudsmith-cli" --version ${{ env.VERSION }}
+              env:
+                  CLOUDSMITH_API_KEY: ${{ secrets.CLOUDSMITH_API_KEY }}
+                  VERSION: ${{ env.VERSION }}

.gitignore

@@ -42,4 +42,4 @@ reports/
 .env
 
 # Zipapp
-*.pyz
+*.pyz

CONTRIBUTING.md

@@ -22,6 +22,7 @@ For most purposes, you probably just want `pip install -r requirements.txt`.
 
 Our [direnv config](./.envrc) file codifies the development environment setup which we use internally.
 
+Run `pre-commit run -a black` to format the code.
 
 ## Coding Conventions
 

cloudsmith_cli/cli/commands/dependencies.py

@@ -41,7 +41,7 @@ def list_dependencies(ctx, opts, owner_repo_package):
     no dependencies then it is possible that dependency extraction isn't support
     for the package format yet.
 
-    - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
+    - OWNER/REPO/PACKAGE(Slug): Specify the OWNER namespace (i.e. user or org), the
     REPO name where the package is stored, and the PACKAGE name (identifier) of the
     package itself. All separated by a slash.
 

cloudsmith_cli/cli/commands/list_.py

@@ -9,7 +9,7 @@
 from ...core.api.packages import get_package_format_names_with_distros, list_packages
 from .. import command, decorators, utils, validators
 from ..exceptions import handle_api_exceptions
-from ..utils import maybe_spinner
+from ..utils import maybe_spinner, paginate_results
 from . import dependencies, entitlements
 from .main import main
 from .repos import get as get_repos
@@ -128,7 +128,7 @@ def entitlements_(*args, **kwargs):  # pylint: disable=missing-docstring
     help=("A boolean-like search term for querying package attributes."),
 )
 @click.pass_context
-def packages(ctx, opts, owner_repo, page, page_size, query):
+def packages(ctx, opts, owner_repo, page, page_size, query, show_all):
     """
     List packages for a repository.
 
@@ -176,8 +176,14 @@ def packages(ctx, opts, owner_repo, page, page_size, query):
     context_msg = "Failed to get list of packages!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            packages_, page_info = list_packages(
-                owner=owner, repo=repo, page=page, page_size=page_size, query=query
+            packages_, page_info = paginate_results(
+                list_packages,
+                show_all,
+                page,
+                page_size,
+                owner=owner,
+                repo=repo,
+                query=query,
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -209,10 +215,17 @@ def packages(ctx, opts, owner_repo, page, page_size, query):
     click.echo()
 
     num_results = len(packages_)
-    list_suffix = "package%s visible" % ("s" if num_results != 1 else "")
-    utils.pretty_print_list_info(
-        num_results=num_results, page_info=page_info, suffix=list_suffix
-    )
+    list_suffix = "package%s" % ("s" if num_results != 1 else "")
+    if show_all:
+        utils.pretty_print_list_info(
+            num_results=num_results, suffix=f"{list_suffix} retrieved", show_all=True
+        )
+    else:
+        utils.pretty_print_list_info(
+            num_results=num_results,
+            page_info=page_info,
+            suffix=f"{list_suffix} visible",
+        )
 
 
 @list_.command()
@@ -229,7 +242,7 @@ def packages(ctx, opts, owner_repo, page, page_size, query):
     required=False,
 )
 @click.pass_context
-def repos(ctx, opts, owner_repo, page, page_size):
+def repos(ctx, opts, owner_repo, page, page_size, show_all):
     """
     List repositories for a namespace (owner).
 

cloudsmith_cli/cli/commands/policy/license.py

@@ -13,13 +13,12 @@
     maybe_spinner,
     maybe_truncate_list,
     maybe_truncate_string,
+    paginate_results,
 )
 from .command import policy
 
 
 def print_license_policies(policies):
-    """Print license policies as a table or output in another format."""
-
     headers = [
         "Name",
         "Description",
@@ -57,10 +56,6 @@ def print_license_policies(policies):
     utils.pretty_print_table(headers, rows)
     click.echo()
 
-    num_results = len(rows)
-    list_suffix = "license polic%s" % ("y" if num_results == 1 else "ies")
-    utils.pretty_print_list_info(num_results=num_results, suffix=list_suffix)
-
 
 @policy.group(cls=command.AliasGroup, name="license", aliases=[])
 @decorators.common_cli_config_options
@@ -85,8 +80,14 @@ def licence(*args, **kwargs):
 @click.argument(
     "owner", metavar="OWNER", callback=validators.validate_owner, required=True
 )
+@click.option(
+    "--show-all",
+    "-a",
+    is_flag=True,
+    help="Show all results, not just the current page",
+)
 @click.pass_context
-def ls(ctx, opts, owner, page, page_size):
+def ls(ctx, opts, owner, page, page_size, show_all):
     """
     List license policies.
 
@@ -111,8 +112,8 @@ def ls(ctx, opts, owner, page, page_size):
     context_msg = "Failed to get license policies!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            policies, page_info = api.list_license_policies(
-                owner=owner, page=page, page_size=page_size
+            policies, page_info = paginate_results(
+                api.list_license_policies, show_all, page, page_size, owner=owner
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -122,6 +123,17 @@ def ls(ctx, opts, owner, page, page_size):
 
     print_license_policies(policies)
 
+    click.echo()
+
+    num_results = len(policies)
+    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,
+        suffix=list_suffix,
+        show_all=show_all,
+    )
+
 
 @licence.command(aliases=["new"])
 @decorators.common_cli_config_options

cloudsmith_cli/cli/commands/policy/vulnerability.py

@@ -6,7 +6,13 @@
 from ....core.api import orgs as api
 from ... import command, decorators, utils, validators
 from ...exceptions import handle_api_exceptions
-from ...utils import fmt_bool, fmt_datetime, maybe_spinner, maybe_truncate_string
+from ...utils import (
+    fmt_bool,
+    fmt_datetime,
+    maybe_spinner,
+    maybe_truncate_string,
+    paginate_results,
+)
 from .command import policy
 
 
@@ -45,10 +51,6 @@ def print_vulnerability_policies(policies):
     utils.pretty_print_table(headers, rows, title="Vulnerability Policies")
     click.echo()
 
-    num_results = len(rows)
-    list_suffix = "vulnerability polic%s" % ("y" if num_results == 1 else "ies")
-    utils.pretty_print_list_info(num_results=num_results, suffix=list_suffix)
-
 
 @policy.group(cls=command.AliasGroup, name="vulnerability", aliases=[])
 @decorators.common_cli_config_options
@@ -74,7 +76,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):
+def ls(ctx, opts, owner, page, page_size, show_all):
     """
     List vulnerability policies.
 
@@ -99,8 +101,8 @@ def ls(ctx, opts, owner, page, page_size):
     context_msg = "Failed to get package vulnerability policies!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            policies, page_info = api.list_vulnerability_policies(
-                owner=owner, page=page, page_size=page_size
+            policies, page_info = paginate_results(
+                api.list_vulnerability_policies, show_all, page, page_size, owner=owner
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -110,6 +112,17 @@ def ls(ctx, opts, owner, page, page_size):
 
     print_vulnerability_policies(policies)
 
+    click.echo()
+
+    num_results = len(policies)
+    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,
+        suffix=list_suffix,
+        show_all=show_all,
+    )
+
 
 @vulnerability.command(aliases=["new"])
 @decorators.common_cli_config_options

cloudsmith_cli/cli/commands/repos.py

@@ -8,11 +8,11 @@
 from ...core.api import repos as api
 from .. import command, decorators, utils, validators
 from ..exceptions import handle_api_exceptions
-from ..utils import maybe_spinner
+from ..utils import maybe_spinner, paginate_results
 from .main import main
 
 
-def print_repositories(opts, data, page_info=None, show_list_info=True):
+def print_repositories(opts, data, page_info=None, show_list_info=True, show_all=False):
     """Print repositories as a table or output in another format."""
     headers = [
         "Name",
@@ -46,13 +46,23 @@ def print_repositories(opts, data, page_info=None, show_list_info=True):
         click.echo()
         utils.pretty_print_table(headers, rows)
 
+    if not show_list_info:
+        return
+
     click.echo()
 
     num_results = len(data)
-    list_suffix = "repositor%s visible" % ("ies" if num_results != 1 else "y")
-    utils.pretty_print_list_info(
-        num_results=num_results, page_info=page_info, suffix=list_suffix
-    )
+    list_suffix = "repositor%s" % ("ies" if num_results != 1 else "y")
+    if show_all:
+        utils.pretty_print_list_info(
+            num_results=num_results, suffix=f"{list_suffix} retrieved", show_all=True
+        )
+    else:
+        utils.pretty_print_list_info(
+            num_results=num_results,
+            page_info=page_info,
+            suffix=f"{list_suffix} visible",
+        )
 
 
 @main.group(cls=command.AliasGroup, name="repositories", aliases=["repos"])
@@ -83,7 +93,7 @@ def repositories(ctx, opts):  # pylink: disable=unused-argument
     required=False,
 )
 @click.pass_context
-def get(ctx, opts, owner_repo, page, page_size):
+def get(ctx, opts, owner_repo, page, page_size, show_all):
     """
     List repositories for a namespace (owner).
 
@@ -118,8 +128,8 @@ def get(ctx, opts, owner_repo, page, page_size):
     context_msg = "Failed to get list of repositories!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            repos_, page_info = api.list_repos(
-                owner=owner, repo=repo, page=page, page_size=page_size
+            repos_, page_info = paginate_results(
+                api.list_repos, show_all, page, page_size, owner=owner, repo=repo
             )
 
     click.secho("OK", fg="green", err=use_stderr)
@@ -128,7 +138,11 @@ def get(ctx, opts, owner_repo, page, page_size):
         return
 
     print_repositories(
-        opts=opts, data=repos_, show_list_info=False, page_info=page_info
+        opts=opts,
+        data=repos_,
+        show_list_info=True,
+        page_info=page_info,
+        show_all=show_all,
     )
 
 
@@ -192,7 +206,10 @@ def create(ctx, opts, owner, repo_config_file):
 
     click.secho("OK", fg="green", err=use_stderr)
 
-    print_repositories(opts=opts, data=[repository], show_list_info=False)
+    if utils.maybe_print_as_json(opts, [repository]):
+        return
+
+    print_repositories(opts=opts, data=[repository], show_list_info=True)
 
 
 @repositories.command()
@@ -252,7 +269,10 @@ def update(ctx, opts, owner_repo, repo_config_file):
 
     click.secho("OK", fg="green", err=use_stderr)
 
-    print_repositories(opts=opts, data=[repository], show_list_info=False)
+    if utils.maybe_print_as_json(opts, [repository]):
+        return
+
+    print_repositories(opts=opts, data=[repository], show_list_info=True)
 
 
 @repositories.command(aliases=["rm"])