Clean up pagination to be re-useable

Author: BartoszBlizniak

.github/workflows/release.yml

@@ -18,7 +18,6 @@ jobs:
               run: |
                   python -m pip install --upgrade pip
                   pip install shiv
-                  pip install cloudsmith-cli
             - name: Get version
               id: get_version
               run: echo "VERSION=$(cat cloudsmith_cli/data/VERSION)" >> $GITHUB_ENV
@@ -44,10 +43,10 @@ jobs:
                   asset_path: ./cloudsmith-${{ env.VERSION }}.pyz
                   asset_name: cloudsmith-${{ env.VERSION }}.pyz
                   asset_content_type: application/zip
-            - name: Rename asses to cloudsmith.pyz
+            - name: Rename asset to cloudsmith.pyz
               run: mv ./cloudsmith-${{ env.VERSION }}.pyz cloudsmith.pyz
             - name: Upload to Cloudsmith
-              run: cloudsmith push raw ${{ vars.CLOUDSMITH_NAMESPACE }}/${{ vars.CLOUDSMITH_REPO }} cloudsmith.pyz --name "cloudsmith-cli" --version ${{ env.VERSION }}
+              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 }}

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
@@ -176,29 +176,15 @@ def packages(ctx, opts, owner_repo, page, page_size, query, show_all):
     context_msg = "Failed to get list of packages!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            if show_all:
-                packages_ = []
-                current_page = 1
-                while True:
-                    page_packages, page_info = list_packages(
-                        owner=owner,
-                        repo=repo,
-                        page=current_page,
-                        page_size=page_size,
-                        query=query,
-                    )
-                    packages_.extend(page_packages)
-                    if (
-                        len(page_packages) < page_size
-                        or current_page >= page_info.page_total
-                    ):
-                        break
-                    current_page += 1
-                page_info.count = len(packages_)
-            else:
-                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)
 

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,7 +8,7 @@
 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
 
 
@@ -128,25 +128,9 @@ def get(ctx, opts, owner_repo, page, page_size, show_all):
     context_msg = "Failed to get list of repositories!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            if show_all:
-                repos_ = []
-                current_page = 1
-                while True:
-                    page_repos, page_info = api.list_repos(
-                        owner=owner, repo=repo, page=current_page, page_size=page_size
-                    )
-                    repos_.extend(page_repos)
-                    if (
-                        len(page_repos) < page_size
-                        or current_page >= page_info.page_total
-                    ):
-                        break
-                    current_page += 1
-                page_info.count = len(repos_)
-            else:
-                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)
 
@@ -222,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()
@@ -282,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"])

cloudsmith_cli/cli/commands/upstream.py

@@ -13,6 +13,7 @@
     maybe_spinner,
     maybe_truncate_list,
     maybe_truncate_string,
+    paginate_results,
 )
 from .main import main
 
@@ -174,33 +175,15 @@ def func(ctx, opts, owner_repo, page, page_size, show_all):
         context_msg = "Failed to get upstreams!"
         with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
             with maybe_spinner(opts):
-                if show_all:
-                    upstreams = []
-                    current_page = 1
-                    while True:
-                        page_upstreams, page_info = api.list_upstreams(
-                            owner=owner,
-                            repo=repo,
-                            upstream_format=upstream_fmt,
-                            page=current_page,
-                            page_size=page_size,
-                        )
-                        upstreams.extend(page_upstreams)
-                        if (
-                            len(page_upstreams) < page_size
-                            or current_page >= page_info.page_total
-                        ):
-                            break
-                        current_page += 1
-                    page_info.count = len(upstreams)
-                else:
-                    upstreams, page_info = api.list_upstreams(
-                        owner=owner,
-                        repo=repo,
-                        upstream_format=upstream_fmt,
-                        page=page,
-                        page_size=page_size,
-                    )
+                upstreams, page_info = paginate_results(
+                    api.list_upstreams,
+                    show_all,
+                    page,
+                    page_size,
+                    owner=owner,
+                    repo=repo,
+                    upstream_format=upstream_fmt,
+                )
 
         click.secho("OK", fg="green", err=use_stderr)
 

cloudsmith_cli/cli/decorators.py

@@ -5,7 +5,7 @@
 import click
 
 from ..core.api.init import initialise_api as _initialise_api
-from . import config, utils, validators
+from . import config, utils
 
 
 def report_retry(seconds, context=None):
@@ -142,39 +142,25 @@ def wrapper(ctx, *args, **kwargs):
 
 
 def common_cli_list_options(f):
-    """Add common list options to commands."""
-
-    @click.option(
-        "-p",
+    """Common CLI options for list commands."""
+    f = click.option(
         "--page",
         default=1,
-        type=int,
-        help="The page to view for lists, where 1 is the first page",
-        callback=validators.validate_page,
-    )
-    @click.option(
-        "-l",
+        help="The page of results to show.",
+        type=click.INT,
+    )(f)
+    f = click.option(
         "--page-size",
-        default=30,
-        type=int,
-        help="The amount of items to view per page for lists.",
-        callback=validators.validate_page_size,
-    )
-    @click.option(
+        default=None,
+        help="The number of results to return per page.",
+        type=click.INT,
+    )(f)
+    f = click.option(
         "--show-all",
         is_flag=True,
-        default=False,
-        help="Show all results by automatically paginating",
-    )
-    @click.pass_context
-    @functools.wraps(f)
-    def wrapper(ctx, *args, **kwargs):
-        # pylint: disable=missing-docstring
-        opts = config.get_or_create_options(ctx)
-        kwargs["opts"] = opts
-        return ctx.invoke(f, *args, **kwargs)
-
-    return wrapper
+        help="Show all results (unpaginated)",
+    )(f)
+    return f
 
 
 def common_api_auth_options(f):

cloudsmith_cli/cli/tests/commands/test_repos.py

@@ -134,6 +134,14 @@ def test_repos_commands(runner, organization, tmp_path):
         update, [owner_slash_repo, str(repo_config_file_path)], catch_exceptions=False
     )
     assert result.exit_code == 0
+    assert (
+        "Updating "
+        + repository_slug
+        + " repository in the "
+        + organization
+        + " namespace ...OK"
+        in result.output
+    )
     assert "Results: 1 repository visible" in result.output
     assert_output_is_equal_to_repo_config(
         result.output, organization, repo_config_file_path