def Run(self, args):
"""Run 'service-management deploy'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The response from the Update API call.
Raises:
BadFileExceptionn: if the provided service configuration files are
invalid or cannot be read.
"""
messages = services_util.GetMessagesModule()
client = services_util.GetClientInstance()
file_types = messages.ConfigFile.FileTypeValueValuesEnum
self.service_name = self.service_version = config_contents = None
config_files = []
self.validate_only = args.validate_only
# If we're not doing a validate-only run, we don't want to output the
# resource directly unless the user specifically requests it using the
# --format flag. The Epilog will show useful information after deployment
# is complete.
if not self.validate_only and not args.IsSpecified('format'):
args.format = 'none'
for service_config_file in args.service_config_file:
config_contents = services_util.ReadServiceConfigFile(
service_config_file)
if services_util.FilenameMatchesExtension(
service_config_file, ['.json', '.yaml', '.yml']):
# Try to load the file as JSON. If that fails, try YAML.
service_config_dict = services_util.LoadJsonOrYaml(
config_contents)
if not service_config_dict:
raise calliope_exceptions.BadFileException(
'Could not read JSON or YAML from service config file '
'[{0}].'.format(service_config_file))
if 'swagger' in service_config_dict:
if 'host' not in service_config_dict:
raise calliope_exceptions.BadFileException((
'Malformed input. Found Swagger service config in file [{}], '
'but no host was specified. Add a host specification to the '
'config file.').format(service_config_file))
if not self.service_name and service_config_dict.get(
'host'):
self.service_name = service_config_dict.get('host')
# Always use YAML for Open API because JSON is a subset of YAML.
config_files.append(
self.MakeConfigFileMessage(config_contents,
service_config_file,
file_types.OPEN_API_YAML))
elif service_config_dict.get('type') == 'google.api.Service':
if not self.service_name and service_config_dict.get(
'name'):
self.service_name = service_config_dict.get('name')
config_files.append(
self.MakeConfigFileMessage(
config_contents, service_config_file,
file_types.SERVICE_CONFIG_YAML))
elif 'name' in service_config_dict:
# This is a special case. If we have been provided a Google Service
# Configuration file which has a service 'name' field, but no 'type'
# field, we have to assume that this is a normalized service config,
# and can be uploaded via the CreateServiceConfig API. Therefore,
# we can short circute the process here.
if len(args.service_config_file) > 1:
raise calliope_exceptions.BadFileException((
'Ambiguous input. Found normalized service configuration in '
'file [{0}], but received multiple input files. To upload '
'normalized service config, please provide it separately from '
'other input files to avoid ambiguity.'
).format(service_config_file))
# If this is a validate-only run, abort now, since this is not
# supported in the ServiceConfigs.Create API
if self.validate_only:
raise exceptions.InvalidFlagError(
'The --validate-only flag is not supported when using '
'normalized service configs as input.')
self.service_name = service_config_dict.get('name')
config_files = []
break
else:
raise calliope_exceptions.BadFileException((
'Unable to parse Open API, or Google Service Configuration '
'specification from {0}').format(service_config_file))
elif services_util.IsProtoDescriptor(service_config_file):
config_files.append(
self.MakeConfigFileMessage(
config_contents, service_config_file,
file_types.FILE_DESCRIPTOR_SET_PROTO))
else:
raise calliope_exceptions.BadFileException((
'Could not determine the content type of file [{0}]. Supported '
'extensions are .json .yaml .yml .pb. and .descriptor'
).format(service_config_file))
# Check to see if the Endpoints meta service needs to be enabled.
enable_api.EnableServiceIfDisabled(
properties.VALUES.core.project.Get(required=True),
services_util.GetEndpointsServiceName(), args. async)
# Check if we need to create the service.
services_util.CreateServiceIfNew(
self.service_name,
properties.VALUES.core.project.Get(required=True))
if config_files:
push_config_result = services_util.PushMultipleServiceConfigFiles(
self.service_name,
config_files,
args. async,
validate_only=self.validate_only)
self.service_config_id = (
services_util.GetServiceConfigIdFromSubmitConfigSourceResponse(
push_config_result))
else:
push_config_result = services_util.PushNormalizedGoogleServiceConfig(
self.service_name,
properties.VALUES.core.project.Get(required=True),
config_contents)
self.service_config_id = push_config_result.id
if not self.service_config_id:
raise exceptions.InvalidConditionError(
'Failed to retrieve Service Configuration Id.')
# Run the Push Advisor to see if we need to warn the user of any
# potentially hazardous changes to the service configuration.
if self.CheckPushAdvisor(args.force):
return None
# Create a Rollout for the new service configuration
if not self.validate_only:
percentages = messages.TrafficPercentStrategy.PercentagesValue()
percentages.additionalProperties.append(
(messages.TrafficPercentStrategy.PercentagesValue.
AdditionalProperty(key=self.service_config_id, value=100.0)))
traffic_percent_strategy = messages.TrafficPercentStrategy(
percentages=percentages)
rollout = messages.Rollout(
serviceName=self.service_name,
trafficPercentStrategy=traffic_percent_strategy,
)
rollout_operation = client.services_rollouts.Create(rollout)
services_util.ProcessOperationResult(rollout_operation,
args. async)
# Check to see if the service is already enabled
enable_api.EnableServiceIfDisabled(
properties.VALUES.core.project.Get(required=True),
self.service_name, args. async)
return push_config_result
def PushServiceConfig(swagger_file, project, client, messages):
"""Pushes Service Configuration to Google Service Management.
Args:
swagger_file: full path to a JSON file containing the swagger spec.
project: the Google cloud project Id
client: the client to use for calls to Service Management API
messages: the client library messages to use for Service Management API
Raises:
SwaggerOpenException: if input is malformed or file cannot be read
SwaggerUploadException: if service fails to convert swagger, or
upload of the service configuration conversion result fails
ValueError: if the required inputs are not provided.
Returns:
EndpointsServiceInfo: an instance of EndpointsServiceInfo that contains the
Endpoints service name and service version that is pushed.
"""
if not swagger_file:
raise ValueError(
'Open API (Swagger) specification file path must be provided.')
if not project:
raise ValueError('Project Id must be provided.')
if not client:
raise ValueError('Service Management client must be provided.')
if not messages:
raise ValueError(
'Service Management client messages must be provided.')
swagger_file_contents = None
try:
with open(swagger_file) as f:
swagger_file_contents = f.read()
except IOError:
raise SwaggerOpenException(
'Unable to read swagger spec file "{0}"'.format(swagger_file))
# Try to load the file as JSON or YAML.
service_config_dict = services_util.LoadJsonOrYaml(swagger_file_contents)
if not service_config_dict:
raise SwaggerOpenException(
'Could not read JSON or YAML from Open API (Swagger) file {}.'.
format(swagger_file))
# Check to see if the Endpoints meta service needs to be enabled.
enable_api.EnableServiceIfDisabled(project,
services_util.GetEndpointsServiceName(),
async=False)
service_name = service_config_dict.get('host', None)
# Create the Service resource if it does not already exist.
services_util.CreateServiceIfNew(service_name, project)
# Push the service configuration.
push_config_result = services_util.PushOpenApiServiceConfig(
service_name,
swagger_file_contents,
os.path.basename(swagger_file),
async=False)
config_id = services_util.GetServiceConfigIdFromSubmitConfigSourceResponse(
push_config_result)
if config_id and service_name:
# Print this to screen and to the log because the output is needed by the
# human user.
log.status.Print(
('\nService Configuration with version [{0}] uploaded '
'for service [{1}]\n').format(config_id, service_name))
else:
raise SwaggerUploadException(
'Failed to retrieve Service Configuration Version')
# Create a Rollout for the new service configuration
percentages = messages.TrafficPercentStrategy.PercentagesValue()
percentages.additionalProperties.append(
messages.TrafficPercentStrategy.PercentagesValue.AdditionalProperty(
key=config_id, value=100.0))
traffic_percent_strategy = messages.TrafficPercentStrategy(
percentages=percentages)
rollout = messages.Rollout(
serviceName=service_name,
trafficPercentStrategy=traffic_percent_strategy,
)
rollout_operation = client.services_rollouts.Create(rollout)
services_util.ProcessOperationResult(rollout_operation, async=False)
# Enable the service for the producer project if it is not already enabled
enable_api.EnableServiceIfDisabled(project, service_name, async=False)
return EndpointsServiceInfo(service_name=service_name,
service_version=config_id)