Add spring cloud gateway cli #8037

Descatles · 2024-09-29T10:28:53Z

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

Related command

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

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.

azure-client-tools-bot-prd · 2024-09-29T10:28:56Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️containerapp

rule cmd_name rule_message suggest_message

⚠️ 1011 - SubgroupAdd containerapp env java-component gateway-for-spring sub group containerapp env java-component gateway-for-spring added

⚠️ 1003 - CmdPropAdd containerapp env java-component nacos create cmd containerapp env java-component nacos create added property is_preview

⚠️ 1003 - CmdPropAdd containerapp env java-component nacos delete cmd containerapp env java-component nacos delete added property is_preview

⚠️ 1003 - CmdPropAdd containerapp env java-component nacos show cmd containerapp env java-component nacos show added property is_preview

⚠️ 1003 - CmdPropAdd containerapp env java-component nacos update cmd containerapp env java-component nacos update added property is_preview

azure-client-tools-bot-prd · 2024-09-29T10:28:59Z

Hi @Descatles,
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-09-29T13:17:56Z

containerapp

Greedygre · 2024-10-10T04:39:10Z

src/containerapp/azext_containerapp/_params.py

@@ -368,6 +368,7 @@ def load_arguments(self, _):
        c.argument('configuration', nargs="*", help="Java component configuration. Configuration must be in format \"<propertyName>=<value>\" \"<propertyName>=<value>\"...")
        c.argument('min_replicas', type=int, help="Minimum number of replicas to run for the Java component.")
        c.argument('max_replicas', type=int, help="Maximum number of replicas to run for the Java component.")
+        c.argument('route_yaml', options_list=['--route-yaml', '--yaml'], help="Path to a .yaml file with the configuration of a Spring Cloud Gateway route. For an example, see https://aka.ms/gateway-for-spring-routes-yaml")


I tried https://aka.ms/gateway-for-spring-routes-yaml
But seems it doesn't work.

The link will point to our SCG doc, we will release the doc after the cli released, and make the link available.

Greedygre · 2024-10-10T04:43:19Z

src/containerapp/azext_containerapp/commands.py

@@ -213,7 +213,7 @@ def load_command_table(self, args):
    with self.command_group('containerapp job replica', is_preview=True) as g:
        g.custom_show_command('list', 'list_replica_containerappsjob')

-    with self.command_group('containerapp env java-component nacos') as g:
+    with self.command_group('containerapp env java-component nacos', is_preview=True) as g:


Why update az containerapp env java-component nacos to preview?

The nacos should be in preview status, and the preview is removed from java component level, we need add the preview back to nacos level. Just add in this pr for convenience

Greedygre · 2024-10-10T04:46:14Z

src/containerapp/azext_containerapp/custom.py

