Changes to make it run better from path and some error handling

viniciusam · viniciusam · commit f2560f95a011 · 2017-05-03T09:54:40.000-03:00
diff --git a/client_source/sqlplus/file_list b/client_source/sqlplus/file_list
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 set -e
 
 clientPath=${1%/}
diff --git a/client_source/sqlplus/ut_run b/client_source/sqlplus/ut_run
@@ -0,0 +1,17 @@
+#!/bin/sh
+set -e
+
+clientDir="$(dirname "$(readlink -f "$0")")"
+projectDir="$(pwd)"
+
+if [ ! "$clientDir" == "${clientDir/ /}" ]; then
+    echo "Error: ut_run script path cannot have spaces."
+    exit 1
+fi
+
+if [ "$@" == "" ]; then
+    echo "Usage: ut_run user/password@database [options...]"
+    exit 1
+fi
+
+sqlplus /nolog @"$clientDir/ut_run.sql" "$clientDir" "$projectDir" "$@"
diff --git a/client_source/sqlplus/ut_run.bat b/client_source/sqlplus/ut_run.bat
@@ -3,4 +3,14 @@
 set clientDir=%~dp0
 set projectDir=%__CD__%
 
-sqlplus /nolog @%clientDir%\ut_run.sql '%clientDir%' '%projectDir%' %*
+if not "%clientDir%" == "%clientDir: =%" (
+    echo Error: ut_run script path cannot have spaces.
+    exit /b 1
+)
+
+if "%1" == "" (
+    echo Usage: ut_run user/password@database [options...]
+    exit /b 1
+)
+
+sqlplus /nolog @"%clientDir%\ut_run.sql" '%clientDir%' '%projectDir%' %*
diff --git a/client_source/sqlplus/ut_run.sh b/client_source/sqlplus/ut_run.sh
diff --git a/client_source/sqlplus/ut_run.sql b/client_source/sqlplus/ut_run.sql
@@ -55,14 +55,17 @@ Parameters:
                      Generates a JSON coverage report providing detailed information on code coverage with line numbers.
                      This coverage report is designed to be consumed by local services like https://about.sonarqube.com/.
                    -f=ut_sonar_test_reporter
-                     TODO
+                     Generates a JSON report providing detailed information on test specifications.
+                     This report is designed to be consumed by local services like https://about.sonarqube.com/.
                  If no -f option is provided, the ut_documentation_reporter will be used.
 
   -o=output    - file name to save the output provided by the reporter.
                  If defined, the output is not displayed on screen by default. This can be changed with the -s parameter.
                  If not defined, then output will be displayed on screen, even if the parameter -s is not specified.
                  If more than one -o parameter is specified for one -f parameter, the last one is taken into consideration.
   -s           - Forces putting output to to screen for a given -f parameter.
+  -source_path=path - Source files path to be used by coverage reporters.
+  -test_path=path - Test files path to be used by coverage reporters.
   -c           - If specified, enables printing of test results in colors as defined by ANSICONSOLE standards
 
   Parameters -f, -o, -s are correlated. That is parameters -o and -s are defining outputs for -f.
@@ -83,9 +86,9 @@ Parameters:
 whenever sqlerror exit failure
 whenever oserror exit failure
 
-define client_path=&1
-define project_path=&2
-define conn_str=&3
+define client_path="&1"
+define project_path="&2"
+define conn_str="&3"
 
 conn &conn_str
 
@@ -333,11 +336,11 @@ column test_path new_value test_path noprint;
 select :l_test_path as test_path from dual;
 
 --try running on windows
-$ &&client_path\file_list.bat "&&client_path" "&&project_path" "&&source_path" "source_file_list.sql.tmp" "l_source_files"
-$ &&client_path\file_list.bat "&&client_path" "&&project_path" "&&test_path" "test_file_list.sql.tmp" "l_test_files"
+$ "&&client_path\file_list.bat" "&&client_path" "&&project_path" "&&source_path" "source_file_list.sql.tmp" "l_source_files"
+$ "&&client_path\file_list.bat" "&&client_path" "&&project_path" "&&test_path" "test_file_list.sql.tmp" "l_test_files"
 --try running on linux/unix
