Tune help message

Author: vyahello

README.md

@@ -33,21 +33,20 @@
 In addition code is **fully** [type annotated](https://docs.python.org/3/library/typing.html) ⭐
 
 ## Quick start
-From the root directory of your shell run following commands:
+From the root directory of your shell run following command:
 
-- Smoke tests
 ```bash
-./run-tests.sh smoke
-```
+./run-tests.sh help
 
-- Unit tests
-```bash
-./run-tests.sh unit
-```
+Tool allows to simplify run of automated tests for POM sample project.
 
-- Whole suite
-```bash
-./run-tests.sh all
+Available actions:
+ - smoke                 run automated smoke tests
+ - unittest              run automated unittest tests
+ - all                   run all automated tests
+ - help                  display help
+
+Note:            help will be provided in case of no input parameters
 ```
 
 ### Tests (html) report sample

run-tests.sh

@@ -1,11 +1,12 @@
 #!/bin/bash
 
+# set of constants to colorize output
 FAILED_OUT="\033[0;31m"
 YELLOW_OUT="\033[1;33m"
 NONE_OUT="\033[0m"
 
 
-function pretty-output {
+pretty-output() {
       t="$@xxxx"
       c=${replace:--}
       echo -e ${t//?/$c}
@@ -14,58 +15,57 @@ function pretty-output {
 }
 
 
-function helper {
+helper() {
     echo "Tool allows to simplify run of automated tests for POM sample project."
     echo ""
     echo "Available actions:"
     echo -e " - smoke\t\t run automated smoke tests"
     echo -e " - unittest\t\t run automated unittest tests"
     echo -e " - all\t\t\t run all automated tests"
-    echo -e " - help\t\t\t display help"
+    echo -e " - help\t\t\t display help message"
     echo ""
     echo -e "Note:\t\t help will be provided in case of no input parameters"
 }
 
 
-function raise-error-message {
+raise-error-message() {
     echo -e "Invalid ${FAILED_OUT}$1${NONE_OUT} parameter is provided!"
     echo -e "Please use ${YELLOW_OUT}smoke${NONE_OUT} or ${YELLOW_OUT}unit${NONE_OUT} or ${YELLOW_OUT}help${NONE_OUT} keys as a flag."
     exit 1
 }
 
 
-function clear-trash {
+clear-trash() {
     local trash='.pytest_cache'
     [[ -d "$trash" ]] && echo "removing ${trash} testing trash" && rm -rf ${trash} && echo "environment is cleared"
 }
 
 
-function unit {
+unit() {
     pytest -m unit
 }
 
 
-function smoke {
+smoke() {
     pytest -m smoke
 }
 
 
-function all {
+all() {
     pytest
 }
 
 
-function run-tests {
+run-tests() {
     local arg=$1
     if [[ ${arg} == "smoke" ]] || [[ ${arg} == "unit" ]];
         then pretty-output "Running ${arg} suite" && pytest -m "${arg}"; clear-trash
     elif [[ ${arg} == "all" ]]
         then pretty-output "Running ${arg} suite" && pytest; clear-trash
-    elif [[ $# -eq 0 ]] || [[ ${arg} == "--help" ]] || [[ ${arg} == "-h" ]]
+    elif [[ $# -eq 0 ]] || [[ ${arg} == "help" ]] || [[ ${arg} == "--help" ]] || [[ ${arg} == "-h" ]]
         then helper
     else raise-error-message "${arg}"
     fi
-    return 0
 }
 
 run-tests "$1"