Cleanup test classes to eliminate warnings coming from PyTest. (#168)

cleemullins · web-flow · commit 288efbf9857a · 2025-10-14T13:22:47.000-07:00
* Cleanup test classes to eliminate warnings coming from PyTest.

- Introduced `MockTestingAdapter` and `MockTestingCustomState` for unit testing.
- Replaced instances of `TestingAdapter` with `MockTestingAdapter` in various test files.
- Updated `test_agent_state.py` to utilize `_MockTestDataItem` instead of `TestDataItem`.
- Added `ObsoleteTestClient` for potential future testing scenarios.
- Refactored `test_turn_context.py` to use `_SimpleTestingAdapter` for context testing.
- Ensured all tests are aligned with the new mock implementations for better isolation and control.

* Refactor test data organization and update configurations for consistency across tests

Enable strict "warnings as errors" in PyTest. Fix associated issues and errors that came up.

* Fix import statement to use DEFAULT_TEST_VALUES for consistency in test setup
diff --git a/libraries/microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage_config.py b/libraries/microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage_config.py
@@ -42,7 +42,8 @@ def __init__(
         """
         config_file: str = kwargs.get("filename", "")
         if config_file:
-            kwargs = json.load(open(config_file))
+            with open(config_file) as f:
+                kwargs = json.load(f)
         self.cosmos_db_endpoint: str = cosmos_db_endpoint or kwargs.get(
             "cosmos_db_endpoint", ""
         )
diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,39 @@
+[pytest]
+# Pytest configuration for Microsoft Agents for Python
+
+# Treat all warnings as errors by default
+# This ensures that any code generating warnings will fail tests,
+# promoting cleaner code and early detection of issues
+filterwarnings = 
+    error
+    # Ignore specific warnings that are not actionable or are from dependencies
+    ignore::DeprecationWarning:pkg_resources.*
+    ignore::DeprecationWarning:setuptools.*
+    ignore::PendingDeprecationWarning
+    # pytest-asyncio warnings that are safe to ignore
+    ignore:.*deprecated.*asyncio.*:DeprecationWarning:pytest_asyncio.*
+
+# Test discovery configuration
+testpaths = tests
+python_files = test_*.py *_test.py
+python_classes = Test*
+python_functions = test_*
+
+# Output configuration
+addopts = 
+    --strict-markers
+    --strict-config
+    --verbose
+    --tb=short
+    --durations=10
+
+# Minimum version requirement
+minversion = 6.0
+
+# Markers for test categorization
+markers =
+    unit: Unit tests
+    integration: Integration tests
+    slow: Slow tests that may take longer to run
+    requires_network: Tests that require network access
+    requires_auth: Tests that require authentication
diff --git a/tests/README.md b/tests/README.md
@@ -2,6 +2,27 @@
 
 This document serves as a quick guide to the utilities we provide internally to test this SDK. More information will come with work on integration testing.
 
+## Pytest Configuration
+
+The project uses a `pytest.ini` configuration file in the root directory that sets up the following testing standards:
+
+- **Warnings as Errors**: All warnings are treated as errors (`filterwarnings = error`) to ensure clean code and early detection of issues
+- **Strict Configuration**: Uses `--strict-markers` and `--strict-config` to catch configuration issues
+- **Test Discovery**: Automatically discovers tests in the `tests/` directory following standard naming conventions
+- **Verbose Output**: Shows detailed test results with short tracebacks and duration information
+
+To run tests locally:
+```bash
+# Run all tests
+python -m pytest
+
+# Run tests for a specific module
+python -m pytest tests/activity/
+
+# Run with custom options (these will be added to the configured defaults)
+python -m pytest -x --lf  # Stop on first failure, run last failed tests
+```
+
 ## Storage Tests
 
 More info soon. For now, there are flags defined in the code that dictate whether the Cosmos DB and the Blob storage tests are run, as these tests rely on local emulators.
diff --git a/tests/_common/data/__init__.py b/tests/_common/data/__init__.py
@@ -1,21 +1,21 @@
-from .test_defaults import TEST_DEFAULTS
-from .test_auth_data import (
-    TEST_AUTH_DATA,
+from .default_test_values import DEFAULT_TEST_VALUES
+from .auth_test_data import (
+    AUTH_TEST_DATA,
     create_test_auth_handler,
 )
-from .test_storage_data import TEST_STORAGE_DATA
-from .test_flow_data import TEST_FLOW_DATA
-from .configs import TEST_ENV_DICT, TEST_ENV
-from .configs import TEST_AGENTIC_ENV_DICT, TEST_AGENTIC_ENV
+from .storage_test_data import STORAGE_TEST_DATA
+from .flow_test_data import FLOW_TEST_DATA
+from .configs import NON_AGENTIC_TEST_ENV_DICT, NON_AGENTIC_TEST_ENV
+from .configs import AGENTIC_TEST_ENV_DICT, AGENTIC_TEST_ENV
 
 __all__ = [
-    "TEST_DEFAULTS",
-    "TEST_AUTH_DATA",
-    "TEST_STORAGE_DATA",
-    "TEST_FLOW_DATA",
+    "DEFAULT_TEST_VALUES",
+    "AUTH_TEST_DATA",
+    "STORAGE_TEST_DATA",
+    "FLOW_TEST_DATA",
     "create_test_auth_handler",
-    "TEST_ENV_DICT",
-    "TEST_ENV",
-    "TEST_AGENTIC_ENV_DICT",
-    "TEST_AGENTIC_ENV",
+    "NON_AGENTIC_TEST_ENV_DICT",
+    "NON_AGENTIC_TEST_ENV",
+    "AGENTIC_TEST_ENV_DICT",
+    "AGENTIC_TEST_ENV",
 ]
diff --git a/tests/_common/data/auth_test_data.py b/tests/_common/data/auth_test_data.py
@@ -29,7 +29,7 @@ def create_test_auth_handler(
     )
 
 
-class TEST_AUTH_DATA:
+class AUTH_TEST_DATA:
     def __init__(self):
 
         self.auth_handler: AuthHandler = create_test_auth_handler("graph")
diff --git a/tests/_common/data/configs/__init__.py b/tests/_common/data/configs/__init__.py
@@ -1,4 +1,9 @@
-from .test_auth_config import TEST_ENV_DICT, TEST_ENV
-from .test_agentic_auth_config import TEST_AGENTIC_ENV_DICT, TEST_AGENTIC_ENV
+from .test_auth_config import NON_AGENTIC_TEST_ENV_DICT, NON_AGENTIC_TEST_ENV
+from .test_agentic_auth_config import AGENTIC_TEST_ENV_DICT, AGENTIC_TEST_ENV
 
-__all__ = ["TEST_ENV_DICT", "TEST_ENV", "TEST_AGENTIC_ENV_DICT", "TEST_AGENTIC_ENV"]
+__all__ = [
+    "NON_AGENTIC_TEST_ENV_DICT",
+    "NON_AGENTIC_TEST_ENV",
+    "AGENTIC_TEST_ENV_DICT",
+    "AGENTIC_TEST_ENV",
+]
diff --git a/tests/_common/data/configs/test_agentic_auth_config.py b/tests/_common/data/configs/test_agentic_auth_config.py
@@ -1,9 +1,9 @@
 from microsoft_agents.activity import load_configuration_from_env
 
 from ...create_env_var_dict import create_env_var_dict
-from ..test_defaults import TEST_DEFAULTS
+from ..default_test_values import DEFAULT_TEST_VALUES
 
-DEFAULTS = TEST_DEFAULTS()
+DEFAULTS = DEFAULT_TEST_VALUES()
 
 _TEST_AGENTIC_ENV_RAW = """
 CONNECTIONS__SERVICE_CONNECTION__SETTINGS__TENANTID=service-tenant-id
@@ -46,9 +46,9 @@
 )
 
 
-def TEST_AGENTIC_ENV():
+def AGENTIC_TEST_ENV():
     return create_env_var_dict(_TEST_AGENTIC_ENV_RAW)
 
 
-def TEST_AGENTIC_ENV_DICT():
-    return load_configuration_from_env(TEST_AGENTIC_ENV())
+def AGENTIC_TEST_ENV_DICT():
+    return load_configuration_from_env(AGENTIC_TEST_ENV())
diff --git a/tests/_common/data/configs/test_auth_config.py b/tests/_common/data/configs/test_auth_config.py
@@ -1,9 +1,9 @@
 from microsoft_agents.activity import load_configuration_from_env
 
 from ...create_env_var_dict import create_env_var_dict
-from ..test_defaults import TEST_DEFAULTS
+from ..default_test_values import DEFAULT_TEST_VALUES
 
-DEFAULTS = TEST_DEFAULTS()
+DEFAULTS = DEFAULT_TEST_VALUES()
 
 _TEST_ENV_RAW = """
 AGENTAPPLICATION__USERAUTHORIZATION__HANDLERS__{auth_handler_id}__SETTINGS__AZUREBOTOAUTHCONNECTIONNAME={abs_oauth_connection_name}
@@ -20,9 +20,9 @@
 )
 
 
-def TEST_ENV():
+def NON_AGENTIC_TEST_ENV():
     return create_env_var_dict(_TEST_ENV_RAW)
 
 
-def TEST_ENV_DICT():
-    return load_configuration_from_env(TEST_ENV())
+def NON_AGENTIC_TEST_ENV_DICT():
+    return load_configuration_from_env(NON_AGENTIC_TEST_ENV())
diff --git a/tests/_common/data/default_test_values.py b/tests/_common/data/default_test_values.py
@@ -6,7 +6,7 @@
 )
 
 
-class TEST_DEFAULTS:
+class DEFAULT_TEST_VALUES:
     def __init__(self):
 
         self.token = "__token"
diff --git a/tests/_common/data/flow_test_data.py b/tests/_common/data/flow_test_data.py
@@ -3,9 +3,9 @@
 from microsoft_agents.hosting.core._oauth import _FlowState, _FlowStateTag
 
 from tests._common.storage import MockStoreItem
-from tests._common.data.test_defaults import TEST_DEFAULTS
+from tests._common.data.default_test_values import DEFAULT_TEST_VALUES
 
-DEFAULTS = TEST_DEFAULTS()
+DEFAULTS = DEFAULT_TEST_VALUES()
 
 DEF_FLOW_ARGS = {
     "ms_app_id": DEFAULTS.ms_app_id,
@@ -15,7 +15,7 @@
 }
 
 
-class TEST_FLOW_DATA:
+class FLOW_TEST_DATA:
     def __init__(self):
 
         self.not_started = _FlowState(
diff --git a/tests/_common/data/storage_test_data.py b/tests/_common/data/storage_test_data.py
@@ -2,16 +2,16 @@
 
 from tests._common.storage import MockStoreItem
 
-from .test_flow_data import (
-    TEST_FLOW_DATA,
+from .flow_test_data import (
+    FLOW_TEST_DATA,
     update_flow_state_handler,
     flow_key,
 )
 
-FLOW_DATA = TEST_FLOW_DATA()
+FLOW_DATA = FLOW_TEST_DATA()
 
 
-class TEST_STORAGE_DATA:
+class STORAGE_TEST_DATA:
     def __init__(self):
 
         self.dict = {
diff --git a/tests/_common/fixtures/flow_state_fixtures.py b/tests/_common/fixtures/flow_state_fixtures.py
@@ -2,9 +2,9 @@
 
 from microsoft_agents.hosting.core._oauth import _FlowStateTag
 
-from tests._common.data import TEST_FLOW_DATA
+from tests._common.data import FLOW_TEST_DATA
 
-FLOW_STATES = TEST_FLOW_DATA()
+FLOW_STATES = FLOW_TEST_DATA()
 
 
 class FlowStateFixtures:
diff --git a/tests/_common/obsolete_test_client.py b/tests/_common/obsolete_test_client.py
@@ -13,9 +13,9 @@
 T = TypeVar("T")
 
 
-# currently unused (probably outdated)
-# but may be useful to bring up-to-date for future testing scenarios
-class TestClient:
+# This is a currently unused (probably outdated & deleted) test client that
+# may be useful to bring up-to-date for future testing scenarios.
+class ObsoleteTestClient:
     """
     A testing channel that connects directly to an adapter.
 
diff --git a/tests/_common/testing_objects/__init__.py b/tests/_common/testing_objects/__init__.py
@@ -1,4 +1,4 @@
-from .adapters import TestingAdapter
+from .adapters import MockTestingAdapter
 
 from .mocks import (
     MockMsalAuth,
@@ -14,7 +14,7 @@
 
 from .testing_authorization import TestingAuthorization
 from .testing_connection_manager import TestingConnectionManager
-from .testing_custom_state import TestingCustomState
+from .mock_testing_custom_state import MockTestingCustomState
 from .testing_token_provider import TestingTokenProvider
 from .testing_user_token_client import TestingUserTokenClient
 
@@ -26,10 +26,10 @@
     "mock_class_UserTokenClient",
     "TestingAuthorization",
     "TestingConnectionManager",
-    "TestingCustomState",
+    "MockTestingCustomState",
     "TestingTokenProvider",
     "TestingUserTokenClient",
-    "TestingAdapter",
+    "MockTestingAdapter",
     "mock_class_UserAuthorization",
     "mock_class_AgenticUserAuthorization",
     "mock_class_Authorization",
diff --git a/tests/_common/testing_objects/adapters/__init__.py b/tests/_common/testing_objects/adapters/__init__.py
@@ -1,3 +1,3 @@
-from .testing_adapter import TestingAdapter
+from .mock_testing_adapter import MockTestingAdapter
 
-__all__ = ["TestingAdapter"]
+__all__ = ["MockTestingAdapter"]
diff --git a/tests/_common/testing_objects/adapters/mock_testing_adapter.py b/tests/_common/testing_objects/adapters/mock_testing_adapter.py
@@ -27,7 +27,7 @@
 AgentCallbackHandler = Callable[[TurnContext], Awaitable]
 
 
-class TestingAdapter(ChannelAdapter):
+class MockTestingAdapter(ChannelAdapter):
     """
     A mock adapter that can be used for unit testing of agent logic.
     """
diff --git a/tests/_common/testing_objects/mock_testing_custom_state.py b/tests/_common/testing_objects/mock_testing_custom_state.py
@@ -1,7 +1,7 @@
 from microsoft_agents.hosting.core import AgentState, Storage, StoreItem, TurnContext
 
 
-class TestingCustomState(AgentState):
+class MockTestingCustomState(AgentState):
     """Custom state implementation for testing."""
 
     def __init__(self, storage: Storage, namespace: str = ""):
diff --git a/tests/_common/testing_objects/mocks/mock_oauth_flow.py b/tests/_common/testing_objects/mocks/mock_oauth_flow.py
@@ -1,9 +1,9 @@
 from microsoft_agents.activity import TokenResponse
 from microsoft_agents.hosting.core._oauth import _OAuthFlow
 
-from tests._common.data import TEST_DEFAULTS
+from tests._common.data import DEFAULT_TEST_VALUES
 
-DEFAULTS = TEST_DEFAULTS()
+DEFAULTS = DEFAULT_TEST_VALUES()
 
 
 def mock_OAuthFlow(
diff --git a/tests/_integration/common/testing_environment.py b/tests/_integration/common/testing_environment.py
@@ -14,7 +14,7 @@
 
 from tests._common.testing_objects import (
     TestingConnectionManager,
-    TestingAdapter,
+    MockTestingAdapter,
 )
 
 
@@ -62,7 +62,7 @@ def __init__(self, mocker):
 
         self.storage = MemoryStorage()
         self.connection_manager = TestingConnectionManager()
-        self.adapter = TestingAdapter()
+        self.adapter = MockTestingAdapter()
         self.authorization = Authorization(
             self.storage, self.connection_manager, **agents_sdk_config
         )
diff --git a/tests/activity/test_activity.py b/tests/activity/test_activity.py
@@ -22,9 +22,9 @@
 
 from tests.activity._common.my_channel_data import MyChannelData
 from tests.activity._common.testing_activity import create_test_activity
-from tests._common.data import TEST_DEFAULTS
+from tests._common.data import DEFAULT_TEST_VALUES
 
-DEFAULTS = TEST_DEFAULTS()
+DEFAULTS = DEFAULT_TEST_VALUES()
 
 
 def helper_validate_recipient_and_from(
@@ -416,7 +416,6 @@ def test_get_product_info_entity_single(self, entities, expected):
 
 
 class TestActivityAgenticOps:
-
     @pytest.fixture(params=[RoleTypes.user, RoleTypes.skill, RoleTypes.agent])
     def non_agentic_role(self, request):
         return request.param
diff --git a/tests/activity/test_channel_id.py b/tests/activity/test_channel_id.py
@@ -2,13 +2,12 @@
 
 from microsoft_agents.activity import ChannelId
 
-from tests._common.data import TEST_DEFAULTS
+from tests._common.data import DEFAULT_TEST_VALUES
 
-DEFAULTS = TEST_DEFAULTS()
+DEFAULTS = DEFAULT_TEST_VALUES()
 
 
 class TestChannelId:
-
     def test_init_from_str(self):
         channel_id = ChannelId("email:support")
         assert channel_id.channel == "email"
diff --git a/tests/activity/test_load_configuration.py b/tests/activity/test_load_configuration.py
@@ -1,9 +1,9 @@
 from microsoft_agents.activity import load_configuration_from_env
 
 from tests._common import create_env_var_dict
-from tests._common.data import TEST_DEFAULTS
+from tests._common.data import DEFAULT_TEST_VALUES
 
-DEFAULTS = TEST_DEFAULTS()
+DEFAULTS = DEFAULT_TEST_VALUES()
 
 ENV_DICT = {
     "CONNECTIONS": {
diff --git a/tests/hosting_core/_oauth/test_flow_storage_client.py b/tests/hosting_core/_oauth/test_flow_storage_client.py
diff --git a/tests/hosting_core/_oauth/test_oauth_flow.py b/tests/hosting_core/_oauth/test_oauth_flow.py
diff --git a/tests/hosting_core/app/_oauth/_common.py b/tests/hosting_core/app/_oauth/_common.py
diff --git a/tests/hosting_core/app/_oauth/_env.py b/tests/hosting_core/app/_oauth/_env.py
diff --git a/tests/hosting_core/app/_oauth/_handlers/test_agentic_user_authorization.py b/tests/hosting_core/app/_oauth/_handlers/test_agentic_user_authorization.py
diff --git a/tests/hosting_core/app/_oauth/_handlers/test_user_authorization.py b/tests/hosting_core/app/_oauth/_handlers/test_user_authorization.py
diff --git a/tests/hosting_core/app/_oauth/test_auth_handler.py b/tests/hosting_core/app/_oauth/test_auth_handler.py
diff --git a/tests/hosting_core/app/_oauth/test_authorization.py b/tests/hosting_core/app/_oauth/test_authorization.py
diff --git a/tests/hosting_core/state/test_agent_state.py b/tests/hosting_core/state/test_agent_state.py
diff --git a/tests/hosting_core/storage/test_transcript_logger_middleware.py b/tests/hosting_core/storage/test_transcript_logger_middleware.py
diff --git a/tests/hosting_core/test_turn_context.py b/tests/hosting_core/test_turn_context.py

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ def create_test_auth_handler(`
`29`	`29`	`)`
`30`	`30`
`31`	`31`
`32`		`-class TEST_AUTH_DATA:`
	`32`	`+class AUTH_TEST_DATA:`
`33`	`33`	`def __init__(self):`
`34`	`34`
`35`	`35`	`self.auth_handler: AuthHandler = create_test_auth_handler("graph")`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`)`
`7`	`7`
`8`	`8`
`9`		`-class TEST_DEFAULTS:`
	`9`	`+class DEFAULT_TEST_VALUES:`
`10`	`10`	`def __init__(self):`
`11`	`11`
`12`	`12`	`self.token = "__token"`