PLSQL Shell Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.

readme.md

utPLSQL v3 | Powerful PL/SQL Unit Testing Framework

latest-release license chat twitter

build build sonar Coveralls coverage


utPLSQL version 3 is a complete rewrite of utPLSQL v2 from scratch. Version 2 still supports older versions of Oracle that are no longer available. The community that had developed on GitHub decided that a new internal architecture was needed, from that version 3 was born.

Introduction

utPLSQL is a Unit Testing framework for Oracle PL/SQL and SQL. The framework follows industry standards and best patterns of modern Unit Testing frameworks like JUnit and RSpec

Key features

  • multiple ways to compare data with matchers
  • native comparison of complex types (objects/collections/cursors)
  • in-depth and consistent reporting of failures and errors for tests
  • tests identified and configured by annotations
  • hierarchies of test suites configured with annotations
  • automatic (configurable) transaction control
  • Build-in coverage reporting
  • Integration with SonarQube, Coveralls, Jenkins and Teamcity with reporters
  • plugin architecture for reporters and matchers
  • flexible and simple test invocation
  • multi-reporting from test-run from command line

Requirements:

Download

Published releases are available for download on the utPLSQL GitHub Releases Page.

Documentation

Full documentation of the project is automatically published on utPLSQL github pages

Cheat-sheets

Installation

To install the utPLSQL into a new database schema and grant it to public, execute the script install_headless.sql. This will create a new user UT3, grant all required privileges to that user and create PUBLIC synonyms needed.

For detailed instructions on other install options see the Install Guide

Running tests

To execute using development IDE (TOAD/SQLDeveloper/PLSQLDeveloper/other) use one of following commands.

begin
  ut.run();
end;
/
exec  ut.run();
select * from table(ut.run());

The above commands will run all the suites in the current schema and provide report to dbms_output or as a select statement.

Command line client

You can use the utPLSQL command line client utPLSQL-cli to run tests without the need for Oracle Client or any IDE like SQLDeveloper/TOAD etc.

Amongst many benefits it provides ability to:

  • see the progress of test execution for long-running tests - real-time reporting
  • use many reporting formats simultaneously and save reports to files (publish)
  • map your project source files and test files into database objects

Just download the latest client, download Oracle jdbc driver you are good to go. See project readme for details.

Example unit test packages

For examples of using Continuous Integration Server & SonarCloud with utPLSQL see the utPLSQL demo project.

The below test package is a fully-functional Unit Test package for testing a betwnstr function. The package specification is annotated with special comments. The annotations define that a package is a unit test suite, they also allow defining a description for the suite as well as the test itself. The package body consists of procedures containing unit test code. To validate an expectation in test, use ut.expect( actual_data ).to_( ... ) syntax.

create or replace package test_between_string as

  -- %suite(Between string function)

  -- %test(Returns substring from start position to end position)
  procedure normal_case;

  -- %test(Returns substring when start position is zero)
  procedure zero_start_position;

  -- %test(Returns string until end if end position is greater than string length)
  procedure big_end_position;

  -- %test(Returns null for null input string value)
  procedure null_string;
end;
/

create or replace package body test_between_string as

  procedure normal_case is
  begin
    ut.expect( betwnstr( '1234567', 2, 5 ) ).to_( equal('2345') );
  end;

  procedure zero_start_position is
  begin
    ut.expect( betwnstr( '1234567', 0, 5 ) ).to_( equal('12345') );
  end;

  procedure big_end_position is
  begin
    ut.expect( betwnstr( '1234567', 0, 500 ) ).to_( equal('1234567') );
  end;

  procedure null_string is
  begin
    ut.expect( betwnstr( null, 2, 5 ) ).to_( be_null );
  end;

end;
/

Outputs from running the above tests

Between string function
  Returns substring from start position to end position
  Returns substring when start position is zero
  Returns string until end if end position is greater than string length
  Returns null for null input string value

Finished in .036027 seconds
4 tests, 0 failures

Contributing to the project

We welcome new developers to join our community and contribute to the utPLSQL project. If you are interested in helping please read our guide to contributing The best place to start is to read the documentation and get familiar with the existing code base. A slack chat is the place to go if you want to talk with team members. To sign up to the chat use this link


Authors


Version 2 to Version 3 Comparison

If you have a great feature in mind, that you would like to see in utPLSQL v3 please create an issue on GitHub or discuss it with us in the Slack chat rooms.

Feature Version 2 Version 3
Easy to install Yes Yes
Documentation Yes Yes
License GPL v2 Apache 2.0
Tests Creation
Declarative test configuration No Yes - Annotations1
Tests as Packages Yes Yes
Multiple Tests in a single Package Yes Yes
Optional Setup/Teardown No Yes
Different Setup/Teardown
For Each Test in a Single Package
No Yes - Annotations1
Suite Definition Storage Tables Package - Annotations1
Multiple Suites Yes Yes
Suites can contain Suites No Yes
Automatic Test detection No Yes - Annotations1
Unconstrained naming of Test packages No - prefixes Yes - name not relevant
Require Prefix on Test procedures No - prefixes Yes - name not relevant
Auto Compilation of Tests Yes No (Let us know if you use this)
Assertion Library 30 assertions2 26 matchers (13 + 13 negated)
Extendable assertions No Yes - custom matchers
PLSQL Record Assertions generated code through utRecEq Package possible on Oracle 12c+ using cursor matchers
Test Skeleton Generation Yes No (Let us know if you use this)
Test Execution3
Single Test Package Execution Yes Yes
Single Test Procedure Execution No Yes
Test Suite Execution Yes Yes
Subset of Suite Execution No Yes
Multiple Suite Execution No Yes
Organizing Suites into hierarchies No Yes
Code Coverage Reporting No Yes
Html Coverage Report No Yes
Sonar XML Coverage Report No Yes
Coveralls Json Coverage Report No Yes
Framework Transaction Control No Yes - Annotations1
Test Output
Real-time test execution progress reporting No Yes
Multiple Output Reporters can be used during test execution No Yes
DBMS_OUTPUT Yes Yes (clean formatting)
File Yes (to db server only) Yes (on client side)
Stored in Table Yes No (can be added as custom reporter)
XUnit format support No Yes
HTML Format Yes No
Custom Output reporter Yes-needs configuration Yes - no config needed

1 Annotations are specially formatted comments in your package specification. This enables declarative test configuration that is coupled with the source code. See Documentation for more details.

2 utAssert2 package - Contains 59 Assertions - 2 Not implemented = 57, 28 are duplicated only change on outcome_in parameter 57-28 = 29, utPipe package - Contains 1 Assertion 29 + 1 = 30

3 Test execution comparison is in a single call so the results are combined. We know it was always possible to group in any way with multiple calls. But that may not be desired under a CI system where you want a single JUnit XML Output.


Project Directories

  • .travis - contains files needed for travis-ci integration
  • client_source - Sources to be used on the client-side. Developer workstation or CI platform to run the tests.
  • development - Set of useful scripts and utilities for development and debugging of utPLSQL
  • docs - Documentation of the project
  • examples - Example source code and unit tests
  • source - The installation code for utPLSQL
  • tests - Tests for utPLSQL framework