Merge pull request #179 from strictdoc-project/stanislaw/escape

SPEC-RELATION: escape LONG-NAME

Author: stanislaw

reqif/parsers/spec_relation_parser.py

@@ -1,3 +1,4 @@
+import html
 from typing import List, Optional
 
 from reqif.models.error_handling import ReqIFMissingTagException
@@ -96,7 +97,7 @@ def unparse(spec_relation: ReqIFSpecRelation):
         if spec_relation.last_change is not None:
             output += f' LAST-CHANGE="{spec_relation.last_change}"'
         if spec_relation.long_name is not None:
-            output += f' LONG-NAME="{spec_relation.long_name}"'
+            output += f' LONG-NAME="{html.escape(spec_relation.long_name)}"'
         output += ">\n"
 
         children_tags: List[str]

tests/integration/reqif/SPEC-RELATION/01_escaping_long_name/sample.reqif

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<REQ-IF xmlns="http://www.omg.org/spec/ReqIF/20110401/reqif.xsd" xmlns:configuration="http://eclipse.org/rmf/pror/toolextensions/1.0">
+  <CORE-CONTENT>
+    <REQ-IF-CONTENT>
+      <SPEC-RELATIONS>
+        <SPEC-RELATION IDENTIFIER="TEST_SPEC_RELATION_ID" LAST-CHANGE="2015-12-14T02:04:52.318+01:00" LONG-NAME="Test &amp; Test">
+          <TARGET>
+            <SPEC-OBJECT-REF>SPEC_OBJECT_B</SPEC-OBJECT-REF>
+          </TARGET>
+          <SOURCE>
+            <SPEC-OBJECT-REF>SPEC_OBJECT_A</SPEC-OBJECT-REF>
+          </SOURCE>
+          <TYPE>
+            <SPEC-RELATION-TYPE-REF>PARENT</SPEC-RELATION-TYPE-REF>
+          </TYPE>
+        </SPEC-RELATION>
+      </SPEC-RELATIONS>
+    </REQ-IF-CONTENT>
+  </CORE-CONTENT>
+</REQ-IF>

tests/integration/reqif/SPEC-RELATION/01_escaping_long_name/test.itest

@@ -0,0 +1,3 @@
+RUN: mkdir -p %S/output
+RUN: %reqif passthrough %S/sample.reqif %S/output/sample.reqif
+RUN: %diff %S/sample.reqif %S/output/sample.reqif