cloudsmith-cli 1.20.0__py3-none-any.whl

cloudsmith_cli/cli/commands/upstream.py

@@ -0,0 +1,479 @@
+"""CLI/Commands - create, retrieve, update or delete repository upstreams."""
+
+import json
+
+import click
+
+from ...core.api import upstreams as api
+from ...core.pagination import paginate_results
+from .. import command, decorators, utils, validators
+from ..exceptions import handle_api_exceptions
+from ..utils import (
+    fmt_bool,
+    fmt_datetime,
+    maybe_spinner,
+    maybe_truncate_list,
+    maybe_truncate_string,
+)
+from .main import main
+
+UPSTREAM_FORMATS = [
+    "alpine",
+    "cargo",
+    "conda",
+    "cran",
+    "dart",
+    "deb",
+    "docker",
+    "generic",
+    "go",
+    "helm",
+    "hex",
+    "huggingface",
+    "maven",
+    "npm",
+    "nuget",
+    "python",
+    "rpm",
+    "ruby",
+    "swift",
+]
+
+
+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):
+        row = [
+            click.style(u["name"], fg="cyan"),
+            click.style(maybe_truncate_string(u["upstream_url"]), fg="cyan"),
+            click.style(str(u["auth_mode"]), fg="yellow"),
+            click.style(
+                maybe_truncate_string(str(u["auth_secret"] or "")),
+                fg="yellow",
+            ),
+            click.style(str(u["auth_username"] or ""), fg="yellow"),
+            click.style(fmt_datetime(u["created_at"]), fg="blue"),
+            click.style(str(u["extra_header_1"] or ""), fg="yellow"),
+            click.style(str(u["extra_header_2"] or ""), fg="yellow"),
+            click.style(str(u["extra_value_1"] or ""), fg="yellow"),
+            click.style(str(u["extra_value_2"] or ""), fg="yellow"),
+            click.style(fmt_bool(u["is_active"]), fg="green"),
+            click.style(u["mode"], fg="green"),
+            click.style(str(u["priority"]), fg="green"),
+            click.style(u["slug_perm"], fg="green"),
+            click.style(fmt_datetime(u["updated_at"]), fg="blue"),
+            click.style(fmt_bool(u["verify_ssl"]), fg="green"),
+        ]
+
+        if upstream_fmt == "deb":
+            # `Component`, `Distribution Versions` and `Upstream Distribution` are deb-only
+            row.append(click.style(str(u.get("component", None)), fg="yellow"))
+            row.append(
+                click.style(
+                    str(maybe_truncate_list(u.get("distro_versions", []))),
+                    fg="yellow",
+                )
+            )
+            row.append(
+                click.style(str(u.get("upstream_distribution", None)), fg="yellow")
+            )
+
+        if upstream_fmt == "rpm":
+            # `Distribution Version` is rpm-only
+            row.append(click.style(str(u.get("distro_version", "")), fg="yellow"))
+
+        return row
+
+    headers = [
+        "Name",
+        "Upstream Url",
+        "Auth mode",
+        "Auth Secret",
+        "Auth Username",
+        "Created At",
+        "Extra Header 1",
+        "Extra Header 2",
+        "Extra Value 1",
+        "Extra Value 2",
+        "Active",
+        "Mode",
+        "Priority",
+        "Slug Perm",
+        "Updated At",
+        "Verify SSL",
+    ]
+
+    if upstream_fmt == "deb":
+        headers.append("Component")
+        headers.append("Distribution Versions")
+        headers.append("Upstream Distribution")
+
+    if upstream_fmt == "rpm":
+        headers.append("Distribution Version")
+
+    rows = [build_row(x) for x in upstreams]
+
+    click.echo()
+    utils.pretty_print_table(headers, rows)
+    click.echo()
+
+    num_results = len(upstreams)
+    list_suffix = "upstream%s" % ("" if num_results == 1 else "s")
+    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,
+    )
+
+
+@main.group(cls=command.AliasGroup, name="upstream", aliases=[])
+@decorators.common_cli_config_options
+@decorators.common_cli_output_options
+@decorators.common_api_auth_options
+@decorators.initialise_api
+@click.pass_context
+def upstream(*args, **kwargs):
+    """
+    Manage upstreams for a repository.
+
+    See the help for subcommands for more information on each.
+    """
+
+
+def build_upstream_group_func(upstream_fmt):
+    @decorators.common_cli_config_options
+    @decorators.common_cli_output_options
+    @decorators.common_api_auth_options
+    @decorators.initialise_api
+    @click.pass_context
+    def func(ctx, opts):
+        pass
+
+    func.__doc__ = (
+        """
+        Manage %s upstreams for a repository.
+
+        See the help for subcommands for more information on each.
+        """
+        % upstream_fmt
+    )
+    return func
+
+
+def build_upstream_list_command(upstream_fmt):
+    @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", metavar="OWNER/REPO", callback=validators.validate_owner_repo
+    )
+    @click.pass_context
+    def func(ctx, opts, owner_repo, page, page_size, page_all):
+        owner, repo = owner_repo
+
+        use_stderr = utils.should_use_stderr(opts)
+
+        if not use_stderr:
+            click.echo("Getting upstreams... ", nl=False, err=use_stderr)
+
+        context_msg = "Failed to get upstreams!"
+        with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+            with maybe_spinner(opts):
+                upstreams, page_info = paginate_results(
+                    api.list_upstreams,
+                    page_all,
+                    page,
+                    page_size,
+                    owner=owner,
+                    repo=repo,
+                    upstream_format=upstream_fmt,
+                )
+
+        if not use_stderr:
+            click.secho("OK", fg="green", err=use_stderr)
+
+        if utils.maybe_print_as_json(opts, upstreams, page_info):
+            return
+
+        print_upstreams(upstreams, upstream_fmt, page_info, page_all)
+
+    func.__doc__ = f"""
+        List {upstream_fmt} upstreams for a repository.
+
+        This requires appropriate permissions for the owner (a member of the organisation, repository privileges and a valid API key).
+
+        - OWNER/REPO: Specify the OWNER namespace (organization) and REPO (repository) to target a specific Cloudsmith repository.
+
+          Example: 'your-org/your-repo'
+
+        Full CLI example:
+
+          $ cloudsmith upstream {upstream_fmt} ls your-org/your-repo
+        """
+    return func
+
+
+def build_upstream_create_command(upstream_fmt):
+    @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
+    )
+    @click.argument("upstream_config_file", type=click.File("rb"), required=True)
+    @click.pass_context
+    def func(ctx, opts, owner_repo, upstream_config_file):
+        # Use stderr for messages if the output is something else (e.g. JSON)
+        use_stderr = opts.output != "pretty"
+
+        owner, repo = owner_repo
+
+        upstream_config = json.load(upstream_config_file)
+
+        upstream_name = upstream_config.get("name", None)
+
+        if upstream_name is None:
+            raise click.BadParameter(
+                "Name is a required field for creating an upstream.", param="name"
+            )
+
+        if not use_stderr:
+            click.secho(
+                'Creating "%(name)s" upstream for the %(owner)s/%(repo)s repository...'
+                % {
+                    "name": click.style(upstream_name, bold=True),
+                    "owner": click.style(owner, bold=True),
+                    "repo": click.style(repo, bold=True),
+                },
+                nl=False,
+                err=use_stderr,
+            )
+
+        context_msg = "Failed to create the upstream!"
+
+        with handle_api_exceptions(ctx, opts, context_msg=context_msg):
+            with maybe_spinner(opts):
+                upstream_resp_data = api.create_upstream(
+                    owner, repo, upstream_fmt, upstream_config
+                )
+
+        if not use_stderr:
+            click.secho("OK", fg="green", err=use_stderr)
+
+        if utils.maybe_print_as_json(opts, upstream_resp_data):
+            return
+
+        print_upstreams([upstream_resp_data], upstream_fmt)
+
+    func.__doc__ = f"""
+        Create a {upstream_fmt} upstream for a repository.
+
+        This requires appropriate permissions for the owner (a member of the organisation, repository privileges and a valid API key).
+
+        - OWNER/REPO: Specify the OWNER namespace (organization) and REPO (repository) to target a specific Cloudsmith repository.
+
+          Example: 'your-org/your-repo'
+
+        - UPSTREAM_CONFIG_FILE: Config json file specifying the settings for the upstream to be updated.
+
+          For a full list of supported config properties, please refer to the "body params" section of the api reference for the relevant endpoint at:
+
+          https://docs.cloudsmith.com/api/repos/upstream/{upstream_fmt}/create
+
+          \b
+          Example:
+            {{
+              "name": "Some Upstream",
+              "upstream_url": "https://someupstream.net",
+              "mode": "Proxy Only",
+              "auth_mode": "None",
+              "priority": 5,
+              ...
+            }}
+
+        Full CLI example:
+
+          $ cloudsmith upstream {upstream_fmt} create your-org/your-repo ./path/to/upstream-config.json
+        """
+
+    return func
+
+
+def build_upstream_update_command(upstream_fmt):
+    @decorators.common_cli_config_options
+    @decorators.common_cli_output_options
+    @decorators.common_api_auth_options
+    @decorators.initialise_api
+    @click.argument(
+        "owner_repo_slug_perm",
+        metavar="OWNER/REPO/SLUG_PERM",
+        callback=validators.validate_owner_repo_slug_perm,
+    )
+    @click.argument("upstream_config_file", type=click.File("rb"), required=True)
+    @click.pass_context
+    def func(ctx, opts, owner_repo_slug_perm, upstream_config_file):
+        # Use stderr for message if the output is something else (e.g. JSON)
+        use_stderr = opts.output != "pretty"
+
+        owner, repo, slug_perm = owner_repo_slug_perm
+
+        upstream_config = json.load(upstream_config_file)
+
+        if not use_stderr:
+            click.secho(
+                "Updating the %(slug_perm)s upstream from the %(owner)s/%(repo)s repository ... "
+                % {
+                    "owner": click.style(owner, bold=True),
+                    "repo": click.style(repo, bold=True),
+                    "slug_perm": click.style(slug_perm, bold=True),
+                },
+                nl=False,
+                err=use_stderr,
+            )
+
+        context_msg = "Failed to update the upstream!"
+        with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+            with maybe_spinner(opts):
+                upstream_resp_data = api.update_upstream(
+                    owner, repo, slug_perm, upstream_fmt, upstream_config
+                )
+
+        if not use_stderr:
+            click.secho("OK", fg="green", err=use_stderr)
+
+        if utils.maybe_print_as_json(opts, upstream_resp_data):
+            return
+
+        print_upstreams([upstream_resp_data], upstream_fmt)
+
+    func.__doc__ = f"""
+        Update a {upstream_fmt} upstream for a repository.
+
+        This requires appropriate permissions for the owner (a member of the organisation, repository privileges and a valid API key).
+
+        - OWNER/REPO/SLUG_PERM: Specify the OWNER namespace (organization), REPO (repository) and SLUG_PERM (upstream) to target a specific upstream belonging to a repo.
+
+          Example: 'your-org/your-repo/abcdefg'
+
+        - UPSTREAM_CONFIG_FILE: Config json file specifying the settings for the upstream to be updated.
+
+          For a full list of supported config properties, please refer to the "body params" section of the api reference for the relevant endpoint at:
+
+          https://docs.cloudsmith.com/api/repos/upstream/{upstream_fmt}/partial-update
+
+          \b
+          Example:
+            {{
+              "name": "Some Upstream",
+              "upstream_url": "https://someupstream.net",
+              "mode": "Proxy Only",
+              "auth_mode": "None",
+              "priority": 5,
+              ...
+            }}
+
+        Full CLI example:
+
+          $ cloudsmith upstream {upstream_fmt} update your-org/your-repo/abcdefg ./path/to/upstream-config.json
+        """
+
+    return func
+
+
+def build_upstream_delete_command(upstream_fmt):
+    @decorators.common_cli_config_options
+    @decorators.common_cli_output_options
+    @decorators.common_api_auth_options
+    @decorators.initialise_api
+    @click.argument(
+        "owner_repo_slug_perm",
+        metavar="OWNER/REPO/SLUG_PERM",
+        callback=validators.validate_owner_repo_slug_perm,
+    )
+    @click.option(
+        "-y",
+        "--yes",
+        default=False,
+        is_flag=True,
+        help="Assume yes as default answer to questions (this is dangerous!)",
+    )
+    @click.pass_context
+    def func(ctx, opts, owner_repo_slug_perm, yes):
+        # Use stderr for message if the output is something else (e.g. JSON)
+        use_stderr = opts.output != "pretty"
+
+        owner, repo, slug_perm = owner_repo_slug_perm
+
+        delete_args = {
+            "owner": click.style(owner, bold=True),
+            "repo": click.style(repo, bold=True),
+            "slug_perm": click.style(slug_perm, bold=True),
+        }
+
+        prompt = (
+            "delete the %(slug_perm)s upstream from the %(owner)s/%(repo)s repository"
+            % delete_args
+        )
+        if not utils.confirm_operation(prompt, assume_yes=yes, err=use_stderr):
+            return
+
+        if not use_stderr:
+            click.secho(
+                "Deleting the %(slug_perm)s upstream from the %(owner)s/%(repo)s repository ... "
+                % delete_args,
+                nl=False,
+                err=use_stderr,
+            )
+
+        context_msg = "Failed to delete the upstream!"
+        with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+            with maybe_spinner(opts):
+                api.delete_upstream(owner, repo, upstream_fmt, slug_perm)
+
+        if not use_stderr:
+            click.secho("OK", fg="green", err=use_stderr)
+
+    func.__doc__ = f"""
+        Delete a {upstream_fmt} upstream for a repository.
+
+        This requires appropriate permissions for the owner (a member of the organisation, repository privileges and a valid API key).
+
+        - OWNER/REPO/SLUG_PERM: Specify the OWNER namespace (organization), REPO (repository) and SLUG_PERM (upstream) to target a specific upstream belonging to a repo.
+
+          Example: 'your-org/your-repo/abcdefg'
+
+        Full CLI example:
+
+          $ cloudsmith upstream {upstream_fmt} delete your-org/your-repo/abcdefg
+        """
+
+    return func
+
+
+for upstream_format in UPSTREAM_FORMATS:
+    # Build a click group for the upstream name e.g. dart, npm, ruby.
+    # Add it to the "upstream" parent group.
+    # This gives us e.g. `cloudsmith upstream dart` in the cli.
+    upstream_group = upstream.group(
+        cls=command.AliasGroup, name=upstream_format, aliases=[]
+    )(build_upstream_group_func(upstream_format))
+
+    # Add create/list/update/delete commands to the child group we created above.
+    # This gives us e.g. `cloudsmith upstream dart ls`.
+    upstream_group.command(name="list", aliases=["ls"])(
+        build_upstream_list_command(upstream_format)
+    )
+    upstream_group.command(name="create", aliases=["new"])(
+        build_upstream_create_command(upstream_format)
+    )
+    upstream_group.command(name="delete", aliases=["rm"])(
+        build_upstream_delete_command(upstream_format)
+    )
+    upstream_group.command(name="update")(
+        build_upstream_update_command(upstream_format)
+    )

