Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 5b8f7bd

Browse files
jgebaljgebal
authored
Merge pull request #926 from utPLSQL/feature/fix_sonar_test_reporter
Failure details in sonar test reporter are now CDATA
2 parents 16ef15f + 00f8584 commit 5b8f7bd

17 files changed

Lines changed: 158 additions & 181 deletions

‎source/core/types/ut_test.tpb‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,5 +162,15 @@ create or replace type body ut_test as
162162
end loop;
163163
return l_outputs;
164164
end;
165+
166+
member function get_failed_expectation_lines return ut_varchar2_rows is
167+
l_results ut_varchar2_rows;
168+
begin
169+
for i in 1 .. failed_expectations.count loop
170+
ut_utils.append_to_list( l_results, ut_utils.convert_collection( failed_expectations(i).get_result_lines() ) );
171+
ut_utils.append_to_list( l_results, failed_expectations(i).caller_info );
172+
end loop;
173+
return l_results;
174+
end;
165175
end;
166176
/

‎source/core/types/ut_test.tps‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ create or replace type ut_test under ut_suite_item (
6464
overriding member procedure calc_execution_result(self in out nocopy ut_test),
6565
overriding member procedure mark_as_errored(self in out nocopy ut_test, a_error_stack_trace varchar2),
6666
overriding member function get_error_stack_traces(self ut_test) return ut_varchar2_list,
67-
overriding member function get_serveroutputs return clob
67+
overriding member function get_serveroutputs return clob,
68+
member function get_failed_expectation_lines return ut_varchar2_rows
6869
)
6970
/

‎source/core/ut_utils.pkb‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -798,5 +798,31 @@ create or replace package body ut_utils is
798798
return l_valid_name;
799799
end;
800800

801+
function to_cdata(a_lines ut_varchar2_rows) return ut_varchar2_rows is
802+
l_results ut_varchar2_rows;
803+
begin
804+
if a_lines is not empty then
805+
ut_utils.append_to_list( l_results, gc_cdata_start_tag);
806+
for i in 1 .. a_lines.count loop
807+
ut_utils.append_to_list( l_results, replace( a_lines(i), gc_cdata_end_tag, gc_cdata_end_tag_wrap ) );
808+
end loop;
809+
ut_utils.append_to_list( l_results, gc_cdata_end_tag);
810+
else
811+
l_results := a_lines;
812+
end if;
813+
return l_results;
814+
end;
815+
816+
function to_cdata(a_clob clob) return clob is
817+
l_result clob;
818+
begin
819+
if a_clob is not null and a_clob != empty_clob() then
820+
l_result := replace( a_clob, gc_cdata_end_tag, gc_cdata_end_tag_wrap );
821+
else
822+
l_result := a_clob;
823+
end if;
824+
return l_result;
825+
end;
826+
801827
end ut_utils;
802828
/

‎source/core/ut_utils.pks‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ create or replace package ut_utils authid definer is
4444
gc_failure_char constant varchar2(7) := 'Failure'; -- one or more expectations failed
4545
gc_error_char constant varchar2(5) := 'Error'; -- exception was raised
4646

47+
gc_cdata_start_tag constant varchar2(10) := '<![CDATA[';
48+
gc_cdata_end_tag constant varchar2(10) := ']]>';
49+
gc_cdata_end_tag_wrap constant varchar2(30) := ']]'||gc_cdata_end_tag||gc_cdata_start_tag||'>';
50+
51+
4752
/*
4853
Constants: Rollback type for ut_test_object
4954
*/
@@ -386,6 +391,18 @@ create or replace package ut_utils authid definer is
386391
* Check if xml name is valid if not build a valid name
387392
*/
388393
function get_valid_xml_name(a_name varchar2) return varchar2;
389-
390-
end ut_utils;
394+
395+
/**
396+
* Converts input list into a list surrounded by CDATA tags
397+
* All CDATA end tags get escaped using recommended method from https://en.wikipedia.org/wiki/CDATA#Nesting
398+
*/
399+
function to_cdata(a_lines ut_varchar2_rows) return ut_varchar2_rows;
400+
401+
/**
402+
* Converts input CLOB into a CLOB surrounded by CDATA tags
403+
* All CDATA end tags get escaped using recommended method from https://en.wikipedia.org/wiki/CDATA#Nesting
404+
*/
405+
function to_cdata(a_clob clob) return clob;
406+
407+
end ut_utils;
391408
/

