File: //snap/google-cloud-cli/396/lib/surface/builds/triggers/create/repository.py
# -*- coding: utf-8 -*- #
# Copyright 2022 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.
"""Create GCB v2 repo 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.calliope.concepts import concepts
from googlecloudsdk.command_lib.cloudbuild import resource_args
from googlecloudsdk.command_lib.util.concepts import concept_parsers
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
# TODO(b/224569250): Remove hidden label once GCB repo trigger is released.
@base.Hidden
class CreateRepository(base.CreateCommand):
"""Create a build trigger for a GCB v2 repository."""
detailed_help = {
'EXAMPLES':
"""\
To create a push trigger for all branches:
$ {command} --name="my-trigger" --service-account="projects/my-project/serviceAccounts/my-byosa@my-project.iam.gserviceaccount.com" --repository=projects/my-project/locations/my-location/connections/my-connection/repositories/my-repository --branch-pattern=".*" --build-config="cloudbuild.yaml"
To create a pull request trigger for master:
$ {command} --name="my-trigger" --service-account="projects/my-project/serviceAccounts/my-byosa@my-project.iam.gserviceaccount.com" --repository=projects/my-project/locations/my-location/connections/my-connection/repositories/my-repository --pull-request-pattern="^master$" --build-config="cloudbuild.yaml"
""",
}
@staticmethod
def Args(parser):
"""Register 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.
"""
region_spec = concepts.ResourceSpec(
'cloudbuild.projects.locations',
resource_name='region',
projectsId=concepts.DEFAULT_PROJECT_ATTRIBUTE_CONFIG,
locationsId=resource_args.RegionAttributeConfig())
concept_parsers.ConceptParser.ForResource(
'--region',
region_spec,
'Cloud region',
required=True).AddToParser(parser)
messages = cloudbuild_util.GetMessagesModule()
flag_config = trigger_utils.AddTriggerArgs(parser, add_region_flag=False)
flag_config.add_argument(
'--repository', help='Resource name of the GCB v2 repository.',
required=True)
ref_config = flag_config.add_mutually_exclusive_group(required=True)
trigger_utils.AddBranchPattern(ref_config)
trigger_utils.AddTagPattern(ref_config)
pr_config = ref_config.add_argument_group(help='Pull Request settings')
pr_config.add_argument(
'--pull-request-pattern',
metavar='REGEX',
required=True,
help="""\
A regular expression specifying which base git branch to match for
pull request events.
This pattern is used as a regex search for the base branch (the branch you are
trying to merge into) for pull request updates.
For example, --pull-request-pattern=foo will match "foo", "foobar", and "barfoo".
The syntax of the regular expressions accepted is the syntax accepted by
RE2 and described at https://github.com/google/re2/wiki/Syntax.
""")
pr_config.add_argument(
'--comment-control',
default=messages.PullRequestFilter.CommentControlValueValuesEnum
.COMMENTS_ENABLED,
help='Require a repository collaborator or owner to comment \'/gcbrun\' on a pull request before running the build.'
)
build_config = (
trigger_utils.AddBuildConfigArgs(flag_config, add_docker_args=False))
trigger_utils.AddBuildDockerArgs(build_config, require_docker_image=True)
trigger_utils.AddRepoEventArgs(flag_config)
def ParseTriggerFromFlags(self, args):
"""Parses command line arguments into a build trigger.
Args:
args: An argparse arguments object.
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.ParseTriggerArgs(args, messages)
if done:
return trigger
# GCB v2 Repo config
repo = messages.RepositoryEventConfig(repository=args.repository)
if args.pull_request_pattern:
repo.pullRequest = messages.PullRequestFilter(
branch=args.pull_request_pattern)
if args.comment_control:
repo.pullRequest.commentControl = messages.PullRequestFilter.CommentControlValueValuesEnum(
args.comment_control)
else:
# Push event
repo.push = messages.PushFilter(
branch=args.branch_pattern, tag=args.tag_pattern)
trigger.repositoryEventConfig = repo
trigger_utils.ParseBuildConfigArgs(
trigger, args, messages, default_image=None)
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:
Some value that we want to have printed later.
"""
client = cloudbuild_util.GetClientInstance()
messages = cloudbuild_util.GetMessagesModule()
trigger = self.ParseTriggerFromFlags(args)
# Send the Create request
project = properties.VALUES.core.project.Get(required=True)
location = args.region
if location is None:
location = properties.VALUES.builds.region.Get(required=True)
location = location.split('/')[-1]
parent = resources.REGISTRY.Create(
collection='cloudbuild.projects.locations',
projectsId=project,
locationsId=location).RelativeName()
created_trigger = client.projects_locations_triggers.Create(
messages.CloudbuildProjectsLocationsTriggersCreateRequest(
parent=parent, buildTrigger=trigger))
trigger_resource = resources.REGISTRY.Parse(
None,
collection='cloudbuild.projects.locations.triggers',
api_version='v1',
params={
'projectsId': project,
'locationsId': location,
'triggersId': created_trigger.id,
})
log.CreatedResource(trigger_resource)
return created_trigger