[containerapp] Add new commands for httprouteconfig #8302

Tratcher · 2024-11-21T20:43:58Z

This adds list/create/update/show/delete commands for the new httprouteconfig feature area. For now create/update uses YAML input because the object model is quite complex. We may add more granular input in the future.

Related command

az containerapp env httprouteconfig

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
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

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.

azure-client-tools-bot-prd · 2024-11-21T20:44:01Z

Validation for Breaking Change Starting...

Thanks for your contribution!

azure-client-tools-bot-prd · 2024-11-21T20:44:04Z

Hi @Tratcher,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

yonzhan · 2024-11-21T20:44:13Z

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

github-actions · 2024-11-21T20:44:58Z

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

github-actions · 2024-11-21T20:47:53Z

Hi @Tratcher

Release Suggestions

Module: containerapp

Update VERSION to 1.1.0b2 in src/containerapp/setup.py

Notes

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

tdaroly · 2024-11-21T22:05:00Z

Can you add a test?

This was for maintenance config which was also env level resource similar to httpRouteConfig. Can we do something similar?
env create:

azure-cli-extensions/src/containerapp/azext_containerapp/tests/latest/test_containerapp_maintenance_config.py

Line 30 in 207cad1

    
           self.cmd('containerapp env create -g {} -n {} --location {}  --logs-destination none --enable-workload-profiles'.format(resource_group, env_name, TEST_LOCATION))

list:

azure-cli-extensions/src/containerapp/azext_containerapp/tests/latest/test_containerapp_maintenance_config.py

Line 45 in 207cad1

    
           self.cmd("az containerapp env maintenance-config list --resource-group {} --environment {}".format(resource_group, env_name), checks=[

update:

azure-cli-extensions/src/containerapp/azext_containerapp/tests/latest/test_containerapp_maintenance_config.py

Line 55 in 207cad1

    
           self.cmd("az containerapp env maintenance-config update --resource-group {} --environment {} -d {} -w {}".format(resource_group, env_name, updatedDuration, updatedWeekday), checks=[

delete:

azure-cli-extensions/src/containerapp/azext_containerapp/tests/latest/test_containerapp_maintenance_config.py

Line 69 in 207cad1

    
           self.cmd("az containerapp env maintenance-config remove --resource-group {} --environment {} -y".format(resource_group, env_name))

src/containerapp/HISTORY.rst

Juliehzl · 2024-11-25T01:42:40Z

src/containerapp/azext_containerapp/commands.py

@@ -37,6 +37,13 @@ def load_command_table(self, args):
        g.custom_command('delete', 'delete_managed_environment', supports_no_wait=True, confirmation=True, exception_handler=ex_handler_factory())
        g.custom_command('update', 'update_managed_environment', supports_no_wait=True, exception_handler=ex_handler_factory())

+    with self.command_group('containerapp env httprouteconfig') as g:


Suggested change

with self.command_group('containerapp env httprouteconfig') as g:

with self.command_group('containerapp env http-route-config') as g:

Suggested change

with self.command_group('containerapp env httprouteconfig') as g:

with self.command_group('containerapp env httprouteconfig') as g:

Juliehzl · 2024-11-25T01:43:24Z

src/containerapp/azext_containerapp/commands.py

@@ -37,6 +37,13 @@ def load_command_table(self, args):
        g.custom_command('delete', 'delete_managed_environment', supports_no_wait=True, confirmation=True, exception_handler=ex_handler_factory())
        g.custom_command('update', 'update_managed_environment', supports_no_wait=True, exception_handler=ex_handler_factory())

+    with self.command_group('containerapp env httprouteconfig') as g:


Suggested change

with self.command_group('containerapp env httprouteconfig') as g:

with self.command_group('containerapp env httprouteconfig', is_preview=True) as g:

For new commands, we always recommend to support in preview mode first

Juliehzl · 2024-11-25T01:46:43Z

src/containerapp/azext_containerapp/custom.py

@@ -3322,3 +3322,43 @@ def list_maintenance_config(cmd, resource_group_name, env_name):
    )
    r = maintenance_config_decorator.list()
    return r
+
+
+def update_httprouteconfig(cmd, resource_group_name, name, httprouteconfig_name, yaml):


Please add help description for your command parameters according to https://github.com/Azure/azure-cli/blob/main/doc/authoring_command_modules/authoring_commands.md#customize-arguments

Juliehzl · 2024-11-25T01:48:10Z

src/containerapp/azext_containerapp/tests/latest/test_containerapp_env_httprouteconfig.py

+            JMESPathCheck('properties.rules[0].targets[0].containerApp', "app1"),
+        ])
+
+        self.cmd("az containerapp env httprouteconfig show -g {} -n {} --httprouteconfig-name {}".format(resource_group, env_name, route_name), checks=[


add short name for --httproutconfig-name for better user experience according to https://github.com/Azure/azure-cli/blob/main/doc/authoring_command_modules/authoring_commands.md#customize-arguments

Greedygre · 2024-11-25T06:53:56Z

src/containerapp/azext_containerapp/_clients.py

+    @classmethod
+    def update_httprouteconfig(cls, cmd, resource_group_name, name, httprouteconfig_name, httprouteconfig_envelope):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/managedEnvironments/{}/httpRouteConfigs/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            httprouteconfig_name,
+            cls.api_version)
+
+        r = send_raw_request(cmd.cli_ctx, "PUT", request_url, body=json.dumps(httprouteconfig_envelope))
+        return r.json()
+
+    @classmethod
+    def list_httprouteconfigs(cls, cmd, resource_group_name, name, formatter=lambda x: x):
+        route_list = []
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/managedEnvironments/{}/httpRouteConfigs?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            cls.api_version)
+
+        r = send_raw_request(cmd.cli_ctx, "GET", request_url, body=None)
+        j = r.json()
+        for route in j["value"]:
+            formatted = formatter(route)
+            route_list.append(formatted)
+        return route_list
+
+    @classmethod
+    def show_httprouteconfig(cls, cmd, resource_group_name, name, httprouteconfig_name):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/managedEnvironments/{}/httpRouteConfigs/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            httprouteconfig_name,
+            cls.api_version)
+
+        r = send_raw_request(cmd.cli_ctx, "GET", request_url, body=None)
+        return r.json()
+
+    @classmethod
+    def delete_httprouteconfig(cls, cmd, resource_group_name, name, httprouteconfig_name):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/managedEnvironments/{}/httpRouteConfigs/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            httprouteconfig_name,
+            cls.api_version)
+
+        send_raw_request(cmd.cli_ctx, "DELETE", request_url, body=None)
+        # API doesn't return JSON (it returns no content)
+        return
+


Recommend using a separate Client for /httpRouteConfigs, you can refer class StorageClient()

Greedygre · 2024-11-25T06:55:29Z

src/containerapp/azext_containerapp/_clients.py

+
+        r = send_raw_request(cmd.cli_ctx, "GET", request_url, body=None)
+        j = r.json()
+        for route in j["value"]:


It may throw None Error if j["value"] is None.

Greedygre · 2024-11-25T06:59:15Z

src/containerapp/azext_containerapp/_clients.py

+        return r.json()
+
+    @classmethod
+    def delete_httprouteconfig(cls, cmd, resource_group_name, name, httprouteconfig_name):


Suggested change

def delete_httprouteconfig(cls, cmd, resource_group_name, name, httprouteconfig_name):

def delete(cls, cmd, resource_group_name, name, httprouteconfig_name):

Greedygre · 2024-11-25T07:00:17Z

src/containerapp/azext_containerapp/_clients.py

+        return r.json()
+
+    @classmethod
+    def list_httprouteconfigs(cls, cmd, resource_group_name, name, formatter=lambda x: x):


Suggested change

def list_httprouteconfigs(cls, cmd, resource_group_name, name, formatter=lambda x: x):

def list(cls, cmd, resource_group_name, name, formatter=lambda x: x):

Greedygre · 2024-11-25T07:02:03Z

src/containerapp/HISTORY.rst

@@ -4,6 +4,7 @@ Release History
 ===============
 upcoming
 ++++++
+* 'az containerapp env httprouteconfig' Add comands for the httprouteconfig feature area.


Suggested change

* 'az containerapp env httprouteconfig' Add comands for the httprouteconfig feature area.

* 'az containerapp env httprouteconfig': Add comands for the httprouteconfig feature area.

