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

jgebal · jgebal · commit 5201f2adb543 · 2022-02-27T01:15:18.000+02:00
diff --git a/.github/scripts/validate_report_files.sh b/.github/scripts/validate_report_files.sh
@@ -7,7 +7,7 @@ XSD_DIR="${SCRIPT_DIR}/xsd"
 XML_JAR_DIR="${SCRIPT_DIR}/lib"
 #XML Validator
 XML_VALIDATOR="$XML_JAR_DIR/xml_validator.jar"
-HTML_VALIDATOR_URL="https://validator.w3.org/nu/"
+HTML_VALIDATOR_URL="http://localhost:8888/"
 
 HTML_FILENAME="coverage.html"
 declare -A XML_FILES
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -60,6 +60,10 @@ jobs:
             oracle-base: '/opt/oracle'
 
     services:
+      html_checker:
+        image: ghcr.io/validator/validator:latest
+        options: >-
+          -p 8888:8888
       oracle:
         image: ${{matrix.oracle-version}}
         env:
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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--develop-blue.svg)
 
 # Introduction to utPLSQL
 
@@ -31,7 +31,7 @@ The framework follows industry standards and best patterns of modern Unit Testin
 
 Have a look at our [demo project](https://github.com/utPLSQL/utPLSQL-demo-project/).
 
-It uses [Travis CI](https://travis-ci.org/utPLSQL/utPLSQL-demo-project) to build on every commit, runs all tests, publishes test results and code coverage to [SonarQube](https://sonarqube.com/dashboard?id=utPLSQL%3AutPLSQL-demo-project%3Adevelop).
+It uses [Travis CI](https://travis-ci.org/utPLSQL/utPLSQL-demo-project) to build on every commit, runs all tests, publishes test results and code coverage to [SonarCloud](https://sonarcloud.io/project/overview?id=utPLSQL:utPLSQL-demo-project).
 
 # Three steps
 
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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--develop-blue.svg)
 
 # Annotations
 
@@ -127,7 +127,7 @@ end;
 | `--%suite(<description>)` | Package | Mandatory. Marks package as a test suite. Optional suite description can be provided (see `displayname`). |
 | `--%suitepath(<path>)` | Package | Similar to java package. The annotation allows logical grouping of suites into hierarchies. |
 | `--%displayname(<description>)` | Package/procedure | Human-readable and meaningful description of a context/suite/test. Overrides the `<description>` provided with `suite`/`test`/`context` annotation. This annotation is redundant and might be removed in future releases. |
-| `--%test(<description>)` | Procedure | Denotes that the annotated procedure is a unit test procedure.  Optional test description can by provided (see `displayname`). |
+| `--%test(<description>)` | Procedure | Denotes that the annotated procedure is a unit test procedure.  Optional test description can be provided (see `displayname`). |
 | `--%throws(<exception>[,...])`| Procedure | Denotes that the annotated test procedure must throw one of the exceptions provided. Supported forms of exceptions are: numeric literals, numeric constant names, exception constant names, predefined Oracle exception names. |
 | `--%beforeall` | Procedure | Denotes that the annotated procedure should be executed once before all elements of the suite. |
 | `--%beforeall([[<owner>.]<package>.]<procedure>[,...])` | Package | Denotes that the mentioned procedure(s) should be executed once before all elements of the suite. |
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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.
@@ -17,7 +17,7 @@ To obtain information about code coverage for unit tests, run utPLSQL with one o
 The following code coverage reporters are supplied with utPLSQL:
 * `ut_coverage_html_reporter` - generates a HTML coverage report providing summary and detailed information on code coverage. The HTML reporter is based on the open-source [simplecov-html](https://github.com/colszowka/simplecov-html) reporter for Ruby. It includes source code of the code that was covered (if possible)  
 * `ut_coveralls_reporter` - generates a [Coveralls compatible JSON](https://coveralls.zendesk.com/hc/en-us/articles/201774865-API-Introduction) coverage report providing detailed information on code coverage with line numbers. This coverage report is designed to be consumed by cloud services like [Coveralls](https://coveralls.io)
-* `ut_coverage_sonar_reporter`  - generates a [Sonar Compatible XML](https://docs.sonarqube.org/display/SONAR/Generic+Test+Data) coverage report providing detailed information on code coverage with line numbers. This coverage report is designed to be consumed by services like [SonarQube/SonarCloud](https://about.sonarcloud.io/)
+* `ut_coverage_sonar_reporter`  - generates a [Sonar Compatible XML](https://docs.sonarqube.org/latest/analysis/generic-test/) coverage report providing detailed information on code coverage with line numbers. This coverage report is designed to be consumed by services like [SonarQube](https://www.sonarqube.org/) and [SonarCloud](https://about.sonarcloud.io/)
 * `ut_coverage_cobertura_reporter`  - generates a basic Cobertura coverage (http://cobertura.sourceforge.net/xml/coverage-04.dtd) report providing detailed information on code coverage with line numbers. This coverage report is designed to be consumed by services like TFS and Jenkins. Check this link for an example of XML generated by Java: https://raw.githubusercontent.com/jenkinsci/cobertura-plugin/master/src/test/resources/hudson/plugins/cobertura/coverage-with-data.xml
 
 ## Security model
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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.
@@ -1096,7 +1096,7 @@ SUCCESS
 
 ## to_be_within of
 
-Determines wheter expected value is within range (tolerance) from another value.
+Determines whether expected value is within range (tolerance) from another value.
 
 The logical formual used for calcuating the matcher is: 
 ```
@@ -1177,7 +1177,7 @@ Failures:
 
 ## to_be_within_pct of
 
-Determines wheter actual value is within percentage range of expected value. 
+Determines whether actual value is within percentage range of expected value. 
 The matcher only works with `number` data-type.
 
 The percentage deviation (distance) must be expressed as a non-negative number.
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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--develop-blue.svg)
 
 utPLSQL provides the following reporting formats.
 
@@ -84,7 +84,7 @@ Example of failure report details
 
 
 # Sonar test reporter
-If you are using [SonarQube](https://about.sonarqube.com/) to do static code analysis for you PLSQL projects, your code analysis can benefit from code coverage and test results.
+If you are using [SonarQube](https://www.sonarqube.org/) or [SonarCloud](https://about.sonarcloud.io/) to do static code analysis for you PLSQL projects, your code analysis can benefit from code coverage and test results.
 utPLSQL provides two reporters to for SonarQube:
 - `ut_sonar_test_reporter` - provides an XML output of each test executed per each project test file (package) 
 - `ut_coverage_sonar_reporter` - provides XML output of code coverage per each project source file 
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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--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.13.3889--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.3908--develop-blue.svg)
 
 # Upgrading from version 2
 
diff --git a/readme.md b/readme.md
@@ -9,7 +9,7 @@
 [![twitter](https://img.shields.io/twitter/follow/utPLSQL.svg?style=social&label=Follow)](https://twitter.com/utPLSQL)
 
 [![build](https://github.com/utPLSQL/utPLSQL/actions/workflows/build.yml/badge.svg)](https://github.com/utPLSQL/utPLSQL/actions/workflows/build.yml)
-[![QualityGate](https://sonarcloud.io/api/project_badges/measure?project=utPLSQL&metric=sqale_rating)](https://sonarcloud.io/dashboard/index?id=utPLSQL)
+[![QualityGate](https://sonarcloud.io/api/project_badges/measure?project=utPLSQL&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=utPLSQL)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=utPLSQL&metric=coverage)](https://sonarcloud.io/summary/new_code?id=utPLSQL)
 
 ----------
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.13.3889-develop';
+  gc_version                 constant varchar2(50) := 'v3.1.13.3908-develop';
     
   subtype t_executable_type      is varchar2(30);
   gc_before_all                  constant t_executable_type := 'beforeall';
diff --git a/source/reporters/ut_coverage_sonar_reporter.tpb b/source/reporters/ut_coverage_sonar_reporter.tpb
@@ -96,9 +96,9 @@ create or replace type body ut_coverage_sonar_reporter is
 
   overriding member function get_description return varchar2 as
   begin
-    return 'Generates a JSON coverage report providing information on code coverage with line numbers.' || chr(10) ||
-           'Designed for [SonarQube](https://about.sonarqube.com/) to report coverage.' || chr(10) ||
-           'JSON format returned conforms with the Sonar specification: https://docs.sonarqube.org/display/SONAR/Generic+Test+Data';
+    return 'Generates a XML coverage report providing information on code coverage with line numbers.' || chr(10) ||
+           'Designed for [SonarQube](https://www.sonarqube.org/) to report coverage.' || chr(10) ||
+           'XML format returned conforms with the Sonar specification: https://docs.sonarqube.org/latest/analysis/generic-test/';
   end;
 
 end;
diff --git a/source/reporters/ut_coverage_sonar_reporter.tps b/source/reporters/ut_coverage_sonar_reporter.tps
@@ -18,7 +18,7 @@ create or replace type ut_coverage_sonar_reporter under ut_coverage_reporter_bas
 
   /**
   * Builds a coverage XML report that follows rules described in
-  * https://docs.sonarqube.org/display/SONAR/Generic+Test+Data
+  * https://docs.sonarqube.org/latest/analysis/generic-test/
   */
   constructor function ut_coverage_sonar_reporter(
     self in out nocopy ut_coverage_sonar_reporter
diff --git a/source/reporters/ut_coveralls_reporter.tps b/source/reporters/ut_coveralls_reporter.tps
@@ -18,7 +18,7 @@ create or replace type ut_coveralls_reporter under ut_coverage_reporter_base(
 
   /**
   * Builds a coverage XML report that follows rules described in
-  * https://docs.sonarqube.org/display/SONAR/Generic+Test+Data
+  * https://docs.coveralls.io/api-introduction
   */
   constructor function ut_coveralls_reporter(
     self in out nocopy ut_coveralls_reporter
diff --git a/source/reporters/ut_sonar_test_reporter.tpb b/source/reporters/ut_sonar_test_reporter.tpb
@@ -106,9 +106,9 @@ create or replace type body ut_sonar_test_reporter is
 
   overriding member function get_description return varchar2 as
   begin
-    return 'Generates a JSON report providing detailed information on test execution.' || chr(10) ||
-           'Designed for [SonarQube](https://about.sonarqube.com/) to report test execution.' || chr(10) ||
-           'JSON format returned conforms with the Sonar specification: https://docs.sonarqube.org/display/SONAR/Generic+Test+Data';
+    return 'Generates a XML report providing detailed information on test execution.' || chr(10) ||
+           'Designed for [SonarQube](https://www.sonarqube.org/) to report test execution.' || chr(10) ||
+           'XML format returned conforms with the Sonar specification: https://docs.sonarqube.org/latest/analysis/generic-test/';
   end;
 
 end;

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