Merge pull request #33 from azure-ai-foundry/python-tools-estraight

updated conftest

Author: e-straight

conftest.py

@@ -1,84 +1,70 @@
-import json
-import types
-from pathlib import Path
-from typing import Dict
-
+# conftest.py
+#
+# Purpose
+# -------
+# Treat every Python sample under  doc-samples/agents/python/**
+# as a Pytest test item.  The script “passes” if it runs without
+# raising an exception (exit code 0).
+#
+# How it works
+# ------------
+# • pytest_collect_file() is a collection hook called for every file
+#   Pytest sees.  We accept the file if:
+#     – it ends with .py
+#     – its path is under SAMPLE_ROOT (any depth)
+# • Accepted files become SampleItem objects, which simply execute
+#   the script with runpy.run_path().
+#
+# Edit SAMPLE_ROOT if you move the samples elsewhere.
+
+import pathlib
+import runpy
 import pytest
 
-REPO_ROOT = Path(__file__).parent.resolve()
-
-
-@pytest.fixture
-def notebook_path(
-    # Create and activate a new venv for each test that requests `notebook_path`
-    venv: types.SimpleNamespace,  # noqa: ARG001
-    notebook_path: Path,
-) -> Path:
-    """Activates a virtual environment for tests that request notebook_path (Jupyter Notebook tests)."""
-    return notebook_path
-
+# Root directory that contains all Python samples
+SAMPLE_ROOT = (
+    pathlib.Path(__file__).parent
+    / "doc-samples"
+    / "agents"
+    / "python"
+).resolve()
 
-@pytest.fixture
-def deployment_outputs() -> Dict[str, str]:
-    """The outputs of the deployment used to setup resources for testing samples.
 
-    Depends on the existence of a `deployment.json` file in the root of the repository,
-    which is the output of running `az deployment sub create -o json`
+def _is_under_sample_root(path_obj: pathlib.Path) -> bool:
     """
-    deployment_file_path = REPO_ROOT / "deployment.json"
+    Return True if `path_obj` is inside SAMPLE_ROOT (recursive).
 
+    Using Path.relative_to() is the safest way and works on all OSes.
+    """
     try:
-        with deployment_file_path.open() as f:
-            deployment = json.load(f)
-    except (FileExistsError, json.JSONDecodeError) as e:
-        raise AssertionError("Please use azure-cli to perform a deployment and same result to deployment.json") from e
-
-    properties = deployment.get("properties")
-
-    if properties is None or "outputs" not in properties:
-        raise AssertionError("Key 'properties.outputs' not present in deployment json")
-
-    outputs = properties.get("outputs")
+        path_obj.resolve().relative_to(SAMPLE_ROOT)
+        return True
+    except ValueError:
+        return False
 
-    return {output_name: output["value"] for output_name, output in outputs.items()}
-
-
-@pytest.fixture
-def azure_ai_project(deployment_outputs: Dict[str, str]) -> Dict[str, str]:
-    """Azure ai project dictionary."""
-    return {
-        "subscription_id": deployment_outputs["subscription_id"],
-        "resource_group_name": deployment_outputs["resource_group_name"],
-        "project_name": deployment_outputs["project_name"],
-    }
-
-
-@pytest.fixture
-def azure_ai_project_connection_string(deployment_outputs: Dict[str, str]) -> str:
-    """The connection string for the azure ai project"""
-    return ";".join(
-        [
-            f"{deployment_outputs['project_location']}.api.azureml.ms",
-            deployment_outputs["subscription_id"],
-            deployment_outputs["resource_group_name"],
-            deployment_outputs["project_name"],
-        ]
-    )
 
+def pytest_collect_file(parent, path):
+    """
+    PyTest collection hook: decide whether *path* should become a test item.
+    `path` is a py.path.local object; convert to Path for easier checks.
+    """
+    if path.ext == ".py" and _is_under_sample_root(pathlib.Path(path)):
+        return SampleItem.from_parent(parent, fspath=path)
 
-@pytest.fixture
-def azure_openai_endpoint(deployment_outputs: Dict[str, str]) -> str:
-    """The azure openai endpoint for the azure ai project."""
-    return deployment_outputs["azure_openai_endpoint"]
 
+class SampleItem(pytest.Item):
+    """
+    Wrapper around an arbitrary Python script.
+    The test *passes* if the script finishes without an exception.
+    """
 
-@pytest.fixture
-def azure_openai_gpt4_deployment(deployment_outputs: Dict[str, str]) -> str:
-    """The deployment name of the gpt-4 deployment."""
-    return deployment_outputs["azure_openai_gpt4_deployment_name"]
+    def runtest(self):
+        # Execute the script in its own namespace.
+        runpy.run_path(str(self.fspath))
 
+    def repr_failure(self, excinfo):
+        # Nicely format any exception raised during runtest().
+        return f"Sample {self.fspath} failed:\n{excinfo.value}"
 
-@pytest.fixture
-def azure_openai_gpt4_api_version(deployment_outputs: Dict[str, str]) -> str:
-    """The api version of the gpt-4 deployment."""
-    return deployment_outputs["azure_openai_gpt4_api_version"]
+    def reportinfo(self):
+        return self.fspath, 0, "sample script"