move get_results_dir_path to utils

Author: mdujava

testsuite/tests/tools/conftest.py

@@ -1,20 +1,9 @@
 """Tools conftest"""
 
 import json
-import os
-from pathlib import Path
 import pytest
 
-
-def get_results_dir_path():
-    """Method that gives you the path to the directory where you should store test results."""
-    try:
-        results_dir = os.environ.get("resultsdir")
-        return Path(results_dir)
-    except KeyError:
-        current_file = Path(__file__).resolve()
-        project_dir = current_file.parents[3]
-        return project_dir / "attachments"
+from testsuite.utils import get_results_dir_path
 
 
 def save_as_json(data, path):
@@ -34,5 +23,6 @@ def save_as_json(data, path):
 @pytest.hookimpl(trylast=True)
 def pytest_metadata(metadata):
     """Saves metadata to the attachments directory in json format"""
+    # path to resultsdir folder defaults to root of testsuite repository
     results_dir_path = get_results_dir_path()
-    save_as_json(metadata, results_dir_path / "pytest_metadata.json")
+    save_as_json(metadata, results_dir_path / "attachments" / "pytest_metadata.json")

testsuite/tests/ui/conftest.py

@@ -33,7 +33,7 @@
 from testsuite.ui.views.master.audience.tenant import TenantNewView, TenantDetailView
 from testsuite.ui.views.master.login import MasterLoginView
 from testsuite.ui.webdriver import ThreescaleWebdriver
-from testsuite.utils import blame
+from testsuite.utils import blame, get_results_dir_path
 
 
 LOGGER = logging.getLogger(__name__)
@@ -448,12 +448,11 @@ def get_resultsdir_path(node):
     """
 
     xml = node.config.getoption("--junitxml")
-    # path to "3scape-py-testsuite" folder
-    no_argument_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../..")
-    resultsdir = os.environ.get("resultsdir", no_argument_dir)
     failed_test_name = node.nodeid.replace("/", ".").replace(".py::", ".")
 
     if not xml:
+        # path to resultsdir folder defaults to root of testsuite repository
+        resultsdir = get_results_dir_path()
         path = f"{resultsdir}/attachments/ui/{failed_test_name}/"
 
     else:

testsuite/utils.py

@@ -8,6 +8,7 @@
 import warnings
 from base64 import b64encode
 from os import urandom
+from pathlib import Path
 
 import pytest
 
@@ -229,3 +230,10 @@ def custom_policy() -> dict:
     return _M
     """
     return {"init.lua": initlua, "example.lua": examplelua, "apicast-policy.json": apicastpolicyjson}
+
+
+def get_results_dir_path():
+    """resolve resultsdir or defaults to root of 3scale-tests repo"""
+    no_argument_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../..")
+    resultsdir = os.environ.get("resultsdir", no_argument_dir)
+    return Path(resultsdir)