Quality improvements for az aks extension and az aks extension type command groups #8794

sophsoph321 · 2025-05-27T15:08:14Z

This PR contains the following improvements for the az aks extension and az aks extension type command groups:

Error message for az aks extension create command when the extension type is not in the allowed list of core extensions has been generalized to fit various scenarios
Adds filter for az aks extension show command to check whether the core extension is in the allowed list of core extensions
For the az aks extension type command group, we return a validation error if the user didn't specify a location, or any cluster details (i.e. resource group name and cluster name)

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

[x ] Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
[ x] Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
My extension version conforms to the Extension version schema

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

…into sophiezhao/coreExtensions

azure-client-tools-bot-prd · 2025-05-27T15:08:19Z

️✔️Azure CLI Extensions Breaking Change Test

️✔️Non Breaking Changes

yonzhan · 2025-05-27T15:08:30Z

Thank you for your contribution! We will review the pull request and get back to you soon.

github-actions · 2025-05-27T15:08:31Z

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

Copilot

Pull Request Overview

This PR aims to enhance the quality of the az aks extension and az aks extension type command groups by refining error messages, strengthening input validation, and ensuring consistency in help text terminology.

Improved error messaging for extension type validation in the create command.
Introduced a new helper to filter extensions against the allowed list and applied an updated validator for location/cluster parameters.
Updated help texts and release history to align with the new "Cluster Extension" terminology.

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/aks-preview/setup.py	Version bump from 18.0.0b3 to 18.0.0b4.
src/aks-preview/azext_aks_preview/custom.py	Updated show command to use the new helper for allowed list filtering.
src/aks-preview/azext_aks_preview/_validators.py	Added a new validator (validate_location_cluster_parameters_present) for location/cluster checks.
src/aks-preview/azext_aks_preview/_params.py	Updated argument validators to use the new location/cluster validator.
src/aks-preview/azext_aks_preview/_helpers.py	Improved the error message for validation failure and introduced get_extension_in_allow_list.
src/aks-preview/azext_aks_preview/_help.py	Updated help texts to replace "K8s Extension" with "Cluster Extension" consistently.
src/aks-preview/HISTORY.rst	Updated the release history with the new version number and release notes.

Comments suppressed due to low confidence (1)

src/aks-preview/azext_aks_preview/_helpers.py:446

[nitpick] The function name get_extension_in_allow_list may be ambiguous since it returns None when the extension type is not allowed. Consider renaming it to filter_extension_in_allow_list to more clearly convey its behavior.

def get_extension_in_allow_list(result):

Copilot · 2025-05-27T15:08:42Z

src/aks-preview/azext_aks_preview/_helpers.py

@@ -442,3 +442,8 @@ def get_all_extensions_in_allow_list(result):
        if _check_if_extension_type_is_in_allow_list(obj.extension_type.lower()):
            output.append(obj)
    return output
+
+def get_extension_in_allow_list(result):


Review whether returning None when the extension does not pass the allowed list check is the best approach for error handling. Consider if raising a ValidationError might provide clearer feedback in the command workflow.

github-actions · 2025-05-27T15:11:58Z

For more info about extension versioning, please refer to Extension version schema

matthchr

Looks good to me. I had a few minor comments and one outstanding question for Fuming, as I think the required changes to the recordings don't look quite right to me (or rather they look right but I assume Fuming has another PR where he's already dealing with them?)

matthchr · 2025-05-27T23:29:12Z

...-preview/azext_aks_preview/tests/latest/recordings/test_aks_addon_disable_confcom_addon.yaml

@@ -60,7 +60,7 @@ interactions:
      User-Agent:
      - AZURECLI/2.53.0 azsdk-python-azure-mgmt-resource/23.1.0b2 Python/3.8.10 (Linux-5.15.0-1051-azure-x86_64-with-glibc2.29)
    method: GET
-    uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/clitest000001?api-version=2022-09-01
+    uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/clitest000001?api-version=2024-11-01


@FumingZhang - Do you understand why these changes were required?

Do you have an outstanding PR to tackle these that Sophie could rebase onto?

yep, I've applied fix for failed test cases in PR #8798

please rebase from main to drop unrelated changes

src/aks-preview/azext_aks_preview/_validators.py

src/aks-preview/azext_aks_preview/_params.py

FumingZhang · 2025-05-28T06:09:48Z

src/aks-preview/azext_aks_preview/tests/latest/test_aks_commands.py

@@ -16176,4 +16176,4 @@ def test_aks_loadbalancer_commands(
    #     self.cmd(


please remove self.cmd('extension add -n k8s-extension') from the init function.

Also, for cases where you need to install an extension, I recommend marking them as @live_only() and you can remove the corresponding recording file

…into sophiezhao/coreExtensions

matthchr

I think the _backup.yaml files aren't intentionally added?

matthchr · 2025-05-28T23:42:36Z

src/aks-preview/azext_aks_preview/_validators.py

+        )
+
+    """Validates that location, cluster name, and resource group name are not specified at the same time"""
+    if location and resource_group_name and cluster_name:


Suggested change

if location and resource_group_name and cluster_name:

