tox offers some very nice features that we rely upon heavily for our CI and local testing:
- Bug-Free parallel invocation of tox environments within CI
- Central, easily-understood config format that enables devs to easily add new environments for various tasks.
But that's about all of the features that we utilize at this time. The actual sets of commands being invoked are transferrable to another format. This issue will serve as the index for this effort. We will utilize uv for package management in this new world, but otherwise will not take an external dependency for the invocation framework.
Expected outcome experience
We have a fully documented and implemented check system that interacts properly with CI and local invocations.
A check invoked for a specific package:
/path/to/azure-sdk-for-python> uv pip install eng/tools/azure-sdk-tools
/path/to/azure-sdk-for-python> cd sdk/core/azure-core
/path/to/azure-sdk-for-python/sdk/core/azure-core> azpysdk sphinx
...<invoke equivalent of sphinx environment>
A check invoked for multiple packages:
/path/to/azure-sdk-for-python> uv pip install eng/tools/azure-sdk-tools
/path/to/azure-sdk-for-python> azsdk sphinx azure-storage*
...<invoke equivalent of sphinx environment on multiple packages below cwd matching glob>
Tasks
(In rough order of operations)
toxoffers some very nice features that we rely upon heavily for our CI and local testing:But that's about all of the features that we utilize at this time. The actual sets of commands being invoked are transferrable to another format. This issue will serve as the index for this effort. We will utilize
uvfor package management in this new world, but otherwise will not take an external dependency for the invocation framework.Expected outcome experience
We have a fully documented and implemented check system that interacts properly with CI and local invocations.
A check invoked for a specific package:
A check invoked for multiple packages:
Tasks
(In rough order of operations)
azpysdkentrypointscbeddcompleted an original prototype of usinguv-script(Prototypeuvscripttoxreplacement #41775), but we have decided not to take that dependency at this time. We are clear to utilizeuvto install packages however.uv, so we can only use it for package-management at this time.uv-scriptis out, we need to devise our own entrypoint.venvusage in pipeline #42486 updated our core pipelines to utilizeuvwhile installing requirements before invoking CI. We can fallback topipat any time.dispatch_tox. Likely name thisdispatch_check. It should be the entrypoint for anycheckthat CI utilizes. It should support all required arguments + requirement replacement that CI currently does.mypycheck in CI #42831pip install requirementduplication present across template calls withinanalyze.yml.mypycheck in CI #42831toxchecks to new script methodology each of these should have the actual. All new checks should utilize theloggerfromci_tools.logging. An example migration will be shown in Bug :azure-ai-projects==1.2.0b1 will pointing to azure-ai-agents==1.1.0 latest version which is causing the Cannot import name "RequiredMcpToolCall" from "azure.ai.agents.models" #42381tox_helper_tasks.pyinstall_dev_build_dependencyscriptsdk_verify_keywordsentrypoint in azure-sdk-tools is removedgenerate_client.pyscript in azure-sdk-tools is removed, as well as a few entrypointssample_guide.md)test_run_samples.pyrun_optional.pytestpublishing after each environment is updated. Ensure we don't lose testResults.xml outputs.dispatch_tox.pyare supported bydispatch_checks.py. Identify any necessary missing support for test execution.nightly alphaversioning still works after the change of all test envsazsdkclipython language service to call into the new check stylecopilot-instructionsthat reflect usage methodology for the new checks, venv utilization, requirements installation, etc.