cloudsmith-cli 1.20.0__py3-none-any.whl

cloudsmith_cli/cli/commands/metrics/packages.py

@@ -0,0 +1,134 @@
+"""CLI/Commands - retrieve metrics."""
+
+import click
+
+from ....core.api import metrics as api
+from ... import decorators, utils, validators
+from ...exceptions import handle_api_exceptions
+from ...utils import maybe_spinner
+from .command import metrics
+
+
+def _print_activity_table(opts, data):
+    """Print token activity as a table."""
+    utils.pretty_print_table(
+        headers=["Active", "Inactive", "Total"],
+        rows=[
+            [
+                click.style(str(getattr(data, k, 0)), fg="green")
+                for k in ("active", "inactive", "total")
+            ]
+        ],
+        title="Activity Summary (Active = Has Downloads)",
+    )
+
+    click.echo()
+
+
+def _print_metrics_table(opts, data):
+    """Print metrics as a table."""
+    category_keys = {"Bandwidth": "bandwidth", "Downloads": "downloads"}
+
+    metrics_keys = {
+        "Average": "average",
+        "Lowest": "lowest",
+        "Highest": "highest",
+        "Total": "total",
+    }
+
+    headers = ["Metric"]
+    headers.extend(metrics_keys.keys())
+    rows = []
+
+    for category_header, category_key in category_keys.items():
+        category_data = getattr(data, category_key)
+        cols = [category_header]
+        for metric_key in metrics_keys.values():
+            metric_data = getattr(category_data, metric_key, {})
+            if hasattr(metric_data, "display"):
+                value = getattr(metric_data, "display")
+            else:
+                value = getattr(metric_data, "value")
+            value = str(value or 0)
+            cols.append(click.style(value, fg="green"))
+        rows.append(cols)
+
+    utils.pretty_print_table(headers=headers, rows=rows, title="Entitlement Metrics")
+
+    click.echo()
+
+
+@metrics.command(name="packages", aliases=["pkgs"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.argument(
+    "owner_repo",
+    metavar="OWNER/REPO",
+    callback=validators.validate_owner_repo,
+    required=True,
+)
+@click.option(
+    "--packages",
+    type=str,
+    required=False,
+    help=(
+        "A comma separated list of package identifiers (i.e. slug_perm). "
+        "If a list is not specified then all package will be included for "
+        "a given repository."
+    ),
+)
+@click.option(
+    "--start",
+    type=str,
+    required=False,
+    help=(
+        "Include metrics from and including this UTC date or UTC datetime. "
+        "For example '2020-12-31' or '2021-12-13T00:00:00Z'."
+    ),
+)
+@click.option(
+    "--finish",
+    type=str,
+    required=False,
+    help=(
+        "Include metrics up to and including this UTC date or UTC datetime. "
+        "For example '2020-12-31' or '2021-12-13T00:00:00Z'."
+    ),
+)
+@click.pass_context
+def usage(ctx, opts, owner_repo, packages, start, finish):
+    """
+    Retrieve package usage metrics.
+
+    OWNER/REPO: Specify the OWNER namespace (i.e user or org) and repository to retrieve the
+    metrics for that namespace/repository combination.
+    """
+    # Use stderr for messages if the output is something else (e.g.  # JSON)
+    use_stderr = utils.should_use_stderr(opts)
+
+    click.echo("Getting usage metrics ... ", nl=False, err=use_stderr)
+
+    owner = None
+    repo = None
+    # owner/repo are required arguments
+    if isinstance(owner_repo, list) and len(owner_repo) == 2:
+        owner, repo = owner_repo
+
+    context_msg = "Failed to get list of metrics!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with maybe_spinner(opts):
+            data = api.get_repository_packages_metrics(
+                owner=owner, repo=repo, packages=packages, start=start, finish=finish
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if utils.maybe_print_as_json(opts, data):
+        return
+
+    click.echo()
+
+    _print_activity_table(opts, data)
+    _print_metrics_table(opts, data)

cloudsmith_cli/cli/commands/move.py

@@ -0,0 +1,111 @@
+"""CLI/Commands - List objects."""
+
+import click
+
+from ...core.api.packages import move_package
+from .. import decorators, utils, validators
+from ..exceptions import handle_api_exceptions
+from ..utils import maybe_spinner
+from .main import main
+from .push import wait_for_package_sync
+
+
+@main.command(aliases=["mv", "promote"])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_package_action_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("destination", metavar="DEST")
+@click.option(
+    "-y",
+    "--yes",
+    default=False,
+    is_flag=True,
+    help="Assume yes as default answer to questions (this is dangerous!)",
+)
+@click.pass_context
+def move(
+    ctx,
+    opts,
+    owner_repo_package,
+    destination,
+    skip_errors,
+    wait_interval,
+    no_wait_for_sync,
+    sync_attempts,
+    yes,
+):
+    """
+    Move (promote) a package to another repo.
+
+    This requires appropriate permissions for both the source
+    repository/package and the destination repository.
+
+    - 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/better-pkg'.
+
+    - DEST: Specify the DEST (destination) repository to move the package to.
+    This *must* be in the same namespace as the source repository.
+
+      Example: 'other-repo'
+
+    Full CLI example:
+
+      $ cloudsmith mv your-org/awesome-repo/better-pkg other-repo
+    """
+    owner, source, slug = owner_repo_package
+
+    move_args = {
+        "slug": click.style(slug, bold=True),
+        "source": click.style(source, bold=True),
+        "dest": click.style(destination, bold=True),
+    }
+
+    use_stderr = utils.should_use_stderr(opts)
+
+    prompt = "move the %(slug)s from %(source)s to %(dest)s" % move_args
+    if not utils.confirm_operation(prompt, assume_yes=yes, err=use_stderr):
+        return
+
+    click.echo(
+        "Moving %(slug)s package from %(source)s to %(dest)s ... " % move_args,
+        nl=False,
+        err=use_stderr,
+    )
+
+    context_msg = "Failed to move package!"
+    with handle_api_exceptions(
+        ctx, opts=opts, context_msg=context_msg, reraise_on_error=skip_errors
+    ):
+        with maybe_spinner(opts):
+            _, new_slug = move_package(
+                owner=owner, repo=source, identifier=slug, destination=destination
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    if no_wait_for_sync:
+        utils.maybe_print_status_json(opts, {"slug": new_slug, "status": "OK"})
+        return
+
+    wait_for_package_sync(
+        ctx=ctx,
+        opts=opts,
+        owner=owner,
+        repo=destination,
+        slug=new_slug,
+        wait_interval=wait_interval,
+        skip_errors=skip_errors,
+        attempts=sync_attempts,
+    )
+
+    utils.maybe_print_status_json(opts, {"slug": new_slug, "status": "OK"})

cloudsmith_cli/cli/commands/policy/__init__.py

@@ -0,0 +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/cli/commands/policy/command.py

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

cloudsmith_cli/cli/commands/policy/deny.py

@@ -0,0 +1,248 @@
+"""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 = utils.should_use_stderr(opts)
+    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 = utils.should_use_stderr(opts)
+    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 = utils.should_use_stderr(opts)
+    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 = utils.should_use_stderr(opts)
+    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
+    )
+
+    use_stderr = utils.should_use_stderr(opts)
+    if not utils.confirm_operation(prompt, assume_yes=yes, err=use_stderr):
+        return
+
+    click.secho(
+        "Deleting %(identifier)s from the %(namespace)s namespace ... " % delete_args,
+        nl=False,
+        err=use_stderr,
+    )
+
+    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", err=use_stderr)