feat: add edit-registries command

snapcraft/cli.py

@@ -143,6 +143,7 @@
     craft_cli.CommandGroup(
         "Store Registries",
         [
+            commands.StoreEditRegistriesCommand,
             commands.StoreListRegistriesCommand,
         ],
     ),

snapcraft/commands/__init__.py

@@ -52,7 +52,7 @@
     StoreRegisterCommand,
 )
 from .plugins import ListPluginsCommand, PluginsCommand
-from .registries import StoreListRegistriesCommand
+from .registries import StoreEditRegistriesCommand, StoreListRegistriesCommand
 from .remote import RemoteBuildCommand
 from .status import (
     StoreListRevisionsCommand,
@@ -77,6 +77,7 @@
     "SnapCommand",
     "StoreCloseCommand",
     "StoreEditValidationSetsCommand",
+    "StoreEditRegistriesCommand",
     "StoreExportLoginCommand",
     "StoreLegacyCreateKeyCommand",
     "StoreLegacyGatedCommand",

snapcraft/commands/registries.py

@@ -69,3 +69,41 @@ def run(self, parsed_args: "argparse.Namespace"):
             name=parsed_args.name,
             output_format=parsed_args.format,
         )
+
+
+class StoreEditRegistriesCommand(craft_application.commands.AppCommand):
+    """Edit a registries set."""
+
+    name = "edit-registries"
+    help_msg = "Edit registries"
+    overview = textwrap.dedent(
+        """
+        Edit a registries set.
+
+        If the registries set does not exist, then a new registries set will be created.
+
+        The account ID of the authenticated account can be determined with the
+        ``snapcraft whoami`` command.
+
+        Use the ``list-registries`` command to view existing registries.
+        """
+    )
+    _services: services.SnapcraftServiceFactory  # type: ignore[reportIncompatibleVariableOverride]
+
+    @override
+    def fill_parser(self, parser: "argparse.ArgumentParser") -> None:
+        parser.add_argument(
+            "account_id",
+            metavar="account-id",
+            help="The account ID of the registries set to edit",
+        )
+        parser.add_argument(
+            "name", metavar="name", help="Name of the registries set to edit"
+        )
+
+    @override
+    def run(self, parsed_args: "argparse.Namespace"):
+        self._services.registries.edit_assertion(
+            name=parsed_args.name,
+            account_id=parsed_args.account_id,
+        )

snapcraft/models/__init__.py

@@ -15,7 +15,13 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Data models for snapcraft."""
 
-from .assertions import Assertion, RegistryAssertion
+from .assertions import (
+    Assertion,
+    EditableAssertion,
+    EditableRegistryAssertion,
+    Registry,
+    RegistryAssertion,
+)
 from .manifest import Manifest
 from .project import (
     MANDATORY_ADOPTABLE_FIELDS,
@@ -43,12 +49,15 @@
     "Component",
     "ComponentProject",
     "ContentPlug",
+    "EditableAssertion",
+    "EditableRegistryAssertion",
     "GrammarAwareProject",
     "Hook",
     "Lint",
     "Manifest",
     "Platform",
     "Project",
+    "Registry",
     "RegistryAssertion",
     "SnapcraftBuildPlanner",
     "Socket",

snapcraft/models/assertions.py

@@ -14,29 +14,81 @@
 #  You should have received a copy of the GNU Lesser General Public License
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Models for assertion sets."""
+"""Assertion models."""
 
-from typing import Any, Literal
+from typing import Literal
 
 from craft_application import models
+from typing_extensions import Self
 
 
-class RegistryAssertion(models.CraftBaseModel):
-    """Data model for a registry assertion."""
+class Registry(models.CraftBaseModel):
+    """Access and data definitions for a specific facet of a snap or system."""
+
+    request: str | None = None
+    """Optional dot-separated path to access the field."""
+
+    storage: str
+    """Dot-separated storage path."""
+
+    access: Literal["read", "write", "read-write"] | None = None
+    """Access permissions for the field."""
+
+    content: list[Self] | None = None
+    """Optional nested rules."""
+
+
+class Rules(models.CraftBaseModel):
+    """A list of registries for a particular view."""
+
+    rules: list[Registry]
+
+
+class EditableRegistryAssertion(models.CraftBaseModel):
+    """Subset of a registries assertion that can be edited by the user."""
 
     account_id: str
-    authority_id: str
-    body: dict[str, Any] | str | None = None
-    body_length: str | None = None
+    """Issuer of the registry assertion and owner of the signing key."""
+
     name: str
-    revision: int = 0
-    sign_key_sha3_384: str | None = None
     summary: str | None = None
-    timestamp: str
+    revision: int | None = 0
+
+    views: dict[str, Rules]
+    """A map of logical views of how the storage is accessed."""
+
+    body: str | None = None
+    """A JSON schema that defines the storage structure."""
+
+
+class RegistryAssertion(EditableRegistryAssertion):
+    """A full registries assertion containing editable and non-editable fields."""
+
     type: Literal["registry"]
-    views: dict[str, Any]
+
+    authority_id: str
+    """Issuer of the registry assertion and owner of the signing key."""
+
+    timestamp: str
+    """Timestamp of when the assertion was issued."""
+
+    body_length: str | None = None
+    """Length of the body field."""
+
+    sign_key_sha3_384: str | None = None
+    """Signing key ID."""
+
+
+class RegistriesList(models.CraftBaseModel):
+    """A list of registry assertions."""
+
+    registry_list: list[RegistryAssertion] = []
 
 
 # this will be a union for validation sets and registries once
 # validation sets are migrated from the legacy codebase
 Assertion = RegistryAssertion
+
+# this will be a union for editable validation sets and editable registries once
+# validation sets are migrated from the legacy codebase
+EditableAssertion = EditableRegistryAssertion

snapcraft/services/__init__.py

@@ -16,20 +16,20 @@
 
 """Snapcraft services."""
 
-from snapcraft.services.assertions import AssertionService
+from snapcraft.services.assertions import Assertion
 from snapcraft.services.lifecycle import Lifecycle
 from snapcraft.services.package import Package
 from snapcraft.services.provider import Provider
-from snapcraft.services.registries import RegistriesService
+from snapcraft.services.registries import Registries
 from snapcraft.services.remotebuild import RemoteBuild
 from snapcraft.services.service_factory import SnapcraftServiceFactory
 
 __all__ = [
-    "AssertionService",
+    "Assertion",
     "Lifecycle",
     "Package",
     "Provider",
-    "RegistriesService",
+    "Registries",
     "RemoteBuild",
     "SnapcraftServiceFactory",
 ]