Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Spring Cloud] Add gateway related methods #4261

Merged
merged 5 commits into from
Dec 29, 2021
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
225 changes: 225 additions & 0 deletions src/spring-cloud/azext_spring_cloud/gateway.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

import json

from azure.cli.core.util import sdk_no_wait
from knack.log import get_logger
from knack.util import CLIError

from .custom import LOG_RUNNING_PROMPT
from .vendored_sdks.appplatform.v2022_01_01_preview import models

logger = get_logger(__name__)
DEFAULT_NAME = "default"


def gateway_update(cmd, client, resource_group, service,
cpu=None,
memory=None,
instance_count=None,
assign_endpoint=None,
https_only=None,
scope=None,
client_id=None,
client_secret=None,
issuer_uri=None,
api_title=None,
api_description=None,
api_documentation_location=None,
api_version=None,
server_url=None,
allowed_origins=None,
allowed_methods=None,
allowed_headers=None,
max_age=None,
allow_credentials=None,
exposed_headers=None,
no_wait=False
):
gateway = client.gateways.get(resource_group, service, DEFAULT_NAME)

sso_properties = gateway.properties.sso_properties
if scope and client_id and client_secret and issuer_uri:
sso_properties = models.SsoProperties(
scope=scope,
client_id=client_id,
client_secret=client_secret,
issuer_uri=issuer_uri,
)

api_metadata_properties = _update_api_metadata(
gateway.properties.api_metadata_properties, api_title, api_description, api_documentation_location, api_version, server_url)

cors_properties = _update_cors(
gateway.properties.cors_properties, allowed_origins, allowed_methods, allowed_headers, max_age, allow_credentials, exposed_headers)

resource_requests = models.GatewayResourceRequests(
cpu=cpu or gateway.properties.resource_requests.cpu,
memory=memory or gateway.properties.resource_requests.memory
)

properties = models.GatewayProperties(
public=assign_endpoint if assign_endpoint is not None else gateway.properties.public,
https_only=https_only if https_only is not None else gateway.properties.https_only,
sso_properties=sso_properties,
api_metadata_properties=api_metadata_properties,
cors_properties=cors_properties,
resource_requests=resource_requests)

sku = models.Sku(name=gateway.sku.name, tier=gateway.sku.tier,
capacity=instance_count or gateway.sku.capacity)

gateway_resource = models.GatewayResource(properties=properties, sku=sku)

logger.warning(LOG_RUNNING_PROMPT)
return sdk_no_wait(no_wait, client.gateways.begin_create_or_update,
resource_group, service, DEFAULT_NAME, gateway_resource)


def gateway_show(cmd, client, resource_group, service):
return client.gateways.get(resource_group, service, DEFAULT_NAME)


def gateway_clear(cmd, client, resource_group, service):
gateway = client.gateways.get(resource_group, service, DEFAULT_NAME)
properties = models.GatewayProperties()
sku = models.Sku(name=gateway.sku.name, tier=gateway.sku.tier)
gateway_resource = models.GatewayResource(properties=properties, sku=sku)
return client.gateways.begin_create_or_update(resource_group, service, DEFAULT_NAME, gateway_resource)


def gateway_custom_domain_show(cmd, client, resource_group, service, domain_name):
return client.gateway_custom_domains.get(resource_group, service, DEFAULT_NAME, domain_name)


def gateway_custom_domain_list(cmd, client, resource_group, service):
return client.gateway_custom_domains.list(resource_group, service, DEFAULT_NAME)


def gateway_custom_domain_update(cmd, client, resource_group, service,
domain_name,
certificate=None):
properties = models.GatewayCustomDomainProperties()
if certificate is not None:
certificate_response = client.certificates.get(
resource_group, service, certificate)
properties.thumbprint = certificate_response.properties.thumbprint

custom_domain_resource = models.GatewayCustomDomainResource(
properties=properties)
return client.gateway_custom_domains.begin_create_or_update(resource_group, service, DEFAULT_NAME,
domain_name, custom_domain_resource)


def gateway_custom_domain_unbind(cmd, client, resource_group, service, domain_name):
client.gateway_custom_domains.get(resource_group, service,
DEFAULT_NAME, domain_name)
return client.gateway_custom_domains.begin_delete(resource_group, service, DEFAULT_NAME, domain_name)


