Allow custom params for keyword "Connect To Database" (#220)

The entire connection logic and implementation was refactored

* There is only one mandatory parameter left - dbapiModuleName, it must be set - either as keyword argument or in config file.
* All other parameters are optional now. So if some connection data was missing, the error would come not from the Database Library, but from the Python DB module.
* If some params are not provided, they are not set to None - they are just not passed to the Python DB module at all.
* Other custom params from keyword arguments and config file are passed to the Python DB module as provided
* All parameters can be now set in a config file - including any custom params
* If same custom parameter is provided both as a keyword argument and in config file, the keyword argument value takes precedence.

Other changes

* Deprecate the Connect To Database Using Custom Params Keyword - it's not needed anymore, the updated Connect To Database keyword replaces it fully
* Stop using localhost as fallback value for DB host
* Stop using {SQL Server} as fallback value for pyodbc driver
* Update docs for the Connect To Database keyword, move docs for using the config file in a separate section

src/DatabaseLibrary/__init__.py

@@ -93,6 +93,55 @@ class DatabaseLibrary(ConnectionManager, Query, Assertion):
     |     Execute Sql String    drop table XYZ
     |
 
+    = Using configuration file =
+    The `Connect To Database` keyword allows providing the connection parameters in two ways:
+    - As keyword arguments
+    - In a configuration file - a simple list of _key=value_ pairs, set inside an _alias_ section.
+
+    You can use only one way or you can combine them:
+    - The keyword arguments are taken by default
+    - If no keyword argument is provided, a parameter value is searched in the config file
+
+    Along with commonly used connection parameters, named exactly as keyword arguments, a config file
+    can contain any other DB module specific parameters as key/value pairs.
+    If same custom parameter is provided both as a keyword argument *and* in config file,
+    the *keyword argument value takes precedence*.
+
+    The path to the config file is set by default to `./resources/db.cfg`.
+    You can change it using an according parameter in the `Connect To Database` keyword.
+
+    A config file *must* contain at least one section name -
+    the connection alias, if used (see `Handling multiple database connections`), or
+    `[default]` if no aliases are used.
+
+    == Config file examples ==
+    === Config file with default alias (equal to using no aliases at all) ===
+    | [default]
+    | dbapiModuleName=psycopg2
+    | dbName=yourdbname
+    | dbUsername=yourusername
+    | dbPassword=yourpassword
+    | dbHost=yourhost
+    | dbPort=yourport
+
+    === Config file with a specific alias ===
+    | [myoracle]
+    | dbapiModuleName=oracledb
+    | dbName=yourdbname
+    | dbUsername=yourusername
+    | dbPassword=yourpassword
+    | dbHost=yourhost
+    | dbPort=yourport
+
+    === Config file with some params only ===
+    | [default]
+    | dbPassword=mysecret
+
+    === Config file with some custom DB module specific params ===
+    | [default]
+    | my_custom_param=value
+
+
     = Inline assertions =
     Keywords, that accept arguments ``assertion_operator`` <`AssertionOperator`> and ``expected_value``,
     perform a check according to the specified condition - using the [https://github.com/MarketSquare/AssertionEngine|Assertion Engine].

test/resources/common.resource

@@ -6,6 +6,7 @@ Library             Collections
 Library             OperatingSystem
 Library             DatabaseLibrary
 Library             DateTime
+Resource            config_files/connect_config_file.resource
 
 
 *** Variables ***
@@ -26,8 +27,10 @@ Connect To DB
     [Documentation]    Connects to the database based on the current DB module under test
     ...    and connection params set in global variables with alias
     [Arguments]    ${alias}=${None}
-    ${DB_KWARGS}    Create Dictionary
-    IF    $alias is not None    Set To Dictionary    ${DB_KWARGS}    alias=${alias}
+    ${DB_KWARGS}=    Create Dictionary
+    IF    $alias is not None
+        Set To Dictionary    ${DB_KWARGS}    alias=${alias}
+    END
     IF    "${DB_MODULE_MODE}" == "custom"
         IF    "${DB_MODULE}" == "sqlite3"
             Remove File    ${DBName}.db
@@ -38,8 +41,16 @@ Connect To DB
             Connect To Database Using Custom Connection String    ${DB_MODULE}    ${Connection String}    &{DB_KWARGS}
         END
     ELSE IF    "${DB_MODULE_MODE}" == "standard"
-        ${DB_ARGS}    Create List    ${DB_MODULE}    ${DB_NAME}    ${DB_USER}    ${DB_PASS}    ${DB_HOST}    ${DB_PORT}
-        IF    "${DB_MODULE}" == "pyodbc"    Set To Dictionary    ${DB_KWARGS}    dbDriver=${DB_DRIVER}
+        ${DB_ARGS}=    Create List
+        ...    ${DB_MODULE}
+        ...    ${DB_NAME}
+        ...    ${DB_USER}
+        ...    ${DB_PASS}
+        ...    ${DB_HOST}
+        ...    ${DB_PORT}
+        IF    "${DB_MODULE}" == "pyodbc"
+            Set To Dictionary    ${DB_KWARGS}    dbDriver=${DB_DRIVER}
+        END
         Connect To Database    @{DB_ARGS}    &{DB_KWARGS}
     ELSE
         Fail    Unexpected mode - ${DB_MODULE_MODE}

test/resources/config_files/connect_config_file.resource

@@ -0,0 +1,11 @@
+*** Settings ***
+Resource    ../common.resource
+
+
+*** Keywords ***
+Connect Using Config File
+    [Documentation]    `File name` is only name without extension,
+    ...    the path is build relative to the resource directory
+    [Arguments]    ${File name}=${None}    &{Params}
+    ${Path}=    Set Variable    ${CURDIR}/${File name}.cfg
+    Connect To Database    dbConfigFile=${Path}    &{Params}

test/resources/config_files/oracledb/custom_param_password.cfg

@@ -0,0 +1,6 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+password=pass
+dbHost=127.0.0.1
+dbPort=1521

test/resources/config_files/oracledb/invalid_custom_params.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=1521
+blah=blah

test/resources/config_files/oracledb/simple_default_alias.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=1521
+driverMode=thin

test/resources/config_files/oracledb/some_basic_params_missing.cfg

@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db

test/resources/config_files/oracledb/thick_mode.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=1521
+driverMode=thick

test/resources/config_files/oracledb/valid_custom_params.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=1521

test/resources/config_files/oracledb/wrong_password.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=oracledb
+dbName=db
+dbUsername=db_user
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=1521

test/resources/config_files/psycopg2/custom_param_password.cfg

@@ -0,0 +1,6 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+password=pass
+dbHost=127.0.0.1
+dbPort=5432

test/resources/config_files/psycopg2/invalid_custom_params.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=5432
+blah=blah

test/resources/config_files/psycopg2/simple_default_alias.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=5432

test/resources/config_files/psycopg2/some_basic_params_missing.cfg

@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db

test/resources/config_files/psycopg2/valid_custom_params.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=5432

test/resources/config_files/psycopg2/wrong_password.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=psycopg2
+dbName=db
+dbUsername=db_user
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=5432

test/resources/config_files/pymssql/charset_invalid.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+user=SA
+password=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433
+dbCharset=wrong

test/resources/config_files/pymssql/custom_param_password.cfg

@@ -0,0 +1,6 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+password=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433

test/resources/config_files/pymssql/invalid_custom_params.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+dbUsername=SA
+dbPassword=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433
+blah=blah

test/resources/config_files/pymssql/simple_default_alias.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+dbUsername=SA
+dbPassword=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433

test/resources/config_files/pymssql/some_basic_params_missing.cfg

@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db

test/resources/config_files/pymssql/valid_custom_params.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+user=SA
+password=MyPass1234!
+dbHost=127.0.0.1
+dbPort=1433

test/resources/config_files/pymssql/wrong_password.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymssql
+dbName=db
+dbUsername=SA
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=1433

test/resources/config_files/pymysql/charset_invalid.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbCharset=wrong

test/resources/config_files/pymysql/custom_param_password.cfg

@@ -0,0 +1,6 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+password=pass
+dbHost=127.0.0.1
+dbPort=3306

test/resources/config_files/pymysql/invalid_custom_params.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=3306
+blah=blah

test/resources/config_files/pymysql/simple_default_alias.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=3306

test/resources/config_files/pymysql/some_basic_params_missing.cfg

@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db

test/resources/config_files/pymysql/valid_custom_params.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=3306

test/resources/config_files/pymysql/wrong_password.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pymysql
+dbName=db
+dbUsername=db_user
+dbPassword=wrong
+dbHost=127.0.0.1
+dbPort=3306

test/resources/config_files/pyodbc/charset_invalid.cfg

@@ -0,0 +1,9 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+user=db_user
+password=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}
+dbCharset=wrong

test/resources/config_files/pyodbc/custom_param_password.cfg

@@ -0,0 +1,7 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+PWD=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}

test/resources/config_files/pyodbc/invalid_custom_params.cfg

@@ -0,0 +1,9 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}
+blah=blah

test/resources/config_files/pyodbc/simple_default_alias.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+dbUsername=db_user
+dbPassword=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}

test/resources/config_files/pyodbc/some_basic_params_missing.cfg

@@ -0,0 +1,3 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db

test/resources/config_files/pyodbc/valid_custom_params.cfg

@@ -0,0 +1,8 @@
+[default]
+dbapiModuleName=pyodbc
+dbName=db
+UID=db_user
+PWD=pass
+dbHost=127.0.0.1
+dbPort=3306
+dbDriver={MySQL ODBC 8.0 ANSI Driver}