-! &&client_path/file_list.sh "&&client_path" "&&project_path" "&&source_path" "source_file_list.sql.tmp" "l_source_files"
-! &&client_path/file_list.sh "&&client_path" "&&project_path" "&&test_path" "test_file_list.sql.tmp" "l_test_files"
+! "&&client_path/file_list" "&&client_path" "&&project_path" "&&source_path" "source_file_list.sql.tmp" "l_source_files"
+! "&&client_path/file_list" "&&client_path" "&&project_path" "&&test_path" "test_file_list.sql.tmp" "l_test_files"
 
 undef source_path
 undef test_path
diff --git a/docs/userguide/ut_run-script.md b/docs/userguide/ut_run-script.md
@@ -1,52 +1,71 @@
-The `ut_run.sql` script is designed to allow invocation of utPLSQL with multiple reporters.
+The `ut_run.bat` and `ut_run` scripts are designed to allow invocation of utPLSQL with multiple reporters.
 It allows saving of outcomes into multiple output files.
 It also facilitates displaying on screen unit test results while the execution is still ongoing.
 Current limit of script parameters is 39
 
-# Scrip invocation
-  ut_run.sql user/password@database [-p=(ut_path|ut_paths)] [-c] [-f=format [-o=output] [-s] ...]
+The easiest way to use it, is by adding the client_source/sqlplus folder on your PATH.
+
+# Script Invocation
+  ut_run user/password@database [-p=(ut_path|ut_paths)] [-c] [-f=format [-o=output] [-s] ...] [-source_path=path] [-test_path=path]
 
 # Parameters
 ```
-  user         - username to connect as
-  password     - password of the user
-  database     - database to connect to
-  -p=ut_path(s)- A path or a comma separated list of paths to unit test to be executed.
-                 The path can be in one of the following formats:
-                   schema[.package[.procedure]]
-                   schema:suite[.suite[.suite][...]][.procedure]
-                 Both formats can be mixed in the comma separated list.
-                 If only schema is provided, then all suites owner by that schema (user) are executed.
-                 If -p is omitted, the current schema is used.
-  -f=format    - A reporter to be used for reporting.
-                 Available options:
-                   -f=ut_documentation_reporter
-                     A textual pretty-print of unit test results (usually use for console output)
-                   -f=ut_teamcity_reporter
-                     A teamcity Unit Test reporter, that can be used to visualize progress of test execution as the job progresses.
-                   -f=ut_xunit_reporter
-                     A XUnit xml format (as defined at: http://stackoverflow.com/a/9691131 and at https://gist.github.com/kuzuha/232902acab1344d6b578)
-                     Usually used  by Continuous Integration servers like Jenkins/Hudson or Teamcity to display test results.
-                 If no -f option is provided, the ut_documentation_reporter will be used.
-
-  -o=output    - file name to save the output provided by the reporter.
-                 If defined, the output is not displayed on screen by default. This can be changed with the -s parameter.
-                 If not defined, then output will be displayed on screen, even if the parameter -s is not specified.
-                 If more than one -o parameter is specified for one -f parameter, the last one is taken into consideration.
-  -s           - Forces putting output to to screen for a given -f parameter.
-  -c           - If specified, enables printing of test results in colors as defined by ANSICONSOLE standards
+  user              - username to connect as
+  password          - password of the user
+  database          - database to connect to
+  -p=ut_path(s)     - A path or a comma separated list of paths to unit test to be executed.     
+                      The path can be in one of the following formats:
+                        schema[.package[.procedure]]
+                        schema:suite[.suite[.suite][...]][.procedure]
+                      Both formats can be mixed in the comma separated list.
+                      If only schema is provided, then all suites owner by that schema (user) are executed.
+                      If -p is omitted, the current schema is used.
+  -f=format         - A reporter to be used for reporting.
+                    Available options:
+                      -f=ut_documentation_reporter
+                        A textual pretty-print of unit test results (usually   use for console output)
+                      -f=ut_teamcity_reporter
+                        A teamcity Unit Test reporter, that can be used to    visualize progress of test execution as the job    progresses.
+                      -f=ut_xunit_reporter
+                        A XUnit xml format (as defined at:    http://stackoverflow.com/a/9691131 and at    https://gist.github.com/kuzuha/232902acab1344d6b578)
+                        Usually used  by Continuous Integration servers like   Jenkins/Hudson or Teamcity to display test results.
+                      -f=ut_coverage_html_reporter
+                        Generates a HTML coverage report providing summary    and detailed information on code coverage.
+                        The html reporter is based on open-source    simplecov-html reporter for Ruby.
+                        It includes source code of the code that was covered   (if possible).
+                      -f=ut_coveralls_reporter
+                        Generates a JSON coverage report providing detailed    information on code coverage with line numbers.
+                        This coverage report is designed to be consumed by    cloud services like https://coveralls.io/.
+                      -f=ut_coverage_sonar_reporter
+                        Generates a JSON coverage report providing detailed    information on code coverage with line numbers.
+                        This coverage report is designed to be consumed by    local services like https://about.sonarqube.com/.
+                      -f=ut_sonar_test_reporter
+                        Generates a JSON report providing detailed     information on test specifications.
+                        This report is designed to be consumed by local     services like https://about.sonarqube.com/.
+                    If no -f option is provided, the ut_documentation_reporter will be used.
+
+  -o=output         - file name to save the output provided by the reporter.
+                      If defined, the output is not displayed on screen by default.      This can be changed with the -s parameter.
+                      If not defined, then output will be displayed on screen, even      if the parameter -s is not specified.
+                      If more than one -o parameter is specified for one -f      parameter, the last one is taken into consideration.
+  -s                - Forces putting output to to screen for a given -f parameter.
+  -source_path=path - Source files path to be used by coverage reporters.
+  -test_path=path   - Test files path to be used by coverage reporters.
+  -c                - If specified, enables printing of test results in colors as defined by ANSICONSOLE standards
 ```
 
