Test and sample recording #44539
Merged
Test and sample recording #44539
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
howieleung
requested review from
dargilco,
glharper,
kingernupur,
nick863,
trangevi and
trrwilson
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the sample testing infrastructure for the Azure AI Projects SDK. The main goal is to consolidate, simplify, and improve the framework for running and validating SDK samples as automated tests with recording/playback support.
Key Changes
- Consolidated sample executor logic into a single
sample_executor.pymodule (replacingsample_executor_helpers.py) - Introduced new features including
additionalSampleTestsdecorator for testing samples with optional environment variables - Separated shared constants and helpers into
test_samples_helpers.pyfor better modularity - Added comprehensive documentation in a new README.md explaining the testing framework
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/ai/azure-ai-projects/tests/samples/sample_executor.py | New consolidated module containing all sample executor classes (SyncSampleExecutor, AsyncSampleExecutor), sample path discovery functions, and the additionalSampleTests decorator for parametrized test variants |
| sdk/ai/azure-ai-projects/tests/samples/test_samples_helpers.py | New helper module extracting shared constants (agent_tools_instructions) and utility functions (get_sample_environment_variables_map) |
| sdk/ai/azure-ai-projects/tests/samples/test_samples.py | Updated to import from new modules, added usage of additionalSampleTests decorator, and separated validation from execution |
| sdk/ai/azure-ai-projects/tests/samples/test_samples_async.py | Updated to import from new modules and use the refactored async executor with separated validation |
| sdk/ai/azure-ai-projects/tests/samples/sample_executor_helpers.py | Deleted file - functionality moved to sample_executor.py and test_samples_helpers.py |
| sdk/ai/azure-ai-projects/tests/samples/README.md | New comprehensive documentation explaining the sample testing framework, with sync/async examples and usage patterns |
| sdk/ai/azure-ai-projects/assets.json | Updated recording assets tag to reflect new test recordings |
howieleung
force-pushed
the
howie/sample-recording-9
branch
from
6dd77eb to
0d03d51
Compare
- Changed environment variable names in test files to use a consistent naming convention, replacing "azure_ai_projects_tests_" prefix with a simplified version. - Updated references in test cases to reflect the new environment variable names for model deployments, project endpoints, and connection IDs. - Modified the sample executor to handle environment variable mapping more flexibly. - Ensured all tests are aligned with the new naming conventions for better clarity and maintainability.
howieleung
force-pushed
the
howie/sample-recording-9
branch
from
0d03d51 to
20deee8
Compare
dargilco
reviewed
Jan 5, 2026
dargilco
reviewed
Jan 5, 2026
dargilco
reviewed
Jan 5, 2026
dargilco
reviewed
Jan 5, 2026
dargilco
reviewed
Jan 5, 2026
dargilco
reviewed
Jan 5, 2026
dargilco
reviewed
Jan 5, 2026
Member
|
Since we have .env.template, do we now also need .env.test.template? |
dargilco
approved these changes
Jan 5, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refractor code for Python SDK team to move sample test feature to dev tools including:
New stuff: