Added optional signing_key_name to msg signer messages

Signed-off-by: Jindrich Luza <[email protected]>

Author: midnightercz

src/pubtools/sign/clients/msg.py

@@ -30,9 +30,8 @@ def on_error(self, event: proton.Event, source: Any = None) -> bool:
             return False
         self.errors.append(
             MsgError(
-                name=event,
-                description=getattr(source, "condition", None)
-                or getattr(source, "remote_condition", None),
+                name=condition.name,
+                description=condition.description,
                 source=source,
             )
         )

src/pubtools/sign/clients/msg_recv_client.py

@@ -2,7 +2,7 @@
 import json
 import logging
 import threading
-from typing import Any, List, Dict, Union
+from typing import Any, List, Dict, Union, cast
 
 from ..models.msg import MsgError
 
@@ -92,14 +92,15 @@ def on_message(self, event: proton.Event) -> None:
             self.recv[msg_id] = (outer_message, headers)
             self.recv_in_time = True
             self.last_message_received = datetime.datetime.now()
-            self.accept(event.delivery)
         else:
             LOG.debug(self._format_log_msg(f"RECEIVER: Ignored message {msg_id}", event=event))
 
         if self.recv_ids.values() and all(self.recv_ids.values()):
             self.timer_task.cancel()
-            event.receiver.close()
-            event.connection.close()
+            if event.receiver:
+                event.receiver.close()
+            if event.connection:
+                event.connection.close()
             LOG.info(self._format_log_msg("RECEIVER:All messages received", event=event))
 
     def on_timer_task(self, event: proton.Event) -> None:
