work in progress

jgebal · jgebal · commit 217913e7d86d · 2016-11-13T11:24:29.000Z
diff --git a/.travis/create_utplsql_user.sql b/.travis/create_utplsql_user.sql
@@ -13,6 +13,9 @@ create user &ut3_user identified by &ut3_password default tablespace &ut3_tables
 
 grant create session, create procedure, create type, create table to &ut3_user;
 
+grant execute on dbms_pipe to &ut3_user;
+grant create job to &ut3_user;
+
 grant alter session to &ut3_user;
 
 exit success
diff --git a/source/core/types/ut_output_clob_list.tps b/source/core/types/ut_output_clob_list.tps
@@ -0,0 +1,2 @@
+create or replace type ut_output_clob_list as table of clob
+/
diff --git a/source/core/types/ut_output_dbms_pipe.tpb b/source/core/types/ut_output_dbms_pipe.tpb
@@ -0,0 +1,83 @@
+create or replace type body ut_output_dbms_pipe as
+
+  constructor function ut_output_dbms_pipe(self in out nocopy ut_output_dbms_pipe) return self as result is
+  begin
+    self.output_type := $$plsql_unit;
+    self.output_id := ut_output_dbms_pipe.generate_output_id;
+    return;
+  end;
+
+  overriding member procedure open(self in out nocopy ut_output_dbms_pipe) is
+    l_buffer_size_bytes integer := 100 * 1024 * 1024;
+    l_flag integer;
+  begin
+    --create an explixit private pipe
+    --explicitly created pipes need to be removed explicitly
+    --otherwise they stay in memmory forever
+    --https://docs.oracle.com/cd/B19306_01/appdev.102/b14258/d_pipe.htm#CHDEICJI
+    --to check ig there are any non-purged pipes execute:
+    --select * from v$db_pipes where pipe_size > 0 order by name desc;
+    l_flag := dbms_pipe.create_pipe(self.output_id, l_buffer_size_bytes);
+  end;
+
+  overriding member procedure send(self in out nocopy ut_output_dbms_pipe, a_text clob) is
+    --we're assuming bax of 4 bytes per char
+    c_size_limit_chars constant integer := 1000;
+    l_text_part varchar2(4000 byte);
+    l_timeout_occured boolean;
+    i integer := 0;
+  begin
+    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);
+      i := i + c_size_limit_chars;
+    end loop;
+    ut_output_pipe_helper.send( self.output_id, ut_utils.gc_output_eom );
+  end;
+
+  overriding member procedure close(self in out nocopy ut_output_dbms_pipe) is
+  begin
+    self.send(ut_utils.gc_output_eot);
+  end;
+
+  static function get_lines(a_output_id varchar2, a_timeout_sec integer := 60*60*4) return ut_output_clob_list pipelined is
+    l_flag            integer;
+    l_text_part       varchar2(4000 byte);
+    l_text            clob;
+    l_timeout_occured boolean;
+  begin
+    if a_output_id is null then
+      return;
+    end if;
+    loop
+      dbms_lob.createtemporary(l_text, true);
+      loop
+        l_timeout_occured := dbms_pipe.receive_message(a_output_id, a_timeout_sec) != 0;
+        exit when l_timeout_occured;
+
+        dbms_pipe.unpack_message(l_text_part);
+        exit when (l_text_part = ut_utils.gc_output_eom or l_text_part = ut_utils.gc_output_eot);
+        dbms_lob.writeappend(l_text,length(l_text_part),l_text_part);
+      end loop;
+      pipe row( l_text );
+      exit when (l_text_part = ut_utils.gc_output_eot);
+    end loop;
+    l_flag := dbms_pipe.remove_pipe(a_output_id);
+    return;
+  end;
+
+  member procedure to_screen(self in ut_output_dbms_pipe) is
+  begin
+    for i in (select column_value as text_line from table( ut_output_dbms_pipe.get_lines( self.output_id ) ) ) loop
+      dbms_output.put_line(i.text_line);
+    end loop;
+  end;
+
+  static procedure to_screen(a_output_id varchar2) is
+  begin
+    for i in (select column_value as text_line from table( ut_output_dbms_pipe.get_lines( a_output_id ) ) ) loop
+      dbms_output.put_line(i.text_line);
+    end loop;
+  end;
+end;
+/
diff --git a/source/core/types/ut_output_dbms_pipe.tps b/source/core/types/ut_output_dbms_pipe.tps
@@ -0,0 +1,11 @@
+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 close(self in out nocopy ut_output_dbms_pipe),
+  static function generate_output_id return varchar2,
+  static function get_lines(a_output_id varchar2, a_timeout_sec integer := 60*60*4) return ut_output_clob_list pipelined,
+  member procedure to_screen(self in ut_output_dbms_pipe),
+  static procedure to_screen(a_output_id varchar2)
+) not final
+/
diff --git a/source/core/ut_output_pipe_helper.pkb b/source/core/ut_output_pipe_helper.pkb
@@ -0,0 +1,80 @@
+create or replace package body ut_output_pipe_helper is
+
+
+  type t_pipe_buffer is table of varchar2(4000);
+  type t_outputs_buffer is table of t_pipe_buffer index by varchar2(128);
+
+  g_outputs_buffer t_outputs_buffer;
+
+  procedure send_from_buffer(a_output_id varchar2) is
+    l_timeout_occured boolean;
+    i integer;
+  begin
+    if g_outputs_buffer.exists(a_output_id) then
+      i :=  g_outputs_buffer(a_output_id).first;
+      while i is not null loop
+        dbms_pipe.pack_message( g_outputs_buffer(a_output_id)(i) );
+        l_timeout_occured := dbms_pipe.send_message(a_output_id, 0) != 0;
+        if l_timeout_occured then
+          dbms_pipe.reset_buffer;
+          return;
+        end if;
+      end loop;
+    end if;
+  end;
+
+  --sends a message to a named pipe
+  --and if sending fails it writes the message to the end of the buffer for pipe
+  procedure send(a_output_id varchar2, a_text varchar2) is
+    l_timeout_occured boolean;
+  begin
+      send_from_buffer(a_output_id);
+      dbms_pipe.pack_message( a_text );
+      l_timeout_occured := dbms_pipe.send_message(a_output_id, 0) != 0;
+      if l_timeout_occured then
+        dbms_pipe.reset_buffer;
+        buffer(a_output_id, a_text);
+      end if;
+  end;
+
+  --writes the message to the end of the buffer for pipe
+  procedure buffer(a_output_id varchar2, a_text varchar2) is
+  begin
+    if not g_outputs_buffer.exists(a_output_id) then
+      g_outputs_buffer(a_output_id) := t_pipe_buffer();
+    end if;
+    g_outputs_buffer(a_output_id).extend;
+    g_outputs_buffer(a_output_id)(g_outputs_buffer(a_output_id).last) :=  a_text;
+  end;
+
+  --registers a close request and tries to close a pipe
+  --by first sending out all messages remaining in the buffers
+  --the procedure holds infomrmation about closure requests
+  --so that if close is not possble as buffer was not yet flusehd
+  --it will proceed to other close requests
+  --scenario with failure:
+  -- two buffers used: output_1, output_2
+  -- call is made to close output_1
+  -- register the close request
+  -- send all messaged from output_1 buffer
+  -- if buffer not empty and timeout
+  -- go to output_2
+  -- if output_2 is still open, return
+  -- so the outout_1 close request is in a pending state
+  -- next a call should be made from framework to close output_2
+  -- register the close request
+  -- send all messaged from output_2 buffer
+  -- if buffer not empty and timeout
+  -- go to output_1
+  -- if output_1 has a pending close
+  -- try to send from output_1 buffer
+  -- if timeout -> raise
+  --scenario with success:
+  -- two buffers used: output_1, output_2
+  procedure request_close(a_output_id varchar2, a_text varchar2) is
+  begin
+    null;
+  end;
+
+end;
+/
diff --git a/source/core/ut_output_pipe_helper.pks b/source/core/ut_output_pipe_helper.pks
@@ -0,0 +1,37 @@
+create or replace package ut_output_pipe_helper is
+
+  --sends a message to a named pipe
+  --and if sending fails it writes the message to the end of the buffer for pipe
+  procedure send(a_output_id varchar2, a_text varchar2);
+
+  --writes the message to the end of the buffer for pipe
+  procedure buffer(a_output_id varchar2, a_text varchar2);
+
+  --registers a close request and tries to close a pipe
+  --by first sending out all messages remaining in the buffers
+  --the procedure holds infomrmation about closure requests
+  --so that if close is not possble as buffer was not yet flusehd
+  --it will proceed to other close requests
+  --scenario with failure:
+  -- two buffers used: output_1, output_2
+  -- call is made to close output_1
+  -- register the close request
+  -- send all messaged from output_1 buffer
+  -- if buffer not empty and timeout
+  -- go to output_2
+  -- if output_2 is still open, return
+  -- so the outout_1 close request is in a pending state
+  -- next a call should be made from framework to close output_2
+  -- register the close request
+  -- send all messaged from output_2 buffer
+  -- if buffer not empty and timeout
+  -- go to output_1
+  -- if output_1 has a pending close
+  -- try to send from output_1 buffer
+  -- if timeout -> raise
+  --scenario with success:
+  -- two buffers used: output_1, output_2
+  procedure request_close(a_output_id varchar2, a_text varchar2);
+
+end;
+/
diff --git a/source/core/ut_utils.pks b/source/core/ut_utils.pks
@@ -40,6 +40,8 @@ create or replace package ut_utils authid definer is
   gc_timestamp_format         constant varchar2(100) := 'yyyy-mm-dd"T"hh24:mi:ssxff';
   gc_timestamp_tz_format      constant varchar2(100) := 'yyyy-mm-dd"T"hh24:mi:ssxff tzh:tzm';
   gc_null_string              constant varchar2(4) := 'NULL';
+  gc_output_eom               constant varchar2(30) := '[{-end-of-message-}]';
+  gc_output_eot               constant varchar2(30) := '[{-end-of-transmission-}]';
   /*
      Function: test_result_to_char
         returns a string representation of a test_result.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+create or replace type ut_output_clob_list as table of clob`
	`2`	`+/`