Merge remote-tracking branch 'origin/develop' into feature/1053_exclude_include_cov_by_regex

jgebal · jgebal · commit efa78a3bec81 · 2022-02-26T02:57:59.000+02:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -49,6 +49,14 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
+      - uses: c-py/action-dotenv-to-setenv@v2
+        with:
+          env-file: .github/variables/.env
+      - uses: FranzDiebold/github-env-vars-action@v2 #https://github.com/marketplace/actions/github-environment-variables-action
+      
+      - name: Set buid version number env variables
+        run: .github/scripts/set_version_numbers_env.sh
+
       - name: Update project version & build number in source code and documentation
         run: .github/scripts/update_project_version.sh
 
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-v3.1.12-develop
+v3.1.13-develop
diff --git a/docs/about/authors.md b/docs/about/authors.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 ### utPLSQL v3 Major Contributors 
 
diff --git a/docs/about/license.md b/docs/about/license.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Version Information
 
diff --git a/docs/about/project-details.md b/docs/about/project-details.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # utPLSQL Project Details
 
diff --git a/docs/about/support.md b/docs/about/support.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # How to get support
 
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Introduction to utPLSQL
 
diff --git a/docs/userguide/advanced_data_comparison.md b/docs/userguide/advanced_data_comparison.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Advanced data comparison
 
diff --git a/docs/userguide/annotations.md b/docs/userguide/annotations.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Annotations
 
@@ -2121,7 +2121,8 @@ It can be accessed from any procecure invoked as part of utPLSQL test execution.
 > For example if utPLSQL is installed into `HR` schema, the context name will be `HR_INFO`
 
 Following attributes are populated:
-- Always:
+- For entire duration of the test-run:
+    - `sys_context( 'UT3_INFO', 'COVERAGE_RUN_ID' );` - Value of COVERAGE_RUN_ID used by utPLSQL internally for coverage gathering 
     - `sys_context( 'UT3_INFO', 'RUN_PATHS' );` - list of suitepaths / suitenames used as input parameters for call to `ut.run(...)` or `ut_runner.run(...)`
     - `sys_context( 'UT3_INFO', 'SUITE_DESCRIPTION' );` - the description of test suite that is currently being executed
     - `sys_context( 'UT3_INFO', 'SUITE_PACKAGE' );` -  the owner and name of test suite package that is currently being executed
diff --git a/docs/userguide/best-practices.md b/docs/userguide/best-practices.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Best Practices
 
diff --git a/docs/userguide/coverage.md b/docs/userguide/coverage.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Coverage
 utPLSQL comes with a built-in coverage reporting engine. The code coverage reporting uses DBMS_PROFILER package provided with Oracle database.
diff --git a/docs/userguide/exception-reporting.md b/docs/userguide/exception-reporting.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Exception handling and reporting
 
diff --git a/docs/userguide/expectations.md b/docs/userguide/expectations.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Expectation concepts 
 Validation of the code under test (the tested logic of procedure/function etc.) is performed by comparing the actual data against the expected data.
diff --git a/docs/userguide/getting-started.md b/docs/userguide/getting-started.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Getting started with TDD and utPLSQL
 
diff --git a/docs/userguide/install.md b/docs/userguide/install.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Supported database versions
 
diff --git a/docs/userguide/querying_suites.md b/docs/userguide/querying_suites.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Qyerying for test suites
 
diff --git a/docs/userguide/reporters.md b/docs/userguide/reporters.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 utPLSQL provides the following reporting formats.
 
diff --git a/docs/userguide/running-unit-tests.md b/docs/userguide/running-unit-tests.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Running tests
 
diff --git a/docs/userguide/upgrade.md b/docs/userguide/upgrade.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)
 
 # Upgrading from version 2
 
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -3,7 +3,7 @@ sonar.organization=utplsql
 sonar.projectKey=utPLSQL
 # this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
 sonar.projectName=utPLSQL
-sonar.projectVersion=v3.1.12-develop
+sonar.projectVersion=v3.1.13-develop
 
 # Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
 # Since SonarQube 4.2, this property is optional if sonar.modules is set.
