nvidia-nat-test 1.3.0a20250826__py3-none-any.whl → 1.3.0a20250827__py3-none-any.whl

nat/test/plugin.py

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
+
 import pytest
 
 
@@ -42,6 +44,14 @@ def pytest_addoption(parser: pytest.Parser):
         help="Run end to end tests that would otherwise be skipped",
     )
 
+    parser.addoption(
+        "--fail_missing",
+        action="store_true",
+        dest="fail_missing",
+        help=("Tests requiring unmet dependencies are normally skipped. "
+              "Setting this flag will instead cause them to be reported as a failure"),
+    )
+
 
 def pytest_runtest_setup(item):
     if (not item.config.getoption("--run_e2e")):
@@ -94,3 +104,93 @@ def function_registry_fixture():
 
     with GlobalTypeRegistry.push() as registry:
         yield registry
+
+
+@pytest.fixture(scope="session", name="fail_missing")
+def fail_missing_fixture(pytestconfig: pytest.Config) -> bool:
+    """
+    Returns the value of the `fail_missing` flag, when false tests requiring unmet dependencies will be skipped, when
+    True they will fail.
+    """
+    yield pytestconfig.getoption("fail_missing")
+
+
+def require_env_variables(varnames: list[str], reason: str, fail_missing: bool = False) -> dict[str, str]:
+    """
+    Checks if the given environment variable is set, and returns its value if it is. If the variable is not set, and
+    `fail_missing` is False the test will ve skipped, otherwise a `RuntimeError` will be raised.
+    """
+    env_variables = {}
+    try:
+        for varname in varnames:
+            env_variables[varname] = os.environ[varname]
+    except KeyError as e:
+        if fail_missing:
+            raise RuntimeError(reason) from e
+
+        pytest.skip(reason=reason)
+
+    return env_variables
+
+
+@pytest.fixture(name="openai_api_key", scope='session')
+def openai_api_key_fixture(fail_missing: bool):
+    """
+    Use for integration tests that require an Openai API key.
+    """
+    yield require_env_variables(
+        varnames=["OPENAI_API_KEY"],
+        reason="openai integration tests require the `OPENAI_API_KEY` environment variable to be defined.",
+        fail_missing=fail_missing)
+
+
+@pytest.fixture(name="nvidia_api_key", scope='session')
+def nvidia_api_key_fixture(fail_missing: bool):
+    """
+    Use for integration tests that require an Nvidia API key.
+    """
+    yield require_env_variables(
+        varnames=["NVIDIA_API_KEY"],
+        reason="Nvidia integration tests require the `NVIDIA_API_KEY` environment variable to be defined.",
+        fail_missing=fail_missing)
+
+
+@pytest.fixture(name="aws_keys", scope='session')
+def aws_keys_fixture(fail_missing: bool):
+    """
+    Use for integration tests that require AWS credentials.
+    """
+
+    yield require_env_variables(
+        varnames=["AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY"],
+        reason=
+        "AWS integration tests require the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables to be "
+        "defined.",
+        fail_missing=fail_missing)
+
+
+@pytest.fixture(name="azure_openai_keys", scope='session')
+def azure_openai_keys_fixture(fail_missing: bool):
+    """
+    Use for integration tests that require Azure OpenAI credentials.
+    """
+    yield require_env_variables(
+        varnames=["AZURE_OPENAI_API_KEY", "AZURE_OPENAI_ENDPOINT"],
+        reason="Azure integration tests require the `AZURE_OPENAI_API_KEY` and `AZURE_OPENAI_ENDPOINT` environment "
+        "variable to be defined.",
+        fail_missing=fail_missing)
+
+
+@pytest.fixture(name="restore_environ")
+def restore_environ_fixture():
+    orig_vars = os.environ.copy()
+    yield os.environ
+
+    for key, value in orig_vars.items():
+        os.environ[key] = value
+
+    # Delete any new environment variables
+    # Iterating over a copy of the keys as we will potentially be deleting keys in the loop
+    for key in list(os.environ.keys()):
+        if key not in orig_vars:
+            del (os.environ[key])

nat/test/test_env_fixtures.py

