Now each reporter can use both capabilities:

jgebal · jgebal · commit 15ff01fe8ca9 · 2016-11-18T01:05:54.000Z
- putting atext line to output
 - putting a bug clob text
 Added support for clob output for both dbms_output and dbms_pipe).
 Separated reporting line by line from reporting big chunks of work (clob).
diff --git a/examples/ut_custom_reporter.tpb b/examples/ut_custom_reporter.tpb
@@ -16,10 +16,10 @@ create or replace type body ut_custom_reporter is
     return tab_str;
   end tab;
 
-  overriding member procedure print(a_text varchar2) is
+  overriding member procedure print_text(a_text varchar2) is
   begin
-    (self as ut_dbms_output_suite_reporter).print(tab || a_text);
-  end print;
+    (self as ut_dbms_output_suite_reporter).print_text(tab || a_text);
+  end;
 
   overriding member procedure before_suite(self in out nocopy ut_custom_reporter, a_suite ut_object) as
   begin
diff --git a/examples/ut_custom_reporter.tps b/examples/ut_custom_reporter.tps
@@ -6,7 +6,7 @@ create or replace type ut_custom_reporter under ut_dbms_output_suite_reporter
 -- Member functions and procedures
   constructor function ut_custom_reporter(a_tab_size integer default 4, a_output ut_output default ut_output_dbms_output() ) return self as result,
   member function tab(self in ut_custom_reporter) return varchar2,
-  overriding member procedure print(a_text varchar2),
+  overriding member procedure print_text(a_text varchar2),
   overriding member procedure before_suite(self in out nocopy ut_custom_reporter, a_suite ut_object),
   overriding member procedure before_test(self in out nocopy ut_custom_reporter, a_test ut_object),
   overriding member procedure on_assert_process(self in out nocopy ut_custom_reporter, a_assert ut_object),
diff --git a/source/core/types/ut_output.tps b/source/core/types/ut_output.tps
@@ -3,7 +3,8 @@ create or replace type ut_output as object (
   output_id   varchar2(128),
   final member function generate_output_id return varchar2,
   not instantiable member procedure open(self in out nocopy ut_output),
-  not instantiable member procedure send(self in out nocopy ut_output, a_text clob),
+  not instantiable member procedure send_line(self in out nocopy ut_output, a_text varchar2),
+  not instantiable member procedure send_clob(self in out nocopy ut_output, a_text clob),
   not instantiable member procedure close(self in out nocopy ut_output)
 ) not final not instantiable
 /
diff --git a/source/core/types/ut_output_dbms_output.tpb b/source/core/types/ut_output_dbms_output.tpb
@@ -12,16 +12,15 @@ create or replace type body ut_output_dbms_output as
     null;
   end;
 
-  overriding member procedure send(self in out nocopy ut_output_dbms_output, a_text clob) is
-    l_text_part varchar2(32767 byte);
-    --we're assuming max of 2 bytes per char
-    c_size_limit_chars constant integer := (32767/2);
-    i integer := 0;
+  overriding member procedure send_line(self in out nocopy ut_output_dbms_output, a_text varchar2) is
   begin
-    while i < length(a_text) loop
-      l_text_part := substr( a_text, i + 1, c_size_limit_chars );
-      dbms_output.put_line(l_text_part);
-      i := i + c_size_limit_chars;
+    dbms_output.put_line(a_text);
+  end;
+
+  overriding member procedure send_clob(self in out nocopy ut_output_dbms_output, a_text clob) is
+  begin
+    for i in (select column_value as text from table(ut_utils.clob_to_table(a_text)) ) loop
+      dbms_output.put_line(i.text);
     end loop;
   end;
 
diff --git a/source/core/types/ut_output_dbms_output.tps b/source/core/types/ut_output_dbms_output.tps
@@ -1,7 +1,8 @@
 create or replace type ut_output_dbms_output under ut_output (
   constructor function ut_output_dbms_output(self in out nocopy ut_output_dbms_output) return self as result,
   overriding member procedure open(self in out nocopy ut_output_dbms_output),
-  overriding member procedure send(self in out nocopy ut_output_dbms_output, a_text clob),
+  overriding member procedure send_line(self in out nocopy ut_output_dbms_output, a_text varchar2),
+  overriding member procedure send_clob(self in out nocopy ut_output_dbms_output, a_text clob),
   overriding member procedure close(self in out nocopy ut_output_dbms_output)
 ) not final
 /