if location and (resource_group_name or cluster_name):

So you reject --location + --cluster-name too, which shouldn't be allowed.

Sophie Zhao added 30 commits March 25, 2021 14:58

add troubleshoot command under connectedk8s

172bf90

resolve check issues

29a8518

fix final new line

fe3c1e8

add back troubleshoot params

be0e8cd

implement helm version and permission checks

18059a8

Merge branch 'main' of https://github.com/Azure/azure-cli-extensions

9db15cd

add aks extension and aks extension type cli groups

a275367

fix pylint

380c7c3

POC for extensions

42b425d

fix formatting

06ab07a

add test and revert connectedk8s changes

06fb262

remove newline from readme

3a44615

fix linter issue

d4433e2

fix faulty examples

448b729

fix linting issues

8983efb

fix parse issue

301dd4d

fix

220480b

fix help.py

b7c8add

fix more pylint issues

761f13c

fix params

e0f3ffa

fix parameter issue

a8ceaf5

fix the over indent

ec96375

fix pylint issue

e5d3cba

resolve pylinter issue

b423474

remove location

10d82a6

remove location

5fd78fe

add extension type

2dd53e8

remove unrecognized parameter

32faf3c

add comma

7fb0a9d

fix invalid naming convensitons

7955f81

sophie zhao added 3 commits May 27, 2025 11:01

update cassette files

cc24709

update history.rst

ac382c1

Merge branch 'main' of https://github.com/Azure/azure-cli-extensions …

e0ec999

…into sophiezhao/coreExtensions

Copilot AI review requested due to automatic review settings May 27, 2025 15:08

sophsoph321 requested review from andyliuliming and FumingZhang as code owners May 27, 2025 15:08

azure-client-tools-bot-prd bot added this to the July 2025 (2025-07-01) milestone May 27, 2025

microsoft-github-policy-service bot requested review from zhoxing-ms, yanzhudd and yonzhan May 27, 2025 15:08

Copilot AI reviewed May 27, 2025

View reviewed changes

microsoft-github-policy-service bot assigned yanzhudd and zhoxing-ms May 27, 2025

microsoft-github-policy-service bot added Auto-Assign Auto assign by bot AKS labels May 27, 2025

sophie zhao added 3 commits May 27, 2025 11:24

fix style issue in helpers.py

f1fcb94

change api version

684ffdb

update casset files with correct API verisons

b8d948d

matthchr reviewed May 27, 2025

View reviewed changes

FumingZhang reviewed May 28, 2025

View reviewed changes

sophie zhao added 4 commits May 28, 2025 17:18

address PR comments

7809d7f

Merge branch 'main' of https://github.com/Azure/azure-cli-extensions …

46960bc

…into sophiezhao/coreExtensions

update setup.py

a096efb

remove extra test files

1b86b35

matthchr reviewed May 28, 2025

View reviewed changes

update casette files

eed5017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Quality improvements for az aks extension and az aks extension type command groups #8794

Quality improvements for az aks extension and az aks extension type command groups #8794

Uh oh!

sophsoph321 commented May 27, 2025

Uh oh!

azure-client-tools-bot-prd bot commented May 27, 2025 •

edited

Loading

Uh oh!

yonzhan commented May 27, 2025

Uh oh!

github-actions bot commented May 27, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 27, 2025

Uh oh!

github-actions bot commented May 27, 2025

Uh oh!

matthchr left a comment

Uh oh!

matthchr May 27, 2025

Uh oh!

FumingZhang May 28, 2025

Uh oh!

FumingZhang May 28, 2025

Uh oh!

Uh oh!

Uh oh!

FumingZhang May 28, 2025

Uh oh!

FumingZhang May 29, 2025

Uh oh!

matthchr left a comment

Uh oh!

matthchr May 28, 2025

Uh oh!

Uh oh!

		@@ -16176,4 +16176,4 @@ def test_aks_loadbalancer_commands(
		# self.cmd(

	if location and resource_group_name and cluster_name:
	if location and (resource_group_name or cluster_name):

Quality improvements for az aks extension and az aks extension type command groups #8794

Are you sure you want to change the base?

Quality improvements for az aks extension and az aks extension type command groups #8794

Uh oh!

Conversation

sophsoph321 commented May 27, 2025

Related command

General Guidelines

About Extension Publish

Uh oh!

azure-client-tools-bot-prd bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yonzhan commented May 27, 2025

Uh oh!

github-actions bot commented May 27, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 27, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 27, 2025

Uh oh!

matthchr left a comment

Choose a reason for hiding this comment

Uh oh!

matthchr May 27, 2025

Choose a reason for hiding this comment

Uh oh!

FumingZhang May 28, 2025

Choose a reason for hiding this comment

Uh oh!

FumingZhang May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

FumingZhang May 28, 2025

Choose a reason for hiding this comment

Uh oh!

FumingZhang May 29, 2025

Choose a reason for hiding this comment

Uh oh!

matthchr left a comment

Choose a reason for hiding this comment

Uh oh!

matthchr May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

azure-client-tools-bot-prd bot commented May 27, 2025 •

edited

Loading