Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/1391.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added `blocklist` subcommand group to `pulp python repository` for managing blocklist entries (add, list, remove, show).
1 change: 1 addition & 0 deletions CHANGES/pulp-glue/1391.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added `PulpPythonRepositoryBlocklistEntryContext` for `pulp_python>=3.29.0`.
23 changes: 23 additions & 0 deletions pulp-glue/src/pulp_glue/python/context.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
EntityDefinition,
PluginRequirement,
PulpContentContext,
PulpContext,
PulpDistributionContext,
PulpEntityContext,
PulpPublicationContext,
PulpRemoteContext,
PulpRepositoryContext,
Expand Down Expand Up @@ -165,3 +167,24 @@ def preprocess_entity(self, body: EntityDefinition, partial: bool = False) -> En
def repair_metadata(self) -> t.Any:
self.needs_capability("repair_metadata")
return self.call("repair_metadata", parameters={self.HREF: self.pulp_href})


class PulpPythonRepositoryBlocklistEntryContext(PulpEntityContext):
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
class PulpPythonRepositoryBlocklistEntryContext(PulpEntityContext):
class PulpPythonBlocklistEntryContext(PulpEntityContext):

I don't think the "repository" in there adds any information or helps distinguishing things.

ENTITY = _("blocklist entry")
ENTITIES = _("blocklist entries")
HREF = "python_python_python_blocklist_entry_href"
ID_PREFIX = "repositories_python_python_blocklist_entries"
NEEDS_PLUGINS = [PluginRequirement("python", specifier=">=3.29.0")]
repository_ctx: PulpPythonRepositoryContext

def __init__(
self,
pulp_ctx: PulpContext,
repository_ctx: PulpPythonRepositoryContext,
) -> None:
super().__init__(pulp_ctx)
self.repository_ctx = repository_ctx

@property
def scope(self) -> dict[str, t.Any]:
return {self.repository_ctx.HREF: self.repository_ctx.pulp_href}
71 changes: 71 additions & 0 deletions src/pulpcore/cli/python/repository.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from pulp_glue.common.context import (
EntityFieldDefinition,
PluginRequirement,
PulpEntityContext,
PulpRemoteContext,
PulpRepositoryContext,
)
Expand All @@ -14,6 +15,7 @@
PulpPythonContentContext,
PulpPythonProvenanceContext,
PulpPythonRemoteContext,
PulpPythonRepositoryBlocklistEntryContext,
PulpPythonRepositoryContext,
)

Expand All @@ -28,6 +30,7 @@
list_command,
lookup_callback,
name_option,
pass_entity_context,
pass_pulp_context,
pass_repository_context,
pulp_group,
Expand Down Expand Up @@ -152,6 +155,74 @@ def repository() -> None:
)


@repository.group(needs_plugins=[PluginRequirement("python", specifier=">=3.29.0")])
@pass_repository_context
@pass_pulp_context
@click.pass_context
def blocklist(
ctx: click.Context,
pulp_ctx: PulpCLIContext,
repository_ctx: PulpRepositoryContext,
/,
) -> None:
"""
Manage blocklist entries for a Python repository.
"""
assert isinstance(repository_ctx, PulpPythonRepositoryContext)
ctx.obj = PulpPythonRepositoryBlocklistEntryContext(pulp_ctx, repository_ctx)


blocklist.add_command(list_command(decorators=nested_lookup_options))
blocklist.add_command(show_command(decorators=nested_lookup_options + [href_option]))
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't look right. How do you identify a blocklist on a repository?

Can a repository have more than one blocklist?

blocklist.add_command(
destroy_command(name="remove", decorators=nested_lookup_options + [href_option])
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also looks like suboptimal ux.
You should be able to remove entries on the blocklist by specifying the name and version IMO.

)


@blocklist.command(name="add")
@repository_href_option
@repository_lookup_option
@click.option(
"--name",
"pkg_name",
default=None,
help=_("Package name to block. Required when 'filename' is not provided."),
)
@click.option(
"--version",
"pkg_version",
default=None,
help=_("Exact version to block. Only used when 'name' is set."),
)
@click.option(
"--filename",
"pkg_filename",
default=None,
help=_("Exact filename to block. Required when 'name' is not provided."),
)
@pass_entity_context
@pass_pulp_context
def blocklist_add(
pulp_ctx: PulpCLIContext,
entity_ctx: PulpEntityContext,
/,
pkg_name: str | None,
pkg_version: str | None,
pkg_filename: str | None,
) -> None:
"""Add a blocklist entry to the repository."""
assert isinstance(entity_ctx, PulpPythonRepositoryBlocklistEntryContext)
body: dict[str, t.Any] = {}
if pkg_name:
body["name"] = pkg_name
if pkg_version:
body["version"] = pkg_version
if pkg_filename:
body["filename"] = pkg_filename
result = entity_ctx.create(body=body)
pulp_ctx.output_result(result)


@repository.command()
@name_option
@href_option
Expand Down
36 changes: 36 additions & 0 deletions tests/scripts/pulp_python/test_blocklist.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
#!/bin/bash

set -eu
# shellcheck source=tests/scripts/config.source
. "$(dirname "$(dirname "$(realpath "$0")")")"/config.source

pulp debug has-plugin --name "python" --specifier ">=3.29.0" || exit 23

cleanup() {
pulp python repository destroy --name "cli_test_python_blocklist" || true
}
trap cleanup EXIT

expect_succ pulp python repository create --name "cli_test_python_blocklist"

# Test adding a blocklist entry by package name + version
expect_succ pulp python repository blocklist add --repository "cli_test_python_blocklist" --name "pkg" --version "1.0"
test "$(echo "$OUTPUT" | jq -r '.name')" = "pkg"
test "$(echo "$OUTPUT" | jq -r '.version')" = "1.0"
test "$(echo "$OUTPUT" | jq -r '.filename')" = "null"
ENTRY_HREF="$(echo "$OUTPUT" | jq -r '.pulp_href')"

# Test listing blocklist entries
expect_succ pulp python repository blocklist list --repository "cli_test_python_blocklist"
expect_succ test "$(echo "$OUTPUT" | jq -r '.|length')" = "1"

# Test showing a specific blocklist entry
expect_succ pulp python repository blocklist show --repository "cli_test_python_blocklist" --href "$ENTRY_HREF"
expect_succ test "$(echo "$OUTPUT" | jq -r '.name')" = "pkg"

# Test removing a blocklist entry
expect_succ pulp python repository blocklist remove --repository "cli_test_python_blocklist" --href "$ENTRY_HREF"
expect_succ pulp python repository blocklist list --repository "cli_test_python_blocklist"
expect_succ test "$(echo "$OUTPUT" | jq -r '.|length')" = "0"

expect_succ pulp python repository destroy --name "cli_test_python_blocklist"
Loading