cloudsmith-cli 1.20.0__py3-none-any.whl

cloudsmith_cli/cli/commands/quarantine.py

@@ -0,0 +1,148 @@
+"""CLI/Commands - Quarantine."""
+
+import functools
+
+import click
+
+from ...core.api import packages as api
+from .. import command, decorators, utils, validators
+from ..exceptions import handle_api_exceptions
+from ..utils import maybe_spinner
+from .main import main
+
+
+def common_quarantine_options(f):
+    """Add common options for quarantine commands."""
+
+    @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_repo_package",
+        metavar="OWNER/REPO/PACKAGE",
+        callback=validators.validate_owner_repo_package,
+    )
+    @click.pass_context
+    @functools.wraps(f)
+    def wrapper(ctx, *args, **kwargs):
+        # pylint: disable=missing-docstring
+        return ctx.invoke(f, *args, **kwargs)
+
+    return wrapper
+
+
+@main.group(cls=command.AliasGroup, aliases=["block"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.pass_context
+def quarantine(ctx, opts):  # pylint: disable=unused-argument
+    """
+    Manage quarantined packages in a repository.
+
+    A quarantined package is not available for download from cloudsmith.
+    This functionality is currently in Invitational Beta. Reach out through
+    the chat function on the website to get it enabled for testing.
+
+    See the help for subcommands for more information on each.
+    """
+
+
+def add_quarantine(ctx, opts, owner_repo_package, page, page_size, page_all):
+    """
+    Add a package to quarantine.
+
+    A quarantined package is not available for download from cloudsmith.
+
+    - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
+    REPO name where the package is stored, and the PACKAGE name (slug) of the
+    package itself. All separated by a slash.
+
+        Example: 'your-org/awesome-repo/bad-pkg'
+
+    Full CLI example:
+
+      $ cloudsmith qu add your-org/awesome-repo/bad-pkg
+    """
+    owner, repo, slug = owner_repo_package
+
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo(
+        "Adding %(repository)s/%(package_slug)s to quarantine... "
+        % {
+            "repository": click.style(repo, bold=True),
+            "package_slug": click.style(slug, bold=True),
+        },
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed quarantine!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            api.quarantine_package(owner=owner, repo=repo, identifier=slug)
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    utils.maybe_print_status_json(opts, {"slug": slug, "status": "OK"})
+
+
+@quarantine.command(name="add")
+@common_quarantine_options
+@functools.wraps(add_quarantine)
+@click.pass_context
+def add(*args, **kwargs):  # pylint: disable=missing-docstring
+    return add_quarantine(*args, **kwargs)
+
+
+def remove_quarantine(ctx, opts, owner_repo_package, page, page_size, page_all):
+    """
+    Remove a package from quarantine.
+
+    A quarantined package is not available for download from cloudsmith.
+
+    - OWNER/REPO/PACKAGE: Specify the OWNER namespace (i.e. user or org), the
+    REPO name where the package is stored, and the PACKAGE name (slug) of the
+    package itself. All separated by a slash.
+
+        Example: 'your-org/awesome-repo/checked-pkg'
+
+    Full CLI example:
+
+      $ cloudsmith qu rm your-org/awesome-repo/checked-pkg
+    """
+    owner, repo, slug = owner_repo_package
+
+    # Use stderr for messages if the output is something else (e.g.  # JSON)
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo(
+        "Removing %(repository)s/%(package_slug)s from quarantine... "
+        % {
+            "repository": click.style(repo, bold=True),
+            "package_slug": click.style(slug, bold=True),
+        },
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed quarantine!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            api.quarantine_restore_package(owner=owner, repo=repo, identifier=slug)
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    utils.maybe_print_status_json(opts, {"slug": slug, "status": "OK"})
+
+
+@quarantine.command(name="remove", aliases=["rm", "restore"])
+@common_quarantine_options
+@functools.wraps(remove_quarantine)
+@click.pass_context
+def remove(*args, **kwargs):  # pylint: disable=missing-docstring
+    return remove_quarantine(*args, **kwargs)

cloudsmith_cli/cli/commands/quota/__init__.py

@@ -0,0 +1,2 @@
+from .history import usage as history_usage
+from .quota import usage as quota_usage

cloudsmith_cli/cli/commands/quota/command.py

@@ -0,0 +1,20 @@
+"""CLI/Commands - Import all Quota commands."""
+
+import click
+
+from ... import command, decorators
+from ..main import main
+
+
+@main.group(cls=command.AliasGroup, name="quota", aliases=[])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.pass_context
+def quota(ctx, opts):  # pylink: disable=unused-argument
+    """
+    Display Quota limits and history for an organisation.
+
+    See the help for subcommands for more information on each.
+    """

cloudsmith_cli/cli/commands/quota/history.py

@@ -0,0 +1,122 @@
+"""CLI/Commands - List Quota History for Namespace."""
+
+import click
+
+from ....core.api import quota as api
+from ... import decorators, utils, validators
+from ...exceptions import handle_api_exceptions
+from ...utils import maybe_spinner
+from .command import quota
+
+
+def display_history(opts, data):
+    histories = data.history
+
+    click.echo()
+    click.echo(click.style("Quota History", bold=True, fg="white"))
+    click.echo(
+        "---------------------------------------------------------------", nl=False
+    )
+
+    headers = [
+        "Plan",
+        "Start",
+        "End",
+        "Days",
+        "Uploaded",
+        "Downloaded",
+        "Download Limit",
+        "Download Used",
+        "Storage",
+        "Storage Limit",
+        "Storage Used",
+    ]
+
+    rows = []
+    for history in histories:
+        display = getattr(history, "display", {})
+        uploaded = getattr(display, "uploaded", {})
+        uploaded_used = getattr(uploaded, "used", "")
+
+        downloaded = getattr(display, "downloaded", {})
+        downloaded_used = getattr(downloaded, "used", "")
+        downloaded_limit = getattr(downloaded, "limit", "")
+        downloaded_percentage = getattr(downloaded, "percentage", "")
+
+        storage = getattr(display, "storage_used", {})
+        storage_used = getattr(storage, "used", "")
+        storage_limit = getattr(storage, "limit", "")
+        storage_percentage = getattr(storage, "percentage", "")
+
+        history_start = str(history.start)[0:10]
+        history_end = str(history.end)[0:10]
+
+        rows.append(
+            [
+                click.style(str(history.plan), fg="green"),
+                click.style(history_start, fg="white"),
+                click.style(history_end, fg="white"),
+                click.style(str(history.days), fg="white"),
+                click.style(str(uploaded_used), fg="yellow"),
+                click.style(str(downloaded_used), fg="cyan"),
+                click.style(str(downloaded_limit), fg="white"),
+                click.style(str(downloaded_percentage), fg="white"),
+                click.style(str(storage_used), fg="magenta"),
+                click.style(str(storage_limit), fg="white"),
+                click.style(str(storage_percentage), fg="white"),
+            ]
+        )
+
+    click.echo()
+    utils.pretty_print_table(headers, rows)
+
+
+@quota.command(name="history", aliases=[])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument(
+    "owner", metavar="OWNER", callback=validators.validate_owner, required=True
+)
+@click.option(
+    "-oss",
+    "--oss",
+    default=False,
+    is_flag=True,
+    help="Shows the open source quota for a namespace",
+)
+@click.pass_context
+def usage(ctx, opts, owner, oss):
+    """
+    Retrieve Quota history for namespace.
+
+    This requires appropriate permissions for the owner (a member of the
+    organisation and a valid API key).
+
+    - OWNER: Specify the OWNER namespace (i.e. org)
+
+      Example: 'your-org'
+
+    Full CLI example:
+
+      $ cloudsmith quota history your-org
+    """
+
+    # Use stderr for messages if the output is something else (e.g.  # JSON)
+    use_stderr = utils.should_use_stderr(opts)
+    click.echo("Getting quota ... ", nl=False, err=use_stderr)
+
+    owner = owner[0]
+
+    context_msg = "Failed to get quota!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            quota_ = api.quota_history(owner=owner, oss=oss)
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, quota_):
+        return
+
+    display_history(opts=opts, data=quota_)

cloudsmith_cli/cli/commands/quota/quota.py

@@ -0,0 +1,107 @@
+"""CLI/Commands - Display Quota for Namespace."""
+
+import click
+
+from ....core.api import quota as api
+from ... import decorators, utils, validators
+from ...exceptions import handle_api_exceptions
+from ...utils import maybe_spinner
+from .command import quota
+
+
+def display_quota(opts, data):
+    """Display Quota usage as a table."""
+    display = getattr(data.usage, "display", {})
+    bandwidth = getattr(display, "bandwidth", {})
+    storage = getattr(display, "storage", {})
+
+    click.echo()
+    click.echo(click.style("Bandwidth Quota", bold=True, fg="white"))
+    click.echo(
+        "---------------------------------------------------------------", nl=False
+    )
+
+    headers = ["Bandwidth Used", "Configured", "Plan Limit", "Total Used"]
+    rows = []
+    rows.append(
+        [
+            click.style(str(getattr(bandwidth, "used", "")), fg="white"),
+            click.style(str(getattr(bandwidth, "configured", "")), fg="white"),
+            click.style(str(getattr(bandwidth, "plan_limit", "")), fg="white"),
+            click.style(str(getattr(bandwidth, "percentage_used", "")), fg="white"),
+        ]
+    )
+    click.echo()
+    utils.pretty_print_table(headers, rows)
+
+    click.echo()
+    click.echo(click.style("Storage Quota", bold=True, fg="white"))
+    click.echo(
+        "---------------------------------------------------------------", nl=False
+    )
+
+    headers = ["Storage Used", "Configured", "Plan Limit", "Total Used"]
+    rows = []
+    rows.append(
+        [
+            click.style(str(getattr(storage, "used", "")), fg="white"),
+            click.style(str(getattr(storage, "configured", "")), fg="white"),
+            click.style(str(getattr(storage, "plan_limit", "")), fg="white"),
+            click.style(str(getattr(storage, "percentage_used", "")), fg="white"),
+        ]
+    )
+    click.echo()
+    utils.pretty_print_table(headers, rows)
+
+    click.echo()
+
+
+@quota.command(name="limits", aliases=[])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument(
+    "owner", metavar="OWNER", callback=validators.validate_owner, required=True
+)
+@click.option(
+    "-oss",
+    "--oss",
+    default=False,
+    is_flag=True,
+    help="Shows the open source quota for a namespace",
+)
+@click.pass_context
+def usage(ctx, opts, owner, oss):
+    """
+    Retrieve Quota limits.
+
+    This requires appropriate permissions for the owner (a member of the
+    organisation and a valid API key).
+
+    - OWNER: Specify the OWNER namespace (i.e. org)
+
+      Example: 'your-org'
+
+    Full CLI example:
+
+      $ cloudsmith quota limits your-org
+    """
+
+    # Use stderr for messages if the output is something else (e.g.  # JSON)
+    use_stderr = utils.should_use_stderr(opts)
+    click.echo("Getting quota ... ", nl=False, err=use_stderr)
+
+    owner = owner[0]
+
+    context_msg = "Failed to get quota!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            quota_ = api.quota_limits(owner=owner, oss=oss)
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, quota_):
+        return
+
+    display_quota(opts=opts, data=quota_)