cloudsmith_cli/cli/commands/vulnerabilities.py

@@ -0,0 +1,141 @@
+"""CLI/Commands - Vulnerabilities."""
+
+import click
+
+from ...core.api.vulnerabilities import (
+    _print_vulnerabilities_assessment_table,
+    _print_vulnerabilities_summary_table,
+    get_package_scan_result,
+)
+from .. import decorators, utils, validators
+from ..exceptions import handle_api_exceptions
+from .main import main
+
+
+@main.command()
+@decorators.common_cli_config_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.option(
+    "-A",
+    "--show-assessment",
+    is_flag=True,
+    help="Show assessment with vulnerability details.",
+)
+@click.option(
+    "--fixable/--non-fixable",
+    is_flag=True,
+    default=None,  # Changed to allow None (Show All) vs True/False
+    help="Filter by fixable status (only fixable vs only non-fixable).",
+)
+@click.option(
+    "--severity",
+    "severity_filter",
+    help="Filter by severities (e.g., 'CRITICAL', 'HIGH', 'MEDIUM', 'LOW').",
+)
+@click.pass_context
+def vulnerabilities(
+    ctx, opts, owner_repo_package, show_assessment, fixable, severity_filter
+):
+    """
+    Retrieve vulnerability scan results for a package.
+
+    \b
+    Usage:
+        cloudsmith vulnerabilities myorg/repo/pkg_identifier [flags]
+
+    \b
+    Aliases:
+        vulnerabilities, vuln
+
+    Examples:
+
+    \b
+    # Display the vulnerability summary
+    cloudsmith vulnerabilities myorg/repo/pkg_identifier
+
+    \b
+    # Display detailed vulnerability assessment
+    cloudsmith vulnerabilities myorg/repo/pkg_identifier -A / --show-assessment
+
+    \b
+    # Filter the result by severity
+    cloudsmith vulnerabilities myorg/repo/pkg_identifier --severity critical,high
+
+    \b
+    # Filter by fixable or non-fixable vulnerabilities
+    cloudsmith vulnerabilities myorg/repo/pkg_identifier --fixable / --non-fixable
+
+
+    """
+    use_stderr = utils.should_use_stderr(opts)
+
+    owner, repo, slug = owner_repo_package
+
+    total_filtered_vulns = 0
+
+    context_msg = "Failed to retrieve vulnerability report!"
+    with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
+        with utils.maybe_spinner(opts):
+            data = get_package_scan_result(
+                opts=opts,
+                owner=owner,
+                repo=repo,
+                package=slug,
+                show_assessment=show_assessment,
+                severity_filter=severity_filter,
+                fixable=fixable,
+            )
+
+    click.secho("OK", fg="green", err=use_stderr)
+
+    # Filter results if severity or fixable flags are active
+    if severity_filter or fixable is not None:
+        scans = getattr(data, "scans", [])
+
+        allowed_severities = (
+            [s.strip().lower() for s in severity_filter.split(",")]
+            if severity_filter
+            else None
+        )
+
+        for scan in scans:
+            results = getattr(scan, "results", [])
+
+            # 1. Filter by Severity
+            if allowed_severities:
+                results = [
+                    res
+                    for res in results
+                    if getattr(res, "severity", "unknown").lower() in allowed_severities
+                ]
+
+            # 2. Filter by Fixable Status
+            # fixable=True: Keep only if has fix_version
+            # fixable=False: Keep only if NO fix_version
+            if fixable is not None:
+                results = [
+                    res
+                    for res in results
+                    if bool(
+                        getattr(res, "fix_version", getattr(res, "fixed_version", None))
+                    )
+                    is fixable
+                ]
+
+            scan.results = results
+            total_filtered_vulns += len(results)
+
+    if utils.maybe_print_as_json(opts, data):
+        return
+
+    _print_vulnerabilities_summary_table(data, severity_filter, total_filtered_vulns)
+
+    if show_assessment:
+        _print_vulnerabilities_assessment_table(data, severity_filter)