diff --git a/source/core/types/ut_output_dbms_pipe.tpb b/source/core/types/ut_output_dbms_pipe.tpb
@@ -16,15 +16,20 @@ create or replace type body ut_output_dbms_pipe as
     l_flag := dbms_pipe.create_pipe(self.output_id);
   end;
 
-  overriding member procedure send(self in out nocopy ut_output_dbms_pipe, a_text clob) is
+  overriding member procedure send_line(self in out nocopy ut_output_dbms_pipe, a_text varchar2) is
+  begin
+    self.send_clob(a_text);
+  end;
+
+  overriding member procedure send_clob(self in out nocopy ut_output_dbms_pipe, a_text clob) is
     c_size_limit_chars constant integer := ut_output_pipe_helper.gc_size_limit_chars;
     l_text_part        ut_output_pipe_helper.t_pipe_item;
     i                  integer := 0;
   begin
     --split test into pieces of a size valid for pipe and send to pipe
     while i < length(a_text) loop
       l_text_part := substr( a_text, i + 1, c_size_limit_chars );
-      ut_output_pipe_helper.send( self.output_id, l_text_part);
+      ut_output_pipe_helper.send_text( self.output_id, l_text_part);
       i := i + c_size_limit_chars;
     end loop;
     --SEND is closed by a EOM message
diff --git a/source/core/types/ut_output_dbms_pipe.tps b/source/core/types/ut_output_dbms_pipe.tps
@@ -1,7 +1,8 @@
 create or replace type ut_output_dbms_pipe under ut_output (
   constructor function ut_output_dbms_pipe(self in out nocopy ut_output_dbms_pipe) return self as result,
   overriding member procedure open(self in out nocopy ut_output_dbms_pipe),
-  overriding member procedure send(self in out nocopy ut_output_dbms_pipe, a_text clob),
+  overriding member procedure send_line(self in out nocopy ut_output_dbms_pipe, a_text varchar2),
+  overriding member procedure send_clob(self in out nocopy ut_output_dbms_pipe, a_text clob),
   overriding member procedure close(self in out nocopy ut_output_dbms_pipe),
   static function get_lines(a_output_id varchar2, a_timeout_sec integer := 60*60*4) return ut_output_clob_list pipelined
 ) not final
diff --git a/source/core/types/ut_output_varchar2_list.tps b/source/core/types/ut_output_varchar2_list.tps
@@ -0,0 +1,2 @@
+create or replace type ut_output_varchar2_list as table of varchar2(32767)
+/
diff --git a/source/core/types/ut_reporter.tpb b/source/core/types/ut_reporter.tpb
@@ -7,10 +7,15 @@ create or replace type body ut_reporter is
     return;
   end;
 
-  member procedure print(self in out nocopy ut_reporter, a_text varchar2) is
+  member procedure print_text(self in out nocopy ut_reporter, a_text varchar2) is
   begin
-    self.output.send(a_text);
-  end print;
+    self.output.send_line(a_text);
+  end;
+
+  member procedure print_clob(self in out nocopy ut_reporter, a_text clob) is
+  begin
+    self.output.send_clob(a_text);
+  end;
 
   member procedure before_run(self in out nocopy ut_reporter, a_suites in ut_objects_list) is
   begin
diff --git a/source/core/types/ut_reporter.tps b/source/core/types/ut_reporter.tps
@@ -4,7 +4,8 @@ create or replace type ut_reporter force as object
   output ut_output,
   constructor function ut_reporter(self in out nocopy ut_reporter, a_output ut_output default ut_output_dbms_output()) return self as result,
 
-  member procedure print(self in out nocopy ut_reporter, a_text varchar2),
+  member procedure print_text(self in out nocopy ut_reporter, a_text varchar2),
+  member procedure print_clob(self in out nocopy ut_reporter, a_text clob),
 
   -- run hooks
   member procedure before_run(self in out nocopy ut_reporter, a_suites in ut_objects_list),
