Rewrite load test data function in unit tests

Helper to load test data for unit tests.

This function supports loading data files relative to the test file.
It works even if the test file is in a subfolder, allowing your
test data to be organized in corresponding subfolders alongside the tests.

Author: cernymi

tests/test_data.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+"""
+Helper functions for loading structured test data for unit tests.
+
+Provides functions to locate JSON test_data files based on the
+location of the test script in tests/unit/ and to return the data
+as lists of tuples for use in pytest parameterization.
+"""
+
+import json
+from pathlib import Path
+
+CURRENT_FILE = Path(__file__).resolve()  # Current file abs path
+UNIT_TESTS_DIR = CURRENT_FILE.parents[1]  # project_root/tests/unit
+# Relative path from project root to unit tests dir - tests/unit
+ROOT_TO_UNIT_TESTS = CURRENT_FILE.parents[1].relative_to(CURRENT_FILE.parents[3])
+
+
+def load_test_data(script_dir: Path, data_path: str, use_subfold: bool = True) -> list:
+    """
+    Load structured test data for a test file.
+
+    The directory structure is derived from:
+    tests/unit/<unit_test_dir>/<optional_subfolder>/...
+
+    Args:
+        test_script_dir: Directory containing the test file.
+        data_path: Name of the test_data folder to load.
+        use_sub: Dive into same subfolders as script_dir in test_data
+
+    Returns:
+        List of tuples extracted from the JSON file.
+    """
+    try:
+        # Normal expected case: script_dir lives under tests/unit
+        units_to_test_file: list = script_dir.relative_to(UNIT_TESTS_DIR).parts
+    except ValueError:
+        # Fallback for tox/CI environments where paths differ
+        # Find the path fragment "tests/unit" and slice from there
+        parts = list(script_dir.parts)
+        try:
+            idx = parts.index(UNIT_TESTS_DIR.parts[-1])  # project/tests/unit/...
+            units_to_test_file: list = parts[idx + 1 :]
+        except ValueError:
+            # Last-resort fallback: treat as having no subfolder
+            units_to_test_file = ()
+
+    unit_test_dir: str = units_to_test_file[0]
+    subfolder = Path(*units_to_test_file[1:]) if len(units_to_test_file) > 1 else None
+
+    # Build data.json path
+    base = ROOT_TO_UNIT_TESTS / unit_test_dir / "test_data"
+    if subfolder and use_subfold:
+        base /= subfolder
+
+    data_file = base / data_path / "data.json"
+
+    with data_file.open("r", encoding="utf-8") as f:
+        data = json.load(f)
+
+    return [tuple(item.values()) for item in data]

tests/unit/helpers/load_data.py

@@ -6,8 +6,8 @@
 
 __metaclass__ = type
 
-import os
 from functools import partial
+from pathlib import Path
 from unittest.mock import Mock, call, mock_open, patch
 
 import pytest
@@ -17,7 +17,9 @@
     from ansible_collections.netbox.netbox.plugins.inventory.nb_inventory import (
         InventoryModule,
     )
-    from ansible_collections.netbox.netbox.tests.test_data import load_test_data
+    from ansible_collections.netbox.netbox.tests.unit.helpers.load_data import (
+        load_test_data,
+    )
 
 except ImportError:
     import sys
@@ -27,15 +29,12 @@
 
     sys.path.append("plugins/inventory")
     sys.path.append("tests")
-    from test_data import load_test_data
+    from tests.unit.helpers.load_data import load_test_data
 
-load_relative_test_data = partial(
-    load_test_data, os.path.dirname(os.path.abspath(__file__))
-)
+load_relative_test_data = partial(load_test_data, Path(__file__).resolve().parent)
 
 
 class MockInventory:
-
     def __init__(self):
         self.variables = {}
 

tests/unit/inventory/test_nb_inventory.py

@@ -8,10 +8,9 @@
 __metaclass__ = type
 
 import re
-import os
 from functools import partial
+from pathlib import Path
 from unittest.mock import MagicMock
-
 import pytest
 
 try:
@@ -21,7 +20,9 @@
     from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import (
         NetboxModule,
     )
-    from ansible_collections.netbox.netbox.tests.test_data import load_test_data
+    from ansible_collections.netbox.netbox.tests.unit.helpers.load_data import (
+        load_test_data,
+    )
 
     MOCKER_PATCH_PATH = "ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils.NetboxModule"
 except ImportError:
@@ -34,13 +35,11 @@
     sys.path.append("tests")
     from netbox_dcim import NB_DEVICES
     from netbox_utils import NetboxModule
-    from test_data import load_test_data
+    from tests.unit.helpers.load_data import load_test_data
 
     MOCKER_PATCH_PATH = "netbox_utils.NetboxModule"
 
-load_relative_test_data = partial(
-    load_test_data, os.path.dirname(os.path.abspath(__file__))
-)
+load_relative_test_data = partial(load_test_data, Path(__file__).resolve().parent)
 
 
 @pytest.fixture