(test,eval_perf)add sql log filename in pytest

backend/geonature/tests/benchmarks/utils.py

@@ -1,5 +1,6 @@
 import time
 import logging
+import os
 
 import pytest
 import pandas
@@ -14,17 +15,32 @@
 logger.setLevel(logging.DEBUG)
 
 
-@pytest.fixture(scope="class")
-def activate_profiling_sql():
+@pytest.fixture(scope="session")
+def activate_profiling_sql(sqllogfilename: pytest.FixtureDef):
     """
-    Fixture to activate profiling for SQL queries and storing query's statements and execution times in a csv file.
+    Fixture to activate profiling for SQL queries and store query's statements and execution times in a CSV file.
+
+    This fixture takes a `sqllogfilename` parameter, which is the path to a CSV file where the query statements and
+    execution times will be stored. If no `sqllogfilename` is provided, the SQL profiling will not be activated.
+
+    Parameters
+    ----------
+    - sqllogfilename: pytest.FixtureDef
+        The path to the CSV file where the query statements and execution times will be stored.
+
     """
 
-    results_file = "sql_queries.csv"
+    if not sqllogfilename:
+        logger.debug("No SQL Log file provided. SQL Profiling will not be activated.")
+        return
+
+    directory = os.path.dirname(sqllogfilename)
+    if directory and not os.path.exists(directory):
+        raise FileNotFoundError(f"Directory {directory} does not exists ! ")
+
     df = pandas.DataFrame([], columns=["Query", "Total Time [s.]"])
-    df.to_csv(results_file, mode="a", header=True, index=None, sep=";")
+    df.to_csv(sqllogfilename, header=True, index=None, sep=";")
 
-    # @event.listens_for(Engine, "before_cursor_execute")
     def before_cursor_execute(conn, cursor, statement, parameters, context, executemany):
         conn.info.setdefault("query_start_time", []).append(time.time())
         logger.debug("Start Query: %s" % statement)
@@ -36,7 +52,7 @@ def after_cursor_execute(conn, cursor, statement, parameters, context, executema
         logger.debug("Total Time: %f" % total)
         if statement.startswith("SELECT"):
             df = pandas.DataFrame([[statement, total]], columns=["Query", "Total Time"])
-            df.to_csv(results_file, mode="a", header=False, index=None, sep=";")
+            df.to_csv(sqllogfilename, mode="a", header=False, index=None, sep=";")
 
     event.listen(db.engine, "before_cursor_execute", before_cursor_execute)
     event.listen(db.engine, "after_cursor_execute", after_cursor_execute)

backend/geonature/tests/conftest.py

@@ -1,3 +1,13 @@
 # force discovery of some fixtures
 from .fixtures import app, users, _session
 from pypnusershub.tests.fixtures import teardown_logout_user
+import pytest
+
+
+def pytest_addoption(parser):
+    parser.addoption("--sql-log-filename", action="store", default=None)
+
+
+@pytest.fixture(scope="session")
+def sqllogfilename(request):
+    return request.config.getoption("--sql-log-filename")