@@ -2352,12 +2352,12 @@ def update_java_component(cmd, java_component_name, environment_name, resource_g
    return java_component_decorator.update()


-def create_config_server_for_spring(cmd, java_component_name, environment_name, resource_group_name, configuration=None, unbind_service_bindings=None, service_bindings=None, min_replicas=1, max_replicas=1, no_wait=False):
-    return create_java_component(cmd, java_component_name, environment_name, resource_group_name, JAVA_COMPONENT_CONFIG, configuration, service_bindings, unbind_service_bindings, min_replicas, max_replicas, no_wait)
+def create_config_server_for_spring(cmd, java_component_name, environment_name, resource_group_name, configuration=None, unbind_service_bindings=None, service_bindings=None, min_replicas=1, max_replicas=1, route_yaml=None, no_wait=False):


Why add route_yaml to not related commands?
You should not update them, right?

Same as update_config_server_for_spring, create_eureka_server_for_spring, update_eureka_server_for_spring, create_nacos, update_nacos, create_admin_for_spring, update_admin_for_spring

Yes, they are not used in commands except gateway. Thanks for teaching me the usage of params, I have removed them with better coding

Greedygre · 2024-10-10T04:53:32Z

src/containerapp/azext_containerapp/java_component_decorator.py

+            if self.get_argument_target_java_component_type() == JAVA_COMPONENT_GATEWAY:
+                raise CLIInternalError("Service binding is not supported by Gateway for Spring.")


remove this after refine the arguments

sure, removed.

Greedygre · 2024-10-10T04:53:47Z

src/containerapp/azext_containerapp/java_component_decorator.py

+        if self.get_argument_unbind_service_bindings() is not None:
+            if self.get_argument_target_java_component_type() == JAVA_COMPONENT_GATEWAY:
+                raise CLIInternalError("Service binding is not supported by Gateway for Spring.")


same as above

sure, removed.

Greedygre · 2024-10-10T04:54:33Z

src/containerapp/azext_containerapp/java_component_decorator.py

+            if self.get_argument_target_java_component_type() != JAVA_COMPONENT_GATEWAY:
+                raise CLIInternalError("The route could only be configured for Gateway for Spring.")


same as above

sure, removed.

Greedygre · 2024-10-10T06:08:57Z

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

+        route_yaml_text_create = f"""
+            springCloudGatewayRoutes:
+            - id: "route1"
+              uri: "https://otherjavacomponent.myenvironment.test.net"
+              predicates:
+              - "Path=/v1/path1"
+              - "After=2024-01-01T00:00:00.000-00:00[America/Denver]"
+              filters:
+              - "SetPath=/filter1"
+            - id: "route2"
+              uri: "https://otherjavacomponent.myenvironment.test.net"
+              predicates:
+              - "Path=/v2/path2"
+              - "After=2024-01-01T00:00:00.000-00:00[America/Denver]"
+              filters:
+              - "SetPath=/filter2"
+            """
+        route_yaml_name_create = f"{self._testMethodName}_route_create.yml"
+
+        write_test_file(route_yaml_name_create, route_yaml_text_create)
+        self.cmd("containerapp env java-component gateway-for-spring create -g {} -n {} --environment {} --route-yaml {}".format(resource_group, gateway_name, env_name, route_yaml_name_create), checks=[
+                JMESPathCheck('name', gateway_name),
+                JMESPathCheck('properties.componentType', "SpringCloudGateway"),
+                JMESPathCheck('properties.provisioningState', "Succeeded"),
+                JMESPathCheck('length(properties.springCloudGatewayRoutes)', 2),
+                JMESPathCheck('properties.scale.minReplicas', 1),
+                JMESPathCheck('properties.scale.maxReplicas', 1)
+        ])
+
+        # List Java Components
+        java_component_list = self.cmd("containerapp env java-component list -g {} --environment {}".format(resource_group, env_name)).get_output_in_json()
+        self.assertTrue(len(java_component_list) == 4)


Please create a new test, this test test_containerapp_java_component already include too many commands.

Okay, that make sense, I have put spring cloud gateway related test in new function

Greedygre · 2024-10-10T06:13:26Z

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

+                JMESPathCheck('name', gateway_name),
+                JMESPathCheck('properties.componentType', "SpringCloudGateway"),
+                JMESPathCheck('properties.provisioningState', "Succeeded"),
+                JMESPathCheck('length(properties.springCloudGatewayRoutes)', 2),


Please check more properties that you set, for example: url, predicates, filters

Sure, add check in create command

Greedygre · 2024-10-10T06:15:27Z

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

+        self.cmd("containerapp env java-component gateway-for-spring update -g {} -n {} --environment {}".format(resource_group, gateway_name, env_name, route_yaml_name_update), checks=[
+            JMESPathCheck('name', gateway_name),
+            JMESPathCheck('properties.componentType', "SpringCloudGateway"),
+            JMESPathCheck('properties.provisioningState', "Succeeded"),
+            JMESPathCheck('length(properties.springCloudGatewayRoutes)', 0),
+            JMESPathCheck('properties.scale.minReplicas', 1),
+            JMESPathCheck('properties.scale.maxReplicas', 1)
+        ])


If execute command containerapp env java-component gateway-for-spring update for a java-component that contains springCloudGatewayRoutes, what will happen?

Good point! added that kind of check

Greedygre · 2024-10-10T06:27:53Z

src/containerapp/azext_containerapp/java_component_decorator.py

+        # Check if the loaded YAML is a dictionary
+        if not isinstance(yaml_scg_routes, dict):
+            raise ValidationError('Invalid YAML provided. Please see https://aka.ms/gateway-for-spring-routes-yaml for a valid Gateway for Spring routes YAML spec.')
+
+        # Ensure that 'springCloudGatewayRoutes' is present and is a list (can be empty)
+        routes = yaml_scg_routes.get('springCloudGatewayRoutes')
+        if routes is None:
+            return []
+
+        if not isinstance(routes, list):
+            raise ValidationError('The "springCloudGatewayRoutes" field must be a list. Please see https://aka.ms/gateway-for-spring-routes-yaml for a valid Gateway for Spring routes YAML spec.')
+
+        # Loop through each route and validate the required fields
+        for route in routes:
+            if not isinstance(route, dict):
+                raise ValidationError('Each route must be a dictionary. Please see https://aka.ms/gateway-for-spring-routes-yaml for a valid Gateway for Spring routes YAML spec.')
+
+            # Ensure each route has 'id' and 'uri' fields
+            if 'id' not in route or not route['id']:
+                raise ValidationError(f'Route is missing required "id" field: {route} Please see https://aka.ms/gateway-for-spring-routes-yaml for a valid Gateway for Spring routes YAML spec.')
+
+            if 'uri' not in route or not route['uri']:
+                raise ValidationError(f'Route is missing required "uri" field: {route} Please see https://aka.ms/gateway-for-spring-routes-yaml for a valid Gateway for Spring routes YAML spec.')
+
+            # Ensure predicates and filters are lists; set to empty lists if not provided
+            if 'predicates' not in route:
+                route['predicates'] = []
+            elif not isinstance(route['predicates'], list):
+                raise ValidationError(f'The "predicates" field must be a list in route {route["id"]}. Please see https://aka.ms/gateway-for-spring-routes-yaml for a valid Gateway for Spring routes YAML spec.')
+
+            if 'filters' not in route:
+                route['filters'] = []
+            elif not isinstance(route['filters'], list):
+                raise ValidationError(f'The "filters" field must be a list in route {route["id"]}. Please see https://aka.ms/gateway-for-spring-routes-yaml for a valid Gateway for Spring routes YAML spec.')


Should we put these check in the RP? If you put them in CLI, if schema in the RP change, it will break CLI.

Sync with rp coder, we do not have such kind of check in RP, the check is still necessary for a short time period.
And from my point of view, if the schema in RP changes, it will result in either a new API version or a breaking change. In the first case, the old CLI package should still work with old api versions. However, if it's a breaking change, seems in any case we'll still need to update the CLI.

Greedygre · 2024-10-11T06:48:14Z

Hi @Juliehzl

Can you help to take a look for this PR when you have chance? Thanks!

Juliehzl · 2024-10-14T06:57:56Z

src/containerapp/azext_containerapp/commands.py

+    with self.command_group('containerapp env java-component gateway-for-spring', is_preview=True) as g:
+        g.custom_command('create', 'create_gateway_for_spring', supports_no_wait=True)
+        g.custom_command('update', 'update_gateway_for_spring', supports_no_wait=True)
+        g.custom_show_command('show', 'show_gateway_for_spring')


what about list?

The list command is consistent with other Java components at the Java component level.

yanzhudd · 2024-10-15T03:26:38Z

/azp run

azure-pipelines · 2024-10-15T03:26:50Z

Azure Pipelines successfully started running 2 pipeline(s).

github-actions · 2024-10-15T07:34:02Z

Hi @Descatles

Release Suggestions

Module: containerapp

Update VERSION to 1.0.0b4 in src/containerapp/setup.py

Notes

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

yanzhudd · 2024-10-15T07:37:39Z

/azp run

azure-pipelines · 2024-10-15T07:37:50Z

Azure Pipelines successfully started running 2 pipeline(s).

Greedygre · 2024-10-15T09:21:04Z

Hi @Descatles
After this PR merge: #8138

Please sync main branch.

Greedygre · 2024-10-16T03:03:38Z

Hi @yanzhudd @wangzelin007

Can you help to handle this PR? Not sure why the CI stuck for a long time. Thank you!

spring cloud gateway cli

cf29687

azure-client-tools-bot-prd bot added this to the September 2024 (2024-10-08) milestone Sep 29, 2024

Wenhao Zhang added 3 commits September 29, 2024 20:13

Merge remote-tracking branch 'azure/main' into wenhao/scg-cli

5e50736

Gateway cli

036a88c

Gateway cli

dc0c56f

yonzhan requested a review from zhoxing-ms September 29, 2024 13:16

yonzhan assigned zhoxing-ms Sep 29, 2024

yonzhan requested a review from yanzhudd September 29, 2024 13:17

Wenhao Zhang added 4 commits September 30, 2024 11:11

update test

eb0ef11

Add preview for nacos

3a60fdb

Merge remote-tracking branch 'azure/main' into wenhao/scg-cli

c6b0743

Add history

b5a96de

Caoxuyang approved these changes Oct 10, 2024

View reviewed changes

Greedygre reviewed Oct 10, 2024

View reviewed changes

Wenhao Zhang added 2 commits October 10, 2024 13:27

Remove useless parameter

26cb728

Remove unused import

813a1ca

Greedygre reviewed Oct 10, 2024

View reviewed changes

Wenhao Zhang added 2 commits October 10, 2024 16:00

revert recording test

218c10e

update tests

28bcc64

Wenhao Zhang added 2 commits October 10, 2024 16:34

Add recording

6d6e81e

remove class

5dac9c2

Greedygre approved these changes Oct 11, 2024

View reviewed changes

Juliehzl reviewed Oct 14, 2024

View reviewed changes

Juliehzl approved these changes Oct 14, 2024

View reviewed changes

yanzhudd approved these changes Oct 15, 2024

View reviewed changes

wangzelin007 closed this Oct 15, 2024

wangzelin007 reopened this Oct 15, 2024

wangzelin007 added Docs and removed Docs labels Oct 15, 2024

Merge remote-tracking branch 'azure/main' into wenhao/scg-cli-local

2e47e63

wangzelin007 added Docs and removed Docs labels Oct 16, 2024

yanzhudd merged commit 8af0340 into Azure:main Oct 16, 2024
22 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add spring cloud gateway cli #8037

Add spring cloud gateway cli #8037

Descatles commented Sep 29, 2024

azure-client-tools-bot-prd bot commented Sep 29, 2024 •

edited

Loading

azure-client-tools-bot-prd bot commented Sep 29, 2024

yonzhan commented Sep 29, 2024

Greedygre Oct 10, 2024 •

edited

Loading

Descatles Oct 10, 2024

Greedygre Oct 10, 2024

Descatles Oct 10, 2024 •

edited

Loading

Greedygre Oct 10, 2024 •

edited

Loading

Descatles Oct 10, 2024

Greedygre Oct 10, 2024

Descatles Oct 10, 2024

Greedygre Oct 10, 2024

Descatles Oct 10, 2024

Greedygre Oct 10, 2024

Descatles Oct 10, 2024

Greedygre Oct 10, 2024 •

edited

Loading

Descatles Oct 10, 2024

Greedygre Oct 10, 2024

Descatles Oct 10, 2024

Greedygre Oct 10, 2024

Descatles Oct 10, 2024

Greedygre Oct 10, 2024

Descatles Oct 10, 2024

Greedygre commented Oct 11, 2024

Juliehzl Oct 14, 2024

Descatles Oct 14, 2024

yanzhudd commented Oct 15, 2024

azure-pipelines bot commented Oct 15, 2024

github-actions bot commented Oct 15, 2024

yanzhudd commented Oct 15, 2024

azure-pipelines bot commented Oct 15, 2024

Greedygre commented Oct 15, 2024 •

edited

Loading

Greedygre commented Oct 16, 2024

		if self.get_argument_target_java_component_type() == JAVA_COMPONENT_GATEWAY:
		raise CLIInternalError("Service binding is not supported by Gateway for Spring.")

		if self.get_argument_target_java_component_type() != JAVA_COMPONENT_GATEWAY:
		raise CLIInternalError("The route could only be configured for Gateway for Spring.")

Add spring cloud gateway cli #8037

Add spring cloud gateway cli #8037

Conversation

Descatles commented Sep 29, 2024

Related command

General Guidelines

About Extension Publish

azure-client-tools-bot-prd bot commented Sep 29, 2024 • edited Loading

azure-client-tools-bot-prd bot commented Sep 29, 2024

yonzhan commented Sep 29, 2024

Greedygre Oct 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Descatles Oct 10, 2024 • edited Loading

Choose a reason for hiding this comment

Greedygre Oct 10, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Greedygre Oct 10, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Greedygre commented Oct 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yanzhudd commented Oct 15, 2024

azure-pipelines bot commented Oct 15, 2024

github-actions bot commented Oct 15, 2024

Release Suggestions

Module: containerapp

Notes

yanzhudd commented Oct 15, 2024

azure-pipelines bot commented Oct 15, 2024

Greedygre commented Oct 15, 2024 • edited Loading

Greedygre commented Oct 16, 2024

azure-client-tools-bot-prd bot commented Sep 29, 2024 •

edited

Loading

Greedygre Oct 10, 2024 •

edited

Loading

Descatles Oct 10, 2024 •

edited

Loading

Greedygre Oct 10, 2024 •

edited

Loading

Greedygre Oct 10, 2024 •

edited

Loading

Greedygre commented Oct 15, 2024 •

edited

Loading