Skip to content

Commit 0700125

Browse files
committed
Added information about ut_debug_reporter to documentation.
1 parent e62d0d3 commit 0700125

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

docs/userguide/reporters.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,46 @@ Details:
120120
# Coverage reporters
121121

122122
utPLSQL comes with a set of build-in coverage reporters. Have a look into the [coverage documentation](coverage.md) to learn more about them.
123+
124+
125+
# Debug reporter
126+
127+
The `ut_debug_reporter` provides a highly verbose output containing thorough details about framework and test execution.
128+
129+
Use this reporter only when you need to investigate framework issues or raise a bug report to utPLSQL team.
130+
131+
Usage of this reporter might have impact on performance of test-suite execution.
132+
133+
Amongst others, reporter provides the following information:
134+
- framework version
135+
- database version
136+
- database OS
137+
- database, instance and session NLS settings
138+
- timing of each event
139+
- time between events logged
140+
- time from start of the run
141+
- stack trace
142+
- information about input parameters for the run including
143+
- run paths
144+
- source file mappings
145+
- test file mappings
146+
- coverage schemas
147+
- coverage exclusions and inclusions
148+
- client character set
149+
- information about every step of the run including
150+
- every suite and context
151+
- every before/after procedure
152+
- every test
153+
- every expectation and it's result
154+
155+
Some of the information in debug log might be redundant.
156+
157+
**Note:**
158+
>Some of the information in debug log may be sensitive. In particular:
159+
> - expectation results and messages (logged even for successful runs)
160+
> - test structure
161+
> - db object names
162+
> - etc.
163+
164+
165+

0 commit comments

Comments
 (0)