utPLSQL · lwasylow · Apr 16, 2018 · Mar 11, 2018 · Mar 13, 2018 · Mar 13, 2018
diff --git a/docs/userguide/coverage.md b/docs/userguide/coverage.md
@@ -53,6 +53,40 @@ The report allow you to navigate to each source file and inspect line by line co
 ![Coverage Details page](../images/coverage_html_details.png)
 
 
+#### Oracle 12.2 block coverage.
+In Oracle 12.2 new functionality was released which supports native [block coverage](https://docs.oracle.com/en/database/oracle/oracle-database/12.2/arpls/DBMS_PLSQL_CODE_COVERAGE.html#GUID-55A9E502-9EC2-4118-B292-DC79E6DC465E).
+This has been enabled in utPLSQL code coverage as a separate option. It can be invoked by passing a argument a_coverage_type with value 'block'. By default profiler option is enabled ('proftab').
+
+Example:
+```sql
+begin
+  ut.run(ut_coverage_html_reporter(),a_coverage_type => 'block');
+end;
+/
+```
+
+In this mode html reporter will show additionally number of lines that been partially covered and highlight them in orange. Number of blocks in code, blocks covered and missed.
+
+#### Oracle 12.2 extended coverage with profiler and block coverage
+Using data collected from profiler and block coverage running parallel we are able to enrich information about coverage.
+For every line recorded by profiler if we have a partially covered same line in block coverage we will display that information
+presenting line as partially covered and displaying number of block and how many blocks been covered in that line.
+
+Example:
+```sql
+begin
+  ut.run(ut_coverage_html_reporter(),a_coverage_type => 'extended');
+end;
+/
+```
+
+Sample output:
+![Package Coverage Summary](../images/extended_coverage_html_summary.png)
+
+![Line Coverage Details](../images/extended_coverage_html_line.png)
+
+
+
 ### Coverage reporting options
 
 There are two distinct ways to gather code coverage:

diff --git a/source/api/ut.pkb b/source/api/ut.pkb
@@ -113,8 +113,8 @@ create or replace package body ut is
   begin
     ut_runner.run(
       a_paths, ut_reporters(coalesce(a_reporter,ut_documentation_reporter())),
-      ut_utils.int_to_boolean(a_color_console), a_coverage_schemes,
-      a_source_file_mappings, a_test_file_mappings, a_include_objects, a_exclude_objects
+      ut_utils.int_to_boolean(a_color_console), a_coverage_schemes, a_source_file_mappings, 
+      a_test_file_mappings, a_include_objects, a_exclude_objects, false
     );
     rollback;
   end;
@@ -131,7 +131,7 @@ create or replace package body ut is
       ut_utils.int_to_boolean(a_color_console), a_coverage_schemes,
       ut_file_mapper.build_file_mappings(a_source_files),
       ut_file_mapper.build_file_mappings(a_test_files),
-      a_include_objects, a_exclude_objects
+      a_include_objects, a_exclude_objects, false
     );
     rollback;
   end;
@@ -376,7 +376,7 @@ create or replace package body ut is
   begin
     ut.run(
       l_paths, a_reporter, a_color_console, a_coverage_schemes, a_source_files, a_test_files,
-      a_include_objects, a_exclude_objects
+      a_include_objects, a_exclude_objects 
     );
   end;
 

diff --git a/source/api/ut_runner.pks b/source/api/ut_runner.pks
@@ -58,7 +58,8 @@ create or replace package ut_runner authid current_user is
   procedure run(
     a_paths ut_varchar2_list, a_reporters ut_reporters, a_color_console boolean := false,
     a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
-    a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null, a_fail_on_errors boolean default false
+    a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null, 
+    a_fail_on_errors boolean default false
   );
 
   /**

diff --git a/source/core/coverage/dbms_plssqlcode.sql b/source/core/coverage/dbms_plssqlcode.sql
@@ -0,0 +1,8 @@
+begin
+  $if dbms_db_version.version = 12 and dbms_db_version.release >= 2 or dbms_db_version.version > 12 $then
+    dbms_plsql_code_coverage.create_coverage_tables(force_it => true);
+  $else
+    null;
+  $end
+end;
+/
diff --git a/source/core/coverage/ut_coverage.pkb b/source/core/coverage/ut_coverage.pkb
@@ -16,21 +16,10 @@ create or replace package body ut_coverage is
   limitations under the License.
   */
 