diff --git a/source/core/session_context/ut_session_info.tpb b/source/core/session_context/ut_session_info.tpb
@@ -28,12 +28,14 @@ create or replace type body ut_session_info as
   member procedure before_calling_run(self in out nocopy ut_session_info, a_run in ut_run) is
   begin
     ut_session_context.set_context( 'run_paths', ut_utils.to_string( ut_utils.table_to_clob( a_run.run_paths,',' ), null ) );
+    ut_session_context.set_context( 'coverage_run_id', rawtohex( a_run.coverage_options.coverage_run_id ) );
     dbms_application_info.set_module( 'utPLSQL', null );
   end;
 
   member procedure after_calling_run(self in out nocopy ut_session_info, a_run in ut_run) is
   begin
     ut_session_context.clear_context( 'run_paths' );
+    ut_session_context.clear_context( 'coverage_run_id' );
     dbms_application_info.set_module( module, action );
     dbms_application_info.set_client_info( client_info );
   end;
diff --git a/source/core/ut_utils.pks b/source/core/ut_utils.pks
@@ -21,7 +21,7 @@ create or replace package ut_utils authid definer is
    *
    */
 
-  gc_version                 constant varchar2(50) := 'v3.1.12.3872-develop';
+  gc_version                 constant varchar2(50) := 'v3.1.13.3889-develop';
     
   subtype t_executable_type      is varchar2(30);
   gc_before_all                  constant t_executable_type := 'beforeall';
diff --git a/source/reporters/ut_realtime_reporter.tpb b/source/reporters/ut_realtime_reporter.tpb
@@ -43,6 +43,7 @@ create or replace type body ut_realtime_reporter is
       self.print_node('objectName', a_test.item.object_name);
       self.print_node('procedureName', a_test.item.procedure_name);
       self.print_node('disabled', case when a_test.get_disabled_flag() then 'true' else 'false' end);
+      self.print_node('disabledReason', a_test.disabled_reason);
       self.print_node('name', a_test.name);
       self.print_node('description',  a_test.description);
       self.print_node('testNumber', to_char(total_number_of_tests));
diff --git a/test/ut3_user/api/test_ut_run.pkb b/test/ut3_user/api/test_ut_run.pkb
@@ -1268,7 +1268,8 @@ Failures:%
   procedure sys_ctx_on_suite_beforeall is
   begin
     ut.expect(g_context_test_results).to_be_like(
-      '%BEFORE_SUITE:CURRENT_EXECUTABLE_NAME='||gc_owner||'.check_context.before_suite'
+      '%BEFORE_SUITE:COVERAGE_RUN_ID=________________________________%'
+        ||'%BEFORE_SUITE:CURRENT_EXECUTABLE_NAME='||gc_owner||'.check_context.before_suite'
         ||'%BEFORE_SUITE:CURRENT_EXECUTABLE_TYPE=beforeall'
         ||'%BEFORE_SUITE:RUN_PATHS=check_context'
         ||'%BEFORE_SUITE:SUITE_DESCRIPTION=Suite description'
diff --git a/test/ut3_user/reporters/test_realtime_reporter.pkb b/test/ut3_user/reporters/test_realtime_reporter.pkb
@@ -45,6 +45,10 @@ create or replace package body test_realtime_reporter as
       --%test
       --%disabled
       procedure test_5;
+
+      --%test
+      --%disabled(Cannot run this item at this time runtime > 10 mins.)
+      procedure test_6_disabled_reason;
     end;]';
     execute immediate q'[create or replace package body check_realtime_reporting2 is
       procedure test_3_ok is
@@ -62,6 +66,11 @@ create or replace package body test_realtime_reporter as
       begin
         null;
       end;
+
+      procedure test_6_disabled_reason is
+      begin
+        null;
+      end;
     end;]';
  
     execute immediate q'[create or replace package check_realtime_reporting3 is
@@ -179,6 +188,8 @@ create or replace package body test_realtime_reporter as
       select 'post-test'  as event_type, 'realtime_reporting.check_realtime_reporting2.test_4_nok'                as item_id from dual union all
       select 'pre-test'   as event_type, 'realtime_reporting.check_realtime_reporting2.test_5'                    as item_id from dual union all
       select 'post-test'  as event_type, 'realtime_reporting.check_realtime_reporting2.test_5'                    as item_id from dual union all
