Fixed examples.

jgebal · jgebal · commit 2ca26cd4b28d · 2017-01-21T13:18:52.000Z
Reworked buffer.
Added ut.run entry point for executing tests with single reporter.
diff --git a/examples/RunExampleTestAnnotationBasedForCurrentSchema.sql b/examples/RunExampleTestAnnotationBasedForCurrentSchema.sql
@@ -6,7 +6,7 @@ set echo off
 @@test_pkg2.pck
 
 begin
-  ut_runner.run();
+  ut.run();
 end;
 /
 
diff --git a/examples/RunExpectations.sql b/examples/RunExpectations.sql
@@ -11,7 +11,7 @@ set echo off
 @@demo_expectations.pck
 
 begin
-  ut_runner.run();
+  ut.run();
 end;
 /
 
diff --git a/examples/RunWithDocumentationReporter.sql b/examples/RunWithDocumentationReporter.sql
@@ -5,7 +5,7 @@ set echo off
 create or replace package demo_doc_reporter1 is
   -- %suite
   -- %displayname(Demo of documentation reporter)
-  
+
   -- %test
   -- %displayname(A passing test sample)
   procedure passing_test;
@@ -50,7 +50,7 @@ end;
 create or replace package demo_doc_reporter2 is
   -- %suite
   -- %displayname(A suite package without body)
-  
+
   -- %test
   -- %displayname(A test)
   procedure test1;
@@ -61,7 +61,7 @@ end;
 
 create or replace package suite_package_without_name is
   -- %suite
-  
+
   -- %test
   -- %displayname(A passing test sample)
   procedure passing_test1;
@@ -83,7 +83,7 @@ end;
 /
 
 begin
-  ut_runner.run();
+  ut.run();
 end;
 /
 
diff --git a/examples/award_bonus/run_award_bonus_test.sql b/examples/award_bonus/run_award_bonus_test.sql
@@ -4,7 +4,7 @@
 
 set serveroutput on size unlimited format truncated
 
-exec ut_runner.run(user||'.test_award_bonus');
+exec ut.run(user||'.test_award_bonus');
 
 drop package test_award_bonus;
 drop procedure award_bonus;
diff --git a/examples/between_string/run_betwnstr_test.sql b/examples/between_string/run_betwnstr_test.sql
@@ -3,7 +3,7 @@
 
 set serveroutput on size unlimited format truncated
 
-exec ut_runner.run(user||'.test_betwnstr');
+exec ut.run(user||'.test_betwnstr');
 
 drop package test_betwnstr;
 drop function betwnstr;
diff --git a/examples/demo_of_expectations/run.sql b/examples/demo_of_expectations/run.sql
@@ -2,7 +2,7 @@
 
 set serveroutput on size unlimited format truncated
 
-exec ut_runner.run(user||'.demo_equal_matcher');
+exec ut.run(user||'.demo_equal_matcher');
 
 drop package demo_equal_matcher;
 drop type demo_departments;
diff --git a/examples/developer_examples/RunExampleComplexSuiteWithCustomReporter.sql b/examples/developer_examples/RunExampleComplexSuiteWithCustomReporter.sql
@@ -1,5 +1,5 @@
 --Shows how to create a test suite with the default reporter which is dbms_output
---No tables are used for this.   
+--No tables are used for this.
 --Suite Management packages are when developed will make this easier.
 --Clear Screen
 Set Serveroutput On Size Unlimited format truncated
@@ -17,6 +17,7 @@ declare
   suite2        ut_logical_suite;
   suite_complex ut_logical_suite;
   listener      ut_event_listener;
+  l_run         ut_run;
 begin
   suite1 := ut_logical_suite(a_object_owner=>null, a_object_name => null, a_name => null, a_description => 'Test Suite 1', a_path => null);
 
@@ -44,7 +45,9 @@ begin
 
   -- provide a reporter to process results
   listener := ut_event_listener(ut_reporters(ut_custom_reporter(a_tab_size => 2)));
-  suite_complex.do_execute(listener);
+  l_run := ut_run(ut_suite_items(suite_complex));
+  l_run.do_execute(listener);
+  ut_output_buffer.lines_to_dbms_output(listener.reporters(1).reporter_id,0);
 end;
 /
 
diff --git a/examples/developer_examples/RunExampleTestSuiteWithCompositeReporter.sql b/examples/developer_examples/RunExampleTestSuiteWithCompositeReporter.sql
@@ -1,5 +1,5 @@
 --Shows how to create a test suite with the default reporter which is dbms_output
---No tables are used for this.   
+--No tables are used for this.
 --Suite Management packages are when developed will make this easier.
 --Clear Screen
 Set Serveroutput On Size Unlimited format truncated
