Merge pull request #79 from arctix625/feat/properties-param

sap_hdbsql: Add new parameter named properties

Author: marcelmamula

plugins/modules/sap_hdbsql.py

@@ -62,6 +62,13 @@
         description: Use encrypted connection.
         type: bool
         default: false
+    properties:
+        description:
+        - Sets SQLDBC connect options e.g. sqlMode=SAPR3
+        - Must be a string or list containing strings.
+        - See SAP HANA documentation for list of available options.
+        type: list
+        elements: str
     filepath:
         description:
         - One or more files each containing one SQL query to run.
@@ -142,6 +149,16 @@
     - select user_name from users
     - select * from users
     autocommit: False
+
+- name: Run query with SQLDBC connect options
+  community.sap_libs.sap_hdbsql:
+    sid: "hdb"
+    instance: "01"
+    password: "Test123"
+    query: select user_name from users
+    properties:
+      - "sqlMode=SAPR3"
+      - "sslHostNameInCertificate=hana.example.com"
 '''
 
 RETURN = r'''
@@ -205,6 +222,7 @@ def main():
             query=dict(type='list', elements='str', required=False),
             filepath=dict(type='list', elements='path', required=False),
             autocommit=dict(type='bool', default=True),
+            properties=dict(type='list', elements='str', required=False),
         ),
         required_one_of=[('query', 'filepath')],
         required_if=[('userstore', False, ['password'])],
@@ -260,6 +278,10 @@ def main():
     if params['database']:
         command.extend(['-d', params['database']])
 
+    if params['properties']:
+        for prop in params['properties']:
+            command.extend(['-Z', prop])
+
     if params['userstore']:
         command.extend(['-x', '-U', params['user']])
 

tests/unit/plugins/modules/test_sap_hdbsql.py

@@ -184,3 +184,23 @@ def test_encrypted_connection_flags(self):
             self.assertIn('-e', executed_cmd)
             self.assertIn('-ssltrustcert', executed_cmd)
             self.assertIn('-sslcreatecert', executed_cmd)
+
+    def test_properties_command_args(self):
+        """Verify that properties are correctly added to the command"""
+        args = {
+            'sid': "HDB",
+            'instance': "01",
+            'password': "pwd",
+            'properties': ["key1=value1", "key2=value2"],
+            'query': ["SELECT 1 FROM DUMMY;"]
+        }
+        with patch.object(basic.AnsibleModule, 'run_command') as run_command:
+            run_command.return_value = 0, '1', ''
+            with self.assertRaises(AnsibleExitJson):
+                with set_module_args(args):
+                    self.module.main()
+
+            executed_cmd = run_command.call_args[0][0]
+            self.assertIn('-Z', executed_cmd)
+            self.assertIn('key1=value1', executed_cmd)
+            self.assertIn('key2=value2', executed_cmd)