chore: Update code base for polarion-rest-api-client v1.2.0

capella2polarion/connectors/polarion_worker.py

@@ -174,6 +174,7 @@ def create_missing_work_items(
             if work_item.uuid_capella in self.polarion_data_repo:
                 continue
 
+            work_item.calculate_checksum()
             missing_work_items.append(work_item)
             logger.info("Create work item for %r...", work_item.title)
         if missing_work_items:
@@ -196,7 +197,7 @@ def compare_and_update_work_item(
         assert old.id is not None
 
         new.calculate_checksum()
-        if not self.force_update and new == old:
+        if not self.force_update and new.checksum == old.checksum:
             return
 
         log_args = (old.id, new.type, new.title)
@@ -205,13 +206,12 @@ def compare_and_update_work_item(
         )
 
         try:
-            old_checksums = json.loads(old.get_current_checksum() or "")
+            old_checksums = json.loads(old.checksum or "")
         except json.JSONDecodeError:
             old_checksums = {"__C2P__WORK_ITEM": ""}
 
-        new_checksum = new.get_current_checksum()
-        assert new_checksum is not None
-        new_checksums = json.loads(new_checksum)
+        assert new.checksum is not None
+        new_checksums = json.loads(new.checksum)
 
         new_work_item_check_sum = new_checksums.pop("__C2P__WORK_ITEM")
         old_work_item_check_sum = old_checksums.pop("__C2P__WORK_ITEM")
@@ -289,11 +289,10 @@ def compare_and_update_work_item(
                 new.linked_work_items, old.linked_work_items
             )
         else:
-            new.additional_attributes = {}
+            new.clear_attributes()
             new.type = None
             new.status = None
             new.description = None
-            new.description_type = None
             new.title = None
 
         try:
@@ -348,8 +347,8 @@ def set_attachment_id(node: etree._Element) -> None:
                     )
 
         if new.description:
-            new.description = chelpers.process_html_fragments(
-                new.description, set_attachment_id
+            new.description.value = chelpers.process_html_fragments(
+                new.description.value, set_attachment_id
             )
         for _, attributes in new.additional_attributes.items():
             if (

capella2polarion/converters/element_converter.py

@@ -57,16 +57,6 @@ def _format(texts: list[str]) -> dict[str, str]:
     return requirement_types
 
 
-def _condition(
-    html: bool, value: str
-) -> data_models.CapellaWorkItem.Condition:
-    _type = "text/html" if html else "text/plain"
-    return {
-        "type": _type,
-        "value": f'<div style="text-align: center;">{value}</div>',
-    }
-
-
 class CapellaWorkItemSerializer(polarion_html_helper.JinjaRendererMixin):
     """The general serializer class for CapellaWorkItems."""
 
@@ -432,8 +422,7 @@ def __generic_work_item(
             type=converter_data.type_config.p_type,
             title=obj.name,
             uuid_capella=obj.uuid,
-            description_type="text/html",
-            description=value,
+            description=polarion_api.HtmlContent(value),
             status="open",
             **requirement_types,  # type:ignore[arg-type]
         )
@@ -463,8 +452,7 @@ def _diagram(
             type=converter_data.type_config.p_type,
             title=diagram.name,
             uuid_capella=diagram.uuid,
-            description_type="text/html",
-            description=diagram_html,
+            description=polarion_api.HtmlContent(diagram_html),
             status="open",
         )
         if attachment:
@@ -491,9 +479,11 @@ def get_condition(cap: m.ModelElement, name: str) -> str:
         post_condition = get_condition(obj, "postcondition")
 
         assert converter_data.work_item, "No work item set yet"
-        converter_data.work_item.preCondition = _condition(True, pre_condition)
-        converter_data.work_item.postCondition = _condition(
-            True, post_condition
+        converter_data.work_item.preCondition = polarion_api.HtmlContent(
+            pre_condition
+        )
+        converter_data.work_item.postCondition = polarion_api.HtmlContent(
+            post_condition
         )
         return converter_data.work_item
 
@@ -502,9 +492,12 @@ def _linked_text_as_description(
     ) -> data_models.CapellaWorkItem:
         """Return attributes for a ``Constraint``."""
         assert converter_data.work_item, "No work item set yet"
+        assert (
+            converter_data.work_item.description
+        ), "Description should already be defined"
         (
             uuids,
-            converter_data.work_item.description,
+            converter_data.work_item.description.value,
             attachments,
         ) = self._sanitize_linked_text(converter_data.capella_element)
         if uuids:
@@ -584,7 +577,12 @@ def _jinja_as_description(
     ) -> data_models.CapellaWorkItem:
         """Use a Jinja template to render the description content."""
         assert converter_data.work_item, "No work item set yet"
-        converter_data.work_item.description = self._render_jinja_template(
-            template_folder, template_path, converter_data
+        assert (
+            converter_data.work_item.description
+        ), "Description should already be defined"
+        converter_data.work_item.description.value = (
+            self._render_jinja_template(
+                template_folder, template_path, converter_data
+            )
         )
         return converter_data.work_item

capella2polarion/converters/text_work_item_provider.py

@@ -64,7 +64,6 @@ def generate_text_work_items(
                     },
                 )
 
-            work_item.description_type = "text/html"
             inner_content = "".join(
                 [
                     (
@@ -78,7 +77,7 @@ def generate_text_work_items(
             if element.text:
                 inner_content = element.text + inner_content
 
-            work_item.description = inner_content
+            work_item.description = polarion_api.HtmlContent(inner_content)
             self.new_text_work_items[text_id] = work_item
 
     def insert_text_work_items(

capella2polarion/data_models.py

@@ -17,23 +17,23 @@
 class CapellaWorkItem(polarion_api.WorkItem):
     """A WorkItem class with additional Capella related attributes."""
 
-    class Condition(t.TypedDict):
-        """A class to describe a pre or post condition."""
-
-        type: str
-        value: str
-
     uuid_capella: str
-    preCondition: Condition | None
-    postCondition: Condition | None
+    checksum: str | None
+    preCondition: polarion_api.HtmlContent | None
+    postCondition: polarion_api.HtmlContent | None
+
+    def clear_attributes(self):
+        """Clear all additional attributes except the checksum."""
+        self.additional_attributes = {"checksum": self.checksum}
 
     def calculate_checksum(self) -> str:
         """Calculate and return a checksum for this WorkItem.
 
         In addition, the checksum will be written to self._checksum.
         """
         data = self.to_dict()
-        del data["checksum"]
+        if "checksum" in data["additional_attributes"]:
+            del data["additional_attributes"]["checksum"]
         del data["id"]
 
         attachments = data.pop("attachments")
@@ -58,11 +58,11 @@ def calculate_checksum(self) -> str:
 
         converted = json.dumps(data).encode("utf8")
         # pylint: disable=attribute-defined-outside-init
-        self._checksum = json.dumps(
+        self.checksum = json.dumps(
             {"__C2P__WORK_ITEM": hashlib.sha256(converted).hexdigest()}
             | dict(sorted(attachment_checksums.items()))
         )
-        return self._checksum
+        return self.checksum
 
 
 @dataclasses.dataclass

pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
   "capellambse_context_diagrams>=0.4.0",
   "click",
   "PyYAML",
-  "polarion-rest-api-client==1.1.3",
+  "polarion-rest-api-client==1.2.0",
   "bidict",
   "cairosvg",
   "jinja2",

tests/conftest.py

@@ -66,8 +66,7 @@ def dummy_work_items() -> dict[str, data_models.CapellaWorkItem]:
             uuid_capella=f"uuid{i}",
             title=f"Fake {i}",
             type="fakeModelObject",
-            description_type="text/html",
-            description=markupsafe.Markup(""),
+            description=polarion_api.HtmlContent(markupsafe.Markup("")),
             linked_work_items=[
                 polarion_api.WorkItemLink(
                     f"Obj-{i}", f"Obj-{j}", "attribute", True, TEST_PROJECT_ID