@@ -14,6 +14,7 @@ PROMPT Runs test report using composite reporter
 declare
   suite         ut_logical_suite;
   listener      ut_event_listener;
+  l_run         ut_run;
 begin
   suite := ut_logical_suite(a_object_owner=>null, a_object_name => 'ut_exampletest', a_name => null, a_description => 'Test Suite Name',a_path => null);
 
@@ -36,7 +37,10 @@ begin
 
   -- provide a reporter to process results
   listener := ut_event_listener(ut_reporters(ut_documentation_reporter, ut_teamcity_reporter));
-  suite.do_execute(listener);
+  l_run := ut_run(ut_suite_items(suite));
+  l_run.do_execute(listener);
+  ut_output_buffer.lines_to_dbms_output(listener.reporters(1).reporter_id,0);
+  ut_output_buffer.lines_to_dbms_output(listener.reporters(2).reporter_id,0);
 end;
 /
 
diff --git a/examples/developer_examples/RunExampleTestSuiteWithCustomReporter.sql b/examples/developer_examples/RunExampleTestSuiteWithCustomReporter.sql
@@ -1,5 +1,5 @@
 --Shows how to create a test suite with the default reporter which is dbms_output
---No tables are used for this.   
+--No tables are used for this.
 --Suite Management packages are when developed will make this easier.
 --Clear Screen
 --http://stackoverflow.com/questions/2584492/how-to-prevent-dbms-output-put-line-from-trimming-leading-whitespace
@@ -16,8 +16,9 @@ set echo off
 declare
   suite         ut_logical_suite;
   listener      ut_event_listener;
+  l_run         ut_run;
 begin
-  -- Install ut_custom_reporter first from example folder	
+  -- Install ut_custom_reporter first from example folder
 
   suite := ut_logical_suite(a_object_owner=>null, a_object_name => 'ut_exampletest', a_name => null, a_description => 'Test Suite Name',a_path => null);
 
@@ -40,7 +41,9 @@ begin
 
   -- provide a reporter to process results tabbing each hierarcy level by tab_size
   listener := ut_event_listener(ut_reporters(ut_custom_reporter(a_tab_size => 2)));
-  suite.do_execute(listener);
+  l_run := ut_run(ut_suite_items(suite));
+  l_run.do_execute(listener);
+  ut_output_buffer.lines_to_dbms_output(listener.reporters(1).reporter_id,0);
 end;
 /
 
diff --git a/examples/remove_rooms_by_name/run_remove_rooms_by_name_test.sql b/examples/remove_rooms_by_name/run_remove_rooms_by_name_test.sql
@@ -4,7 +4,7 @@
 
 set serveroutput on size unlimited format truncated
 
-exec ut_runner.run(user||'.test_remove_rooms_by_name');
+exec ut.run(user||'.test_remove_rooms_by_name');
 
 drop package test_remove_rooms_by_name;
 drop procedure remove_rooms_by_name;
diff --git a/source/api/ut.pkb b/source/api/ut.pkb
@@ -64,11 +64,62 @@ create or replace package body ut is
   begin
     return ut_expectation_dsinterval(ut_data_value_dsinterval(a_actual), a_message);
   end;
-  
+
   procedure fail(a_message in varchar2) is
   begin
     ut_assert_processor.report_error(a_message);
   end;
 
+  function run(a_paths ut_varchar2_list, a_reporter ut_reporter_base := ut_documentation_reporter(), a_color_console boolean := false) return ut_varchar2_list pipelined is
+    l_reporter  ut_reporter_base := a_reporter;
+    l_lines     sys_refcursor;
+    l_line      varchar2(4000);
+  begin
+    if l_reporter is null then
+      l_reporter := ut_documentation_reporter();
+    end if;
+    ut_runner.run(a_paths, l_reporter, a_color_console);
+    l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
+    loop
+      fetch l_lines into l_line;
+      exit when l_lines%notfound;
+      pipe row(l_line);
+    end loop;
+    close l_lines;
+  end;
+
+  function run(a_path varchar2 := null, a_reporter ut_reporter_base := ut_documentation_reporter(), a_color_console boolean := false) return ut_varchar2_list pipelined is
+    l_reporter  ut_reporter_base := a_reporter;
+    l_lines     sys_refcursor;
+    l_line      varchar2(4000);
+  begin
+    if l_reporter is null then
+      l_reporter := ut_documentation_reporter();
+    end if;
+    ut_runner.run(a_path, a_reporter, a_color_console);
+    l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
+    loop
+      fetch l_lines into l_line;
+      exit when l_lines%notfound;
+      pipe row(l_line);
+    end loop;
+    close l_lines;
+  end;
+
+  procedure run(a_paths ut_varchar2_list, a_reporter ut_reporter_base := ut_documentation_reporter(), a_color_console boolean := false) is
+    l_reporter ut_reporter_base := a_reporter;
+  begin
+    if l_reporter is null then
+      l_reporter := ut_documentation_reporter();
+    end if;
+    ut_runner.run(a_paths, l_reporter, a_color_console);
+    ut_output_buffer.lines_to_dbms_output(l_reporter.reporter_id);
+  end;
+
+  procedure run(a_path varchar2 := null, a_reporter ut_reporter_base := ut_documentation_reporter(), a_color_console boolean := false) is
+  begin
+    ut.run(ut_varchar2_list(coalesce(a_path, sys_context('userenv', 'current_schema'))), a_reporter, a_color_console);
+  end;
+
 end ut;
 /
