Updated documentation

viniciusam · viniciusam · commit cdf8d566a9f7 · 2017-05-06T18:00:55.000-03:00
diff --git a/client_source/sqlplus/ut_run.sql b/client_source/sqlplus/ut_run.sql
@@ -22,9 +22,11 @@
   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] ...]
+  ut_run.sql "client_Path" "project_path" user/password@database [-p=(ut_path|ut_paths)] [-c] [-f=format [-o=output] [-s] ...] [-source_path=path] [-test_path=path]
 
 Parameters:
+  client_path  - The path where this script is installed. Will be used to find auxiliary scripts and to save temp files.
+  project_path - The path from where this script is being called.
   user         - username to connect as
   password     - password of the user
   database     - database to connect to
@@ -53,10 +55,10 @@ Parameters:
                      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/.
+                     This report is designed to be consumed by SonarQube to report code coverage.
                    -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/.
+                     This report is designed to be consumed by SonarQube to report test files.
                  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.
@@ -68,18 +70,21 @@ Parameters:
   -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
+    sqlplus /nolog @ut_run ~/ut_run_path ~/project/source 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
 
-      All Unit tests from schema "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"
+      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_coverage_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
 
-      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.
 
  */
 
diff --git a/docs/userguide/ut_run-script.md b/docs/userguide/ut_run-script.md
@@ -25,31 +25,31 @@ You need to run the `ut_run.bat` or `ut_run` script from your project's root dir
   -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)
+                        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.
+                        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.
+                        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.
+                        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).
+                        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/.
+                        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 [Coveralls](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/.
+                        Generates a JSON coverage report providing detailed information on code coverage with line numbers.
+                        This report is designed to be consumed by [SonarQube](https://about.sonarqube.com/) to report code coverage.
                       -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/.
+                        Generates a JSON report providing detailed information on test specifications.
+                        This report is designed to be consumed by [SonarQube](https://about.sonarqube.com/) to report code coverage.
                     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.
+                      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. The path need to be relative to the priject root directory.
   -test_path=path   - Test files path to be used by coverage reporters. The path need to be relative to the priject root directory.
@@ -60,9 +60,9 @@ You need to run the `ut_run.bat` or `ut_run` script from your project's root dir
 
 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:
+Examples of invocation from command line:
 
-`ut_run @ut_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`
+`ut_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`
 
 All Unit tests from schema/package "hr_test" will be be invoked with two reporters:
   - ut_documentation_reporter - will output to screen and save output to file "run.log"