def gateway_route_config_show(cmd, client, resource_group, service, name):
return client.gateway_route_configs.get(resource_group, service, DEFAULT_NAME, name)


def gateway_route_config_list(cmd, client, resource_group, service):
return client.gateway_route_configs.list(resource_group, service, DEFAULT_NAME)


def gateway_route_config_create(cmd, client, resource_group, service, name,
app_name=None,
routes_json=None,
routes_file=None):
_validate_route_config_exist(client, resource_group, service, name)

app_resource_id = _update_app_resource_id(client, resource_group, service, app_name, None)
routes = _update_routes(routes_file, routes_json, [])

return _create_or_update_gateway_route_configs(client, resource_group, service, name, app_resource_id, routes)


def gateway_route_config_update(cmd, client, resource_group, service, name,
app_name=None,
routes_json=None,
routes_file=None):
gateway_route_config = client.gateway_route_configs.get(
resource_group, service, DEFAULT_NAME, name)

app_resource_id = _update_app_resource_id(client, resource_group, service, app_name, gateway_route_config.properties.app_resource_id)
routes = _update_routes(routes_file, routes_json, gateway_route_config.properties.routes)

return _create_or_update_gateway_route_configs(client, resource_group, service, name, app_resource_id, routes)


def gateway_route_config_remove(cmd, client, resource_group, service, name):
return client.gateway_route_configs.begin_delete(resource_group, service, DEFAULT_NAME, name)


def _update_api_metadata(existing, api_title, api_description, api_documentation_location, version, server_url):
if api_title is None and api_description is None and api_documentation_location is None and version is None and server_url is None:
ninpan-ms marked this conversation as resolved.
Show resolved Hide resolved
return None
api_metadata = models.GatewayApiMetadataProperties() if existing is None else existing
if api_title:
api_metadata.title = api_title
if api_description:
api_metadata.description = api_description
if api_documentation_location:
api_metadata.documentation = api_documentation_location
if version:
api_metadata.version = version
if server_url:
api_metadata.server_url = server_url
return api_metadata


def _update_cors(existing, allowed_origins, allowed_methods, allowed_headers, max_age, allow_credentials, exposed_headers):
if allowed_origins is None and allowed_methods is None and allowed_headers is None and max_age is None and allow_credentials is None and exposed_headers is None:
ninpan-ms marked this conversation as resolved.
Show resolved Hide resolved
return None
cors = existing if existing is not None else models.GatewayCorsProperties()
if allowed_origins:
cors.allowed_origins = allowed_origins.split(",")
if allowed_methods:
cors.allowed_methods = allowed_methods.split(",")
if allowed_headers:
cors.allowed_headers = allowed_headers.split(",")
if max_age:
cors.max_age = max_age
if allow_credentials is not None:
cors.allow_credentials = allow_credentials
if exposed_headers:
cors.exposed_headers = exposed_headers.split(",")
return cors


def _validate_route_config_exist(client, resource_group, service, name):
route_configs = client.gateway_route_configs.list(
resource_group, service, DEFAULT_NAME)
if name in (route_config.name for route_config in list(route_configs)):
raise CLIError("Route config " + name + " already exists")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we use the specific error type InvalidArgumentValueError or ValidationError instead of CLIError?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated and added description



def _update_app_resource_id(client, resource_group, service, app_name, app_resource_id):
if app_name is not None:
app_resource = client.apps.get(resource_group, service, app_name)
app_resource_id = app_resource.id
return app_resource_id


def _update_routes(routes_file, routes_json, routes):
if routes_file is not None:
with open(routes_file, 'r') as json_file:
routes = json.load(json_file)

if routes_json is not None:
routes = json.loads(routes_json)
return routes


def _create_or_update_gateway_route_configs(client, resource_group, service, name, app_resource_id, routes):
properties = models.GatewayRouteConfigProperties(
app_resource_id=app_resource_id, routes=routes)
route_config_resource = models.GatewayRouteConfigResource(
properties=properties)
return client.gateway_route_configs.begin_create_or_update(resource_group, service, DEFAULT_NAME, name, route_config_resource)