diff --git a/capella2polarion/__main__.py b/capella2polarion/__main__.py
index a0fd6105..6bd86257 100644
--- a/capella2polarion/__main__.py
+++ b/capella2polarion/__main__.py
@@ -115,6 +115,12 @@ def print_cli_state(capella2polarion_cli: Capella2PolarionCli) -> None:
is_flag=True,
default=True,
)
+@click.option(
+ "--generate-figure-captions",
+ envvar="CAPELLA2POLARION_GENERATE_FIGURE_CAPTIONS",
+ is_flag=True,
+ default=False,
+)
@click.pass_context
def synchronize(
ctx: click.core.Context,
@@ -123,6 +129,7 @@ def synchronize(
type_prefix: str,
role_prefix: str,
grouped_links_custom_fields: bool,
+ generate_figure_captions: bool,
) -> None:
"""Synchronise model elements."""
capella_to_polarion_cli: Capella2PolarionCli = ctx.obj
@@ -159,6 +166,7 @@ def synchronize(
generate_links=True,
generate_attachments=True,
generate_grouped_links_custom_fields=grouped_links_custom_fields,
+ generate_figure_captions=generate_figure_captions,
)
polarion_worker.compare_and_update_work_items(converter.converter_session)
diff --git a/capella2polarion/converters/element_converter.py b/capella2polarion/converters/element_converter.py
index 237e8f7d..56b94096 100644
--- a/capella2polarion/converters/element_converter.py
+++ b/capella2polarion/converters/element_converter.py
@@ -19,7 +19,7 @@
from capellambse import helpers as chelpers
from capellambse import model as m
from capellambse_context_diagrams import context
-from lxml import etree
+from lxml import etree, html
from capella2polarion import data_model
from capella2polarion.connectors import polarion_repo
@@ -69,11 +69,13 @@ def __init__(
capella_polarion_mapping: polarion_repo.PolarionDataRepository,
converter_session: data_session.ConverterSession,
generate_attachments: bool,
+ generate_figure_captions: bool = False,
):
self.model = model
self.capella_polarion_mapping = capella_polarion_mapping
self.converter_session = converter_session
self.generate_attachments = generate_attachments
+ self.generate_figure_captions = generate_figure_captions
self.jinja_envs: dict[str, jinja2.Environment] = {}
def serialize_all(self) -> list[data_model.CapellaWorkItem]:
@@ -144,6 +146,7 @@ def _draw_diagram_svg(
max_width: int,
cls: str,
render_params: dict[str, t.Any] | None = None,
+ caption: tuple[str, str] | None = None,
) -> tuple[str, data_model.CapellaDiagramAttachment | None]:
file_name = f"{C2P_IMAGE_PREFIX}{file_name}.svg"
@@ -161,7 +164,7 @@ def _draw_diagram_svg(
return (
polarion_html_helper.generate_image_html(
- title, file_name, max_width, cls
+ title, file_name, max_width, cls, caption
),
attachment,
)
@@ -201,6 +204,7 @@ def __insert_diagram(
file_name: str,
render_params: dict[str, t.Any] | None = None,
max_width: int = 800,
+ caption: tuple[str, str] | None = None,
):
if attachment := next(
(
@@ -216,6 +220,7 @@ def __insert_diagram(
attachment.file_name,
max_width,
JINJA_RENDERED_IMG_CLS,
+ caption,
)
diagram_html, attachment = self._draw_diagram_svg(
@@ -246,6 +251,11 @@ def _draw_additional_attributes_diagram(
650,
"additional-attributes-diagram",
render_params,
+ (
+ ("Figure", f"{title} of {work_item.title}")
+ if self.generate_figure_captions
+ else None
+ ),
)
if attachment:
self._add_attachment(work_item, attachment)
@@ -325,6 +335,17 @@ def repair_images(node: etree._Element) -> None:
# We use the filename here as the ID is unknown here
# This needs to be refactored after updating attachments
node.attrib["src"] = f"workitemimg:{file_name}"
+ if self.generate_figure_captions:
+ caption = node.get(
+ "alt", f'Image "{file_url.stem}" of {obj.name}'
+ )
+ node.addnext(
+ html.fromstring(
+ polarion_html_helper.POLARION_CAPTION.format(
+ label="Figure", caption=caption
+ )
+ )
+ )
except FileNotFoundError:
self.converter_session[obj.uuid].errors.add(
@@ -432,7 +453,17 @@ def _diagram(
work_item_id = converter_data.work_item.id
diagram_html, attachment = self._draw_diagram_svg(
- diagram, "diagram", "Diagram", 750, "diagram", render_params
+ diagram,
+ "diagram",
+ "Diagram",
+ 750,
+ "diagram",
+ render_params,
+ (
+ ("Figure", f"Diagram {diagram.name}")
+ if self.generate_figure_captions
+ else None
+ ),
)
converter_data.work_item = data_model.CapellaWorkItem(
diff --git a/capella2polarion/converters/model_converter.py b/capella2polarion/converters/model_converter.py
index 13edbf62..07204c35 100644
--- a/capella2polarion/converters/model_converter.py
+++ b/capella2polarion/converters/model_converter.py
@@ -84,6 +84,7 @@ def generate_work_items(
generate_links: bool = False,
generate_attachments: bool = False,
generate_grouped_links_custom_fields: bool = False,
+ generate_figure_captions: bool = False,
) -> dict[str, data_model.CapellaWorkItem]:
"""Return a work items mapping from model elements for Polarion.
@@ -104,12 +105,15 @@ def generate_work_items(
generate_grouped_links_custom_fields
A boolean flag to control grouped links custom fields
generation.
+ generate_figure_captions
+ A boolean flag to enable the generation of figure captions
"""
serializer = element_converter.CapellaWorkItemSerializer(
self.model,
polarion_data_repo,
self.converter_session,
generate_attachments,
+ generate_figure_captions,
)
work_items = serializer.serialize_all()
for work_item in work_items:
diff --git a/capella2polarion/converters/polarion_html_helper.py b/capella2polarion/converters/polarion_html_helper.py
index 1d26a058..8fa58bba 100644
--- a/capella2polarion/converters/polarion_html_helper.py
+++ b/capella2polarion/converters/polarion_html_helper.py
@@ -37,6 +37,11 @@
"params=id={pid}|layout={lid}|{custom_info}external=true"
'|project={project}">'
)
+POLARION_CAPTION = (
+ '\n '
+ '{label} # {caption}\n
'
+)
RE_DESCR_DELETED_PATTERN = re.compile(
f"<deleted element ({chelpers.RE_VALID_UUID.pattern})>"
)
@@ -52,7 +57,11 @@ def strike_through(string: str) -> str:
def generate_image_html(
- title: str, attachment_id: str, max_width: int, cls: str
+ title: str,
+ attachment_id: str,
+ max_width: int,
+ cls: str,
+ caption: tuple[str, str] | None = None,
) -> str:
"""Generate an image as HTMl with the given source."""
description = (
@@ -60,6 +69,10 @@ def generate_image_html(
f'src="workitemimg:{attachment_id}" '
f'style="max-width: {max_width}px;"/>'
)
+ if caption:
+ description += POLARION_CAPTION.format(
+ label=caption[0], caption=caption[1]
+ )
return description
diff --git a/tests/data/model/Melody Model Test.afm b/tests/data/model/Melody Model Test.afm
index 02f4486c..ca9e0093 100644
--- a/tests/data/model/Melody Model Test.afm
+++ b/tests/data/model/Melody Model Test.afm
@@ -1,6 +1,6 @@
-
-
-
+
+
+
diff --git a/tests/data/model/Melody Model Test.aird b/tests/data/model/Melody Model Test.aird
index 513cb8f7..6e389c75 100644
--- a/tests/data/model/Melody Model Test.aird
+++ b/tests/data/model/Melody Model Test.aird
@@ -1,6 +1,6 @@
-
-
+
+
Melody%20Model%20Test.afm
Melody%20Model%20Test.capella
@@ -8,74 +8,74 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
\n '
+ 'Figure '
+ "# Context Diagram of PhysicalFunction 3\n
"
+ )
diff --git a/tests/test_workitem_attachments.py b/tests/test_workitem_attachments.py
index e568df03..4c19f99d 100644
--- a/tests/test_workitem_attachments.py
+++ b/tests/test_workitem_attachments.py
@@ -620,3 +620,49 @@ def test_diagram_delete_attachments(
assert len(work_item.additional_attributes) == 1
assert work_item.title is None
assert work_item.checksum == DIAGRAM_CHECKSUM
+
+
+def test_attached_image_in_description_with_caption(
+ model: capellambse.MelodyModel,
+ worker: polarion_worker.CapellaPolarionWorker,
+):
+ uuid = "e76aa1f5-cc12-4885-a8c2-a0022b061549"
+ converter = model_converter.ModelConverter(model, "TEST")
+ worker.polarion_data_repo = polarion_repo.PolarionDataRepository(
+ [data_model.CapellaWorkItem(WORKITEM_ID, uuid_capella=uuid)]
+ )
+
+ converter.converter_session[uuid] = data_session.ConverterData(
+ "",
+ converter_config.CapellaTypeConfig("test"),
+ model.by_uuid(uuid),
+ )
+
+ worker.project_client.work_items.attachments.create = mock.MagicMock()
+ worker.project_client.work_items.attachments.create.side_effect = (
+ set_attachment_ids
+ )
+
+ converter.generate_work_items(
+ worker.polarion_data_repo, False, True, False, True
+ )
+ worker.compare_and_update_work_item(converter.converter_session[uuid])
+
+ assert worker.project_client.work_items.update.call_count == 1
+ assert worker.project_client.work_items.attachments.create.call_count == 1
+
+ created_attachments: list[polarion_api.WorkItemAttachment] = (
+ worker.project_client.work_items.attachments.create.call_args.args[0]
+ )
+ work_item: data_model.CapellaWorkItem = (
+ worker.project_client.work_items.update.call_args.args[0]
+ )
+
+ assert len(created_attachments) == 1
+ assert str(work_item.description.value) == (
+ '![Other Text used as Caption]()
'
+ '\n Figure '
+ '#'
+ " Other Text used as Caption\n
\n\nTest
\n"
+ )