‎source/reporters/ut_junit_reporter.tpb‎

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ create or replace type body ut_junit_reporter is
2323
end;
2424

2525
overriding member procedure after_calling_run(self in out nocopy ut_junit_reporter, a_run in ut_run) is
26-
c_cddata_tag_start constant varchar2(30) := '<![CDATA[';
27-
c_cddata_tag_end constant varchar2(10) := ']]>';
2826
l_suite_id integer := 0;
2927
l_tests_count integer := a_run.results_count.disabled_count + a_run.results_count.success_count +
3028
a_run.results_count.failure_count + a_run.results_count.errored_count;
@@ -36,8 +34,7 @@ create or replace type body ut_junit_reporter is
3634

3735
procedure print_test_elements(a_test ut_test) is
3836
l_results ut_varchar2_rows := ut_varchar2_rows();
39-
l_lines ut_varchar2_list;
40-
l_output clob;
37+
l_output clob;
4138
begin
4239
ut_utils.append_to_list(
4340
l_results,
@@ -51,30 +48,18 @@ create or replace type body ut_junit_reporter is
5148
end if;
5249
if a_test.result = ut_utils.gc_error then
5350
ut_utils.append_to_list( l_results, '<error>');
54-
ut_utils.append_to_list( l_results, c_cddata_tag_start);
55-
ut_utils.append_to_list( l_results, ut_utils.convert_collection(a_test.get_error_stack_traces()) );
56-
ut_utils.append_to_list( l_results, c_cddata_tag_end);
51+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( ut_utils.convert_collection( a_test.get_error_stack_traces() ) ) );
5752
ut_utils.append_to_list( l_results, '</error>');
5853
elsif a_test.result > ut_utils.gc_success then
5954
ut_utils.append_to_list( l_results, '<failure>');
60-
for i in 1 .. a_test.failed_expectations.count loop
61-
62-
l_lines := a_test.failed_expectations(i).get_result_lines();
63-
64-
for j in 1 .. l_lines.count loop
65-
ut_utils.append_to_list( l_results, dbms_xmlgen.convert(l_lines(j)) );
66-
end loop;
67-
ut_utils.append_to_list( l_results, dbms_xmlgen.convert(a_test.failed_expectations(i).caller_info) );
68-
end loop;
55+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( a_test.get_failed_expectation_lines() ) );
6956
ut_utils.append_to_list( l_results, '</failure>');
7057
end if;
71-
-- TODO - decide if we need/want to use the <system-err/> tag too
58+
7259
l_output := a_test.get_serveroutputs();
7360
if l_output is not null then
7461
ut_utils.append_to_list( l_results, '<system-out>');
75-
ut_utils.append_to_list( l_results, c_cddata_tag_start);
76-
ut_utils.append_to_list( l_results, l_output);
77-
ut_utils.append_to_list( l_results, c_cddata_tag_end );
62+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( a_test.get_serveroutputs() ) );
7863
ut_utils.append_to_list( l_results, '</system-out>' );
7964
else
8065
ut_utils.append_to_list( l_results, '<system-out/>');
@@ -86,7 +71,7 @@ create or replace type body ut_junit_reporter is
8671
end;
8772