diff --git a/source/core/ut_output_pipe_helper.pkb b/source/core/ut_output_pipe_helper.pkb
@@ -33,7 +33,7 @@ create or replace package body ut_output_pipe_helper is
           dbms_pipe.pack_message_rowid( NULL );
         elsif a_buffer(i).message_type = gc_eot then
           dbms_pipe.pack_message_raw( NULL );
-        else
+        elsif a_buffer(i).message_type = gc_text then
           dbms_pipe.pack_message( a_buffer(i).message );
         end if;
         l_is_successful := dbms_pipe.send_message(a_output_id, a_timeout_seconds) = 0;
@@ -123,7 +123,7 @@ create or replace package body ut_output_pipe_helper is
   end;
 
   --writes the message to the end of the buffer
-  procedure buffer(a_output_id t_output_id, a_text t_pipe_item, a_message_type integer := null) is
+  procedure buffer(a_output_id t_output_id, a_message_type integer, a_text t_pipe_item := null) is
   begin
     if not g_outputs_buffer.exists(a_output_id) then
       g_outputs_buffer(a_output_id).data := tt_pipe_buffer();
@@ -135,32 +135,35 @@ create or replace package body ut_output_pipe_helper is
   end;
 
 
+  procedure buffer_and_send(a_output_id t_output_id, a_message_type integer, a_text t_pipe_item:= null) is
+    l_is_successful boolean;
+  begin
+      buffer(a_output_id, a_message_type, a_text);
+      l_is_successful := send_from_buffer(a_output_id);
+  end;
   ---public
 
   --adds message to pipe buffer and tries to sent all messages from the buffer
   --exists immediately when sending timesout (pipe full)
   --the messages that were sent are removed from buffer
-  procedure send(a_output_id t_output_id, a_text t_pipe_item) is
+  procedure send_text(a_output_id t_output_id, a_text t_pipe_item) is
     l_is_successful boolean;
   begin
-      buffer(a_output_id, a_text);
-      l_is_successful := send_from_buffer(a_output_id);
+      buffer_and_send(a_output_id, gc_text, a_text);
   end;
 
   --sends a end of message into a a pipe
   procedure send_eom(a_output_id t_output_id) is
     l_is_successful boolean;
   begin
-      buffer(a_output_id, null, gc_eom);
-      l_is_successful := send_from_buffer(a_output_id);
+      buffer_and_send(a_output_id, gc_eom);
   end;
 
   --sends a end of message into a a pipe
   procedure send_eot(a_output_id t_output_id) is
     l_is_successful boolean;
   begin
-      buffer(a_output_id, null, gc_eot);
-      l_is_successful := send_from_buffer(a_output_id);
+      buffer_and_send(a_output_id, gc_eot);
   end;
 
   --marks a buffer as ready to be flushed
diff --git a/source/core/ut_output_pipe_helper.pks b/source/core/ut_output_pipe_helper.pks
@@ -16,7 +16,7 @@ create or replace package ut_output_pipe_helper is
   --adds message to pipe buffer and tries to sent all messages from the buffer
   --exists immediately when sending timesout (pipe full)
   --the messages that were sent are removed from buffer
-  procedure send(a_output_id t_output_id, a_text t_pipe_item);
+  procedure send_text(a_output_id t_output_id, a_text t_pipe_item);
 
   --sends a end of message into a a pipe
   procedure send_eom(a_output_id t_output_id);
diff --git a/source/core/ut_utils.pkb b/source/core/ut_utils.pkb
@@ -126,5 +126,59 @@ create or replace package body ut_utils is
     return case a_value when 1 then true when 0 then false end;
   end;
 