+      select 'pre-test'   as event_type, 'realtime_reporting.check_realtime_reporting2.test_6_disabled_reason'    as item_id from dual union all
+      select 'post-test'  as event_type, 'realtime_reporting.check_realtime_reporting2.test_6_disabled_reason'    as item_id from dual union all
       select 'post-suite' as event_type, 'realtime_reporting.check_realtime_reporting2'                           as item_id from dual union all
       select 'pre-suite'  as event_type, 'realtime_reporting.check_realtime_reporting1'                           as item_id from dual union all
       select 'pre-suite'  as event_type, 'realtime_reporting.check_realtime_reporting1.test_context'              as item_id from dual union all
@@ -226,6 +237,7 @@ create or replace package body test_realtime_reporter as
         select 'event/items/suite/items/suite/items/test'             as node_path from dual union all
         select 'event/items/suite/items/suite/items/test'             as node_path from dual union all
         select 'event/items/suite/items/suite/items/test'             as node_path from dual union all
+        select 'event/items/suite/items/suite/items/test'             as node_path from dual union all
         select 'event/items/suite/items/suite'                        as node_path from dual union all
         select 'event/items/suite/items/suite/items'                  as node_path from dual union all
         select 'event/items/suite/items/suite/items/suite'            as node_path from dual union all
@@ -237,7 +249,7 @@ create or replace package body test_realtime_reporter as
   
   procedure total_number_of_tests is
     l_actual   integer;
-    l_expected integer := 8; 
+    l_expected integer := 9;
   begin
     select t.event_doc.extract('/event/totalNumberOfTests/text()').getnumberval()
       into l_actual
@@ -283,9 +295,9 @@ create or replace package body test_realtime_reporter as
           and t.event_doc.extract('//test/@id').getstringval() is not null;
     open l_expected for
        select level as test_number, 
-              8     as total_number_of_tests 
+              9     as total_number_of_tests
          from dual
-      connect by level <= 8;
+      connect by level <= 9;
     ut.expect(l_actual).to_equal(l_expected).unordered;
   end pre_test_nodes;
   
@@ -311,9 +323,9 @@ create or replace package body test_realtime_reporter as
           and t.event_doc.extract('//test/counter/warning/text()').getnumberval() is not null;
     open l_expected for
        select level as test_number, 
-              8     as total_number_of_tests 
+              9     as total_number_of_tests
          from dual
-      connect by level <= 8;
+      connect by level <= 9;
     ut.expect(l_actual).to_equal(l_expected).unordered;
   end post_test_nodes;
 
@@ -494,6 +506,22 @@ create or replace package body test_realtime_reporter as
     ut.expect(l_xml is not null).to_be_true();
   end;
 
+  procedure disabled_reason is
+    l_actual   varchar2(32767);
+    l_expected varchar2(80) := dbms_xmlgen.convert('Cannot run this item at this time runtime > 10 mins.');
+  begin
+    select t.event_doc.extract(
+             '//test/disabledReason/text()'
+           ).getstringval()
+      into l_actual
+      from table(g_events) t
+     where xmlexists(
+       '/event[@type="pre-run"]/*//test[@id="realtime_reporting.check_realtime_reporting2.test_6_disabled_reason"]'
+       passing t.event_doc
+    );
+    ut.expect(l_actual).to_equal(l_expected);
+  end;
+
   procedure remove_test_suites is
     pragma autonomous_transaction;
   begin
diff --git a/test/ut3_user/reporters/test_realtime_reporter.pks b/test/ut3_user/reporters/test_realtime_reporter.pks
@@ -57,6 +57,9 @@ create or replace package test_realtime_reporter as
   --%test(Escape nested CDATA sections in test output)
   procedure nested_cdata_output;
 
+  --%test(Provide reason disabled test)
+  procedure disabled_reason;
+
   --%afterall
   procedure remove_test_suites;
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-![version](https://img.shields.io/badge/version-v3.1.12.3872--develop-blue.svg)`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.13.3889--develop-blue.svg)`
`2`	`2`
`3`	`3`	`### utPLSQL v3 Major Contributors`
`4`	`4`