|
1 | 1 | # utPLSQL-cli |
2 | | -A command line client for invoking utPLSQL |
| 2 | +Java command-line client for [utPLSQL v3](https://github.com/utPLSQL/utPLSQL/). |
| 3 | + |
| 4 | +Provides an easy way of invoking utPLSQL from command-line. Main features: |
| 5 | + |
| 6 | +* Ability to run tests with multiple reporters simultaneously. |
| 7 | +* Ability to save output from every individual reporter to a separate output file. |
| 8 | +* Allows execution of selected suites, subset of suite. |
| 9 | +* ~~Maps project and test files to database objects for reporting purposes.~~ (Comming Soon) |
| 10 | + |
| 11 | +## Downloading |
| 12 | +You can download development versions on [Bintray](https://bintray.com/viniciusam/utPLSQL-cli/utPLSQL-cli-develop#files). |
| 13 | + |
| 14 | + |
| 15 | +## Requirements |
| 16 | +* [Java SE Runtime Environment 8](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) |
| 17 | +* ~~When using reporters for Sonar or Coveralls client needs to be invoked from project's root directory.~~ |
| 18 | + |
| 19 | +## Usage |
| 20 | +utplsql run user/password@database [-p=(ut_path|ut_paths)] [-f=format [-o=output_file] [-s] ...] |
| 21 | + |
| 22 | +``` |
| 23 | +user - username to connect as. |
| 24 | +password - password of the user. |
| 25 | +database - database to connect to. |
| 26 | +-p=suite_path(s) - A suite path or a comma separated list of suite paths for unit test to be executed. |
| 27 | + The path(s) can be in one of the following formats: |
| 28 | + schema[.package[.procedure]] |
| 29 | + schema:suite[.suite[.suite][...]][.procedure] |
| 30 | + Both formats can be mixed in the list. |
| 31 | + If only schema is provided, then all suites owner by that schema are executed. |
| 32 | + If -p is omitted, the current schema is used. |
| 33 | +-f=format - A reporter to be used for reporting. |
| 34 | + If no -f option is provided, the default ut_documentation_reporter is used. |
| 35 | + Available options: |
| 36 | + -f=ut_documentation_reporter |
| 37 | + A textual pretty-print of unit test results (usually use for console output) |
| 38 | + -f=ut_teamcity_reporter |
| 39 | + For reporting live progress of test execution with Teamcity CI. |
| 40 | + -f=ut_xunit_reporter |
| 41 | + Used for reporting test results with CI servers like Jenkins/Hudson/Teamcity. |
| 42 | + -f=ut_coverage_html_reporter |
| 43 | + Generates a HTML coverage report with summary and line by line information on code coverage. |
| 44 | + Based on open-source simplecov-html coverage reporter for Ruby. |
| 45 | + Includes source code in the report. |
| 46 | + -f=ut_coveralls_reporter |
| 47 | + Generates a JSON coverage report providing information on code coverage with line numbers. |
| 48 | + Designed for [Coveralls](https://coveralls.io/). |
| 49 | + -f=ut_coverage_sonar_reporter |
| 50 | + Generates a JSON coverage report providing information on code coverage with line numbers. |
| 51 | + Designed for [SonarQube](https://about.sonarqube.com/) to report coverage. |
| 52 | + -f=ut_sonar_test_reporter |
| 53 | + Generates a JSON report providing detailed information on test execution. |
| 54 | + Designed for [SonarQube](https://about.sonarqube.com/) to report test execution. |
| 55 | +
|
| 56 | +-o=output - Defines file name to save the output from the specified reporter. |
| 57 | + If defined, the output is not displayed on screen by default. This can be changed with the -s parameter. |
| 58 | + If not defined, then output will be displayed on screen, even if the parameter -s is not specified. |
| 59 | + If more than one -o parameter is specified for one -f parameter, the last one is taken into consideration. |
| 60 | +-s - Forces putting output to to screen for a given -f parameter. |
| 61 | +``` |
| 62 | + |
| 63 | +Parameters -f, -o, -s are correlated. That is parameters -o and -s are controlling outputs for reporter specified by the preceding -f parameter. |
| 64 | + |
| 65 | +~~Sonar and Coveralls reporter will only provide valid reports, when source_path and/or test_path are provided, and ut_run is executed from your project's root path.~~ |
| 66 | + |
| 67 | +Examples: |
| 68 | + |
| 69 | +``` |
| 70 | +utplsql run hr/hr@xe -p=hr_test -f=ut_documentation_reporter -o=run.log -s -f=ut_coverage_html_reporter -o=coverage.html -source_path=source |
| 71 | +``` |
| 72 | + |
| 73 | +Invokes all Unit tests from schema/package "hr_test" with two reporters: |
| 74 | + |
| 75 | +* ut_documentation_reporter - will output to screen and save output to file "run.log" |
| 76 | +* ~~ut_coverage_html_reporter - will report only on database objects that are mapping to file structure from "source" folder and save output to file "coverage.html"~~ |
| 77 | + |
| 78 | +``` |
| 79 | +utplsql run hr/hr@xe |
| 80 | +``` |
| 81 | + |
| 82 | +Invokes all unit test suites from schema "hr". Results are displayed to screen using default ut_documentation_reporter. |
0 commit comments