Added reporting of line where assertion has failed.

jgebal · jgebal · commit 274af66a9367 · 2016-11-27T01:14:44.000Z
Addded separate example with demo of ut_documentation_reporter
diff --git a/examples/RunAllExamples.sql b/examples/RunAllExamples.sql
@@ -20,3 +20,5 @@ prompt RunExampleTestAnnotationsHugePackage
 @@RunExampleTestAnnotationsHugePackage.sql
 prompt RunExpectations
 @@RunExpectations.sql
+prompt RunWithDocumentationReporter
+RunWithDocumentationReporter.sql
diff --git a/examples/RunExpectations.sql b/examples/RunExpectations.sql
@@ -3,7 +3,7 @@
 --Suite Management packages are when developed will make this easier.
 --Clear Screen
 Set Serveroutput On Size Unlimited format truncated
-set linesize 1000
+set linesize 10000
 set echo off
 --install the example unit test packages
 @@department.tps
diff --git a/examples/RunWithDocumentationReporter.sql b/examples/RunWithDocumentationReporter.sql
@@ -0,0 +1,82 @@
+Set Serveroutput On Size Unlimited format truncated
+set linesize 10000
+set echo off
+
+create or replace package demo_doc_reporter1 is
+  -- %suite(Demo of documentation reporter)
+  -- %test(A passing test sample)
+  procedure passing_test;
+  -- %test
+  procedure test_without_name;
+  -- %test(A failing test exsample)
+  procedure failing_test;
+  -- %test
+  procedure failing_no_name;
+  -- %test(repoting exception)
+  procedure failing_exception_raised;
+end;
+/
+
+create or replace package body demo_doc_reporter1 is
+
+  procedure passing_test is begin null; end;
+
+  procedure test_without_name is
+  begin
+    ut.expect(1).to_(equal(1));
+  end;
+
+  procedure failing_test is
+  begin
+    ut.expect(1).to_(equal(2));
+  end;
+  procedure failing_no_name is
+  begin
+    ut.expect(sysdate).to_(equal(to_char(sysdate)));
+  end;
+  procedure failing_exception_raised is
+    l_date date;
+  begin
+    l_date := to_date('abcd');
+  end;
+end;
+/
+
+create or replace package demo_doc_reporter2 is
+  -- %suite(A suite pacakge without body)
+  -- %test(A test)
+  procedure passing_test1;
+  -- %test
+  procedure passing_test2;
+end;
+/
+
+create or replace package suite_package_without_name is
+  -- %suite
+  -- %test(A passing test sample)
+  procedure passing_test1;
+  -- %test(A passing test sample)
+  procedure passing_test2;
+end;
+/
+
+create or replace package body suite_package_without_name is
+
+  procedure passing_test1 is begin null; end;
+
+  procedure passing_test2 is
+  begin
+    ut.expect(1).to_(equal(1));
+  end;
+end;
+/
+
+begin
+  ut_suite_manager.run_cur_schema_suites_static(ut_documentation_reporter(), a_force_parse_again => true);
+end;
+/
+
+
+drop package demo_doc_reporter2;
+drop package suite_package_without_name;
+drop package demo_doc_reporter1;
diff --git a/source/core/types/ut_assert_result.tpb b/source/core/types/ut_assert_result.tpb
@@ -7,6 +7,7 @@ create or replace type body ut_assert_result is
     self.object_type   := 0;
     self.result        := a_result;
     self.error_message := a_error_message;
+    self.caller_info   := ut_assert_processor.who_called_expectation();
     return;
   end ut_assert_result;
 
@@ -24,6 +25,7 @@ create or replace type body ut_assert_result is
     self.actual_type           := a_actual_type;
     self.expected_value_string := a_expected_value_string;
     self.actual_value_string   := a_actual_value_string;
+    self.caller_info           := ut_assert_processor.who_called_expectation();
     return;
   end ut_assert_result;
 
diff --git a/source/core/types/ut_assert_result.tps b/source/core/types/ut_assert_result.tps
@@ -7,6 +7,7 @@ create or replace type ut_assert_result force under ut_object
   actual_value_string   varchar2(4000 char),
   message               varchar2(4000 char),
   error_message         varchar2(4000 char),
+  caller_info           varchar2(4000 char),
   constructor function ut_assert_result(self in out nocopy ut_assert_result, a_result integer, a_error_message varchar2, a_name varchar2 default null)
     return self as result,
   constructor function ut_assert_result(self in out nocopy ut_assert_result, a_name varchar2, a_additional_info varchar2, a_error_message varchar2,
diff --git a/source/core/types/ut_test.tpb b/source/core/types/ut_test.tpb
@@ -70,9 +70,8 @@ create or replace type body ut_test is
               -- dbms_utility.format_error_backtrace is 10g or later
               -- utl_call_stack package may be better but it's 12c but still need to investigate
               -- article with details: http://www.oracle.com/technetwork/issue-archive/2014/14-jan/o14plsql-2045346.html
-              ut_utils.debug_log('testmethod failed-' || sqlerrm(sqlcode) || ' ' || dbms_utility.format_error_backtrace);
-
-              ut_assert_processor.report_error(sqlerrm(sqlcode) || ' ' || dbms_utility.format_error_backtrace);
+              ut_utils.debug_log('test method failed-' || sqlerrm(sqlcode) || ' ' || dbms_utility.format_error_stack || dbms_utility.format_error_backtrace);
+              ut_assert_processor.report_error( dbms_utility.format_error_stack || dbms_utility.format_error_backtrace );
           end;
           a_reporter.after_test_execute(self);
 
@@ -92,8 +91,7 @@ create or replace type body ut_test is
           end if;
           ut_utils.debug_log('ut_test.execute failed-' || sqlerrm(sqlcode) || ' ' || dbms_utility.format_error_backtrace);
           -- most likely occured in setup or teardown if here.
-          ut_assert_processor.report_error(sqlerrm(sqlcode) || ' ' || dbms_utility.format_error_stack);
-          ut_assert_processor.report_error(sqlerrm(sqlcode) || ' ' || dbms_utility.format_error_backtrace);
+          ut_assert_processor.report_error( dbms_utility.format_error_stack || dbms_utility.format_error_backtrace );
       end;
 
       if self.rollback_type = ut_utils.gc_rollback_auto then
diff --git a/source/core/ut_assert_processor.pkb b/source/core/ut_assert_processor.pkb
@@ -111,5 +111,45 @@ create or replace package body ut_assert_processor as
 
   end;
 
+  function get_source_definition_line(a_owner varchar2, a_object_name varchar2, a_line_no integer) return varchar2 is
+    l_line varchar2(4000);
+  begin
+    execute immediate
+      q'[select text from dba_source
+          where owner = :a_owner and name = :a_object_name and line = :a_line_no
+             -- skip the declarations, consider only definitions
+            and type not in ('PACKAGE', 'TYPE') ]'
+      into l_line using a_owner, a_object_name, a_line_no;
+    return '"'||ltrim(rtrim( lower( l_line ), chr(10) ))||'"';
+  exception
+    when no_data_found then
+      return null;
+  end;
+
+  function who_called_expectation return varchar2 is
+    l_call_stack                 varchar2(32767) := dbms_utility.format_call_stack();
+    l_caller_stack_line          varchar2(4000);
+    l_caller_type_and_name       varchar2(4000);
+    l_line_no                    integer;
+    l_owner                      varchar2(100);
+    l_object_name                varchar2(100);
+    l_last_space_pos             integer;
+    l_object_delimiter_pos       integer;
+    c_expectation_search_pattern constant varchar2(50) := '(.*\.UT_EXPECTATION[A-Z0-9#_$]*\s)+(.*)\s';
+  begin
+    l_caller_stack_line    := regexp_substr( l_call_stack, c_expectation_search_pattern, 1, 1, 'm', 2);
+    l_line_no              := to_number( trim( substr( l_caller_stack_line, 11, 10 ) ) );
+    l_caller_type_and_name    := substr( l_caller_stack_line, 23 );
+    l_last_space_pos       := instr( l_caller_type_and_name, ' ', -1 );
+    l_object_delimiter_pos := instr( l_caller_type_and_name, '.' );
+    if l_object_delimiter_pos > 0 then
+      l_owner := substr( l_caller_type_and_name, l_last_space_pos + 1, l_object_delimiter_pos - l_last_space_pos - 1 );
+      l_object_name  := substr( l_caller_type_and_name, l_object_delimiter_pos + 1 );
+    end if;
+    return
+      case when l_owner is not null and l_object_name is not null and l_line_no is not null then
+        'at "'||l_owner||'.'||l_object_name||'", line '||l_line_no||' '||get_source_definition_line(l_owner, l_object_name, l_line_no)
+      end;
+  end;
 end;
 /
diff --git a/source/core/ut_assert_processor.pks b/source/core/ut_assert_processor.pks
@@ -22,5 +22,13 @@ create or replace package ut_assert_processor authid current_user as
 
   procedure reset_nls_params;
 
+  -- function is looking at call stack
+  -- and tries to figure out at which line of code
+  -- in a unit test, the expectation was called
+  -- if found, it returns a text:
+  --   at: owner.name:line "source code line text"
+  -- The text is to be consumed by expectation result
+  function who_called_expectation return varchar2;
+
 end;
 /
diff --git a/source/core/ut_utils.pkb b/source/core/ut_utils.pkb
@@ -81,7 +81,7 @@ create or replace package body ut_utils is
       case
         when l_len = 0 then gc_null_string
         when l_len <= gc_max_input_string_length then quote_string(rawtohex(a_value))
-        else to_string( rawtohex(dbms_lob.substr(a_value, gc_overflow_substr_len)) )
+        else quote_string( rawtohex(dbms_lob.substr(a_value, gc_overflow_substr_len)) )
       end;
   end;
 
@@ -135,5 +135,10 @@ create or replace package body ut_utils is
       extract(second from(a_end_time - a_start_time));
   end;
 
+  function indent_lines(a_text varchar2, a_indent_size integer) return varchar2 is
+  begin
+    return replace( a_text, chr(10), chr(10) || lpad( ' ', a_indent_size ) );
+  end;
+
 end ut_utils;
 /
diff --git a/source/core/ut_utils.pks b/source/core/ut_utils.pks
@@ -90,5 +90,7 @@ create or replace package ut_utils authid definer is
 
   function time_diff(a_start_time timestamp with time zone, a_end_time timestamp with time zone) return number;
 
+  function indent_lines(a_text varchar2, a_indent_size integer) return varchar2;
+
 end ut_utils;
 /
diff --git a/source/reporters/ut_documentation_reporter.tpb b/source/reporters/ut_documentation_reporter.tpb
@@ -12,10 +12,8 @@ create or replace type body ut_documentation_reporter is
   end;
 
   member function tab(self in ut_documentation_reporter) return varchar2 is
-    tab_str varchar2(255);
   begin
-    tab_str := rpad(' ', lvl * 2);
-    return tab_str;
+    return rpad(' ', self.lvl * 2);
   end tab;
 
   overriding member procedure print(self in out nocopy ut_documentation_reporter, a_text varchar2) is
@@ -82,18 +80,25 @@ create or replace type body ut_documentation_reporter is
                 self.print('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(
-                  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
-                );
+                if l_assert.actual_value_string is not null or l_assert.actual_type is not null then
+                  self.print('expected: '||ut_utils.indent_lines( l_assert.actual_value_string||'('||l_assert.actual_type||')', self.lvl*2+length('expected: ') ) );
+                end if;
+                if l_assert.name is not null or l_assert.additional_info is not null
+                   or l_assert.expected_value_string is not null or l_assert.expected_type is not null then
+                  self.print(
+                    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 ': '||ut_utils.indent_lines( l_assert.expected_value_string||'('||l_assert.expected_type||')', self.lvl*2+length(l_assert.name || l_assert.additional_info||': ') )
+                       end
+                  );
+                end if;
               end if;
               if l_assert.error_message is not null then
-                self.print('error: '||l_assert.error_message);
+                self.print('error: '||ut_utils.indent_lines( l_assert.error_message, self.lvl*2+length('error: ') ) );
               end if;
+              self.print(l_assert.caller_info);
+              self.print('');
             end if;
           end loop;
           lvl := lvl - 4;
@@ -117,9 +122,6 @@ create or replace type body ut_documentation_reporter is
         when igonred_test_count > 0 then ', '||igonred_test_count||' ignored'
       end
     );
-    --todo: report total suite result here with pretty message
---    self.print('suite "' || l_suite.name || '" ended. Took: '||to_char(l_duration));
---    self.print(ut_documentation_reporter.c_dashed_line);
   end;
 
 end;

Original file line number	Diff line number	Diff line change
`@@ -90,5 +90,7 @@ create or replace package ut_utils authid definer is`
`90`	`90`
`91`	`91`	`function time_diff(a_start_time timestamp with time zone, a_end_time timestamp with time zone) return number;`
`92`	`92`
	`93`	`+ function indent_lines(a_text varchar2, a_indent_size integer) return varchar2;`
	`94`	`+`
`93`	`95`	`end ut_utils;`
`94`	`96`	`/`