| `--%tags` | Package/procedure | Used to label a test or a suite for purpose of identification |

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.

or

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.

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`

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'));

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

​