+**To make coverage reporters work source_path and/or test_path cannot be empty, and ut_run need to be executed from your project's path.**
+
 Parameters -f, -o, -s are correlated. That is parameters -o and -s are defining outputs for -f.
 
 Examples of invocation using sqlplus from command line:
 
-`sqlplus /nolog @ut_run hr/hr@xe -p=hr_test -f=ut_documentation_reporter -o=run.log -s -f=ut_teamcity_reporter -o=teamcity.xml`
+`ut_run @ut_run hr/hr@xe -p=hr_test -f=ut_documentation_reporter -o=run.log -s -f=ut_html_reporter -o=coverage.html -source_path=source`
 
 All Unit tests from schema/package "hr_test" will be be invoked with two reporters:
   - ut_documentation_reporter - will output to screen and save it's output to file "run.log"
-  - ut_teamcity_reporter - will save it's output to file "teamcity.xml"
+  - ut_html_reporter - will read file structure from source folder, and save it's output to file "coverage.html"
 
-`sqlplus /nolog @ut_run hr/hr@xe`
+`ut_run hr/hr@xe`
 
-All Unit tests from schema "hr" will be be invoked with ut_documentation_reporter as a format and the results will be printed to screen
+All Unit tests from schema "hr" will be be invoked with ut_documentation_reporter as a format and the results will be printed to screen.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#!/bin/bash`
	`1`	`+#!/bin/sh`
`2`	`2`	`set -e`
`3`	`3`
`4`	`4`	`clientPath=${1%/}`