8873
procedure print_suite_elements(a_suite ut_logical_suite, a_suite_id in out nocopy integer) is
89-
l_tests_count integer := a_suite.results_count.disabled_count + a_suite.results_count.success_count +
74+
l_count integer := a_suite.results_count.disabled_count + a_suite.results_count.success_count +
9075
a_suite.results_count.failure_count + a_suite.results_count.errored_count;
9176
l_suite ut_suite;
9277
l_tests ut_suite_items := ut_suite_items();
@@ -95,7 +80,7 @@ create or replace type body ut_junit_reporter is
9580
l_errors ut_varchar2_list;
9681
begin
9782
a_suite_id := a_suite_id + 1;
98-
self.print_text('<testsuite tests="' || l_tests_count || '"' || ' id="' || a_suite_id || '"' || ' package="' ||
83+
self.print_text('<testsuite tests="' || l_count || '"' || ' id="' || a_suite_id || '"' || ' package="' ||
9984
dbms_xmlgen.convert(a_suite.path) || '" ' || self.get_common_suite_attributes(a_suite) || '>');
10085

10186
-- Becasue testsuites have to appear before test we capture test and leave it for later.
@@ -117,11 +102,9 @@ create or replace type body ut_junit_reporter is
117102
l_suite := treat(a_suite as ut_suite);
118103

119104
l_data := l_suite.get_serveroutputs();
120-
if l_data is not null and l_data != empty_clob() then
105+
if l_data is not null then
121106
ut_utils.append_to_list( l_results, '<system-out>');
122-
ut_utils.append_to_list( l_results, c_cddata_tag_start);
123-
ut_utils.append_to_list( l_results, l_data);
124-
ut_utils.append_to_list( l_results, c_cddata_tag_end);
107+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( l_data ) );
125108
ut_utils.append_to_list( l_results, '</system-out>');
126109
else
127110
ut_utils.append_to_list( l_results, '<system-out/>');
@@ -130,9 +113,7 @@ create or replace type body ut_junit_reporter is
130113
l_errors := l_suite.get_error_stack_traces();
131114
if l_errors is not empty then
132115
ut_utils.append_to_list( l_results, '<system-err>');
133-
ut_utils.append_to_list( l_results, c_cddata_tag_start);
134-
ut_utils.append_to_list( l_results, ut_utils.table_to_clob(l_errors));
135-
ut_utils.append_to_list( l_results, c_cddata_tag_end);
116+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( ut_utils.convert_collection( l_errors ) ) );
136117
ut_utils.append_to_list( l_results, '</system-err>');
137118
else
138119
ut_utils.append_to_list( l_results, '<system-err/>');

‎source/reporters/ut_sonar_test_reporter.tpb‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,18 @@ create or replace type body ut_sonar_test_reporter is
4343
end;
4444

4545
procedure print_test_results(a_test ut_test) is
46-
l_results ut_varchar2_rows := ut_varchar2_rows();
47-
l_lines ut_varchar2_list;
46+
l_results ut_varchar2_rows := ut_varchar2_rows();
4847
begin
4948
ut_utils.append_to_list( l_results, '<testCase name="'||dbms_xmlgen.convert(a_test.name)||'" duration="'||round(a_test.execution_time()*1000,0)||'" >');
5049
if a_test.result = ut_utils.gc_disabled then
5150
ut_utils.append_to_list( l_results, '<skipped message="skipped"/>');
5251
elsif a_test.result = ut_utils.gc_error then
5352
ut_utils.append_to_list( l_results, '<error message="encountered errors">');
54-
ut_utils.append_to_list( l_results, '<![CDATA[');
55-
ut_utils.append_to_list( l_results, ut_utils.table_to_clob(a_test.get_error_stack_traces()));
56-
ut_utils.append_to_list( l_results, ']]>');
53+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( ut_utils.convert_collection( a_test.get_error_stack_traces() ) ) );
5754
ut_utils.append_to_list( l_results, '</error>');
5855
elsif a_test.result > ut_utils.gc_success then
5956
ut_utils.append_to_list( l_results, '<failure message="some expectations have failed">');
60-
for i in 1 .. a_test.failed_expectations.count loop
61-
l_lines := a_test.failed_expectations(i).get_result_lines();
62-
for i in 1 .. l_lines.count loop
63-
ut_utils.append_to_list( l_results, dbms_xmlgen.convert(l_lines(i)));
64-
end loop;
65-
end loop;
57+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( a_test.get_failed_expectation_lines() ) );
6658
ut_utils.append_to_list( l_results, '</failure>');
6759
end if;
6860
ut_utils.append_to_list( l_results, '</testCase>');

