Skip to content

Commit 1556177

Browse files
DDieterichDDieterich
committed
Documentation Updates
1 parent f152304 commit 1556177

7 files changed

Lines changed: 52 additions & 18 deletions

File tree

‎docs/Best-Practices.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,7 @@ $END ----------------%WTPLSQL_end_ignore_lines%----------------
5353
-------------------------------------- WTPLSQL Testing --
5454
```
5555

56+
**Check and/or set NLS settings before testing.** Many data types are implicitly converted to VARCHAR2 before comparison. The "wtplsql" package includes functions to check and set NLS settings. Note: Modifying these settings always includes a COMMIT.
57+
5658
---
5759
[Website Home Page](README.md)

‎docs/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ More information is available [in this link](utPLSQL-V2-Comparison).
9292
* [Other Definitions](Other-Definitions.md)
9393
* [utPLSQL V3 Comparison](utPLSQL-V3-Comparison)
9494
* [utPLSQL V1/V2 Comparison](utPLSQL-V2-Comparison)
95+
* [Reference](Reference.md)
9596
* [Latest wtPSQL DB Docs](core/DBDocs/index.html)
9697
* [ER Diagram PDF](core/ER_Diagrams.pdf)
9798
* [Call Tree Diagrams PDF](core/Call_Tree_Diagrams.pdf)

‎docs/Reference.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
[Website Home Page](README.md)
2+
3+
# Reference
4+
5+
---
6+
## Datatypes Supported
7+
Oracle Data Type Families<br>
8+
https://docs.oracle.com/cd/E11882_01/appdev.112/e25519/predefined.htm#LNPLS2047
9+
10+
* VARCHAR2 - Includes ROWID, LONG*, RAW, LONG RAW*, and NVARCHAR2
11+
* DATE** - Includes TIMESTAMP and INTERVAL
12+
* NUMBER** - Includes PLS_INTEGER
13+
* BOOLEAN
14+
* XMLTYPE
15+
* CLOB - Includes NCLOB
16+
* BLOB
17+
18+
*LONG and LONG RAW data length is limited to VARCHAR2 length in PL/SQL (32K).<br>
19+
**VARCHAR2 includes DATE and NUMBER using Implicit Data Conversions:<br>
20+
https://docs.oracle.com/cd/E11882_01/server.112/e41084/sql_elements002.htm#i163326
21+
22+
Many data types are converted to VARCHAR2 before comparison. This ensures most results are captured and reported exactly as they were tested.
23+
24+
There is a balance to strike between simplicity and localization. Many data types must be converted to "strings" before display. Converting a data type at the time it is displayed can lead to confusing results. Since each assertion includes the capture of the values that were compared, the values that are captured are the actual values tested.
25+
26+
An obvious drawback of this approach is running assertions when NLS settings must be set to something other than the setting that is needed for comparison. In this case, an explicit conversion can be made in the Test Runnner using the needed format.
27+
28+
## Custom Error Codes
29+
* ORA-20001 - WTPLSQL Package: RUNNER_NAME is NULL
30+
* ORA-20002 - WTPLSQL Package: RUNNER_NAME (name) is not valid
31+
* ORA-20003 - WT_ASSERT Package: User Test Result is FAIL (g_raise_exception is TRUE)
32+
* ORA-20004 - WT_PROFILER Package: in_test_run_id is NULL
33+
* ORA-20005 - WT_PROFILER Package: dbms_profiler.INTERNAL_VERSION_CHECK returned (error)
34+
* ORA-20006 - WT_PROFILER Package: dbms_profiler.START_PROFILER returned (error)
35+
* ORA-20009 - WT_RESULT Package: "in_test_run_id" cannot be NULL
36+
* ORA-20010 - WT_TEST_RUN_STAT Package: Unknown Result status
37+
* ORA-20011 - WT_TEST_RUN_STAT Package: Unknown Profile status
38+
---
39+
[Website Home Page](README.md)

‎docs/demo/README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# Demonstrations and Examples
22
---
33
Demonstrations and examples assume successful connection to an [Oracle database](http://www.oracle.com/technetwork/database/database-technologies/express-edition/overview/index.html) with wtPLSQL installed. [wtPLSQL Installation instructions](https://github.com/DDieterich/wtPLSQL/releases) are available on the [wtPLSQL Releases page](https://github.com/DDieterich/wtPLSQL/releases).
4-
All demonstration and example code is included in the web pages below?
54

65
## Simple Stuff
76

8-
The simplest check for the wtplsql is to select the "version from dual".
7+
The simplest check for a wtPLSQL installation is to select the "version from dual".
98

109
Run this:
1110
```
@@ -36,7 +35,7 @@ And get this:
3635
PASS Ad-Hoc Test. EQ - Expected "1" and got "1"
3736
```
3837

39-
This ad-hoc test also demonstrates implicit data type conversion, which allows a wider variety of testing. Many data types are converted to VARCHAR2 before comparison. This ensures most results are captured and reported exactly as they were tested.
38+
Note: This ad-hoc test also demonstrates implicit data type conversion.
4039

4140
The majority of wtPLSQL testing uses a Test Runner. A Test Runner is a PL/SQL package written by the tester. [This page](Test-Runner.md) has an example of a very simple [Test Runner](Test-Runner.md). All the examples below will use Test Runners.
4241

‎docs/demo/Test-Runner.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,10 @@ end;
3535
/
3636
```
3737

38-
The results can be queried from those tables. Alternatively, a default reporting package called
38+
The results can be queried from those tables. Alternatively, a default reporting package called
39+
40+
## Test Cases
41+
42+
## Annotations
43+
44+
Why is it necessary to scan the Test Runner source code for the DBOUT annotation?

‎src/core/README.txt‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,3 @@ UnInstall Procedure:
4848
1) sqlplus SYS/password as SYSDBA @uninstall
4949
2) exit
5050
3) Compare uninstall.LST to uninstallO.LST
51-
52-
53-
Custom Error Codes:
54-
-------------------
55-
20001 - WTPLSQL: RUNNER_NAME is NULL
56-
20002 - WTPLSQL: RUNNER_NAME (name) is not valid
57-
20003 - WT_ASSERT: User Test Result is FAIL (g_raise_exception is TRUE)
58-
20004 - WT_PROFILER: in_test_run_id is NULL
59-
20005 - WT_PROFILER: dbms_profiler.INTERNAL_VERSION_CHECK returned (error)
60-
20006 - WT_PROFILER: dbms_profiler.START_PROFILER returned (error)
61-
20009 - WT_RESULT: "in_test_run_id" cannot be NULL
62-
20010 - WT_TEST_RUN_STAT: Unknown Result status
63-
20011 - WT_TEST_RUN_STAT: Unknown Profile status

‎src/core/wt_assert.pks‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ is
99

1010
-- See RESET_GLOBALS procedure for default global values
1111

12-
-- Testcase name for a series of assetions.
12+
-- Testcase name for a series of assertions.
1313
-- Modify as required
1414
g_testcase wt_results.testcase%TYPE;
1515

0 commit comments

Comments
 (0)