+
   type t_source_lines is table of binary_integer;
 
-  -- The source query has two important transformations done in it.
-  -- the flag: to_be_skipped ='Y' is set for a line of code that is badly reported by DBMS_PROFILER as executed 0 times.
-  -- This includes lines that are:
-  --   - PACKAGE, PROCEDURE, FUNCTION definition line,
-  --   - BEGIN, END  of a block
-  -- Another transformation is adjustment of line number for TRIGGER body.
-  -- DBMS_PROFILER is reporting line numbers for triggers not as defined in DBA_SOURCE, its usign line numbers as defined in DBA_TRIGGERS
-  -- the DBA_TRIGGERS does not contain the trigger specification lines, only lines that define the trigger body.
-  -- the query adjusts the line numbers for triggers by finding first occurrence of begin|declare|compound in the trigger body line.
-  -- The subquery is optimized by:
-  -- - COALESCE function -> it will execute only for TRIGGERS
-  -- - scalar subquery cache -> it will only execute once for one trigger source code.
-  function get_cov_sources_sql(a_coverage_options ut_coverage_options) return varchar2 is
+  function get_cov_sources_sql(a_coverage_options ut_coverage_options, a_skipped_lines varchar2 default 'Y') return varchar2 is
     l_result varchar2(32767);
     l_full_name varchar2(100);
     l_view_name      varchar2(200) := ut_metadata.get_dba_view('dba_source');
@@ -54,8 +43,10 @@ create or replace package body ut_coverage is
                      where t.owner = s.owner and t.type = s.type and t.name = s.name
                        and regexp_like( t.text, '[A-Za-z0-9$#_]*(begin|declare|compound).*','i'))
                  ) as line,
-                 s.text,
-                 case
+                 s.text, ]';
+     if a_skipped_lines = 'Y' then
+      l_result := l_result ||
+                 q'[case
                    when
                      -- to avoid execution of regexp_like on every line
                      -- first do a rough check for existence of search pattern keyword
@@ -70,8 +61,13 @@ create or replace package body ut_coverage is
                         '^([\t ]*(((not)?\s*(overriding|final|instantiable)[\t ]*)*(static|constructor|member)?[\t ]*(procedure|function)|package([\t ]+body)|begin|end([\t ]+\S+)*[ \t]*;))', 'i'
                      )
                     then 'Y'
-                 end as to_be_skipped
-            from ]'||l_view_name||q'[ s]';
+                 end as to_be_skipped ]';
+    else
+      l_result := l_result || q'['N' as to_be_skipped ]';
+    end if;
+
+    l_result := l_result ||' from '||l_view_name||q'[ s]';
+
     if a_coverage_options.file_mappings is not empty then
       l_result := l_result || '
             join table(:file_mappings) f
@@ -95,7 +91,7 @@ create or replace package body ut_coverage is
     return l_result;
   end;
 
-  function get_cov_sources_cursor(a_coverage_options ut_coverage_options) return sys_refcursor is
+  function get_cov_sources_cursor(a_coverage_options in ut_coverage_options,a_sql in varchar2) return sys_refcursor is
     l_cursor        sys_refcursor;
     l_skip_objects  ut_object_names;
     l_sql           varchar2(32767);
@@ -104,7 +100,7 @@ create or replace package body ut_coverage is
       --skip all the utplsql framework objects and all the unit test packages that could potentially be reported by coverage.
       l_skip_objects := ut_utils.get_utplsql_objects_list() multiset union all coalesce(a_coverage_options.exclude_objects, ut_object_names());
     end if;
-    l_sql := get_cov_sources_sql(a_coverage_options);
+    l_sql := a_sql;
     if a_coverage_options.file_mappings is not empty then
       open l_cursor for l_sql using a_coverage_options.file_mappings, l_skip_objects;
     elsif a_coverage_options.include_objects is not empty then