@@ -237,7 +238,7 @@ def get_received(self) -> Dict[Any, Any]:
         """
         return self.recv  # pragma: no cover
 
-    def run(self) -> Union[Dict[Any, Any], List[MsgError]]:
+    def run(self) -> Union[Dict[Any, Any], List[MsgError]]:  # type: ignore[override]
         """Run the receiver."""
         LOG.info("Running messaging receiver")
         if not len(self.message_ids):
@@ -252,7 +253,7 @@ def close(self) -> None:
         """Close receiver."""
         LOG.info("Closing messaging receiver")
         if self._handler:
-            self._handler.close()
+            cast(_RecvClient, self._handler).close()
 
 
 class RecvThread(threading.Thread):

src/pubtools/sign/clients/msg_send_client.py

@@ -50,12 +50,12 @@ def on_start(self, event: proton.Event) -> None:
         )
 
     def on_connection_opened(self, event: proton.Event) -> None:
-        event.container.connected = True
-        self.sender = event.container.create_sender(event.connection)
+        if event.connection:
+            self.sender = event.container.create_sender(event.connection)
 
     @tw.instrument_func()
     def on_sendable(self, event: proton.Event) -> None:
-        if event.sender.credit and self.sent < self.total:
+        if event.sender and event.sender.credit and self.sent < self.total:
             message = self.messages[self.sent]
             # Inject trace context to message properties
             propagator.inject(carrier=message.headers)
@@ -66,21 +66,23 @@ def on_sendable(self, event: proton.Event) -> None:
                     f"{json.dumps(message.headers)}",
                 )
             )
-            event.sender.send(
-                proton.Message(
-                    properties=message.headers,
-                    address=message.address,
-                    body=json.dumps(message.body),
+            if event.sender:
+                event.sender.send(
+                    proton.Message(
+                        properties=message.headers,
+                        address=message.address,
+                        body=json.dumps(message.body),
+                    )
                 )
-            )
             self.sent += 1
 
     def on_accepted(self, event: proton.Event) -> None:
         # LOG.info("Sender accepted")
         self.confirmed += 1
         if self.confirmed == self.total:
             LOG.info("SENDER: closing")
-            event.connection.close()
+            if event.connection:
+                event.connection.close()
             self.sender.close()
 
     def on_disconnected(self, event: proton.Event) -> None:  # pragma: no cover
@@ -138,7 +140,7 @@ def __init__(
         self._errors = errors
         super().__init__(self.handler, **kwargs)
 
-    def run(self) -> List[MsgError]:
+    def run(self) -> List[MsgError]:  # type: ignore[override]
         """Run the SendClient."""
         errors_len = 0
         if not len(self.messages):

src/pubtools/sign/operations/base.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, abstractmethod
 
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import ClassVar, Dict, Any, Type
 from typing_extensions import Self
 
@@ -15,6 +15,13 @@ class SignOperation(ABC):
 
     ResultType: ClassVar[OperationResult]
     signing_key: str
+    signing_key_name: str = field(
+        default="",
+        metadata={
+            "description": "Signing key name which should be used for signing",
+            "sample": "key1",
+        },
+    )
 
     @classmethod
     def doc_arguments(cls: Type[Self]) -> Dict[str, Any]:

src/pubtools/sign/operations/clearsign.py

@@ -20,31 +20,35 @@ class ClearSignOperation(SignOperation):
             "description": "Signing data",
             "required": "true",
             "sample": ["input1", "input2"],
-        }
+        },
+        default_factory=list,
     )
     signing_key: str = field(
         metadata={
             "type": "str",
             "description": "Signing key short id which should be used for signing",
             "required": "true",
             "sample": "123",
-        }
+        },
+        default="",
     )
     task_id: str = field(
         metadata={
             "type": "str",
             "description": "Usually pub task id, serves as identifier for in signing request",
             "required": "true",
             "sample": "1",
-        }
+        },
+        default="",
     )
     repo: str = field(
         metadata={
             "type": "str",
             "description": "Repository name",
             "required": "true",
             "sample": "repo",
-        }
+        },
+        default="",
     )
     requester: str = field(
         metadata={"description": "Requester of the signing operation"}, default=""

src/pubtools/sign/operations/containersign.py

@@ -14,13 +14,21 @@ class ContainerSignOperation(SignOperation):
     """ContainersSignOperation model class."""
 
     ResultType: ClassVar[OperationResult]
-    digests: List[str] = field(metadata={"description": "List of digest to sign"})
-    references: List[str] = field(metadata={"description": "List of references to sign"})
+    digests: List[str] = field(
+        metadata={"description": "List of digest to sign"}, default_factory=list
+    )
+    references: List[str] = field(
+        metadata={"description": "List of references to sign"}, default_factory=list
+    )
     signing_key: str = field(
-        metadata={"description": "Signing key short id which should be used for signing"}
+        metadata={"description": "Signing key short id which should be used for signing"},
+        default="",
     )
     task_id: str = field(
-        metadata={"description": "Usually pub task id, serves as identifier for in signing request"}
+        metadata={
+            "description": "Usually pub task id, serves as identifier for in signing request"
+        },
+        default="",
     )
     identity_references: List[str] = field(
         metadata={"description": "List of references to sign"}, default_factory=list
@@ -34,6 +42,7 @@ def to_dict(self) -> dict[str, Any]:
         return dict(
             digests=self.digests,
             references=self.references,
+            signing_key_name=self.signing_key_name,
             signing_key=self.signing_key,
             task_id=self.task_id,
             requester=self.requester,

src/pubtools/sign/signers/msgsigner.py

@@ -36,6 +36,7 @@
 
 
 LOG = logging.getLogger("pubtools.sign.signers.msgsigner")
+LOG.setLevel(logging.INFO)
 
 
 class SignRequestType(str, enum.Enum):
@@ -169,6 +170,7 @@ def _construct_signing_message(
         claim: str,
         signing_key: str,
         repo: str,
+        signing_key_name: str = "",
         extra_attrs: Optional[Dict[str, Any]] = None,
         sig_type: str = SignRequestType.CONTAINER,
     ) -> dict[str, Any]:
@@ -182,6 +184,8 @@ def _construct_signing_message(
             "requested_by": self.creator,
             "repo": repo,
         }
+        if signing_key_name:
+            message["sig_keyname"] = signing_key_name
         message.update(_extra_attrs)
         return message
 
@@ -217,6 +221,7 @@ def _create_msg_message(
                 data,
                 signing_key,
                 repo,
+                signing_key_name=operation.signing_key_name,
                 extra_attrs=extra_attrs,
                 sig_type=sig_type.value,
             ),
@@ -625,6 +630,7 @@ def msg_clear_sign(
 
 def msg_container_sign(
     signing_key: str = "",
+    signing_key_name: str = "",
     task_id: str = "",
     config_file: str = "",
     digest: list[str] = [],
@@ -642,6 +648,7 @@ def msg_container_sign(
         digests=digest,
         references=reference,
         signing_key=signing_key,
+        signing_key_name=signing_key_name,
         task_id=task_id,
         requester=requester,
     )
@@ -727,6 +734,11 @@ def msg_clear_sign_main(
     required=True,
     help="8 characters key fingerprint of key which should be used for signing",
 )
+@click.option(
+    "--signing-key-name",
+    required=False,
+    help="signing key name",
+)
 @click.option("--task-id", required=True, help="Task id identifier (usually pub task-id)")
 @click.option("--config-file", default=CONFIG_PATHS[0], help="path to the config file")
 @click.option(
@@ -759,6 +771,7 @@ def msg_clear_sign_main(
 )
 def msg_container_sign_main(
     signing_key: str = "",
+    signing_key_name: str = "",
     task_id: str = "",
     config_file: str = "",
     digest: List[str] = [],
@@ -775,6 +788,7 @@ def msg_container_sign_main(
 
     ret = msg_container_sign(
         signing_key=signing_key,
+        signing_key_name=signing_key_name,
         task_id=task_id,
         config_file=config_file,
         digest=digest,

tests/test_msg_handle.py

@@ -14,15 +14,21 @@ def test_msg_handler_errors():
     msgsc = _MsgClient(errors)
     msgsc.on_link_error(mock_error)
     assert errors == [
-        MsgError(name=mock_error, description=mock_error.link.condition, source=mock_error.link)
+        MsgError(
+            name=mock_error.link.condition.name,
+            description=mock_error.link.condition.description,
+            source=mock_error.link,
+        )
     ]
 
     errors = []
     msgsc = _MsgClient(errors)
     msgsc.on_session_error(mock_error)
     assert errors == [
         MsgError(
-            name=mock_error, description=mock_error.session.condition, source=mock_error.session
+            name=mock_error.session.condition.name,
+            description=mock_error.session.condition.description,
+            source=mock_error.session,
         )
     ]
 
@@ -31,8 +37,8 @@ def test_msg_handler_errors():
     msgsc.on_connection_error(mock_error)
     assert errors == [
         MsgError(
-            name=mock_error,
-            description=mock_error.connection.condition,
+            name=mock_error.connection.condition.name,
+            description=mock_error.connection.condition.description,
             source=mock_error.connection,
         )
     ]

tests/test_msg_send_client.py

@@ -123,6 +123,8 @@ def test_non_ingored_error(
     msgsc.on_transport_error(mock_error)
     assert errors == [
         MsgError(
-            name=mock_error, description=mock_error.transport.condition, source=mock_error.transport
+            name="amqp:simulated-error",
+            description="",
+            source=mock_error.transport,
         )
     ]