@@ -0,0 +1,60 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""
+Comprehensive tests for environment variable handling and API key fixtures.
+"""
+
+import os
+
+import pytest
+
+from nat.test.plugin import require_env_variables
+
+
+@pytest.mark.usefixtures("restore_environ")
+@pytest.mark.parametrize("fail_on_missing", [True, False])
+@pytest.mark.parametrize("env_vars",
+                         [{
+                             "SOME_KEY": "xyz"
+                         }, {
+                             "SOME_KEY": "xyz", "OTHER_KEY": "abc"
+                         }, {
+                             "SOME_KEY": "xyz", "OTHER_KEY": "abc", "MISSING_KEY": None
+                         }, {
+                             "SOME_KEY": "xyz", "OTHER_KEY": "abc", "MISSING_KEY": None, "EMPTY_KEY": None
+                         }])
+def test_require_env_variables(fail_on_missing: bool, env_vars: dict[str, str | None]):
+    # Note the variable name `fail_on_missing` is used to avoid conflict with the `fail_missing` fixture
+    has_missing = False
+    var_names = []
+    for (env_var, value) in env_vars.items():
+        var_names.append(env_var)
+        if value is not None:
+            os.environ[env_var] = value
+        else:
+            has_missing = True
+            os.environ.pop(env_var, None)
+
+    if has_missing:
+        if fail_on_missing:
+            expected_exception = RuntimeError
+        else:
+            expected_exception = pytest.skip.Exception
+
+        with pytest.raises(expected_exception, match="unittest"):
+            require_env_variables(varnames=var_names, reason="unittest", fail_missing=fail_on_missing)
+
+    else:
+        assert require_env_variables(varnames=var_names, reason="unittest", fail_missing=fail_on_missing) == env_vars

{nvidia_nat_test-1.3.0a20250826.dist-info → nvidia_nat_test-1.3.0a20250827.dist-info}/METADATA

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: nvidia-nat-test
-Version: 1.3.0a20250826
+Version: 1.3.0a20250827
 Summary: Testing utilities for NeMo Agent toolkit
 Keywords: ai,rag,agents
 Classifier: Programming Language :: Python
 Requires-Python: <3.13,>=3.11
 Description-Content-Type: text/markdown
-Requires-Dist: nvidia-nat==v1.3.0a20250826
+Requires-Dist: nvidia-nat==v1.3.0a20250827
 Requires-Dist: langchain-community~=0.3
 Requires-Dist: pytest~=8.3
 

{nvidia_nat_test-1.3.0a20250826.dist-info → nvidia_nat_test-1.3.0a20250827.dist-info}/RECORD

@@ -4,11 +4,12 @@ nat/test/embedder.py,sha256=ClDyK1kna4hCBSlz71gK1B-ZjlwcBHTDQRekoNM81Bs,1809
 nat/test/functions.py,sha256=0ScrdsjcxCsPRLnyb5gfwukmvZxFi_ptCswLSIG0DVY,3095
 nat/test/memory.py,sha256=xki_A2yiMhEZuQk60K7t04QRqf32nQqnfzD5Iv7fkvw,1456
 nat/test/object_store_tests.py,sha256=PyJioOtoSzILPq6LuD-sOZ_89PIcgXWZweoHBQpK2zQ,4281
-nat/test/plugin.py,sha256=A__zjl49WjmQIl39ZfyTC3fpFj8yoQmSYPWUCw-RO3g,3535
+nat/test/plugin.py,sha256=sMZ7xupCgEpQCuwUksUDYMjbBj0VNlhR6SK5UcOrBzg,6953
 nat/test/register.py,sha256=fbCLr3E4u8PYMFUlkRNlg53Td2YJ80iQCyxpRIbGId4,859
+nat/test/test_env_fixtures.py,sha256=zGhFBiZmdDYuj8kOU__RL9LOrood3L58KG8OWXnyOjQ,2375
 nat/test/tool_test_runner.py,sha256=EP5Zo_YmfCOeeifzSv1ztx6xF-E-GVGYktN5hkZIBSc,17405
-nvidia_nat_test-1.3.0a20250826.dist-info/METADATA,sha256=vr3bWneqUPqjaaJO6QMx7IHRfVPqclSDkZHBj76Phjs,1466
-nvidia_nat_test-1.3.0a20250826.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nvidia_nat_test-1.3.0a20250826.dist-info/entry_points.txt,sha256=7dOP9XB6iMDqvav3gYx9VWUwA8RrFzhbAa8nGeC8e4Y,99
-nvidia_nat_test-1.3.0a20250826.dist-info/top_level.txt,sha256=8-CJ2cP6-f0ZReXe5Hzqp-5pvzzHz-5Ds5H2bGqh1-U,4
-nvidia_nat_test-1.3.0a20250826.dist-info/RECORD,,
+nvidia_nat_test-1.3.0a20250827.dist-info/METADATA,sha256=dhwJgvCZzsH9kqhCygerDpW-9i1cxO3GfbZzR_8uxnA,1466
+nvidia_nat_test-1.3.0a20250827.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nvidia_nat_test-1.3.0a20250827.dist-info/entry_points.txt,sha256=7dOP9XB6iMDqvav3gYx9VWUwA8RrFzhbAa8nGeC8e4Y,99
+nvidia_nat_test-1.3.0a20250827.dist-info/top_level.txt,sha256=8-CJ2cP6-f0ZReXe5Hzqp-5pvzzHz-5Ds5H2bGqh1-U,4
+nvidia_nat_test-1.3.0a20250827.dist-info/RECORD,,