<h1 id="wtplsql-home-page">wtPLSQL Home Page</h1>

<hr />

<p><a href="https://github.com/DDieterich/wtPLSQL/releases/latest">Click here</a> for the latest release on GitHub.</p>

<p><a href="https://github.com/DDieterich/wtPLSQL/wiki/Compatibility">Click here</a> for the compatibility wiki page on GitHub.</p>

<p>Use <a href="https://github.com/DDieterich/wtPLSQL/issues">GitHub "issues"</a> for support. A (free) GitHub account will be required to create a new issue. Issues can be searched without an account.</p>

<h3 id="overview">Overview</h3>

<p>wtPLSQL is a test automation server that runs in an Oracle database to provide the following services for Test Runner packages written in PL/SQL.</p>

<li>Execution of One or More Test Runners</li>

<li>Assertion Results including Timing Between Assertions</li>

<li>Capture/Storage/Reporting of Assertion Results</li>

<li>Source Code Coverage of Test Runner</li>

<li>Web Based Graphical User Interface (APEX)</li>

<h3 id="core-component-example-test-results">Core Component Example Test Results</h3>

<p>Here is an example result summary from the core component. Only core is needed to produce this result.</p>

<img src="images/Core Example wtPLSQL Test Results.PNG" alt="Sample DBMS_OUTPUT from wtPLSQL core">

<p>To view the complete test results from the wtPLSQL core self-test, go to the "<a href="https://github.com/DDieterich/wtPLSQL/blob/master/src/core/test_allO.LST">src/core/test_allO.LST</a>" file in GitHub.</p>

<h3 id="persist-add-on-example-test-results">Persist Add-on Example Test Results</h3>

<p>Here is the summary from the WT_ASSERT package self-test. It was created with the default DBMS_OUTPUT reporting package. Because test results and code coverage are stored in Oracle tables, other report formats are simple to create.</p>

<img src="images/Persist Example wtPLSQL Test Results.PNG" alt="Sample DBMS_OUTPUT from wtPLSQL Persist">

<p>To view the complete test results from the wtPLSQL persist self-test, go to the "<a href="https://github.com/DDieterich/wtPLSQL/blob/master/src/persist/test_allO.LST">src/persist/test_allO.LST</a>" file in GitHub.</p>

<h3 id="gui-add-on-example-test-results">GUI Add-on Example Test Results</h3>

<p>The GUI module uses the Oracle APEX to enhance the UI experience. Many useful reports are available with the GUI module. This is an example of ???</p>

<img src="images/GUI Example wtPLSQL Test Results.PNG" alt="Sample Graphical from wtPLSQL GUI">

<h3 id="general-documentation">General Documentation</h3>

<li><a href="About-wtPLSQL.htm">About wtPLSQL</a></li>

<li><a href="demo/README.htm">Examples and Documentation</a></li>

<li><a href="Definitions.htm">Definitions</a></li>

<li><a href="Best-Practices.htm">Best Practices</a></li>

<li><a href="Reference.htm">Reference</a></li>

<li><a href="utPLSQL-V2-Comparison.htm">utPLSQL V1/V2 Comparison</a></li>

<li><a href="utPLSQL-V3-Comparison.htm">utPLSQL V3 Comparison</a></li>

<li><a href="OO-Style-Unit-Testing.htm">OO Style Unit Testing is not for Databases</a></li>

<tr class="header">

<th>Component</th>

<th>Description</th>

<tr class="odd">

<td><a href="core-component.htm">core</a></td>

<td>Required for all wtPLSQL functionality. Small, fast, and maintenance free.</td>

<tr class="even">

<td><a href="conversion-component.htm">conversion</a></td>

<td>Convert Test Runner packages from utPLSQL V1/V2 to wtPLSQL</td>

<tr class="header">

<th>Add-on</th>

<th>Description</th>

<tr class="odd">

<td><a href="persist-add-on.htm">persist</a></td>

