From 960ac32adffac3ff91c1c307ca04c62667a11b2b Mon Sep 17 00:00:00 2001
From: Andrew Klychkov <aklychko@redhat.com>
Date: Thu, 16 Jan 2025 15:49:53 +0100
Subject: [PATCH] mysql_query: returns execution_time_ms list containing
 execution time per query (#697)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* mysql_query: returns execution_time_ms list containing execution time per query

* Update changelogs/fragments/0-mysql_query-returns-exec-time-ms.yml

Co-authored-by: Laurent Indermühle <laurent.indermuehle@pm.me>
---
 .../0-mysql_query-returns-exec-time-ms.yml    |  2 ++
 plugins/modules/mysql_query.py                | 28 +++++++++++++++++--
 .../tasks/mysql_query_initial.yml             |  3 ++
 3 files changed, 31 insertions(+), 2 deletions(-)
 create mode 100644 changelogs/fragments/0-mysql_query-returns-exec-time-ms.yml

diff --git a/changelogs/fragments/0-mysql_query-returns-exec-time-ms.yml b/changelogs/fragments/0-mysql_query-returns-exec-time-ms.yml
new file mode 100644
index 0000000..d17628c
--- /dev/null
+++ b/changelogs/fragments/0-mysql_query-returns-exec-time-ms.yml
@@ -0,0 +1,2 @@
+minor_changes:
+- mysql_query - returns the ``execution_time_ms`` list containing execution time per query in milliseconds.
diff --git a/plugins/modules/mysql_query.py b/plugins/modules/mysql_query.py
index 2cdf096..35beeb3 100644
--- a/plugins/modules/mysql_query.py
+++ b/plugins/modules/mysql_query.py
@@ -62,7 +62,6 @@ author:
 - Andrew Klychkov (@Andersson007)
 extends_documentation_fragment:
 - community.mysql.mysql
-
 '''
 
 EXAMPLES = r'''
@@ -117,8 +116,18 @@ rowcount:
     returned: changed
     type: list
     sample: [5, 1]
+execution_time_ms:
+    description:
+    - A list containing execution time per query in milliseconds.
+    - The measurements are done right before and after passing
+      the query to the driver for execution.
+    returned: success
+    type: list
+    sample: [7104, 85]
+    version_added: '3.12.0'
 '''
 
+import time
 import warnings
 
 from ansible.module_utils.basic import AnsibleModule
@@ -139,6 +148,18 @@ DDL_QUERY_KEYWORDS = ('CREATE', 'DROP', 'ALTER', 'RENAME', 'TRUNCATE')
 # Module execution.
 #
 
+
+def execute_and_return_time(cursor, query, args):
+    # Measure query execution time in milliseconds
+    start_time = time.perf_counter()
+
+    cursor.execute(query, args)
+
+    # Calculate the execution time rounding it to 4 decimal places
+    exec_time_ms = round((time.perf_counter() - start_time) * 1000, 4)
+    return cursor, exec_time_ms
+
+
 def main():
     argument_spec = mysql_common_argument_spec()
     argument_spec.update(
@@ -213,6 +234,7 @@ def main():
     query_result = []
     executed_queries = []
     rowcount = []
+    execution_time_ms = []
 
     already_exists = False
     for q in query:
@@ -223,7 +245,8 @@ def main():
                                         category=mysql_driver.Warning)
 
                 try:
-                    cursor.execute(q, arguments)
+                    cursor, exec_time_ms = execute_and_return_time(cursor, q, arguments)
+                    execution_time_ms.append(exec_time_ms)
                 except mysql_driver.Warning:
                     # When something is run with IF NOT EXISTS
                     # and there's "already exists" MySQL warning,
@@ -280,6 +303,7 @@ def main():
         'executed_queries': executed_queries,
         'query_result': query_result,
         'rowcount': rowcount,
+        'execution_time_ms': execution_time_ms,
     }
 
     # Exit:
diff --git a/tests/integration/targets/test_mysql_query/tasks/mysql_query_initial.yml b/tests/integration/targets/test_mysql_query/tasks/mysql_query_initial.yml
index fbf5ca8..310f925 100644
--- a/tests/integration/targets/test_mysql_query/tasks/mysql_query_initial.yml
+++ b/tests/integration/targets/test_mysql_query/tasks/mysql_query_initial.yml
@@ -35,6 +35,7 @@
       that:
         - result is changed
         - result.executed_queries == ['CREATE TABLE {{ test_table1 }} (id int)']
+        - result.execution_time_ms[0] > 0
 
   - name: Insert test data
     mysql_query:
@@ -52,6 +53,8 @@
         - result is changed
         - result.rowcount == [2, 1]
         - result.executed_queries == ['INSERT INTO {{ test_table1 }} VALUES (1), (2)', 'INSERT INTO {{ test_table1 }} VALUES (3)']
+        - result.execution_time_ms[0] > 0
+        - result.execution_time_ms[1] > 0
 
   - name: Check data in {{ test_table1 }}
     mysql_query: