File: //snap/google-cloud-cli/current/lib/surface/builds/triggers/update/cloud_source_repositories.py
# -*- coding: utf-8 -*- #
# Copyright 2023 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Update Cloud Source Repositories trigger command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.cloudbuild import cloudbuild_util
from googlecloudsdk.api_lib.cloudbuild import trigger_config as trigger_utils
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.cloudbuild import resource_args
from googlecloudsdk.command_lib.source import resource_args as repo_resource
from googlecloudsdk.command_lib.util.concepts import concept_parsers
from googlecloudsdk.command_lib.util.concepts import presentation_specs
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
class UpdateCSR(base.UpdateCommand):
"""Updates Cloud Source Repositories trigger used by Cloud Build."""
detailed_help = {
'EXAMPLES':
"""\
To update the branch pattern of the trigger:
$ {command} my-trigger --branch-pattern=".*"
To update the build config of the trigger:
$ {command} my-trigger --build-config="cloudbuild.yaml"
To update the substitutions of the trigger:
$ {command} my-trigger --update-substitutions=_REPO_NAME=my-repo,_BRANCH_NAME=master
""",
}
@staticmethod
def Args(parser):
"""Registers flags for this command.
Args:
parser: An argparse.ArgumentParser-like object. It is mocked out in order
to capture some information, but behaves like an ArgumentParser.
"""
concept_parsers.ConceptParser.ForResource(
'TRIGGER',
resource_args.GetTriggerResourceSpec(),
'Build Trigger.', required=True).AddToParser(parser)
flag_config = trigger_utils.AddTriggerArgs(
parser, add_region_flag=False, add_name=False)
repo_spec = presentation_specs.ResourcePresentationSpec(
'--repo', # This defines how the "anchor" or leaf argument is named.
repo_resource.GetRepoResourceSpec(),
'Cloud Source Repository.',
prefixes=False)
concept_parsers.ConceptParser([repo_spec]).AddToParser(flag_config)
ref_config = flag_config.add_mutually_exclusive_group()
trigger_utils.AddBranchPattern(ref_config)
trigger_utils.AddTagPattern(ref_config)
trigger_utils.AddBuildConfigArgsForUpdate(
flag_config, has_build_config=True, require_docker_image=True)
trigger_utils.AddRepoEventArgs(flag_config)
def ParseTriggerFromFlags(self, args, old_trigger, update_mask):
"""Parses command line arguments into a build trigger.
Args:
args: An argparse arguments object.
old_trigger: The existing trigger to be updated.
update_mask: The fields to be updated.
Returns:
A build trigger object.
Raises:
RequiredArgumentException: If comment_control is defined but
pull_request_pattern isn't.
"""
messages = cloudbuild_util.GetMessagesModule()
trigger, done = trigger_utils.ParseTriggerArgsForUpdate(args, messages)
if done:
return trigger
repo_ref = args.CONCEPTS.repo.Parse()
repo = None
if repo_ref:
repo = repo_ref.reposId
trigger = messages.BuildTrigger(
description=args.description,
serviceAccount=args.service_account,
triggerTemplate=messages.RepoSource(
repoName=repo,
branchName=args.branch_pattern,
tagName=args.tag_pattern,
),
)
trigger_utils.ParseRequireApproval(trigger, args, messages)
# Build Config
trigger_utils.ParseBuildConfigArgsForUpdate(
trigger,
old_trigger,
args,
messages,
update_mask,
'',
has_build_config=True,
)
trigger_utils.ParseRepoEventArgs(trigger, args)
return trigger
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: An argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
The updated CSR trigger.
"""
client = cloudbuild_util.GetClientInstance()
messages = cloudbuild_util.GetMessagesModule()
project = properties.VALUES.core.project.Get(required=True)
regionprop = properties.VALUES.builds.region.Get()
location = args.region or regionprop or cloudbuild_util.DEFAULT_REGION
triggerid = args.TRIGGER
name = resources.REGISTRY.Parse(
triggerid,
params={
'projectsId': project,
'locationsId': location,
'triggersId': triggerid,
},
collection='cloudbuild.projects.locations.triggers').RelativeName()
old_trigger = client.projects_locations_triggers.Get(
client.MESSAGES_MODULE.CloudbuildProjectsLocationsTriggersGetRequest(
name=name, triggerId=triggerid))
update_mask = []
trigger = self.ParseTriggerFromFlags(args, old_trigger, update_mask)
# Overwrite the substitutions.additionalProperties in updateMask.
sub = 'substitutions'
update_mask.extend(cloudbuild_util.MessageToFieldPaths(trigger))
update_mask = list(
set(map(lambda m: sub if m.startswith(sub) else m, update_mask)))
req = messages.CloudbuildProjectsLocationsTriggersPatchRequest(
resourceName=name,
triggerId=triggerid,
buildTrigger=trigger,
updateMask=','.join(update_mask))
updated_trigger = client.projects_locations_triggers.Patch(req)
log.UpdatedResource(triggerid, kind='build_trigger')
return updated_trigger