@@ -115,7 +111,7 @@ create or replace package body ut_coverage is
     return l_cursor;
   end;
 
-  procedure populate_tmp_table(a_coverage_options ut_coverage_options) is
+  procedure populate_tmp_table(a_coverage_options in ut_coverage_options,a_sql in varchar2) is
     pragma autonomous_transaction;
     l_cov_sources_crsr sys_refcursor;
     l_cov_sources_data ut_coverage_helper.t_coverage_sources_tmp_rows;
@@ -124,7 +120,7 @@ create or replace package body ut_coverage is
     if not ut_coverage_helper.is_tmp_table_populated() or ut_coverage_helper.is_develop_mode() then
       ut_coverage_helper.cleanup_tmp_table();
 
-      l_cov_sources_crsr := get_cov_sources_cursor(a_coverage_options);
+      l_cov_sources_crsr := get_cov_sources_cursor(a_coverage_options,a_sql);
 
       loop
         fetch l_cov_sources_crsr bulk collect into l_cov_sources_data limit 1000;
@@ -143,14 +139,14 @@ create or replace package body ut_coverage is
   /**
   * Public functions
   */
-  procedure coverage_start is
+  procedure coverage_start(a_coverage_options ut_coverage_options default null) is
   begin
     ut_coverage_helper.coverage_start('utPLSQL Code coverage run '||ut_utils.to_string(systimestamp));
   end;
 
-  procedure coverage_start_develop is
+  procedure coverage_start_develop(a_coverage_options ut_coverage_options default null) is
   begin
-    ut_coverage_helper.coverage_start_develop();
+    ut_coverage_helper.coverage_start_develop;
   end;
 
   procedure coverage_pause is
@@ -174,81 +170,54 @@ create or replace package body ut_coverage is
   end;
 
   function get_coverage_data(a_coverage_options ut_coverage_options) return t_coverage is
-    l_line_calls          ut_coverage_helper.t_unit_line_calls;
-    l_result              t_coverage;
-    l_new_unit            t_unit_coverage;
-    l_line_no              binary_integer;
-    l_source_objects_crsr ut_coverage_helper.t_tmp_table_objects_crsr;
-    l_source_object       ut_coverage_helper.t_tmp_table_object;
+    l_result_block           ut_coverage.t_coverage;
+    l_result_profiler_enrich ut_coverage.t_coverage;
+    l_object                 ut_coverage.t_full_name;
+    l_line_no                binary_integer;
   begin
