Merge branch 'develop' into feature/cache_improvements

utPLSQL · Jun 10, 2019 · 62d683a · 62d683a
2 parents 56803f7 + df67dee
commit 62d683a
Show file tree

Hide file tree

Showing 46 changed files with 1,364 additions and 231 deletions.
diff --git a/docs/about/authors.md b/docs/about/authors.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 ### utPLSQL v3 Major Contributors 
 

diff --git a/docs/about/license.md b/docs/about/license.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Version Information
 

diff --git a/docs/about/project-details.md b/docs/about/project-details.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # utPLSQL Project Details
 

diff --git a/docs/about/support.md b/docs/about/support.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # How to get support
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Introduction to utPLSQL
 

diff --git a/docs/userguide/advanced_data_comparison.md b/docs/userguide/advanced_data_comparison.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Advanced data comparison
 

diff --git a/docs/userguide/annotations.md b/docs/userguide/annotations.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Annotations
 
@@ -38,6 +38,7 @@ We strongly recommend putting package level annotations at the very top of packa
 | `--%disabled` | Package/procedure | Used to disable a suite or a test. Disabled suites/tests do not get executed, they are however marked and reported as disabled in a test run. |
 | `--%context(<name>)` | Package | Denotes start of a named context (sub-suite) in a suite package |
 | `--%endcontext` | Package | Denotes end of a nested context (sub-suite) in a suite package |
+| `--%tags` | Package/procedure | Used to label a test or a suite for purpose of identification |
 
 ### Suite
 
