Added task_id_attribute configuration option

To support different 'task_id' attributes for various consumers
it has to be configurable.

Author: midnightercz

src/pubtools/sign/conf/conf.py

@@ -22,6 +22,7 @@ class MsgSignerSchema(ma.Schema):
     message_id_key = ma.fields.String(required=True)
     log_level = ma.fields.String(required=False)
     key_aliases = ma.fields.Dict(required=False, keys=ma.fields.String(), values=ma.fields.String())
+    task_id_attribute = ma.fields.String(required=False)
 
 
 class MsgBatchSignerSchema(MsgSignerSchema):

src/pubtools/sign/signers/msgsigner.py

@@ -158,6 +158,14 @@ class MsgSigner(Signer):
     )
 
     log_level: str = field(init=False, metadata={"description": "Log level", "sample": "debug"})
+    task_id_attribute: str = field(
+        init=False,
+        default="pub_task_id",
+        metadata={
+            "description": "Attribute used to custom identification of signing request",
+            "sample": "task_id",
+        },
+    )
 
     SUPPORTED_OPERATIONS: ClassVar[List[Type[SignOperation]]] = [
         ContainerSignOperation,
@@ -268,6 +276,7 @@ def load_config(self: MsgSigner, config_data: Dict[str, Any]) -> None:
         self.timeout = config_data["msg_signer"]["timeout"]
         self.creator = self._get_cert_subject_cn()
         self.key_aliases = config_data["msg_signer"].get("key_aliases", {})
+        self.task_id_attribute = config_data["msg_signer"].get("task_id_attribute", "pub_task_id")
 
     def _get_cert_subject_cn(self) -> str:
         x509 = crypto.load_certificate(
@@ -402,7 +411,7 @@ def clear_sign(self: MsgSigner, operation: ClearSignOperation) -> SigningResults
                 operation.repo,
                 operation,
                 SignRequestType.CLEARSIGN,
-                extra_attrs={"pub_task_id": operation.task_id},
+                extra_attrs={self.task_id_attribute: operation.task_id},
             )
             for message in _key_messages:
                 message_to_data[message.body["request_id"]] = message
@@ -478,7 +487,10 @@ def _prepare_messages(self, operation: ContainerSignOperation) -> List[List[MsgM
                         SignRequestType.CONTAINER,
                     ],
                     kwargs={
-                        "extra_attrs": {"pub_task_id": operation.task_id, "manifest_digest": digest}
+                        "extra_attrs": {
+                            self.task_id_attribute: operation.task_id,
+                            "manifest_digest": digest,
+                        }
                     },
                 )
             )
@@ -571,7 +583,7 @@ def blob_sign(self: MsgSigner, operation: BlobSignOperation) -> SigningResults:
                 "",
                 operation,
                 SignRequestType.GPGSIGN,
-                extra_attrs={"pub_task_id": operation.task_id, "manifest_digest": ""},
+                extra_attrs={self.task_id_attribute: operation.task_id},
             )
             for message in _key_messages:
                 message_to_data[message.body["request_id"]] = message
@@ -776,6 +788,9 @@ def load_config(self: Self, config_data: Dict[str, Any]) -> None:
         self.creator = self._get_cert_subject_cn()
         self.key_aliases = config_data["msg_batch_signer"].get("key_aliases", {})
         self.chunk_size = config_data["msg_batch_signer"]["chunk_size"]
+        self.task_id_attribute = config_data["msg_batch_signer"].get(
+            "task_id_attribute", "pub_task_id"
+        )
 
 
 def msg_clear_sign(

tests/test_msg_batch_signer.py

@@ -777,6 +777,9 @@ def test_msgsig_doc_arguments():
             "creator": {"description": "Identification of creator of signing request"},
             "environment": {"description": "Environment indetification in sent messages"},
             "service": {"description": "Service identificator"},
+            "task_id_attribute": {
+                "description": "Attribute used to custom identification of signing request"
+            },
             "timeout": {"description": "Timeout for messaging receive"},
             "retries": {"description": "Retries for messaging receive"},
             "send_retries": {"description": "Retries for messaging send+receive"},
@@ -797,6 +800,7 @@ def test_msgsig_doc_arguments():
                 "creator": "pubtools-sign",
                 "environment": "prod",
                 "service": "pubtools-sign",
+                "task_id_attribute": "task_id",
                 "timeout": 1,
                 "retries": 3,
                 "send_retries": 2,

tests/test_msg_signer.py

@@ -1276,6 +1276,9 @@ def test_msgsig_doc_arguments():
             "creator": {"description": "Identification of creator of signing request"},
             "environment": {"description": "Environment indetification in sent messages"},
             "service": {"description": "Service identificator"},
+            "task_id_attribute": {
+                "description": "Attribute used to custom identification of signing request"
+            },
             "timeout": {"description": "Timeout for messaging receive"},
             "retries": {"description": "Retries for messaging receive"},
             "send_retries": {"description": "Retries for messaging send+receive"},
@@ -1296,6 +1299,7 @@ def test_msgsig_doc_arguments():
                 "creator": "pubtools-sign",
                 "environment": "prod",
                 "service": "pubtools-sign",
+                "task_id_attribute": "task_id",
                 "timeout": 1,
                 "retries": 3,
                 "send_retries": 2,