Fixes issue when in failure message appears a special characters or a tag like CDDATA.

lwasylow · lwasylow · commit d1dc6e1ffe49 · 2018-05-12T11:34:50.000+01:00
diff --git a/source/reporters/ut_junit_reporter.tpb b/source/reporters/ut_junit_reporter.tpb
@@ -59,7 +59,7 @@ create or replace type body ut_junit_reporter is
           l_lines := a_test.failed_expectations(i).get_result_lines();
           
           for j in 1 .. l_lines.count loop
-            self.print_text(l_lines(j));
+            self.print_text(dbms_xmlgen.convert(l_lines(j)));
           end loop;
           self.print_text(a_test.failed_expectations(i).caller_info);
         end loop;
diff --git a/source/reporters/ut_sonar_test_reporter.tpb b/source/reporters/ut_sonar_test_reporter.tpb
@@ -60,7 +60,7 @@ create or replace type body ut_sonar_test_reporter is
         for i in 1 .. a_test.failed_expectations.count loop
           l_lines := a_test.failed_expectations(i).get_result_lines();
           for i in 1 .. l_lines.count loop
-            self.print_text(l_lines(i));
+            self.print_text(dbms_xmlgen.convert(l_lines(i)));
           end loop;
         end loop;
         self.print_text(']]>');
diff --git a/source/reporters/ut_tfs_junit_reporter.tpb b/source/reporters/ut_tfs_junit_reporter.tpb
@@ -80,7 +80,7 @@ create or replace type body ut_tfs_junit_reporter is
         for i in 1 .. a_test.failed_expectations.count loop
           l_lines := a_test.failed_expectations(i).get_result_lines();
           for j in 1 .. l_lines.count loop
-            self.print_text(l_lines(j));
+            self.print_text(dbms_xmlgen.convert(l_lines(j)));
           end loop;
           self.print_text(a_test.failed_expectations(i).caller_info);
         end loop;
diff --git a/test/core/reporters/test_junit_reporter.pkb b/test/core/reporters/test_junit_reporter.pkb
@@ -62,6 +62,23 @@ create or replace package body test_junit_reporter as
     procedure test1 is begin ut.expect(1).to_equal(1); end;
   end;]';
 
+  execute immediate q'[create or replace package check_fail_escape is
+      --%suitepath(core)
+      --%suite(checkfailedescape)
+      --%displayname(Check JUNIT XML failure is escaped)
+            
+      --%test(Fail Miserably)
+      procedure fail_miserably;
+      
+    end;]';
+    
+    execute immediate q'[create or replace package body check_fail_escape is
+      procedure fail_miserably is
+      begin
+        ut3.ut.expect('test').to_equal('<![CDATA[some stuff]]>');
+      end;
+    end;]';
+
   reporters.reporters_setup;
   
   end;
@@ -267,13 +284,30 @@ create or replace package body test_junit_reporter as
     ut.expect(l_actual).to_be_like(l_expected);  
   end;
   
+  
+  procedure check_failure_escaped is
+    l_results   ut3.ut_varchar2_list;
+    l_actual    clob;
+  begin
+    --Act
+    select *
+      bulk collect into l_results
+      from table(ut3.ut.run('check_fail_escape',ut3.ut_junit_reporter()));
+    l_actual := ut3.ut_utils.table_to_clob(l_results);
+    --Assert
+    ut.expect(l_actual).to_be_like('%<![CDATA[%
+Actual: &apos;test&apos; (varchar2) was expected to equal: &apos;&lt;![CDATA[some stuff]]&gt;&apos; (varchar2)%
+]]>%');
+  end;
+  
   procedure remove_test_package is
     pragma autonomous_transaction;
   begin
     execute immediate 'drop package check_junit_reporting';
     execute immediate 'drop package check_junit_rep_suitepath';
     execute immediate 'drop package tst_package_junit_nodesc';
     execute immediate 'drop package tst_package_junit_nosuite';
+    execute immediate 'drop package check_fail_escape';
     reporters.reporters_cleanup;
   end;
 end;
diff --git a/test/core/reporters/test_junit_reporter.pks b/test/core/reporters/test_junit_reporter.pks
@@ -27,15 +27,18 @@ create or replace package test_junit_reporter as
   --%test(Reports duration according to XML specification for numbers)
   procedure check_nls_number_formatting;
   
-    --%test(Report on test without description)
+  --%test(Report on test without description)
   procedure report_test_without_desc;
   
-    --%test(Report on suite without description)
+  --%test(Report on suite without description)
   procedure report_suite_without_desc;
   
-    --%test(Report produces expected output)
+  --%test(Report produces expected output)
   procedure reporort_produces_expected_out;
 
+  --%test( Validate that fail with special char are escaped )
+  procedure check_failure_escaped;
+
   --%afterall
   procedure remove_test_package;
 end;
diff --git a/test/core/reporters/test_tfs_junit_reporter.pkb b/test/core/reporters/test_tfs_junit_reporter.pkb
@@ -48,8 +48,28 @@ create or replace package body test_tfs_junit_reporter as
         null;
       end;
     end;]';
+    
+
+  execute immediate q'[create or replace package check_fail_escape is
+      --%suitepath(core)
+      --%suite(checkfailedescape)
+      --%displayname(Check JUNIT XML failure is escaped)
+            
+      --%test(Fail Miserably)
+      procedure fail_miserably;
+      
+    end;]';
+    
+    execute immediate q'[create or replace package body check_fail_escape is
+      procedure fail_miserably is
+      begin
+        ut3.ut.expect('test').to_equal('<![CDATA[some stuff]]>');
+      end;
+    end;]';   
+    
   end;
 
+
   procedure escapes_special_chars is
     l_results   ut3.ut_varchar2_list;
     l_actual    clob;
@@ -143,6 +163,21 @@ create or replace package body test_tfs_junit_reporter as
     execute immediate 'alter session set NLS_NUMERIC_CHARACTERS='''||l_nls_numeric_characters||'''';
   end;
 
+  procedure check_failure_escaped is
+    l_results   ut3.ut_varchar2_list;
+    l_actual    clob;
+  begin
+    --Act
+    select *
+      bulk collect into l_results
+      from table(ut3.ut.run('check_fail_escape',ut3.ut_tfs_junit_reporter()));
+    l_actual := ut3.ut_utils.table_to_clob(l_results);
+    --Assert
+    ut.expect(l_actual).to_be_like('%<![CDATA[%
+Actual: &apos;test&apos; (varchar2) was expected to equal: &apos;&lt;![CDATA[some stuff]]&gt;&apos; (varchar2)%
+]]>%');
+  end;
+
   procedure check_classname_suitepath is
     l_results   ut3.ut_varchar2_list;
     l_actual    clob;    
@@ -161,6 +196,7 @@ create or replace package body test_tfs_junit_reporter as
     execute immediate 'drop package check_junit_reporting';
     execute immediate 'drop package check_junit_rep_suitepath';
     execute immediate 'drop package check_junit_flat_suitepath';
+    execute immediate 'drop package check_fail_escape';
   end;
 end;
 /
diff --git a/test/core/reporters/test_tfs_junit_reporter.pks b/test/core/reporters/test_tfs_junit_reporter.pks
@@ -27,6 +27,9 @@ create or replace package test_tfs_junit_reporter as
   --%test(Reports duration according to XML specification for numbers)
   procedure check_nls_number_formatting;
 
+  --%test( Validate that failures with special char are escaped )
+  procedure check_failure_escaped;
+
   --%afterall
   procedure remove_test_package;
 end;
