a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
community.general/lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger.py

629 lines
22 KiB
Python
Raw Blame History

#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2017 Google
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file at
# https://www.github.com/GoogleCloudPlatform/magic-modules
#
# ----------------------------------------------------------------------------
from __future__ import absolute_import, division, print_function
__metaclass__ = type
################################################################################
# Documentation
################################################################################
ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'}
DOCUMENTATION = '''
---
module: gcp_cloudbuild_trigger
description:
- Configuration for an automated build in response to source repository changes.
short_description: Creates a GCP Trigger
version_added: 2.8
author: Google Inc. (@googlecloudplatform)
requirements:
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
options:
state:
description:
- Whether the given object should exist in GCP
choices:
- present
- absent
default: present
id:
description:
- The unique identifier for the trigger.
required: false
description:
description:
- Human-readable description of the trigger.
required: false
disabled:
description:
- Whether the trigger is disabled or not. If true, the trigger will never result
in a build.
required: false
substitutions:
description:
- Substitutions data for Build resource.
required: false
filename:
description:
- Path, from the source root, to a file whose contents is used for the template.
required: false
ignored_files:
description:
- ignoredFiles and includedFiles are file glob matches using http://godoc/pkg/path/filepath#Match
extended with support for `**`.
- If ignoredFiles and changed files are both empty, then they are not used to
determine whether or not to trigger a build.
- If ignoredFiles is not empty, then we ignore any files that match any of the
ignored_file globs. If the change has no files that are outside of the ignoredFiles
globs, then we do not trigger a build.
required: false
included_files:
description:
- ignoredFiles and includedFiles are file glob matches using http://godoc/pkg/path/filepath#Match
extended with support for `**`.
- If any of the files altered in the commit pass the ignoredFiles filter and includedFiles
is empty, then as far as this filter is concerned, we should trigger the build.
- If any of the files altered in the commit pass the ignoredFiles filter and includedFiles
is not empty, then we make sure that at least one of those files matches a includedFiles
glob. If not, then we do not trigger a build.
required: false
trigger_template:
description:
- Template describing the types of source changes to trigger a build.
- Branch and tag names in trigger templates are interpreted as regular expressions.
Any branch or tag change that matches that regular expression will trigger a
build.
required: false
suboptions:
project_id:
description:
- ID of the project that owns the Cloud Source Repository. If omitted, the
project ID requesting the build is assumed.
required: false
repo_name:
description:
- Name of the Cloud Source Repository. If omitted, the name "default" is assumed.
required: false
default: default
dir:
description:
- Directory, relative to the source root, in which to run the build.
- This must be a relative path. If a step's dir is specified and is an absolute
path, this value is ignored for that step's execution.
required: false
branch_name:
description:
- Name of the branch to build.
required: false
tag_name:
description:
- Name of the tag to build.
required: false
commit_sha:
description:
- Explicit commit SHA to build.
required: false
build:
description:
- Contents of the build template.
required: false
suboptions:
tags:
description:
- Tags for annotation of a Build. These are not docker tags.
required: false
images:
description:
- A list of images to be pushed upon the successful completion of all build
steps.
- The images are pushed using the builder service account's credentials.
- The digests of the pushed images will be stored in the Build resource's
results field.
- If any of the images fail to be pushed, the build status is marked FAILURE.
required: false
steps:
description:
- The operations to be performed on the workspace.
required: false
suboptions:
name:
description:
- The name of the container image that will run this particular build
step.
- If the image is available in the host's Docker daemon's cache, it will
be run directly. If not, the host will attempt to pull the image first,
using the builder service account's credentials if necessary.
- The Docker daemon's cache will already have the latest versions of all
of the officially supported build steps (U(https://github.com/GoogleCloudPlatform/cloud-builders).)
- The Docker daemon will also have cached many of the layers for some
popular images, like "ubuntu", "debian", but they will be refreshed
at the time you attempt to use them.
- If you built an image in a previous build step, it will be stored in
the host's Docker daemon's cache and is available to use as the name
for a later build step.
required: false
args:
description:
- A list of arguments that will be presented to the step when it is started.
- If the image used to run the step's container has an entrypoint, the
args are used as arguments to that entrypoint. If the image does not
define an entrypoint, the first element in args is used as the entrypoint,
and the remainder will be used as arguments.
required: false
extends_documentation_fragment: gcp
notes:
- 'API Reference: U(https://cloud.google.com/cloud-build/docs/api/reference/rest/)'
- 'Automating builds using build triggers: U(https://cloud.google.com/cloud-build/docs/running-builds/automate-builds)'
- The id for this resource is created by the API after you create the resource the
first time. If you want to manage this resource after creation, you'll have to copy
the generated id into the playbook. If you do not, new triggers will be created
on subsequent runs.
'''
EXAMPLES = '''
- name: create a repository
gcp_sourcerepo_repository:
name: projects/{{ gcp_project }}/repos/{{ resource_name }}
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
- name: create a trigger
gcp_cloudbuild_trigger:
trigger_template:
branch_name: master
project_id: "test_project"
repo_name: "test_object"
filename: cloudbuild.yaml
project: "test_project"
auth_kind: "serviceaccount"
service_account_file: "/tmp/auth.pem"
state: present
'''
RETURN = '''
id:
description:
- The unique identifier for the trigger.
returned: success
type: str
description:
description:
- Human-readable description of the trigger.
returned: success
type: str
disabled:
description:
- Whether the trigger is disabled or not. If true, the trigger will never result
in a build.
returned: success
type: str
createTime:
description:
- Time when the trigger was created.
returned: success
type: str
substitutions:
description:
- Substitutions data for Build resource.
returned: success
type: dict
filename:
description:
- Path, from the source root, to a file whose contents is used for the template.
returned: success
type: str
ignoredFiles:
description:
- ignoredFiles and includedFiles are file glob matches using http://godoc/pkg/path/filepath#Match
extended with support for `**`.
- If ignoredFiles and changed files are both empty, then they are not used to determine
whether or not to trigger a build.
- If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file
globs. If the change has no files that are outside of the ignoredFiles globs,
then we do not trigger a build.
returned: success
type: list
includedFiles:
description:
- ignoredFiles and includedFiles are file glob matches using http://godoc/pkg/path/filepath#Match
extended with support for `**`.
- If any of the files altered in the commit pass the ignoredFiles filter and includedFiles
is empty, then as far as this filter is concerned, we should trigger the build.
- If any of the files altered in the commit pass the ignoredFiles filter and includedFiles
is not empty, then we make sure that at least one of those files matches a includedFiles
glob. If not, then we do not trigger a build.
returned: success
type: list
triggerTemplate:
description:
- Template describing the types of source changes to trigger a build.
- Branch and tag names in trigger templates are interpreted as regular expressions.
Any branch or tag change that matches that regular expression will trigger a build.
returned: success
type: complex
contains:
projectId:
description:
- ID of the project that owns the Cloud Source Repository. If omitted, the project
ID requesting the build is assumed.
returned: success
type: str
repoName:
description:
- Name of the Cloud Source Repository. If omitted, the name "default" is assumed.
returned: success
type: str
dir:
description:
- Directory, relative to the source root, in which to run the build.
- This must be a relative path. If a step's dir is specified and is an absolute
path, this value is ignored for that step's execution.
returned: success
type: str
branchName:
description:
- Name of the branch to build.
returned: success
type: str
tagName:
description:
- Name of the tag to build.
returned: success
type: str
commitSha:
description:
- Explicit commit SHA to build.
returned: success
type: str
build:
description:
- Contents of the build template.
returned: success
type: complex
contains:
tags:
description:
- Tags for annotation of a Build. These are not docker tags.
returned: success
type: list
images:
description:
- A list of images to be pushed upon the successful completion of all build
steps.
- The images are pushed using the builder service account's credentials.
- The digests of the pushed images will be stored in the Build resource's results
field.
- If any of the images fail to be pushed, the build status is marked FAILURE.
returned: success
type: list
steps:
description:
- The operations to be performed on the workspace.
returned: success
type: complex
contains:
name:
description:
- The name of the container image that will run this particular build step.
- If the image is available in the host's Docker daemon's cache, it will
be run directly. If not, the host will attempt to pull the image first,
using the builder service account's credentials if necessary.
- The Docker daemon's cache will already have the latest versions of all
of the officially supported build steps (U(https://github.com/GoogleCloudPlatform/cloud-builders).)
- The Docker daemon will also have cached many of the layers for some popular
images, like "ubuntu", "debian", but they will be refreshed at the time
you attempt to use them.
- If you built an image in a previous build step, it will be stored in the
host's Docker daemon's cache and is available to use as the name for a
later build step.
returned: success
type: str
args:
description:
- A list of arguments that will be presented to the step when it is started.
- If the image used to run the step's container has an entrypoint, the args
are used as arguments to that entrypoint. If the image does not define
an entrypoint, the first element in args is used as the entrypoint, and
the remainder will be used as arguments.
returned: success
type: list
'''
################################################################################
# Imports
################################################################################
from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest, remove_nones_from_dict, replace_resource_dict
import json
################################################################################
# Main
################################################################################
def main():
"""Main function"""
module = GcpModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
id=dict(type='str'),
description=dict(type='str'),
disabled=dict(type='str'),
substitutions=dict(type='dict'),
filename=dict(type='str'),
ignored_files=dict(type='list', elements='str'),
included_files=dict(type='list', elements='str'),
trigger_template=dict(
type='dict',
options=dict(
project_id=dict(type='str'),
repo_name=dict(default='default', type='str'),
dir=dict(type='str'),
branch_name=dict(type='str'),
tag_name=dict(type='str'),
commit_sha=dict(type='str'),
),
),
build=dict(
type='dict',
options=dict(
tags=dict(type='list', elements='str'),
images=dict(type='list', elements='str'),
steps=dict(type='list', elements='dict', options=dict(name=dict(type='str'), args=dict(type='list', elements='str'))),
),
),
),
mutually_exclusive=[['build', 'filename']],
)
if not module.params['scopes']:
module.params['scopes'] = ['https://www.googleapis.com/auth/cloud-platform']
state = module.params['state']
if module.params['id']:
fetch = fetch_resource(module, self_link(module))
else:
fetch = {}
changed = False
if fetch:
if state == 'present':
if is_different(module, fetch):
update(module, self_link(module))
fetch = fetch_resource(module, self_link(module))
changed = True
else:
delete(module, self_link(module))
fetch = {}
changed = True
else:
if state == 'present':
fetch = create(module, collection(module))
changed = True
else:
fetch = {}
fetch.update({'changed': changed})
module.exit_json(**fetch)
def create(module, link):
auth = GcpSession(module, 'cloudbuild')
return return_if_object(module, auth.post(link, resource_to_request(module)))
def update(module, link):
auth = GcpSession(module, 'cloudbuild')
return return_if_object(module, auth.patch(link, resource_to_request(module)))
def delete(module, link):
auth = GcpSession(module, 'cloudbuild')
return return_if_object(module, auth.delete(link))
def resource_to_request(module):
request = {
u'id': module.params.get('id'),
u'description': module.params.get('description'),
u'disabled': module.params.get('disabled'),
u'substitutions': module.params.get('substitutions'),
u'filename': module.params.get('filename'),
u'ignoredFiles': module.params.get('ignored_files'),
u'includedFiles': module.params.get('included_files'),
u'triggerTemplate': TriggerTriggertemplate(module.params.get('trigger_template', {}), module).to_request(),
u'build': TriggerBuild(module.params.get('build', {}), module).to_request(),
}
return_vals = {}
for k, v in request.items():
if v or v is False:
return_vals[k] = v
return return_vals
def fetch_resource(module, link, allow_not_found=True):
auth = GcpSession(module, 'cloudbuild')
return return_if_object(module, auth.get(link), allow_not_found)
def self_link(module):
return "https://cloudbuild.googleapis.com/v1/projects/{project}/triggers/{id}".format(**module.params)
def collection(module):
return "https://cloudbuild.googleapis.com/v1/projects/{project}/triggers".format(**module.params)
def return_if_object(module, response, allow_not_found=False):
# If not found, return nothing.
if allow_not_found and response.status_code == 404:
return None
# If no content, return nothing.
if response.status_code == 204:
return None
try:
module.raise_for_status(response)
result = response.json()
except getattr(json.decoder, 'JSONDecodeError', ValueError):
module.fail_json(msg="Invalid JSON response with error: %s" % response.text)
if navigate_hash(result, ['error', 'errors']):
module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
return result
def is_different(module, response):
request = resource_to_request(module)
response = response_to_hash(module, response)
# Remove all output-only from response.
response_vals = {}
for k, v in response.items():
if k in request:
response_vals[k] = v
request_vals = {}
for k, v in request.items():
if k in response:
request_vals[k] = v
return GcpRequest(request_vals) != GcpRequest(response_vals)
# Remove unnecessary properties from the response.
# This is for doing comparisons with Ansible's current parameters.
def response_to_hash(module, response):
return {
u'id': response.get(u'id'),
u'description': response.get(u'description'),
u'disabled': response.get(u'disabled'),
u'createTime': response.get(u'createTime'),
u'substitutions': response.get(u'substitutions'),
u'filename': response.get(u'filename'),
u'ignoredFiles': response.get(u'ignoredFiles'),
u'includedFiles': response.get(u'includedFiles'),
u'triggerTemplate': TriggerTriggertemplate(response.get(u'triggerTemplate', {}), module).from_response(),
u'build': TriggerBuild(response.get(u'build', {}), module).from_response(),
}
class TriggerTriggertemplate(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict(
{
u'projectId': self.request.get('project_id'),
u'repoName': self.request.get('repo_name'),
u'dir': self.request.get('dir'),
u'branchName': self.request.get('branch_name'),
u'tagName': self.request.get('tag_name'),
u'commitSha': self.request.get('commit_sha'),
}
)
def from_response(self):
return remove_nones_from_dict(
{
u'projectId': self.request.get(u'projectId'),
u'repoName': self.request.get(u'repoName'),
u'dir': self.request.get(u'dir'),
u'branchName': self.request.get(u'branchName'),
u'tagName': self.request.get(u'tagName'),
u'commitSha': self.request.get(u'commitSha'),
}
)
class TriggerBuild(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict(
{
u'tags': self.request.get('tags'),
u'images': self.request.get('images'),
u'steps': TriggerStepsArray(self.request.get('steps', []), self.module).to_request(),
}
)
def from_response(self):
return remove_nones_from_dict(
{
u'tags': self.request.get(u'tags'),
u'images': self.request.get(u'images'),
u'steps': TriggerStepsArray(self.request.get(u'steps', []), self.module).from_response(),
}
)
class TriggerStepsArray(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = []
def to_request(self):
items = []
for item in self.request:
items.append(self._request_for_item(item))
return items
def from_response(self):
items = []
for item in self.request:
items.append(self._response_from_item(item))
return items
def _request_for_item(self, item):
return remove_nones_from_dict({u'name': item.get('name'), u'args': item.get('args')})
def _response_from_item(self, item):
return remove_nones_from_dict({u'name': item.get(u'name'), u'args': item.get(u'args')})
if __name__ == '__main__':
main()
Reference in New Issue View Git Blame Copy Permalink