Add get_databases function + its unit and CI tests

plugins/modules/cockroachdb_info.py

@@ -147,6 +147,28 @@ def get_server_version(module, cursor):
     return v_info
 
 
+def get_databases(module, cursor):
+    """Get database info from a server.
+
+    Return a dictionary containing database info.
+    """
+    res = exec_query(module, cursor, 'SHOW DATABASES WITH COMMENT')
+
+    if not res:
+        return {}
+
+    db_info = {}
+    for tup in res:
+        dbname = tup[0]
+        comment = tup[1]
+        db_info[dbname] = {}
+
+        if comment:
+            db_info[dbname]['comment'] = comment
+
+    return db_info
+
+
 def main():
     # Set up arguments
     argument_spec = common_argument_spec()
@@ -168,11 +190,13 @@ def main():
     # We will return it to users at the end
     server_info = {
         'version': {},
+        'databases': {},
     }
 
     # Collect info
     # TODO: implement via loop with filtering
     server_info['version'] = get_server_version(module, cursor)
+    server_info['databases'] = get_databases(module, cursor)
 
     # Close cursor and conn
     cursor.close()

tests/integration/targets/cockroachdb_info/tasks/main.yml

@@ -32,6 +32,9 @@
         - result.version.release > 0
         - result.version.release < 5
         - result.version.patch >= 0
+        - result.databases.defaultdb.comment == 'root'
+        - result.databases.postgres.comment == 'root'
+        - result.databases.system.comment == 'node'
 
 
   - name: Fetch server info in check_mode
@@ -49,3 +52,6 @@
         - result.version.release > 0
         - result.version.release < 5
         - result.version.patch >= 0
+        - result.databases.defaultdb.comment == 'root'
+        - result.databases.postgres.comment == 'root'
+        - result.databases.system.comment == 'node'

tests/unit/plugins/modules/test_cockroachdb_info.py

@@ -9,6 +9,7 @@
 from ansible_collections.community.cockroachdb.plugins.modules.cockroachdb_info import (
     exec_query,
     extract_server_ver,
+    get_databases,
     get_server_version,
 )
 
@@ -68,6 +69,7 @@ def mock__init__(self):
 
     monkeypatch.setattr(Cursor, 'fetchall', mock_fetchall)
     monkeypatch.setattr(AnsibleModule, '__init__', mock__init__)
+
     module = AnsibleModule()
     cursor = Cursor()
     query = 'SELECT VERSION()'
@@ -92,8 +94,8 @@ def mock_execute(self, query):
     monkeypatch.setattr(Cursor, 'execute', mock_execute)
     monkeypatch.setattr(AnsibleModule, '__init__', mock__init__)
     monkeypatch.setattr(AnsibleModule, 'fail_json', mock_fail_json)
-    module = AnsibleModule()
 
+    module = AnsibleModule()
     cursor = Cursor()
     query = 'SELECT VERSION()'
 
@@ -110,12 +112,32 @@ def mock_fetchall(self):
     monkeypatch.setattr(Cursor, 'fetchall', mock_fetchall)
     monkeypatch.setattr(AnsibleModule, '__init__', mock__init__)
     monkeypatch.setattr(AnsibleModule, 'fail_json', mock_fail_json)
-    module = AnsibleModule()
 
+    module = AnsibleModule()
     cursor = Cursor()
     query = 'SELECT VERSION()'
 
     exec_query(module, cursor, query)
 
     assert module.fail_msg == ('Failed to fetch rows for query "SELECT VERSION()" '
                                'from cursor: Fake cursor.fetchall() failing.')
+
+
+@pytest.mark.parametrize('fetchall_out,expected', [
+    ([['postgres', None]], {'postgres': {}}),
+    ([['postgres', 'comment1']], {'postgres': {'comment': 'comment1'}}),
+    (
+        [['postgres', 'comment1'], ['test', 'comment2']],
+        {'postgres': {'comment': 'comment1'}, 'test': {'comment': 'comment2'}},
+    )]
+)
+def test_get_databases(monkeypatch, fetchall_out, expected):
+    monkeypatch.setattr(Cursor, 'execute', lambda self, x: None)
+    monkeypatch.setattr(Cursor, 'fetchall', lambda self: fetchall_out)
+    monkeypatch.setattr(AnsibleModule, '__init__', mock__init__)
+    monkeypatch.setattr(AnsibleModule, 'fail_json', mock_fail_json)
+
+    module = AnsibleModule()
+    cursor = Cursor()
+
+    assert get_databases(module, cursor) == expected