-
-    --prepare global temp table with sources
-    populate_tmp_table(a_coverage_options);
-
-    l_source_objects_crsr := ut_coverage_helper.get_tmp_table_objects_cursor();
-    loop
-      fetch l_source_objects_crsr into l_source_object;
-      exit when l_source_objects_crsr%notfound;
-
-      --get coverage data
-      l_line_calls := ut_coverage_helper.get_raw_coverage_data( l_source_object.owner, l_source_object.name );
-
-      --if there is coverage, we need to filter out the garbage (badly indicated data from dbms_profiler)
-      if l_line_calls.count > 0 then
-        --remove lines that should not be indicted as meaningful
-        for i in 1 .. l_source_object.to_be_skipped_list.count loop
-          if l_source_object.to_be_skipped_list(i) is not null then
-            l_line_calls.delete(l_source_object.to_be_skipped_list(i));
-          end if;
-        end loop;
-      end if;
-
-      --if there are no file mappings or object was actually captured by profiler
-      if a_coverage_options.file_mappings is null or l_line_calls.count > 0 then
-
-        --populate total stats
-        l_result.total_lines := l_result.total_lines + l_source_object.lines_count;
-
-        --populate object level coverage stats
-        if not l_result.objects.exists(l_source_object.full_name) then
-          l_result.objects(l_source_object.full_name) := l_new_unit;
-          l_result.objects(l_source_object.full_name).owner := l_source_object.owner;
-          l_result.objects(l_source_object.full_name).name  := l_source_object.name;
-          l_result.objects(l_source_object.full_name).total_lines := l_source_object.lines_count;
+    -- Get raw data for both reporters, order is important as tmp table will skip headers and dont populate 
+    -- tmp table for block again.
+    l_result_profiler_enrich:= ut_coverage_profiler.get_coverage_data(a_coverage_options => a_coverage_options);
+
+   -- If block coverage available we will use it.
+   $if dbms_db_version.version = 12 and dbms_db_version.release >= 2 or dbms_db_version.version > 12 $then
+    l_result_block := ut_coverage_block.get_coverage_data(a_coverage_options => a_coverage_options);
+
+    -- Enrich profiler results with some of the block results
+    l_object := l_result_profiler_enrich.objects.first;
+    while (l_object is not null)
+     loop
+
+      l_line_no := l_result_profiler_enrich.objects(l_object).lines.first;
+
+      -- to avoid no data found check if we got object in profiler
+      if l_result_block.objects.exists(l_object) then
+      while (l_line_no is not null)
+       loop         
+        -- To avoid no data check for object line
+        if l_result_block.objects(l_object).lines.exists(l_line_no) then
+         -- enrich line level stats
+         l_result_profiler_enrich.objects(l_object).lines(l_line_no).partcove := l_result_block.objects(l_object).lines(l_line_no).partcove;
+         l_result_profiler_enrich.objects(l_object).lines(l_line_no).covered_blocks := l_result_block.objects(l_object).lines(l_line_no).covered_blocks;
+         l_result_profiler_enrich.objects(l_object).lines(l_line_no).no_blocks := l_result_block.objects(l_object).lines(l_line_no).no_blocks;
+         -- enrich object level stats
+         l_result_profiler_enrich.objects(l_object).partcovered_lines :=  nvl(l_result_profiler_enrich.objects(l_object).partcovered_lines,0) + l_result_block.objects(l_object).lines(l_line_no).partcove;    
         end if;
-        --map to results
-        l_line_no := l_line_calls.first;
-        if l_line_no is null then
-          l_result.uncovered_lines := l_result.uncovered_lines + l_source_object.lines_count;
-          l_result.objects(l_source_object.full_name).uncovered_lines := l_source_object.lines_count;
-        else
-          loop
-            exit when l_line_no is null;
-
-            if l_line_calls(l_line_no) > 0 then
-              --total stats
-              l_result.covered_lines := l_result.covered_lines + 1;
-              l_result.executions := l_result.executions + l_line_calls(l_line_no);
-              --object level stats
-              l_result.objects(l_source_object.full_name).covered_lines := l_result.objects(l_source_object.full_name).covered_lines + 1;
-              l_result.objects(l_source_object.full_name).executions := l_result.objects(l_source_object.full_name).executions + l_line_calls(l_line_no);
-            elsif l_line_calls(l_line_no) = 0 then
-              l_result.uncovered_lines := l_result.uncovered_lines + 1;
-              l_result.objects(l_source_object.full_name).uncovered_lines := l_result.objects(l_source_object.full_name).uncovered_lines + 1;
-            end if;
-            l_result.objects(l_source_object.full_name).lines(l_line_no) := l_line_calls(l_line_no);
-
-            l_line_no := l_line_calls.next(l_line_no);
-          end loop;
-        end if;
-      end if;
-
-    end loop;
-
-    close l_source_objects_crsr;
-
-    return l_result;
-  end get_coverage_data;
-
+        --At the end go to next line
+        l_line_no := l_result_profiler_enrich.objects(l_object).lines.next(l_line_no);
+       end loop;
+       --total level stats enrich
+       l_result_profiler_enrich.partcovered_lines := nvl(l_result_profiler_enrich.partcovered_lines,0) + l_result_profiler_enrich.objects(l_object).partcovered_lines;
+      -- At the end go to next object
+     end if;
+
+     l_object := l_result_profiler_enrich.objects.next(l_object);
+
+     end loop;    
+    $end   
+
+    return l_result_profiler_enrich;
+  end get_coverage_data;  
+
 end;
 /