Improvements to Arm backend pytest setup

* Add pytest fixture to ensure randomness on tests
* Move pytest setup to conftest.py to separate pytest commonalities
from general ones
* Minor error catching improvements
* Removed pytest dependency in ArmTester

Change-Id: I9132681d705c1501391f3d4603f5d6f0786db873

Author: freddan80

backends/arm/test/common.py

@@ -4,156 +4,33 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
-import logging
+
 import os
-import platform
-import shutil
-import subprocess
-import sys
+
 import tempfile
 from datetime import datetime
-from enum import auto, Enum
 from pathlib import Path
-from typing import Any
-
-import pytest
 
-import torch
+from conftest import is_option_enabled
 
 from executorch.backends.arm.arm_backend import ArmCompileSpecBuilder
 from executorch.exir.backend.compile_spec_schema import CompileSpec
 
 
-class arm_test_options(Enum):
-    quantize_io = auto()
-    corstone300 = auto()
-    dump_path = auto()
-    date_format = auto()
-    fast_fvp = auto()
-
-
-_test_options: dict[arm_test_options, Any] = {}
-
-# ==== Pytest hooks ====
-
-
-def pytest_addoption(parser):
-    parser.addoption("--arm_quantize_io", action="store_true")
-    parser.addoption("--arm_run_corstone300", action="store_true")
-    parser.addoption("--default_dump_path", default=None)
-    parser.addoption("--date_format", default="%d-%b-%H:%M:%S")
-    parser.addoption("--fast_fvp", action="store_true")
-
-
-def pytest_configure(config):
-    if config.option.arm_quantize_io:
-        load_libquantized_ops_aot_lib()
-        _test_options[arm_test_options.quantize_io] = True
-    if config.option.arm_run_corstone300:
-        corstone300_exists = shutil.which("FVP_Corstone_SSE-300_Ethos-U55")
-        if not corstone300_exists:
-            raise RuntimeError(
-                "Tests are run with --arm_run_corstone300 but corstone300 FVP is not installed."
-            )
-        _test_options[arm_test_options.corstone300] = True
-    if config.option.default_dump_path:
-        dump_path = Path(config.option.default_dump_path).expanduser()
-        if dump_path.exists() and os.path.isdir(dump_path):
-            _test_options[arm_test_options.dump_path] = dump_path
-        else:
-            raise RuntimeError(
-                f"Supplied argument 'default_dump_path={dump_path}' that does not exist or is not a directory."
-            )
-    _test_options[arm_test_options.date_format] = config.option.date_format
-    _test_options[arm_test_options.fast_fvp] = config.option.fast_fvp
-    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
-
-
-def pytest_collection_modifyitems(config, items):
-    if not config.option.arm_quantize_io:
-        skip_if_aot_lib_not_loaded = pytest.mark.skip(
-            "u55 tests can only run with quantize_io=True."
-        )
-
-        for item in items:
-            if "u55" in item.name:
-                item.add_marker(skip_if_aot_lib_not_loaded)
-
-
-def pytest_sessionstart(session):
-    pass
-
-
-def pytest_sessionfinish(session, exitstatus):
-    if get_option(arm_test_options.dump_path):
-        _clean_dir(
-            get_option(arm_test_options.dump_path),
-            f"ArmTester_{get_option(arm_test_options.date_format)}.log",
-        )
-
-
-# ==== End of Pytest hooks =====
-
-# ==== Custom Pytest decorators =====
-
-
-def expectedFailureOnFVP(test_item):
-    if is_option_enabled("corstone300"):
-        test_item.__unittest_expecting_failure__ = True
-    return test_item
-
-
-# ==== End of Custom Pytest decorators =====
-
-
-def load_libquantized_ops_aot_lib():
-    so_ext = {
-        "Darwin": "dylib",
-        "Linux": "so",
-        "Windows": "dll",
-    }.get(platform.system(), None)
-
-    find_lib_cmd = [
-        "find",
-        "cmake-out-aot-lib",
-        "-name",
-        f"libquantized_ops_aot_lib.{so_ext}",
-    ]
-    res = subprocess.run(find_lib_cmd, capture_output=True)
-    if res.returncode == 0:
-        library_path = res.stdout.decode().strip()
-        torch.ops.load_library(library_path)
-
-
-def is_option_enabled(
-    option: str | arm_test_options, fail_if_not_enabled: bool = False
-) -> bool:
-    """
-    Returns whether an option is successfully enabled, i.e. if the flag was
-    given to pytest and the necessary requirements are available.
-    Implemented options are:
-        - corstone300.
-        - quantize_io.
-
-    The optional parameter 'fail_if_not_enabled' makes the function raise
-      a RuntimeError instead of returning False.
+def get_time_formatted_path(path: str, log_prefix: str) -> str:
     """
-    if isinstance(option, str):
-        option = arm_test_options[option.lower()]
-
-    if option in _test_options and _test_options[option]:
-        return True
-    else:
-        if fail_if_not_enabled:
-            raise RuntimeError(f"Required option '{option}' for test is not enabled")
-        else:
-            return False
+    Returns the log path with the current time appended to it. Used for debugging.
 
+    Args:
+        path: The path to the folder where the log file will be stored.
+        log_prefix: The name of the test.
 
-def get_option(option: arm_test_options) -> Any | None:
-    if option in _test_options:
-        return _test_options[option]
-    return None
+    Example output:
+        './my_log_folder/test_BI_artifact_28-Nov-14:14:38.log'
+    """
+    return str(
+        Path(path) / f"{log_prefix}_{datetime.now().strftime('%d-%b-%H:%M:%S')}.log"
+    )
 
 
 def maybe_get_tosa_collate_path() -> str | None:
@@ -303,35 +180,6 @@ def get_u85_compile_spec_unbuilt(
     return compile_spec
 
 
-def current_time_formated() -> str:
-    """Return current time as a formated string"""
-    return datetime.now().strftime(get_option(arm_test_options.date_format))
-
-
-def _clean_dir(dir: Path, filter: str, num_save=10):
-    sorted_files: list[tuple[datetime, Path]] = []
-    for file in dir.iterdir():
-        try:
-            creation_time = datetime.strptime(file.name, filter)
-            insert_index = -1
-            for i, to_compare in enumerate(sorted_files):
-                compare_time = to_compare[0]
-                if creation_time < compare_time:
-                    insert_index = i
-                    break
-            if insert_index == -1 and len(sorted_files) < num_save:
-                sorted_files.append((creation_time, file))
-            else:
-                sorted_files.insert(insert_index, (creation_time, file))
-        except ValueError:
-            continue
-
-    if len(sorted_files) > num_save:
-        for remove in sorted_files[0 : len(sorted_files) - num_save]:
-            file = remove[1]
-            file.unlink()
-
-
 def get_target_board(compile_spec: list[CompileSpec]) -> str | None:
     for spec in compile_spec:
         if spec.key == "compile_flags":