def Filter(self, context, args):
"""Runs before command.Run and validates platform with passed args."""
# Ensures a platform is set on the run/platform property and
# all other passed args are valid for this platform and release track.
flags.GetAndValidatePlatform(args, self.ReleaseTrack(),
flags.Product.RUN)
return context
def testGetFromProperty(self):
properties.VALUES.run.platform.Set('gke')
self.assertEqual(
'gke',
flags.GetAndValidatePlatform(self.args,
calliope_base.ReleaseTrack.GA,
flags.Product.RUN))
def testGetFromPrompt(self):
self.WriteInput('2\n')
expected_platform = 'gke'
actual_platform = flags.GetAndValidatePlatform(self.args, self.track,
flags.Product.RUN)
self.AssertErrContains(
'run `gcloud config set run/platform {}`'.format(expected_platform))
self.assertEqual(expected_platform, actual_platform)
def testGetFromFlag(self):
properties.VALUES.run.platform.Set('gke')
self.parser.parse_args(['--platform', 'managed'], self.args)
self.assertEqual(
'managed',
flags.GetAndValidatePlatform(self.args,
calliope_base.ReleaseTrack.GA,
flags.Product.RUN))
def testParseTriggerFilterGKESucceeds(self):
args = self.parser.parse_args(
['--trigger-filters=key1=value1', '--platform=gke'])
expected_platform = 'gke'
run_flags.GetAndValidatePlatform(args,
calliope_base.ReleaseTrack.ALPHA,
run_flags.Product.EVENTS)
self.assertEqual(expected_platform, args.platform)
def Filter(self, context, args):
"""Runs before command.Run and validates platform with passed args."""
# Ensures a platform is set on the run/platform property and
# all other passed args are valid for this platform and release track.
flags.GetAndValidatePlatform(args, self.ReleaseTrack(),
flags.Product.EVENTS)
# TODO(b/190533973): Determine if command group works with project number
base.RequireProjectID(args)
self._CheckPlatform()
return context
def testParseTriggerFilterManagedFails(self):
args = self.parser.parse_args(
['--trigger-filters=key1=value1', '--platform=managed'])
with self.assertRaises(
serverless_exceptions.ConfigurationError) as ctx:
run_flags.GetAndValidatePlatform(args,
calliope_base.ReleaseTrack.ALPHA,
run_flags.Product.EVENTS)
self.assertIn('--trigger-filters', str(ctx.exception))
def Run(self, args):
"""Deploy a container to Cloud Run."""
platform = flags.GetAndValidatePlatform(args, self.ReleaseTrack(),
flags.Product.RUN)
include_build = flags.FlagIsExplicitlySet(args, 'source')
if not include_build and not args.IsSpecified('image'):
if console_io.CanPrompt():
args.source = flags.PromptForDefaultSource()
include_build = True
else:
raise c_exceptions.RequiredArgumentException(
'--image', 'Requires a container image to deploy (e.g. '
'`gcr.io/cloudrun/hello:latest`) if no build source is provided.'
)
service_ref = args.CONCEPTS.service.Parse()
flags.ValidateResource(service_ref)
# Obtaining the connection context prompts the user to select a region if
# one hasn't been provided. We want to do this prior to preparing a source
# deploy so that we can use that region for the Artifact Registry repo.
conn_context = connection_context.GetConnectionContext(
args, flags.Product.RUN, self.ReleaseTrack())
build_type = None
image = None
pack = None
source = None
operation_message = 'Deploying container to'
repo_to_create = None
# Build an image from source if source specified
if include_build:
source = args.source
ar_repo = docker_util.DockerRepo(
project_id=properties.VALUES.core.project.Get(required=True),
location_id=artifact_registry.RepoRegion(
args,
cluster_location=(conn_context.cluster_location if platform
== platforms.PLATFORM_GKE else None)),
repo_id='cloud-run-source-deploy')
if artifact_registry.ShouldCreateRepository(ar_repo):
repo_to_create = ar_repo
# The image is built with latest tag. After build, the image digest
# from the build result will be added to the image of the service spec.
args.image = '{repo}/{service}'.format(
repo=ar_repo.GetDockerString(), service=service_ref.servicesId)
# Use GCP Buildpacks if Dockerfile doesn't exist
docker_file = source + '/Dockerfile'
if os.path.exists(docker_file):
build_type = BuildType.DOCKERFILE
else:
pack = [{'image': args.image}]
build_type = BuildType.BUILDPACKS
image = None if pack else args.image
operation_message = (
'Building using {build_type} and deploying container'
' to').format(build_type=build_type.value)
pretty_print.Info(
messages_util.GetBuildEquivalentForSourceRunMessage(
service_ref.servicesId, pack, source))
# Deploy a container with an image
changes = flags.GetServiceConfigurationChanges(args)
changes.insert(
0,
config_changes.DeleteAnnotationChange(
k8s_object.BINAUTHZ_BREAKGLASS_ANNOTATION))
changes.append(
config_changes.SetLaunchStageAnnotationChange(self.ReleaseTrack()))
with serverless_operations.Connect(conn_context) as operations:
service = operations.GetService(service_ref)
allow_unauth = GetAllowUnauth(args, operations, service_ref,
service)
resource_change_validators.ValidateClearVpcConnector(service, args)
pretty_print.Info(
messages_util.GetStartDeployMessage(conn_context, service_ref,
operation_message))
has_latest = (service is None or traffic.LATEST_REVISION_KEY
in service.spec_traffic)
deployment_stages = stages.ServiceStages(
include_iam_policy_set=allow_unauth is not None,
include_route=has_latest,
include_build=include_build,
include_create_repo=repo_to_create is not None,
)
header = None
if include_build:
header = 'Building and deploying'
else:
header = 'Deploying'
if service is None:
header += ' new service'
header += '...'
with progress_tracker.StagedProgressTracker(
header,
deployment_stages,
failure_message='Deployment failed',
suppress_output=args.async_) as tracker:
service = operations.ReleaseService(
service_ref,
changes,
tracker,
asyn=args.async_,
allow_unauthenticated=allow_unauth,
prefetch=service,
build_image=image,
build_pack=pack,
build_source=source,
repo_to_create=repo_to_create)
if args.async_:
pretty_print.Success(
'Service [{{bold}}{serv}{{reset}}] is deploying '
'asynchronously.'.format(serv=service.name))
else:
service = operations.GetService(service_ref)
pretty_print.Success(
messages_util.GetSuccessMessageForSynchronousDeploy(
service))
return service
def Run(self, args):
"""Deploy a container to Cloud Run."""
flags.GetAndValidatePlatform(args, self.ReleaseTrack(),
flags.Product.RUN)
service_ref = args.CONCEPTS.service.Parse()
flags.ValidateResource(service_ref)
build_type = None
image = None
pack = None
source = None
include_build = flags.FlagIsExplicitlySet(args, 'source')
operation_message = 'Deploying container'
# Build an image from source if source specified
if include_build:
# Create a tag for the image creation
source = args.source
if not args.IsSpecified('image'):
args.image = 'gcr.io/{projectID}/cloud-run-source-deploy/{service}:{tag}'.format(
projectID=properties.VALUES.core.project.Get(
required=True),
service=service_ref.servicesId,
tag=uuid.uuid4().hex)
# Use GCP Buildpacks if Dockerfile doesn't exist
docker_file = args.source + '/Dockerfile'
if os.path.exists(docker_file):
build_type = BuildType.DOCKERFILE
else:
pack = [{'image': args.image}]
build_type = BuildType.BUILDPACKS
image = None if pack else args.image
operation_message = 'Building using {build_type} and deploying container'.format(
build_type=build_type.value)
elif not args.IsSpecified('image'):
raise c_exceptions.RequiredArgumentException(
'--image', 'Requires a container image to deploy (e.g. '
'`gcr.io/cloudrun/hello:latest`) if no build source is provided.'
)
# Deploy a container with an image
conn_context = connection_context.GetConnectionContext(
args, flags.Product.RUN, self.ReleaseTrack())
changes = flags.GetConfigurationChanges(args)
changes.insert(
0,
config_changes.DeleteAnnotationChange(
k8s_object.BINAUTHZ_BREAKGLASS_ANNOTATION))
changes.append(
config_changes.SetLaunchStageAnnotationChange(self.ReleaseTrack()))
with serverless_operations.Connect(conn_context) as operations:
service = operations.GetService(service_ref)
allow_unauth = GetAllowUnauth(args, operations, service_ref,
service)
resource_change_validators.ValidateClearVpcConnector(service, args)
pretty_print.Info(
messages_util.GetStartDeployMessage(conn_context, service_ref,
operation_message))
has_latest = (service is None or traffic.LATEST_REVISION_KEY
in service.spec_traffic)
deployment_stages = stages.ServiceStages(
include_iam_policy_set=allow_unauth is not None,
include_route=has_latest,
include_build=include_build)
header = None
if include_build:
header = 'Building and deploying'
else:
header = 'Deploying'
if service is None:
header += ' new service'
header += '...'
with progress_tracker.StagedProgressTracker(
header,
deployment_stages,
failure_message='Deployment failed',
suppress_output=args.async_) as tracker:
service = operations.ReleaseService(
service_ref,
changes,
tracker,
asyn=args.async_,
allow_unauthenticated=allow_unauth,
prefetch=service,
build_image=image,
build_pack=pack,
build_source=source)
if args.async_:
pretty_print.Success(
'Service [{{bold}}{serv}{{reset}}] is deploying '
'asynchronously.'.format(serv=service.name))
else:
service = operations.GetService(service_ref)
pretty_print.Success(
messages_util.GetSuccessMessageForSynchronousDeploy(
service))
return service
def testCantGetFromPrompt(self):
self.is_interactive.return_value = False
with self.assertRaises(flags.ArgumentError):
flags.GetAndValidatePlatform(self.args, self.track, flags.Product.RUN)
def testInvalidProperty(self):
properties.VALUES.run.platform.Set('invalid')
with self.assertRaises(flags.ArgumentError):
flags.GetAndValidatePlatform(self.args, self.track, flags.Product.RUN)
def testGetFromProperty(self):
properties.VALUES.run.platform.Set('gke')
self.assertEqual(
'gke',
flags.GetAndValidatePlatform(self.args, self.track, flags.Product.RUN))
