{Core} Add run_az_cmd for internal az-related cmd execution
#29899
Conversation
This file contains 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
AllyW
requested review from
jiasli,
evelyn-ys,
jsntcy,
kairu-ms,
zhoxing-ms,
calvinhzy,
necusjz and
bebound
as code owners
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
|
Core |
microsoft-github-policy-service
bot
added
Auto-Assign
jiasli
reviewed
Sep 12, 2024
Comment on lines
1377
to
1381
| Args: | ||
| args: cmd to be executed, array of string, like `["az", "--version"]` | ||
| out_file: The file to send output to. file-like object | ||
| Returns: | ||
| result: cmd execution result object, containing `result`, `error`, `exit_code` |
There was a problem hiding this comment.
It's better to use the :param convention.
jiasli
reviewed
Sep 12, 2024
Comment on lines
1386
to
1388
| if args[0] != "az": | ||
| raise ArgumentUsageError('Invalid cmd. run_az_cmd must be used to run `az` related cmds, ' | ||
| 'like ["az", "--version"]') |
There was a problem hiding this comment.
I think we can allow passing the command args without az, such as ['version'].
This is the case for calling self.cmd within ScenarioTest.
AllyW
commented
Sep 13, 2024
| from azure.cli.core import get_default_cli | ||
| cli = get_default_cli() | ||
| cli.invoke(args, out_file=out_file) | ||
| return cli.result |
There was a problem hiding this comment.
If exception raised during cli.invoke, then no result can be fetched by caller but the exception itself.
jsntcy
reviewed
Sep 14, 2024
| from azure.cli.core.azclierror import ArgumentUsageError | ||
| if not isinstance(args, list): | ||
| raise ArgumentUsageError("Invalid args. run_az_cmd args must be a list") | ||
| if args[0] == "az": |
There was a problem hiding this comment.
If args[0] != "az", what will happen? Should it raise error or return immediately with warning instead of continuing to call cli.invoke?
There was a problem hiding this comment.
act as @jiasli suggested, support az version and version as self.cmd does in our ScenarioTest. Related code as below:
if command.startswith('az '):
command = command[3:]
AllyW
force-pushed
the
add-run-az-cmd
branch
from
e7354b5
to
f9bffc8
Compare
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.
Related command
Description
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.