-end ut_utils;
+  function string_to_table(a_string varchar2, a_delimiter varchar2:= chr(10)) return ut_output_varchar2_list is
+    l_offset             integer := 1;
+    l_length             integer;
+    l_result             ut_output_varchar2_list := ut_output_varchar2_list();
+    l_delimiter_position integer;
+  begin
+    if a_string is not null then
+      l_length := length(a_string);
+      loop
+        l_result.extend;
+        l_delimiter_position := instr(a_string, a_delimiter, l_offset);
+        if l_delimiter_position > 0 then
+          l_result(l_result.last) := substr(a_string, l_offset, l_delimiter_position - l_offset);
+        else
+          l_result(l_result.last) := substr(a_string, l_offset);
+        end if;
+        exit when l_delimiter_position = 0;
+        l_offset := l_delimiter_position + 1;
+      end loop;
+    end if;
+    return l_result;
+  end;
+
+  function clob_to_table(a_clob clob, a_delimiter varchar2:= chr(10), a_max_amount integer := 32767) return ut_output_varchar2_list pipelined is
+    l_offset    integer := 1;
+    l_length    integer := dbms_lob.getlength(a_clob);
+    l_amount    integer := a_max_amount;
+    l_buffer    varchar2(32767);
+    l_last_line varchar2(32767);
+    l_results ut_output_varchar2_list;
+    l_is_last_line boolean;
+  begin
+    while l_offset <= l_length loop
+      l_amount := a_max_amount - coalesce( length(l_last_line), 0 );
+      dbms_lob.read(a_clob, l_amount, l_offset, l_buffer);
+      l_offset := l_offset + l_amount;
+
+      l_results := string_to_table( l_last_line || l_buffer, a_delimiter );
+      l_is_last_line := false;
+      for i in 1 .. l_results.count loop
+        if i < l_results.count or l_results.count = 1 then
+          pipe row( l_results(i) );
+        else
+          l_is_last_line := true;
+          l_last_line := l_results(i);
+        end if;
+      end loop;
+    end loop;
+    if l_is_last_line then
+      pipe row( l_last_line );
+    end if;
+    return;
+  end;
+
+end;
 /
diff --git a/source/core/ut_utils.pks b/source/core/ut_utils.pks
@@ -88,5 +88,45 @@ create or replace package ut_utils authid definer is
   */
   procedure validate_rollback_type(a_rollback_type number);
 
+
+  /*
+   Function: string_to_table
+
+     Parameters:
+          a_string - the text to be split.
+          a_delimiter - the delimiter character or string
+
+     Returns:
+        ut_output_varchar2_list - table of string
+
+   Splits a given string into table of string by delimiter.
+   The delimiter gets removed.
+   If null passed as any of the parameters, empty table is returned.
+   If no occurence of a_delimiter found in a_text then text is returned as a single row of the table.
+   If no text between delimiters found then an empty row is returned, example:
+     string_to_table( 'a,,b', ',' ) gives table ut_output_varchar2_list( 'a', null, 'b' );
+  */
+  function string_to_table(a_string varchar2, a_delimiter varchar2:= chr(10)) return ut_output_varchar2_list;
+
+  /*
+   Function: clob_to_table
+
+     Parameters:
+          a_clob - the text to be split.
+          a_delimiter - the delimiter character or string (default chr(10) )
+          a_max_amount - the maximum length of returned string (default 32767)
+
+     Returns:
+        ut_output_varchar2_list - table of string
+
+   Splits a given string into table of string by delimiter.
+   The delimiter gets removed.
+   If null passed as any of the parameters, empty table is returned.
+   If no occurence of a_delimiter found in a_text then text is returned as a single row of the table.
+   If no text between delimiters found then an empty row is returned, example:
+     string_to_table( 'a,,b', ',' ) gives table ut_output_varchar2_list( 'a', null, 'b' );
+  */
+  function clob_to_table(a_clob clob, a_delimiter varchar2:= chr(10), a_max_amount integer := 32767) return ut_output_varchar2_list pipelined;
+
 end ut_utils;
 /
diff --git a/source/install.sql b/source/install.sql
@@ -11,6 +11,7 @@ whenever sqlerror exit failure rollback
 whenever oserror exit failure rollback
 
 --common utilities
+@@core/types/ut_output_varchar2_list.tps
 @@core/ut_utils.pks
 @@core/ut_metadata.pks
 @@core/ut_utils.pkb
diff --git a/source/reporters/ut_dbms_output_suite_reporter.tpb b/source/reporters/ut_dbms_output_suite_reporter.tpb
@@ -14,18 +14,18 @@ create or replace type body ut_dbms_output_suite_reporter is
 
   overriding member procedure before_suite(self in out nocopy ut_dbms_output_suite_reporter, a_suite ut_object) as
   begin
-    self.print(ut_dbms_output_suite_reporter.c_dashed_line);
-    self.print('suite "' || a_suite.name || '" started.');
+    self.print_text(ut_dbms_output_suite_reporter.c_dashed_line);
+    self.print_text('suite "' || a_suite.name || '" started.');
   end;
 
   overriding member procedure before_test(self in out nocopy ut_dbms_output_suite_reporter, a_test ut_object) as
     test ut_test := treat(a_test as ut_test);
   begin
-    self.print(ut_dbms_output_suite_reporter.c_dashed_line);
+    self.print_text(ut_dbms_output_suite_reporter.c_dashed_line);
     if a_test.name is not null then
-      self.print('test  ' || test.name || ' (' || test.test.form_name || ')');
+      self.print_text('test  ' || test.name || ' (' || test.test.form_name || ')');
     else
-      self.print('test  ' || test.test.form_name);
+      self.print_text('test  ' || test.test.form_name);
     end if;
   end;
 
@@ -34,21 +34,21 @@ create or replace type body ut_dbms_output_suite_reporter is
   begin
     if l_assert is not null then
       if l_assert.message is not null then
-        self.print('message: '||l_assert.message);
+        self.print_text('message: '||l_assert.message);
       end if;
       if l_assert.result != ut_utils.tr_success then
-        self.print('expected: ' || l_assert.actual_value_string||'('||l_assert.actual_type||')');
-        self.print(
+        self.print_text('expected: ' || l_assert.actual_value_string||'('||l_assert.actual_type||')');
+        self.print_text(
           l_assert.name || l_assert.additional_info
           || case
                when l_assert.expected_value_string is not null or l_assert.expected_type is not null
                then ': '||l_assert.expected_value_string||'('||l_assert.expected_type||')'
              end
         );
-        self.print(l_assert.result_to_char());
+        self.print_text(l_assert.result_to_char());
       end if;
       if l_assert.error_message is not null then
-        self.print('error message: '||l_assert.error_message);
+        self.print_text('error message: '||l_assert.error_message);
       end if;
     end if;
   end;
@@ -57,17 +57,17 @@ create or replace type body ut_dbms_output_suite_reporter is
     l_test     ut_test_object := treat(a_test as ut_test);
     l_duration interval day(0) to second(6) := (l_test.end_time - l_test.start_time);
   begin
-    self.print('result: ' || l_test.result_to_char||'. Took: '||to_char(l_duration));
+    self.print_text('result: ' || l_test.result_to_char||'. Took: '||to_char(l_duration));
   end;
 
   overriding member procedure after_suite(self in out nocopy ut_dbms_output_suite_reporter, a_suite ut_object) as
     l_suite    ut_test_object := treat(a_suite as ut_test_object);
     l_duration interval day(0) to second(6) := (l_suite.end_time - l_suite.start_time);
   begin
     --todo: report total suite result here with pretty message
-    self.print(ut_dbms_output_suite_reporter.c_dashed_line);
-    self.print('suite "' || l_suite.name || '" ended. Took: '||to_char(l_duration));
-    self.print(ut_dbms_output_suite_reporter.c_dashed_line);
+    self.print_text(ut_dbms_output_suite_reporter.c_dashed_line);
+    self.print_text('suite "' || l_suite.name || '" ended. Took: '||to_char(l_duration));
+    self.print_text(ut_dbms_output_suite_reporter.c_dashed_line);
   end;
 
   overriding member procedure before_asserts_process(self in out nocopy ut_dbms_output_suite_reporter, a_test in ut_object) as
diff --git a/source/reporters/ut_teamcity_reporter.tpb b/source/reporters/ut_teamcity_reporter.tpb
diff --git a/source/uninstall.sql b/source/uninstall.sql

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+create or replace type ut_output_varchar2_list as table of varchar2(32767)`
	`2`	`+/`