Greedygre · 2024-11-25T07:09:15Z

src/containerapp/azext_containerapp/_clients.py

+        return r.json()
+
+    @classmethod
+    def list_httprouteconfigs(cls, cmd, resource_group_name, name, formatter=lambda x: x):


Why you need the formatter here? Seems lambda x: x do nothing.

Tratcher added 2 commits November 21, 2024 20:22

CRUD for httprouteconfig

e584762

Update history

0f9e81d

microsoft-github-policy-service bot requested review from yonzhan, wangzelin007, yanzhudd, zhoxing-ms, jsntcy, ruslany, sanchitmehta, ebencarek, JennyLawrance, howang-ms, vinisoto, chinadragon0515, vturecek, torosent, pagariyaalok, Juliehzl, jijohn14 and Greedygre November 21, 2024 20:44

microsoft-github-policy-service bot added the Auto-Assign Auto assign by bot label Nov 21, 2024

microsoft-github-policy-service bot assigned zhoxing-ms Nov 21, 2024

microsoft-github-policy-service bot added the ContainerApp label Nov 21, 2024

yonzhan added this to the Backlog milestone Nov 22, 2024

Add test

a6c31ac

tdaroly approved these changes Nov 22, 2024

View reviewed changes

Version bump, test replay

4e75421

Greedygre reviewed Nov 22, 2024

View reviewed changes

src/containerapp/HISTORY.rst Outdated Show resolved Hide resolved

Revert version change

35cd411

Tratcher requested a review from Greedygre November 22, 2024 23:28

Juliehzl reviewed Nov 25, 2024

View reviewed changes

Greedygre reviewed Nov 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[containerapp] Add new commands for httprouteconfig #8302

[containerapp] Add new commands for httprouteconfig #8302

Tratcher commented Nov 21, 2024

azure-client-tools-bot-prd bot commented Nov 21, 2024

azure-client-tools-bot-prd bot commented Nov 21, 2024

yonzhan commented Nov 21, 2024

github-actions bot commented Nov 21, 2024

github-actions bot commented Nov 21, 2024 •

edited

Loading

tdaroly commented Nov 21, 2024 •

edited

Loading

Juliehzl Nov 25, 2024

Juliehzl Nov 25, 2024

Juliehzl Nov 25, 2024

Juliehzl Nov 25, 2024

Juliehzl Nov 25, 2024

Greedygre Nov 25, 2024 •

edited

Loading

Greedygre Nov 25, 2024

Greedygre Nov 25, 2024 •

edited

Loading

Greedygre Nov 25, 2024

Greedygre Nov 25, 2024

Greedygre Nov 25, 2024

	with self.command_group('containerapp env httprouteconfig') as g:
	with self.command_group('containerapp env http-route-config') as g:

	def delete_httprouteconfig(cls, cmd, resource_group_name, name, httprouteconfig_name):
	def delete(cls, cmd, resource_group_name, name, httprouteconfig_name):

	def list_httprouteconfigs(cls, cmd, resource_group_name, name, formatter=lambda x: x):
	def list(cls, cmd, resource_group_name, name, formatter=lambda x: x):

	* 'az containerapp env httprouteconfig' Add comands for the httprouteconfig feature area.
	* 'az containerapp env httprouteconfig': Add comands for the httprouteconfig feature area.

[containerapp] Add new commands for httprouteconfig #8302

Are you sure you want to change the base?

[containerapp] Add new commands for httprouteconfig #8302

Conversation

Tratcher commented Nov 21, 2024

Related command

General Guidelines

About Extension Publish

azure-client-tools-bot-prd bot commented Nov 21, 2024

azure-client-tools-bot-prd bot commented Nov 21, 2024

yonzhan commented Nov 21, 2024

github-actions bot commented Nov 21, 2024

CodeGen Tools Feedback Collection

github-actions bot commented Nov 21, 2024 • edited Loading

Release Suggestions

Module: containerapp

Notes

tdaroly commented Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Greedygre Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Greedygre Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 21, 2024 •

edited

Loading

tdaroly commented Nov 21, 2024 •

edited

Loading

Greedygre Nov 25, 2024 •

edited

Loading

Greedygre Nov 25, 2024 •

edited

Loading