‎source/reporters/ut_tfs_junit_reporter.tpb‎

Lines changed: 33 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ create or replace type body ut_tfs_junit_reporter is
2929

3030
member procedure junit_version_one(self in out nocopy ut_tfs_junit_reporter,a_run in ut_run) is
3131
l_suite_id integer := 0;
32-
l_tests_count integer := a_run.results_count.disabled_count + a_run.results_count.success_count +
33-
a_run.results_count.failure_count + a_run.results_count.errored_count;
34-
32+
3533
function get_common_suite_attributes(a_item ut_suite_item) return varchar2 is
3634
begin
3735
return ' errors="' ||a_item.results_count.errored_count || '"' ||
@@ -55,7 +53,6 @@ create or replace type body ut_tfs_junit_reporter is
5553

5654
procedure print_test_results(a_test ut_test) is
5755
l_results ut_varchar2_rows := ut_varchar2_rows();
58-
l_lines ut_varchar2_list;
5956
begin
6057
self.print_text('<testcase classname="' || dbms_xmlgen.convert(get_path(a_test.path, a_test.name)) || '" ' ||
6158
get_common_testcase_attributes(a_test) || '>');
@@ -69,20 +66,12 @@ create or replace type body ut_tfs_junit_reporter is
6966

7067
if a_test.result = ut_utils.gc_error then
7168
ut_utils.append_to_list( l_results, '<error type="error" message="Error while executing '||a_test.name||'">');
72-
ut_utils.append_to_list( l_results, '<![CDATA[');
73-
ut_utils.append_to_list( l_results, ut_utils.table_to_clob(a_test.get_error_stack_traces()));
74-
ut_utils.append_to_list( l_results, ']]>');
69+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( ut_utils.convert_collection( a_test.get_error_stack_traces() ) ) );
7570
ut_utils.append_to_list( l_results, '</error>');
7671
-- Do not count error as failure
7772
elsif a_test.result = ut_utils.gc_failure then
7873
ut_utils.append_to_list( l_results, '<failure type="failure" message="Test '||a_test.name||' failed">');
79-
for i in 1 .. a_test.failed_expectations.count loop
80-
l_lines := a_test.failed_expectations(i).get_result_lines();
81-
for j in 1 .. l_lines.count loop
82-
ut_utils.append_to_list( l_results, dbms_xmlgen.convert(l_lines(j)));
83-
end loop;
84-
ut_utils.append_to_list( l_results, dbms_xmlgen.convert(a_test.failed_expectations(i).caller_info));
85-
end loop;
74+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( a_test.get_failed_expectation_lines() ) );
8675
ut_utils.append_to_list( l_results, '</failure>');
8776
end if;
8877

@@ -106,43 +95,39 @@ create or replace type body ut_tfs_junit_reporter is
10695
end if;
10796
end loop;
10897