<td>Adds storage in tables. Adds code coverage.</td>

<tr class="even">

<td><a href="gui-add-on.htm">gui</a></td>

<td>Adds Oracle APEX screens and reports. Requires persist add-on.</td>

<tr class="odd">

<td><a href="junit-add-on.htm">junit</a></td>

<td>Adds JUnit XML reporting.</td>

<tr class="header">

<th>DB Docs</th>

<th>E-R Diagrams</th>

<th>Call Tree Diags</th>

<tr class="odd">

<td><a href="core/DBDocs/index.html">core docs</a></td>

<td><a href="core/ER_Diagrams.pdf">core ERDs</a></td>

<td><a href="core/Call_Tree_Diagrams.pdf">core trees</a></td>

<tr class="even">

<td><a href="persist/DBDocs/index.html">persist docs</a></td>

<td><a href="persist/ER_Diagrams.pdf">persist ERDs</a></td>

<td><a href="persist/Call_Tree_Diagrams.pdf">persist trees</a></td>

<tr class="odd">

<td><a href="gui/DBDocs/index.html">gui docs</a></td>

<td><a href="gui/ER_Diagrams.pdf">gui ERDs</a></td>

<td><a href="gui/Call_Tree_Diagrams.pdf">gui trees</a></td>

<li><strong>DB Docs</strong> has web pages similar to JavaDocs created by Oracle's SQL*Developer.</li>

<li><strong>E-R Diagrams</strong> show relationships between tables (entities).</li>

<li><strong>Call Tree Diagrams</strong> show the PL/SQL programs, tables, and common (global) memory structures called by all PL/SQL programs.</li>

<p>To determine which components and add-ons have been installed, run this query:</p>

<pre><code>select wtplsql.show_version from dual;

<h2 id="contribute">Contribute</h2>

<p>Help us improve by joining us at the <a href="https://github.com/DDieterich/wtPLSQL">wtPLSQL repository</a>.</p>

<p>The web pages in this website contain information about the wtPLSQL software. Documentation on design and usage are included here. This website is version specific. Each release includes its own version of this website. The "master" branch (latest release) is always displayed at Github.io. Un-released updates are not displayed here.</p>

<p>For project information, see the <a href="https://github.com/DDieterich/wtPLSQL/wiki">wtPLSQL wiki</a>. Documentation on procedures and compatibility are included in the wiki. The wiki includes information for all releases of wtPLSQL. Any updates are immediately displayed.</p>

<hr />

<p><em>The following applies to files and directories at this location in the documentation repository.</em></p>

<h3 id="files-and-directories">Files and Directories</h3>

<tr class="header">

<th>File Name</th>

<th>Description</th>

<tr class="odd">

<td>core</td>

<td>Core Documentation Directory</td>

<tr class="even">

<td>demo</td>

<td>Demonstration Documentation Directory</td>

<tr class="odd">

<td>gui</td>

<td>Graphical User Interface Documentation</td>

<tr class="even">

<td>images</td>

<td>Image Files referenced by MD and HTML</td>

<tr class="odd">

<td>persist</td>

<td>Persist Documentation Directory</td>

<tr class="even">

<td>_config.yml</td>

<td>YAML Configuration File for Markdown</td>

<tr class="odd">

<td>*.md</td>

<td>Markdown files for "github.io"</td>

<tr class="even">

<td>*.htm</td>

<td>HTML files for local documentation</td>

<tr class="odd">

<td>md-to-htm.bat</td>

<td>MS-Dos Batch File to convert MD to HTML</td>

<tr class="even">

<td>md-to-htm.lua</td>

<td>Lua script used by Pandoc for MD to HTML</td>

<p>To view documentation use the URL "file://README.htm" or Double-click on the README.htm file.</p>

<p>NOTE: All HTML files are sourced from Markdown files. Modify the Markdown files, then build HTML from the Markdown files using "md-to-htm.bat".</p>

<hr />

<p><em>Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</em></p>