[spring-cloud] Refactor app create update and deploy logic by yuwzho · Pull Request #4266 · Azure/azure-cli-extensions

yuwzho · 2021-12-28T11:06:15Z

This PR refactors the logic when app create, app deploy, app update and deployment create.

This PR will NOT upgrade the version and will update together with other PRs.

App's command usually operates an Spring/Apps and the active Spring/Apps/Deployments under the app.
The general idea of these command is putting all input command in parameter dict and let the Resource factory to construct the payload.

_app_factory construct the App's properties
_deployment_factory construct the Deployment's properties, which includes source and other settings.
There are 5 types for different deployment source types, here use _deployment_source_factory to construct the payload according to the source_type
A deployment must consume a path can be deployable, it can be a relative path, custom container or build result resource id,
- _deployment_deployable_factory determines the deployable type and upload necessary binary/code to the service when constructing the deployable_path.
- _deployment_uploadable_factory will upload the local file to a given destination, or compress the local folder and upload according to the parameter.

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

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?

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 PR is merged into master branch, a new PR will be created to update src/index.json automatically.
The precondition is to put your code inside this repo and upgrade the version in the PR but do not modify src/index.json.

yuwzho · 2021-12-28T11:07:52Z

src/spring-cloud/azext_spring_cloud/commands.py

        g.custom_command('repo list', 'config_repo_list')

-    with self.command_group('spring-cloud app', client_factory=cf_spring_cloud_20220101preview,
+    with self.command_group('spring-cloud app', custom_command_type=app_command,


The 4 commands' traffic will be routing to the app.py

spring-cloud app create

spring-cloud app update

spring-cloud app deploy

spring-cloud app deployment create

yonzhan · 2021-12-28T14:49:45Z

spring-cloud

yuwzho · 2021-12-29T10:53:42Z

ready_to_review

zhoxing-ms · 2021-12-30T02:19:29Z

src/spring-cloud/azext_spring_cloud/_buildservices_factory.py

+                raise CLIError("Failed to get a SAS URL to upload context.")
+            return response
+        except CloudError as e:
+            raise CLIError("Failed to get a SAS URL to upload context. Error: {}".format(e.message))
+        except AttributeError as e:
+            raise CLIError("Failed to get a SAS URL to upload context. Error: {}".format(e))


Please use the specific error type instead of CLIError

zhoxing-ms · 2021-12-30T02:19:51Z

src/spring-cloud/azext_spring_cloud/_buildservices_factory.py

+                                                                    app,
+                                                                    build).properties.triggered_build_result.id
+        except (AttributeError, CloudError) as e:
+            raise CLIError("Failed to create or update a build. Error: {}".format(e.message))


Same as above

zhoxing-ms · 2021-12-30T02:20:30Z

src/spring-cloud/azext_spring_cloud/_buildservices_factory.py

+
+        if result.properties.provisioning_state != "Succeeded":
+            log_url = self._try_get_build_log_url(build_result_id)
+            raise CLIError("Failed to build docker image, please check the build logs {} and retry.".format(log_url))


Same as above

zhoxing-ms · 2021-12-30T02:46:17Z

src/spring-cloud/azext_spring_cloud/app.py

+        # ignore
+        return
+    if app:
+        raise CLIError('App {} already exist.'.format(app.id))


Same as above

zhoxing-ms · 2021-12-30T02:53:49Z

src/spring-cloud/azext_spring_cloud/_app_validator.py

 from azure.core.exceptions import (ResourceNotFoundError)
-from ._client_factory import cf_spring_cloud
 from ._resource_quantity import (validate_cpu as validate_cpu_value, validate_memory as validate_memory_value)
+from ._client_factory import cf_spring_cloud_20220101preview


May I ask why did you add the api-version number to the name of _client_factory ?

Here follows the current implementation about client factory. The default client factory uses the latest stable API version. But some features in previewed is only available in preview API version. Ideally, we, service team will flush all preview features in a new stable API version, at that time, we can remove the factory_preview_api_version and replace them as the new default client factory.

Got it, thanks

yuwzho · 2022-01-05T03:25:43Z

#4294

yuwzho added 2 commits December 28, 2021 18:49

[Spring-Cloud] refactor app create, update or deploy

8634438

Add comments

5392ee4

yuwzho commented Dec 28, 2021

View reviewed changes

yuwzho added 3 commits December 28, 2021 19:41

Add more test

0d91a19

mask credential

649552b

fix lint

f356bfc

yonzhan requested review from wangzelin007 and zhoxing-ms December 28, 2021 14:49

yonzhan assigned zhoxing-ms Dec 28, 2021

yonzhan added this to the Jan 2022 (2022-02-01) milestone Dec 28, 2021

yonzhan modified the milestones: Jan 2022 (2022-02-01), Dec 2021 (2022-01-04) Dec 28, 2021

yonzhan requested a review from jsntcy December 28, 2021 14:50

yonzhan assigned jsntcy Dec 28, 2021

yuwzho added 3 commits December 29, 2021 12:03

update comments

3e4cae6

Add enterprise app deploy

597d245

remove duplicate test file

bd9def1

zhoxing-ms reviewed Dec 30, 2021

View reviewed changes

Address comments

185e280

zhoxing-ms approved these changes Dec 30, 2021

View reviewed changes

zhoxing-ms merged commit 47c9f28 into Azure:main Dec 30, 2021

yuwzho deleted the yuwzho/refactor-app branch December 30, 2021 07:43

This was referenced Dec 30, 2021

[Spring-Cloud] Remove unused method #4279

Merged

[Spring-Cloud] Upgrade version #4294

Merged

Conversation

yuwzho commented Dec 28, 2021

General Guidelines

About Extension Publish

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yonzhan commented Dec 28, 2021

Uh oh!

yuwzho commented Dec 29, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yuwzho commented Jan 5, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants