Updated report formatting and separated responsibilities of: report content and report formatting between methods

jgebal · jgebal · commit 6547ebaffb5c · 2018-02-04T01:29:06.000Z
diff --git a/source/core/ut_utils.pkb b/source/core/ut_utils.pkb
@@ -268,14 +268,6 @@ create or replace package body ut_utils is
     return l_result;
   end;
 
-  procedure append_to_clob(a_clob in out nocopy clob, a_clob_table t_clob_tab, a_delimiter varchar2:= chr(10)) is
-  begin
-    for i in 1 .. a_clob_table.count loop
-      append_to_clob(a_clob,a_delimiter);
-      dbms_lob.append(a_clob,a_clob_table(i));
-    end loop;
-  end;
-
   function time_diff(a_start_time timestamp with time zone, a_end_time timestamp with time zone) return number is
   begin
     return
@@ -316,6 +308,21 @@ create or replace package body ut_utils is
     end if;
   end append_to_varchar2_list;
 
+  procedure append_to_clob(a_src_clob in out nocopy clob, a_clob_table t_clob_tab, a_delimiter varchar2:= chr(10)) is
+  begin
+    if a_clob_table is not null and cardinality(a_clob_table) > 0 then
+      if a_src_clob is null then
+        dbms_lob.createtemporary(a_src_clob, true);
+      end if;
+      for i in 1 .. a_clob_table.count loop
+        dbms_lob.append(a_src_clob,a_clob_table(i));
+        if i < a_clob_table.count then
+          append_to_clob(a_src_clob,a_delimiter);
+        end if;
+      end loop;
+    end if;
+  end;
+
   procedure append_to_clob(a_src_clob in out nocopy clob, a_new_data clob) is
   begin
     if a_new_data is not null and dbms_lob.getlength(a_new_data) > 0 then
diff --git a/source/core/ut_utils.pks b/source/core/ut_utils.pks
@@ -198,8 +198,6 @@ create or replace package ut_utils authid definer is
 
   function table_to_clob(a_text_table ut_varchar2_list, a_delimiter varchar2:= chr(10)) return clob;
 
-  procedure append_to_clob(a_clob in out nocopy clob, a_clob_table t_clob_tab, a_delimiter varchar2 := chr(10));
-
   /**
    * Returns time difference in seconds (with miliseconds) between given timestamps
    */
@@ -221,7 +219,10 @@ create or replace package ut_utils authid definer is
    */
   procedure append_to_varchar2_list(a_list in out nocopy ut_varchar2_list, a_line varchar2);
 
+  procedure append_to_clob(a_src_clob in out nocopy clob, a_clob_table t_clob_tab, a_delimiter varchar2 := chr(10));
+
   procedure append_to_clob(a_src_clob in out nocopy clob, a_new_data clob);
+
   procedure append_to_clob(a_src_clob in out nocopy clob, a_new_data varchar2);
 
   function convert_collection(a_collection ut_varchar2_list) return ut_varchar2_rows;
diff --git a/source/expectations/data_values/ut_data_value.tpb b/source/expectations/data_values/ut_data_value.tpb
@@ -35,24 +35,26 @@ create or replace type body ut_data_value as
     return false;
   end;
 
-  final member function format_multi_line( a_string varchar2) return varchar2 is
+  member function get_object_info return varchar2 is
   begin
-    if is_multi_line() then
-      return chr(10)||rtrim(a_string,chr(10))||chr(10);
-    else
-      return a_string;
-    end if;
+    return self.data_type;
   end;
 
-  final member function to_string_report(a_add_new_line_for_multi_line boolean := false, a_with_type_name boolean := true) return varchar2 is
+  final member function to_string_report(a_add_new_line_for_multi_line boolean := false, a_with_object_info boolean := true) return varchar2 is
     l_result varchar2(32767);
+    l_info   varchar2(32767);
   begin
-    l_result := ut_utils.indent_lines( self.to_string() );
-    if a_with_type_name then
-      l_result := l_result ||' ('||self.data_type||') ';
+    if a_with_object_info then
+      l_info := '('||get_object_info()||')';
     end if;
-    if self.is_multi_line and a_add_new_line_for_multi_line then
-      l_result := l_result || chr(10);
+    if self.is_multi_line() then
+      l_result :=
+        l_info || chr(10) || ut_utils.indent_lines( rtrim(self.to_string(),chr(10)), a_include_first_line =>true );
+      if a_add_new_line_for_multi_line then
+        l_result := l_result || chr(10);
+      end if;
+    else
+      l_result := self.to_string() || ' ' || l_info || ' ';
     end if;
     return l_result;
   end;
diff --git a/source/expectations/data_values/ut_data_value.tps b/source/expectations/data_values/ut_data_value.tps
@@ -19,9 +19,9 @@ create or replace type ut_data_value authid current_user as object (
   self_type         varchar2(250 char),
   not instantiable member function is_null return boolean,
   not instantiable member function to_string return varchar2,
+  member function get_object_info return varchar2,
   member function is_multi_line return boolean,
-  final member function format_multi_line( a_string varchar2) return varchar2,
-  final member function to_string_report(a_add_new_line_for_multi_line boolean := false, a_with_type_name boolean := true) return varchar2,
+  final member function to_string_report(a_add_new_line_for_multi_line boolean := false, a_with_object_info boolean := true) return varchar2,
   order member function compare( a_other ut_data_value ) return integer,
   member function is_diffable return boolean,
   member function diff( a_other ut_data_value ) return varchar2,
diff --git a/source/expectations/data_values/ut_data_value_anydata.tpb b/source/expectations/data_values/ut_data_value_anydata.tpb
@@ -16,11 +16,6 @@ create or replace type body ut_data_value_anydata as
   limitations under the License.
   */
 
-  overriding member function is_null return boolean is
-  begin
-    return true;
-  end;
-
   overriding member function to_string return varchar2 is
     l_result varchar2(32767);
     l_clob   clob;
@@ -33,7 +28,7 @@ create or replace type body ut_data_value_anydata as
       l_result := ut_utils.to_string( l_clob, null );
       ut_expectation_processor.reset_nls_params();
     end if;
-    return self.format_multi_line( l_result );
+    return l_result;
   end;
 
   overriding member function compare_implementation(a_other ut_data_value) return integer is
@@ -77,11 +72,26 @@ create or replace type body ut_data_value_anydata as
     return l_result;
   end;
 
-  final member procedure init(self in out nocopy ut_data_value_anydata, a_value anydata, a_self_type varchar2) is
+  final member procedure init(self in out nocopy ut_data_value_anydata, a_value anydata, a_data_object_type varchar2) is
   begin
     self.data_value := a_value;
-    self.self_type  := a_self_type;
     self.data_type  := case when a_value is not null then lower(a_value.gettypename) else 'undefined' end;
+    if data_value is not null then
+      execute immediate '
+        declare
+          l_data '||self.data_value.gettypename()||';
+          l_value anydata := :a_value;
+          l_status integer;
+        begin
+          l_status := l_value.get'||a_data_object_type||'(l_data);
+          :l_data_is_null := case when l_data is null then 1 else 0 end;
+        end;' using in self.data_value, out self.data_value_is_null;
+    end if;
+  end;
+
+  overriding member function is_null return boolean is
+  begin
+    return self.data_value is null or ut_utils.int_to_boolean(self.data_value_is_null);
   end;
 
   static function get_instance(a_data_value anydata, a_exclude varchar2 := null, a_include varchar2 := null) return ut_data_value_anydata is
diff --git a/source/expectations/data_values/ut_data_value_anydata.tps b/source/expectations/data_values/ut_data_value_anydata.tps
@@ -17,6 +17,8 @@ create or replace type ut_data_value_anydata under ut_data_value(
   */
 
   data_value anydata,
+
+  data_value_is_null integer,
   /**
    *  Holds xpath (list of attributes) to exclude when comparing object
    */
@@ -26,10 +28,10 @@ create or replace type ut_data_value_anydata under ut_data_value(
    */
   include_xpath   varchar2(32767),
 
-  overriding member function is_null return boolean,
   overriding member function to_string return varchar2,
   overriding member function compare_implementation( a_other ut_data_value ) return integer,
-  final member procedure init(self in out nocopy ut_data_value_anydata, a_value anydata, a_self_type varchar2),
+  final member procedure init(self in out nocopy ut_data_value_anydata, a_value anydata, a_data_object_type varchar2),
+  overriding member function is_null return boolean,
   static function get_instance(a_data_value anydata, a_exclude varchar2 := null, a_include varchar2 := null) return ut_data_value_anydata,
   static function get_instance(a_data_value anydata, a_exclude ut_varchar2_list, a_include ut_varchar2_list) return ut_data_value_anydata
 ) not final not instantiable
diff --git a/source/expectations/data_values/ut_data_value_blob.tpb b/source/expectations/data_values/ut_data_value_blob.tpb
@@ -31,7 +31,7 @@ create or replace type body ut_data_value_blob as
 
   overriding member function to_string return varchar2 is
   begin
-    return self.format_multi_line( ut_utils.to_string(self.data_value) );
+    return ut_utils.to_string(self.data_value);
   end;
 
   overriding member function compare_implementation(a_other ut_data_value) return integer is
diff --git a/source/expectations/data_values/ut_data_value_clob.tpb b/source/expectations/data_values/ut_data_value_clob.tpb
@@ -31,7 +31,7 @@ create or replace type body ut_data_value_clob as
 
   overriding member function to_string return varchar2 is
   begin
-    return self.format_multi_line( ut_utils.to_string(self.data_value) );
+    return ut_utils.to_string(self.data_value);
   end;
 
   overriding member function compare_implementation(a_other ut_data_value) return integer is
diff --git a/source/expectations/data_values/ut_data_value_collection.tpb b/source/expectations/data_values/ut_data_value_collection.tpb
@@ -18,48 +18,27 @@ create or replace type body ut_data_value_collection as
 
   constructor function ut_data_value_collection(self in out nocopy ut_data_value_collection, a_value anydata) return self as result is
   begin
-    self.init(a_value, $$plsql_unit);
-    return;
-  end;
-
-  overriding member function is_null return boolean is
-    l_is_null       boolean;
-    l_data_is_null  pls_integer;
-    l_sql           varchar2(32767);
-    l_cursor        number;
-    l_status        number;
-  begin
-    if self.data_value is null then
-      l_is_null := true;
-    --check if typename is a schema based object
-    else
-      --XMLTYPE doesn't like the null being passed to ANYDATA so we need to check if anydata holds null Object/collection
-      l_sql := '
+    self.self_type  := $$plsql_unit;
+    self.init(a_value, 'collection');
+    if a_value is not null then
+      execute immediate '
         declare
-          l_data '||self.data_value.gettypename()||';
+          l_data '||a_value.gettypename()||';
           l_value anydata := :a_value;
-          x integer;
+          l_status integer;
         begin
-          x := l_value.getCollection(l_data);
-          :l_data_is_null := case when l_data is null then 1 else 0 end;
-        end;';
-      l_cursor := sys.dbms_sql.open_cursor();
-      sys.dbms_sql.parse(l_cursor, l_sql, dbms_sql.native);
-      sys.dbms_sql.bind_variable(l_cursor,'a_value',self.data_value);
-      sys.dbms_sql.bind_variable(l_cursor,'l_data_is_null',l_data_is_null);
-      begin
-        l_status := sys.dbms_sql.execute(l_cursor);
-        sys.dbms_sql.variable_value(l_cursor,'l_data_is_null',l_data_is_null);
-        sys.dbms_sql.close_cursor(l_cursor);
-      exception when others then
-        if sys.dbms_sql.is_open(l_cursor) then
-          sys.dbms_sql.close_cursor(l_cursor);
-        end if;
-        raise;
-      end;
-      l_is_null := ut_utils.int_to_boolean(l_data_is_null);
+          l_status := l_value.getCollection(l_data);
+          if l_data is not null then
+            :l_count := l_data.count;
+          end if;
+        end;' using in self.data_value, out self.elements_count;
     end if;
-    return l_is_null;
+    return;
+  end;
+
+  overriding member function get_object_info return varchar2 is
+  begin
+    return self.data_type||' [ count = '||self.elements_count||' ]';
   end;
 
   member function is_empty return boolean is
diff --git a/source/expectations/data_values/ut_data_value_collection.tps b/source/expectations/data_values/ut_data_value_collection.tps
@@ -15,8 +15,11 @@ create or replace type ut_data_value_collection under ut_data_value_anydata(
   See the License for the specific language governing permissions and
   limitations under the License.
   */
+
+  elements_count integer,
+
   constructor function ut_data_value_collection(self in out nocopy ut_data_value_collection, a_value anydata) return self as result,
-  overriding member function is_null return boolean,
+  overriding member function get_object_info return varchar2,
   member function is_empty return boolean,
   overriding member function is_multi_line return boolean
 )
diff --git a/source/expectations/data_values/ut_data_value_object.tpb b/source/expectations/data_values/ut_data_value_object.tpb
@@ -18,50 +18,11 @@ create or replace type body ut_data_value_object as
 
   constructor function ut_data_value_object(self in out nocopy ut_data_value_object, a_value anydata) return self as result is
   begin
-    self.init(a_value, $$plsql_unit);
+    self.self_type  := $$plsql_unit;
+    self.init(a_value, 'object');
     return;
   end;
 
-  overriding member function is_null return boolean is
-    l_is_null       boolean;
-    l_data_is_null  pls_integer;
-    l_sql           varchar2(32767);
-    l_cursor        number;
-    l_status        number;
-  begin
-    if self.data_value is null then
-      l_is_null := true;
-    --check if typename is a schema based object
-    else
-      --XMLTYPE doesn't like the null being passed to ANYDATA so we need to check if anydata holds null Object/collection
-      l_sql := '
-        declare
-          l_data '||self.data_value.gettypename()||';
-          l_value anydata := :a_value;
-          x integer;
-        begin
-          x := l_value.getObject(l_data);
-          :l_data_is_null := case when l_data is null then 1 else 0 end;
-        end;';
-      l_cursor := sys.dbms_sql.open_cursor();
-      sys.dbms_sql.parse(l_cursor, l_sql, dbms_sql.native);
-      sys.dbms_sql.bind_variable(l_cursor,'a_value',self.data_value);
-      sys.dbms_sql.bind_variable(l_cursor,'l_data_is_null',l_data_is_null);
-      begin
-        l_status := sys.dbms_sql.execute(l_cursor);
-        sys.dbms_sql.variable_value(l_cursor,'l_data_is_null',l_data_is_null);
-        sys.dbms_sql.close_cursor(l_cursor);
-      exception when others then
-        if sys.dbms_sql.is_open(l_cursor) then
-          sys.dbms_sql.close_cursor(l_cursor);
-        end if;
-        raise;
-      end;
-      l_is_null := ut_utils.int_to_boolean(l_data_is_null);
-    end if;
-    return l_is_null;
-  end;
-
   overriding member function is_multi_line return boolean is
   begin
     return not self.is_null();
diff --git a/source/expectations/data_values/ut_data_value_object.tps b/source/expectations/data_values/ut_data_value_object.tps
@@ -16,7 +16,6 @@ create or replace type ut_data_value_object under ut_data_value_anydata(
   limitations under the License.
   */
   constructor function ut_data_value_object(self in out nocopy ut_data_value_object, a_value anydata) return self as result,
-  overriding member function is_null return boolean,
   overriding member function is_multi_line return boolean
 )
 /
diff --git a/source/expectations/data_values/ut_data_value_refcursor.tpb b/source/expectations/data_values/ut_data_value_refcursor.tpb
@@ -39,6 +39,11 @@ create or replace type body ut_data_value_refcursor as
     return;
   end;
 
+  overriding member function get_object_info return varchar2 is
+  begin
+    return self.data_type||' [ count = '||self.row_count||' ]';
+  end;
+
   member procedure init(self in out nocopy ut_data_value_refcursor, a_value sys_refcursor) is
     l_ctx                 number;
     l_xml                 xmltype;
@@ -126,12 +131,11 @@ create or replace type body ut_data_value_refcursor as
            and ucd.item_no <= :max_rows'
       bulk collect into l_results using self.data_set_guid, c_max_rows;
 
-    ut_utils.append_to_clob(l_result,'row count: '||row_count);
     ut_utils.append_to_clob(l_result,l_results);
 
     l_result_string := ut_utils.to_string(l_result,null);
     dbms_lob.freetemporary(l_result);
-    return self.format_multi_line( l_result_string );
+    return l_result_string;
   end;
 
   overriding member function is_diffable return boolean is
@@ -167,7 +171,7 @@ create or replace type body ut_data_value_refcursor as
                           and rownum <= :max_rows'
       bulk collect into l_results using c_pad_depth, self.data_set_guid, l_diff_id, c_max_rows;
 
-    ut_utils.append_to_clob(l_result,'(count: ' || to_char(l_diff_row_count) ||')');
+    ut_utils.append_to_clob(l_result,'[ count = ' || to_char(l_diff_row_count) ||' ]' || chr(10));
     ut_utils.append_to_clob(l_result,l_results);
 
     l_result_string := ut_utils.to_string(l_result,null);
diff --git a/source/expectations/data_values/ut_data_value_refcursor.tps b/source/expectations/data_values/ut_data_value_refcursor.tps
@@ -50,8 +50,9 @@ create or replace type ut_data_value_refcursor under ut_data_value(
   constructor function ut_data_value_refcursor(self in out nocopy ut_data_value_refcursor, a_value sys_refcursor, a_exclude ut_varchar2_list := null, a_include ut_varchar2_list) return self as result,
   member procedure init(self in out nocopy ut_data_value_refcursor, a_value sys_refcursor),
   overriding member function is_null return boolean,
-  overriding member function to_string return varchar2,
   overriding member function is_diffable return boolean,
+  overriding member function get_object_info return varchar2,
+  overriding member function to_string return varchar2,
   overriding member function diff( a_other ut_data_value ) return varchar2,
   member function is_empty return boolean,
   overriding member function is_multi_line return boolean,
diff --git a/source/expectations/data_values/ut_data_value_varchar2.tpb b/source/expectations/data_values/ut_data_value_varchar2.tpb
@@ -31,7 +31,7 @@ create or replace type body ut_data_value_varchar2 as
 
   overriding member function to_string return varchar2 is
   begin
-    return self.format_multi_line( ut_utils.to_string(self.data_value) );
+    return ut_utils.to_string(self.data_value);
   end;
 
   overriding member function compare_implementation(a_other ut_data_value) return integer is
diff --git a/source/expectations/matchers/ut_be_between.tpb b/source/expectations/matchers/ut_be_between.tpb
diff --git a/source/expectations/matchers/ut_equal.tpb b/source/expectations/matchers/ut_equal.tpb
diff --git a/test/core/expectations/compound_data/test_expect_to_be_empty.pkb b/test/core/expectations/compound_data/test_expect_to_be_empty.pkb
diff --git a/test/core/expectations/compound_data/test_expectation_anydata.pkb b/test/core/expectations/compound_data/test_expectation_anydata.pkb
diff --git a/test/core/expectations/compound_data/test_expectations_cursor.pkb b/test/core/expectations/compound_data/test_expectations_cursor.pkb