diff --git a/source/api/ut.pks b/source/api/ut.pks
@@ -25,8 +25,16 @@ create or replace package ut authid current_user as
   function expect(a_actual in yminterval_unconstrained, a_message varchar2 := null) return ut_expectation_yminterval;
 
   function expect(a_actual in dsinterval_unconstrained, a_message varchar2 := null) return ut_expectation_dsinterval;
-  
+
   procedure fail(a_message in varchar2);
 
+  function run(a_paths ut_varchar2_list, a_reporter ut_reporter_base := ut_documentation_reporter(), a_color_console boolean := false) return ut_varchar2_list pipelined;
+
+  function run(a_path varchar2 := null, a_reporter ut_reporter_base := ut_documentation_reporter(), a_color_console boolean := false) return ut_varchar2_list pipelined;
+
+  procedure run(a_paths ut_varchar2_list, a_reporter ut_reporter_base := ut_documentation_reporter(), a_color_console boolean := false);
+
+  procedure run(a_path varchar2 := null, a_reporter ut_reporter_base := ut_documentation_reporter(), a_color_console boolean := false);
+
 end ut;
 /
diff --git a/source/core/types/ut_reporter_base.tpb b/source/core/types/ut_reporter_base.tpb
@@ -3,18 +3,19 @@ create or replace type body ut_reporter_base is
   final member procedure init(self in out nocopy ut_reporter_base, a_self_type varchar2) is
   begin
     self.self_type   := a_self_type;
-    self.reporter_id := self.self_type||'-'||userenv('sessionid')||'-'||ut_utils.to_string(cast(current_timestamp as timestamp));
+    self.reporter_id := sys_guid();
+    self.start_date  := sysdate();
     return;
   end;
 
-  final member function get_reporter_id(self in out nocopy ut_reporter_base) return varchar2 is
+  final member function get_reporter_id(self in out nocopy ut_reporter_base) return raw is
   begin
     return self.reporter_id;
   end;
 
   member procedure print_text(self in out nocopy ut_reporter_base, a_text varchar2) is
   begin
-    ut_output_buffer.send_line(self.reporter_id,a_text);
+    ut_output_buffer.send_line(self,a_text);
   end;
 
   -- run hooks
@@ -112,7 +113,7 @@ create or replace type body ut_reporter_base is
   -- run hooks continued
   member procedure after_calling_run (self in out nocopy ut_reporter_base, a_run in ut_run) is
   begin
-    ut_output_buffer.close(self.reporter_id);
+    ut_output_buffer.close(self);
   end;
 end;
 /