109-
if a_suite is of(ut_suite) then
110-
a_suite_id := a_suite_id + 1;
111-
self.print_text('<testsuite tests="' || l_tests_count || '"' || ' id="' || a_suite_id || '"' || ' package="' ||
112-
dbms_xmlgen.convert(a_suite.path) || '" ' || get_common_suite_attributes(a_suite) || '>');
113-
self.print_text('<properties/>');
114-
for i in 1 .. a_suite.items.count loop
115-
if a_suite.items(i) is of(ut_test) then
116-
print_test_results(treat(a_suite.items(i) as ut_test));
117-
end if;
118-
end loop;
119-
l_suite := treat(a_suite as ut_suite);
120-
l_outputs := l_suite.get_serveroutputs();
121-
if l_outputs is not null and l_outputs != empty_clob() then
122-
ut_utils.append_to_list( l_results, '<system-out>');
123-
ut_utils.append_to_list( l_results, '<![CDATA[');
124-
ut_utils.append_to_list( l_results, l_outputs);
125-
ut_utils.append_to_list( l_results, ']]>');
126-
ut_utils.append_to_list( l_results, '</system-out>');
127-
else
128-
ut_utils.append_to_list( l_results, '<system-out/>');
129-
end if;
98+
if a_suite is of(ut_suite) then
99+
a_suite_id := a_suite_id + 1;
100+
self.print_text('<testsuite tests="' || l_tests_count || '"' || ' id="' || a_suite_id || '"' || ' package="' ||
101+
dbms_xmlgen.convert(a_suite.path) || '" ' || get_common_suite_attributes(a_suite) || '>');
102+
self.print_text('<properties/>');
103+
for i in 1 .. a_suite.items.count loop
104+
if a_suite.items(i) is of(ut_test) then
105+
print_test_results(treat(a_suite.items(i) as ut_test));
106+
end if;
107+
end loop;
108+
l_suite := treat(a_suite as ut_suite);
109+
l_outputs := l_suite.get_serveroutputs();
110+
if l_outputs is not null and l_outputs != empty_clob() then
111+
ut_utils.append_to_list( l_results, '<system-out>');
112+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( l_suite.get_serveroutputs() ) );
113+
ut_utils.append_to_list( l_results, '</system-out>');
114+
else
115+
ut_utils.append_to_list( l_results, '<system-out/>');
116+
end if;
130117

131-
l_errors := l_suite.get_error_stack_traces();
132-
if l_errors is not empty then
133-
ut_utils.append_to_list( l_results, '<system-err>');
134-
ut_utils.append_to_list( l_results, '<![CDATA[');
135-
ut_utils.append_to_list( l_results, ut_utils.table_to_clob(l_errors));
136-
ut_utils.append_to_list( l_results, ']]>');
137-
ut_utils.append_to_list( l_results, '</system-err>');
138-
else
139-
ut_utils.append_to_list( l_results, '<system-err/>');
140-
end if;
141-
ut_utils.append_to_list( l_results, '</testsuite>');
118+
l_errors := l_suite.get_error_stack_traces();
119+
if l_errors is not empty then
120+
ut_utils.append_to_list( l_results, '<system-err>');
121+
ut_utils.append_to_list( l_results, ut_utils.to_cdata( ut_utils.convert_collection( l_errors ) ) );
122+
ut_utils.append_to_list( l_results, '</system-err>');
123+
else
124+
ut_utils.append_to_list( l_results, '<system-err/>');
125+
end if;
126+
ut_utils.append_to_list( l_results, '</testsuite>');
142127

143-
self.print_text_lines(l_results);
128+
self.print_text_lines(l_results);
144129
end if;
145-
end;
130+
end;
146131

147132
begin
148133
l_suite_id := 0;

‎test/ut3_user/api/test_ut_run.pkb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -734,8 +734,8 @@ Failures:%
734734
procedure remove_time_from_results(a_results in out nocopy ut3.ut_varchar2_list) is
735735
begin
736736
for i in 1 .. a_results.count loop
737-
a_results(i) := regexp_replace(a_results(i),'\[[0-9]*\.[0-9]+ sec\]','');
738-
a_results(i) := regexp_replace(a_results(i),'Finished in [0-9]*\.[0-9]+ seconds','');
737+
a_results(i) := regexp_replace(a_results(i),'\[[0-9]*[\.,][0-9]+ sec\]','');
738+
a_results(i) := regexp_replace(a_results(i),'Finished in [0-9]*[\.,][0-9]+ seconds','');
739739
end loop;
740740
end;
741741

0 commit comments

Comments
 (0)