runV3 (utPLSQL)

Owned by Joel Wenzel
Last updated: Sept 07, 2021 by Jay-Ar Brouillard

Executes utPLSQL v3 test cases using ut.run(options). utPLSQL version 3.0+ only.

Environment/Instance Properties

Property Name

Property Code

Required

Description

utPLSQL Database User

FDUTPLSQL_DB_USER

Yes

User/Schema used to connect to the Database for utPLSQL testing.

utPLSQL Database PasswordFDUTPLSQL_DB_PASSWORDYesPassword for the User used to connect to the Database for utPLSQL testing.
Oracle Database URLFDORA_URLYesThe JDBC URL for the target Oracle database.
Target JDBC Driver PathFDORA_DRIVER_PATHYesPath containing JDBC driver for target database connection.

Project Properties

Property Name

Property Code

Required

Description





Inputs

Input Name

Input Code

Required

Description

Suite PathFDUTPLSQL_INP_RUN_PATHNo

@before 5.6.0.1 Input name was called "Run Path" and was required. 

A suite path or a comma separated list of suite paths for unit test to be executed. This can be a schema, package, procedure, function, etc... If only schema is provided, then all suites owned by that schema are executed. If not set, then the current schema is used. IE: 'hr' or 'hr:com.my_org.my_project' or 'hr.test_apply_bonus,customers'

ReportersFDUTPLSQL_INP_REPORTERSNo

@since 5.6.0.1

Select output reporting format(s). UT_JUNIT_REPORTER is always added, therefore, is not in the list. For each reporter selected the corresponding file will be exported to the reports tab on the project workflow execution.

Available reporters include: UT_COVERAGE_COBERTURA_REPORTER, UT_COVERAGE_HTML_REPORTER, UT_COVERAGE_SONAR_REPORTER, UT_COVERALLS_REPORTER, UT_DEBUG_REPORTER, UT_DOCUMENTATION_REPORTER, UT_REALTIME_REPORTER, UT_SONAR_TEST_REPORTER, UT_TEAMCITY_REPORTER, UT_TFS_JUNIT_REPORTER

Read more about the different reporter types.

TagsFDUTPLSQL_INP_TAGSNo

@since 5.6.0.1

A comma separated list of tags to run. IE: 'suite1' or 'suite1,suite2' or '-suite1'. Filtering the tests to be run is in addition to any suite paths defined. The framework applies OR logic to all specified tags so any test / suite that matches at least one tag will be included in the test run. You can also exclude specific tags by adding a - (dash) in front of the tag.

Coverage SchemesFDUTPLSQL_INP_COVERAGE_SCHEMESNo

@since 5.6.0.1

A comma separated list of schemas on which coverage should be gathered. Only applicable to coverage reporters.

Fail on ErrorsFDUTPLSQL_INP_FAIL_ON_ERRORSNo

@since 5.6.0.1

Force workflow execution to fail if UTPLSQL run fails any tests. When set to false UTPLSQL run always exits with a success status. Defaults to false.

Skip Compatibility CheckFDUTPLSQL_INP_SKIP_COMPATIBILITY_CHECKNo

@since 5.6.0.1

Skips the compatibility check with the version of the database framework. If you skip compatibility check, CLI will expect the latest framework version.

Random Test OrderFDUTPLSQL_INP_RANDOM_TEST_ORDERNo

@since 5.6.0.1

Enables random order of test executions.

Random Test Order SeedFDUTPLSQL_INP_RANDOM_TEST_ORDER_SEEDNo

@since 5.6.0.1

Sets the seed to use for random test execution order. If set, Random Test Order is set to true.

Include ObjectsFDUTPLSQL_INP_INCLUDE_OBJECTSNo

@since 5.6.0.1

Comma-separated object list to include in the coverage report. Only applicable to coverage reporters.

Exclude ObjectsFDUTPLSQL_INP_EXCLUDE_OBJECTSNo

@since 5.6.0.1

Comma-separated object list to exclude in the coverage report. Only applicable to coverage reporters.

Source File MappingFDUTPLSQL_INP_SOURCE_FILE_MAPPING_JSONNo

@since 5.6.0.1

JSON for path to project source files with options to enable custom type mappings. Map database object names to project files. Keys must be spelled as shown in the example below and "file_paths" is the only required JSON field.

JSON Example 
{ 
    "file_paths": [{"path": "sources"}],
    "type_mapping": [{"key": "packages_bodies", "value": "PACKAGE BODY"}, {"key": "types_bodies", "value": "TYPE BODY"}],
    "owner": "code_owner",
    "regex_expression": "((\w+)/)?(\w+)\.(\w{3})$",
	"owner_subexpression": 2,
    "name_subexpression": 3,
    "type_subexpression": 4
}

Read more about custom type mappings under the Project based Coverage section.

Test File MappingFDUTPLSQL_INP_TEST_FILE_MAPPING_JSONNo

@since 5.6.0.1

JSON for path to project test files with options to enable custom type mappings. Map database object names to test files. Keys must be spelled as shown in the example below and "file_paths" is the only required JSON field.

JSON Example 
{ 
    "file_paths": [{"path": "hr"}, {"path": "customers"}],
    "type_mapping": [{"key": "functions", "value": "FUNCTION"}, {"key": "triggers", "value": "TRIGGER"}],
    "owner": "tests_owner",
    "regex_expression": "(\w+)/(\w+)(\w+)\..{3}$",
	"owner_subexpression": 2,
    "name_subexpression": 3,
    "type_subexpression": 4
}

Read more about custom type mappings under the Project based Coverage section.

Outputs

Output Name

Required

Description




Artifacts

This operation doesn’t consume or produce any artifacts.


Endpoint Selection

This operation will select all available endpoints associated to the environment/instance.


Endpoint Execution 

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

This operation is not backward compatible with utPLSQL version 2.  It can only be run against v3 test cases.


The following macros are not currently supported in the footer:
  • style