diff --git a/source/core/types/ut_reporter_base.tps b/source/core/types/ut_reporter_base.tps
@@ -1,9 +1,10 @@
 create or replace type ut_reporter_base force authid current_user as object
 (
-  self_type    varchar2(250 char),
-  reporter_id  varchar2(250),
+  self_type    varchar2(250),
+  reporter_id  raw(32),
+  start_date   date,
   final member procedure init(self in out nocopy ut_reporter_base, a_self_type varchar2),
-  final member function get_reporter_id(self in out nocopy ut_reporter_base) return varchar2,
+  final member function get_reporter_id(self in out nocopy ut_reporter_base) return raw,
 
   member procedure print_text(self in out nocopy ut_reporter_base, a_text varchar2),
 
diff --git a/source/core/ut_message_id_seq.sql b/source/core/ut_message_id_seq.sql
@@ -0,0 +1 @@
+create sequence ut_message_id_seq nocycle cache 20;
diff --git a/source/core/ut_output_buffer.pkb b/source/core/ut_output_buffer.pkb
@@ -1,36 +1,36 @@
 create or replace package body ut_output_buffer is
 
-  procedure send_line(a_reporter_id varchar2, a_text varchar2) is
+  procedure send_line(a_reporter ut_reporter_base, a_text varchar2) is
     l_text_list  ut_varchar2_list;
     pragma autonomous_transaction;
   begin
-    if a_reporter_id is not null and a_text is not null then
+    if a_reporter is not null and a_reporter.reporter_id is not null and a_reporter.start_date is not null and a_text is not null then
       if length(a_text) > ut_utils.gc_max_storage_varchar2_len then
         l_text_list := ut_utils.clob_to_table(a_text, ut_utils.gc_max_storage_varchar2_len);
         forall i in 1 .. l_text_list.count
-          insert into ut_output_buffer_tmp(reporter_id, message_id, text)
-          values (a_reporter_id, ut_output_buffer_id_seq.nextval, l_text_list(i));
+          insert into ut_output_buffer_tmp(start_date, reporter_id, message_id, text)
+          values (a_reporter.start_date, a_reporter.reporter_id, ut_message_id_seq.nextval, l_text_list(i));
       else
-        insert into ut_output_buffer_tmp(reporter_id, message_id, text)
-        values (a_reporter_id, ut_output_buffer_id_seq.nextval, a_text);
+        insert into ut_output_buffer_tmp(start_date, reporter_id, message_id, text)
+        values (a_reporter.start_date, a_reporter.reporter_id, ut_message_id_seq.nextval, a_text);
       end if;
       commit;
     end if;
   end;
 
-  procedure close(a_reporter_id varchar2) is
+  procedure close(a_reporter ut_reporter_base) is
     pragma autonomous_transaction;
   begin
-    insert into ut_output_buffer_tmp(reporter_id, message_id, is_finished)
-    values (a_reporter_id, ut_output_buffer_id_seq.nextval, 1);
+    insert into ut_output_buffer_tmp(start_date, reporter_id, message_id, is_finished)
+    values (a_reporter.start_date, a_reporter.reporter_id, ut_message_id_seq.nextval, 1);
     commit;
   end;
 
   function get_lines(a_reporter_id varchar2, a_timeout_sec naturaln := gc_max_wait_sec) return ut_varchar2_list pipelined is
     pragma autonomous_transaction;
     l_results        ut_varchar2_list;
     l_wait_wait_time number(10,1) := 0;
-    c_sleep_time     number(1,1) := 0.1; --sleep for 100 ms between checks
+    c_sleep_time     number(1,1)  := 0.1; --sleep for 100 ms between checks
     l_finished       boolean := false;
   begin
     loop
@@ -60,11 +60,41 @@ create or replace package body ut_output_buffer is
     return;
   end;
 
+  function get_lines_cursor(a_reporter_id varchar2, a_timeout_sec naturaln := gc_max_wait_sec) return sys_refcursor is
+    l_lines sys_refcursor;
+  begin
+    open l_lines for
+      select column_value as text
+        from table(ut_output_buffer.get_lines(a_reporter_id, a_timeout_sec));
+    return l_lines;
+  end;
+
+  procedure lines_to_dbms_output(a_reporter_id varchar2, a_timeout_sec naturaln := gc_max_wait_sec) is
+    l_lines sys_refcursor;
+    l_line varchar2(32767);
+  begin
+    l_lines := ut_output_buffer.get_lines_cursor(a_reporter_id, a_timeout_sec);
+    loop
+      fetch l_lines into l_line;
+      dbms_output.put_line(l_line);
+      exit when l_lines%notfound;
+    end loop;
+    close l_lines;
+  end;
+
   procedure purge(a_reporters ut_reporters) is
   begin
     delete from ut_output_buffer_tmp t
      where t.reporter_id in (select r.reporter_id from table(a_reporters) r);
   end;
 
+  procedure cleanup_buffer(a_retention_time_sec naturaln := gc_buffer_retention_sec) is
+    l_retention_days number := a_retention_time_sec / (60 * 60 * 24);
+    l_max_retention_date date := sysdate - l_retention_days;
+  begin
+    delete from ut_output_buffer_tmp t
+     where t.start_date <= l_max_retention_date;
+  end;
+
 end;
 /
diff --git a/source/core/ut_output_buffer.pks b/source/core/ut_output_buffer.pks
diff --git a/source/core/ut_output_buffer_id_seq.sql b/source/core/ut_output_buffer_id_seq.sql
diff --git a/source/core/ut_output_buffer_tmp.sql b/source/core/ut_output_buffer_tmp.sql
diff --git a/source/install.sql b/source/install.sql
diff --git a/source/uninstall.sql b/source/uninstall.sql

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ set echo off`
`6`	`6`	`@@test_pkg2.pck`
`7`	`7`
`8`	`8`	`begin`
`9`		`- ut_runner.run();`
	`9`	`+ ut.run();`
`10`	`10`	`end;`
`11`	`11`	`/`
`12`	`12`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ set echo off`
`11`	`11`	`@@demo_expectations.pck`
`12`	`12`
`13`	`13`	`begin`
`14`		`- ut_runner.run();`
	`14`	`+ ut.run();`
`15`	`15`	`end;`
`16`	`16`	`/`
`17`	`17`