Deploy to gh-pages branch: base commit 4cdc7d424a8851b25b8c48bf15c22d6177c783d6

github-actions[bot] · github-actions[bot] · commit 04a1e6d37ea5 · 2022-09-09T13:24:57.000+01:00
diff --git a/utPLSQL/develop/about/authors.md b/utPLSQL/develop/about/authors.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 ### utPLSQL v3 Major Contributors 
 
diff --git a/utPLSQL/develop/about/license.md b/utPLSQL/develop/about/license.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Version Information
 
diff --git a/utPLSQL/develop/about/project-details.md b/utPLSQL/develop/about/project-details.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # utPLSQL Project Details
 
diff --git a/utPLSQL/develop/about/support.md b/utPLSQL/develop/about/support.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # How to get support
 
diff --git a/utPLSQL/develop/index.md b/utPLSQL/develop/index.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Introduction to utPLSQL
 
diff --git a/utPLSQL/develop/userguide/advanced_data_comparison.md b/utPLSQL/develop/userguide/advanced_data_comparison.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Advanced data comparison
 
diff --git a/utPLSQL/develop/userguide/annotations.md b/utPLSQL/develop/userguide/annotations.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Annotations
 
diff --git a/utPLSQL/develop/userguide/best-practices.md b/utPLSQL/develop/userguide/best-practices.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Best Practices
 
diff --git a/utPLSQL/develop/userguide/coverage.md b/utPLSQL/develop/userguide/coverage.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Coverage
 utPLSQL comes with a built-in coverage reporting engine. The code coverage reporting uses package DBMS_PROFILER (and DBMS_PLSQL_CODE_COVERAGE on Oracle database version 12.2 and above) provided with Oracle database.
diff --git a/utPLSQL/develop/userguide/exception-reporting.md b/utPLSQL/develop/userguide/exception-reporting.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Exception handling and reporting
 
diff --git a/utPLSQL/develop/userguide/expectations.md b/utPLSQL/develop/userguide/expectations.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--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/utPLSQL/develop/userguide/getting-started.md b/utPLSQL/develop/userguide/getting-started.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Getting started with TDD and utPLSQL
 
diff --git a/utPLSQL/develop/userguide/install.md b/utPLSQL/develop/userguide/install.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Supported database versions
 
diff --git a/utPLSQL/develop/userguide/querying_suites.md b/utPLSQL/develop/userguide/querying_suites.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Qyerying for test suites
 
diff --git a/utPLSQL/develop/userguide/reporters.md b/utPLSQL/develop/userguide/reporters.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 utPLSQL provides the following reporting formats.
 
@@ -161,5 +161,20 @@ Some of the information in debug log might be redundant.
 > - db object names
 > - etc.
 
- 
-       
+# Custom reporters
+
+It is possible to add your own reporters by creating an appropriate object type. In principle, it has to be a subtype of `ut_reporter_base`. However, if the reporter is expected to produce output consumable by a client oustside of the database (e.g. the data has to be reported to the screen or to a file), then you should base it on `ut_output_reporter_base` (which is a subtype of `ut_reporter_base`). In contrast, if you would like to create a reporter that, for example, saves the data to a database table, then it should be based directly on `ut_reporter_base`. (Currently, all reporters in the utPLSQL framework are based on `ut_output_reporter_base`.) Coverage reporters are based on `ut_coverage_reporter_base` (a subtype of `ut_output_reporter_base`).
+
+If need to produce a colored text output from the custom reporter, then you can build it basing on `ut_console_reporter_base` (a subtype of `ut_output_reporter_base`). In many cases it may also be more convenient to create the custom reporter type under a more specialized type, like `ut_documentation_reporter` or `ut_junit_reporter`, and override just some of the functionality.
+
+It is recommended to create the reporter type in the schema where utPLSQL is installed (by default it is the `UT3` schema). Note that before running the utPLSQL uninstall scripts, all custom reporters should be dropped (cf. [the installation documentation](install.md)). In particular, when upgrading to a newer version of utPLSQL, one has to drop the custom reporters and recreate them after the upgrade.
+
+**Note:**
+> It is possible, but cumbersome, to use another schema for storing the custom reporters. This requires to create a synonym for the base reporter type in the schema that is going to own the custom reporter, and to provide appropriate grants both to the owner of the custom reporter and to the user running the reporter. After upgrading or reinstalling utPLSQL, the extra privileges need to be recreated. This approach is not recommended.
+
+Assuming that the custom reporter type is created in the `UT3` schema, to run the tests using a custom reporter just call: `exec ut.run(ut3.custom_reporter_name());`, optionally providing parameter values to the `custom_reporter_name` constructor.
+
+One may get acquainted with the source code of the standard reporters bundled with utPLSQL (including the coverage reporters) by browsing the [`source/reporters/`](https://github.com/utPLSQL/utPLSQL/tree/develop/source/reporters) directory. The base reporter types `ut_reporter_base`, `ut_output_reporter_base` and `ut_console_reporter_base` are defined in [`source/core/types`](https://github.com/utPLSQL/utPLSQL/tree/develop/source/core/types). The base coverage reporter type `ut_coverage_reporter_base` is in [`source/core/coverage`](https://github.com/utPLSQL/utPLSQL/tree/develop/source/core/coverage). There are also two examples of custom reporters in [`examples/custom_reporters/`](https://github.com/utPLSQL/utPLSQL/tree/develop/examples/custom_reporters), both extending the functionality of `ut_documentation_reporter`:
+
+* `ut_custom_reporter` accepts an integer parameter `a_tab_size`; it alters the behaviour of `ut_documentation_reporter` by changing the size of the indentation according to the parameter value (by default the indentation is increased).
+* `ut_expectations_reporter` accepts a `varchar2` parameter `a_report_all_expectations`; if its value is `'Y'` (which is the default), then the reporter shows the results of all expectations that are run. This stays in contrast with `ut_documentation_reporter`, which shows the results of all tests that are run, but only of the expectations that failed (keep in mind that a single test may consist of several expectations).
diff --git a/utPLSQL/develop/userguide/running-unit-tests.md b/utPLSQL/develop/userguide/running-unit-tests.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Running tests
 
diff --git a/utPLSQL/develop/userguide/upgrade.md b/utPLSQL/develop/userguide/upgrade.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.13.4021--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)
 
 # Upgrading from version 2
 
diff --git a/utPLSQL/index.md b/utPLSQL/index.md
@@ -5,7 +5,7 @@ layout: default
 # Documentation
 
  - [Latest v3.1.12 documentation](latest/) - Created 25 Feb 2022 - 12:47:56 AM
- - [Latest development version](develop/) - Created 15 Aug 2022 - 11:41:40 AM
+ - [Latest development version](develop/) - Created 09 Sep 2022 - 01:24:57 PM
 
 ## Documentation release history
 

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.4021--develop-blue.svg)`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.13.4036--develop-blue.svg)`
`2`	`2`
`3`	`3`	`### utPLSQL v3 Major Contributors`
`4`	`4`