@@ -823,7 +824,7 @@ See [beforeall](#Beforeall) for more examples.
 Indicates specific setup procedure(s) to be executed for a test. The procedure(s) can be located either:
 - within current package (package name is optional)
 - within another package 
- 
+
 The annotation need to be placed alongside `--%test` annotation.
 
 The `--%beforetest` procedures are executed after invoking all `--%beforeeach` for a test.
@@ -911,7 +912,7 @@ Finished in .015185 seconds
 Indicates specific cleanup procedure(s) to be executed for a test. The procedure(s) can be located either:
 - within current package (package name is optional)
 - within another package 
- 
+
 The annotation need to be placed alongside `--%test` annotation.
 
 If a test is marked as disabled the `--%aftertest` procedures are not invoked for that test.
@@ -1221,6 +1222,98 @@ Finished in .035261 seconds
 ```
 
 
+
+### Tags
+
+Tag is a label attached to the test or a suite path. It is used for identification and execution a group of tests / suites that share same tag.  
+
+It allows us to group a tests / suites using a various categorization and place a test / suite in multiple buckets. Same tests can be group with other tests based on the functionality , frequency, type of output etc.
+
+e.q. 
+
+```sql
+--%tags(batch,daily,csv)
+```
+
+or
+
+```sql
+--%tags(api,online,json)
+```
+
+
+
+Tags are defined as a coma separated list. When executing a test run with tag filter applied, framework will find all tests associated with given tags and execute them. Framework applies `OR` logic when resolving a tags so any tests / suites that match at least one tag will be included in the test run. 
+
+When a suite gets tagged all of its children will automatically inherit a tag and get executed along the parent. Parent suit tests are not executed. but a suitepath hierarchy is kept.
+
+Sample tag package.
+
+```sql
+create or replace package ut_sample_test IS
+
+   --%suite(Sample Test Suite)
+   --%tag(suite1)
+
+   --%test(Compare Ref Cursors)
+   --%tag(test1,sample)
+   procedure ut_refcursors1;
+
+   --%test(Run equality test)
+   --%tag(test2,sample)
+   procedure ut_test;
+
+end ut_sample_test;
+/
+
+create or replace package body ut_sample_test is
+
+   procedure ut_refcursors1 is
+      v_actual   sys_refcursor;
+      v_expected sys_refcursor;
+   begin
+    open v_expected for select 1 as test from dual;
+    open v_actual   for select 2 as test from dual;
+
+      ut.expect(v_actual).to_equal(v_expected);
+   end;
+
+   procedure ut_test is
+   begin
+       ut.expect(1).to_equal(0);
+   end;
+
+end ut_sample_test;
+/
+```
+
+Execution of the test is done by using a parameter `a_tags`
+
+```sql
+select * from table(ut.run(a_path => 'ut_sample_test',a_tags => 'suite1'));
+select * from table(ut.run(a_tags => 'test1,test2'));
+select * from table(ut.run(a_tags => 'sample'));
+
+begin
+  ut.run(a_path => 'ut_sample_test',a_tags => 'suite1');
+end;
+/
+
+exec ut.run('ut_sample_test', a_tags => 'sample');
+```
+
+
+
+Tags should adhere to following rules:
+
+- tags are case sensitive
+- tags cannot be an empty string
+- tags cannot contain spaces e.g. to create a multi-word `tag` please use underscores,dashes, dots etc. e.g. `test_of_batch`
+- tags with empty spaces will be ignored during execution
+- tags can contain special characters
+
+
+
 ### Suitepath
 
 It is very likely that the application for which you are going to introduce tests consists of many different packages, procedures and functions.
@@ -1346,9 +1439,9 @@ If `--%throws` annotation is specified with arguments and exception raised is no
 The framework will raise a warning, when `--%throws` annotation has invalid arguments or when no arguments were provided.
 
 Annotation `--%throws(7894562, operaqk, -=1, -20496, pow74d, posdfk3)` will be interpreted as `--%throws(-20496)`.
- 
+
 Please note that `NO_DATA_FOUND` exception is a special case in Oracle. To capture it use `NO_DATA_FOUND` named exception or `-1403` exception No.
-
+                                                                                                        
 Example:
 ```sql
 create or replace package exc_pkg is

diff --git a/docs/userguide/best-practices.md b/docs/userguide/best-practices.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Best Practices
 

diff --git a/docs/userguide/coverage.md b/docs/userguide/coverage.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Coverage
 utPLSQL comes with a built-in coverage reporting engine. The code coverage reporting is based on the DBMS_PROFILER package provided with Oracle database.

diff --git a/docs/userguide/exception-reporting.md b/docs/userguide/exception-reporting.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Exception handling and reporting
 

diff --git a/docs/userguide/expectations.md b/docs/userguide/expectations.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--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/docs/userguide/getting-started.md b/docs/userguide/getting-started.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Getting started with TDD and utPLSQL
 

diff --git a/docs/userguide/install.md b/docs/userguide/install.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Downloading latest version of utPLSQL
 

diff --git a/docs/userguide/querying_suites.md b/docs/userguide/querying_suites.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Qyerying for test suites
 
@@ -22,21 +22,22 @@ Querying the data from function provides the follwing details:
 - `item_line_no`     - line_number where annotation identifying the item exists
 - `path`             - suitepath of the item
 - `disabled_flag`    - (0/1) indicator if item is disabled by --%disabled annotation
-
+- `tags`     - tags associated with suites
+
 To get list of all test suites in current schema 
 ```sql
 select * from table(ut_runner.get_suites_info()) where item_type = 'UT_SUITE';
-``` 
+```
 
 To get list of all tests for test suite `TEST_STUFF` in current user schema  
 ```sql
 select * from table(ut_runner.get_suites_info(USER, 'TEST_STUFF')) where item_type = 'UT_TEST';
-``` 
+```
 
 To get a full information about suite `TEST_STUFF` including suite description, all contexts and tests in a suite  
 ```sql
 select * from table(ut_runner.get_suites_info(USER, 'TEST_STUFF')) where item_type = 'UT_TEST';
-``` 
+```
 
 ## Checking if schema contains tests
 

diff --git a/docs/userguide/reporters.md b/docs/userguide/reporters.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 utPLSQL provides the following reporting formats.
 

diff --git a/docs/userguide/running-unit-tests.md b/docs/userguide/running-unit-tests.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Running tests
 

diff --git a/docs/userguide/upgrade.md b/docs/userguide/upgrade.md
@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/version-v3.1.7.2999--develop-blue.svg)
+![version](https://img.shields.io/badge/version-v3.1.7.3006--develop-blue.svg)
 
 # Upgrading from version 2