code clean up and added readme #44525
Open
+565
−372
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 test infrastructure by consolidating and organizing the sample executor code, extracting shared helper functions, and adding comprehensive documentation. The changes improve code maintainability and provide clear guidance for writing sample tests.
Key Changes
- Consolidated
sample_executor_helpers.pyintosample_executor.pywith better organization of sync and async executors - Extracted shared constants and helper functions to
test_samples_helpers.pyfor better reusability - Added comprehensive README.md with examples and documentation for the sample test framework
- Refactored validation to use explicit
validate_print_calls_by_llmmethod calls with configurable instructions
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/ai/azure-ai-projects/tests/test_base.py | Added originalServicePreparer configuration (appears unused) |
| sdk/ai/azure-ai-projects/tests/samples/test_samples_helpers.py | New file containing shared agent_tools_instructions constant and get_sample_environment_variables_map helper function |
| sdk/ai/azure-ai-projects/tests/samples/test_samples_async.py | Updated imports to use new module structure and added explicit LLM validation call |
| sdk/ai/azure-ai-projects/tests/samples/test_samples.py | Updated imports to use new module structure, removed unused is_async parameter, and added explicit LLM validation call |
| sdk/ai/azure-ai-projects/tests/samples/sample_executor_helpers.py | File deleted - code moved to sample_executor.py and test_samples_helpers.py |
| sdk/ai/azure-ai-projects/tests/samples/sample_executor.py | New consolidated file with improved structure, overloaded functions for better type hints, and separated validation logic |
| sdk/ai/azure-ai-projects/tests/samples/README.md | New documentation file with detailed examples and guidance for writing sample tests |
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: