From 67eac8d7c0a53b453bb73d5e7385e0042033c4ab Mon Sep 17 00:00:00 2001 From: The Magician Date: Wed, 20 Feb 2019 10:11:28 -0800 Subject: [PATCH] New Module: gcp_cloudbuild_trigger_facts (#52622) --- .../google/gcp_cloudbuild_trigger_facts.py | 271 ++++++++++++++++++ 1 file changed, 271 insertions(+) create mode 100644 lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger_facts.py diff --git a/lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger_facts.py b/lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger_facts.py new file mode 100644 index 00000000000..ee929ff1945 --- /dev/null +++ b/lib/ansible/modules/cloud/google/gcp_cloudbuild_trigger_facts.py @@ -0,0 +1,271 @@ +#!/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_facts +description: +- Gather facts for GCP Trigger +short_description: Gather facts for GCP Trigger +version_added: 2.8 +author: Google Inc. (@googlecloudplatform) +requirements: +- python >= 2.6 +- requests >= 2.18.4 +- google-auth >= 1.3.0 +options: {} +extends_documentation_fragment: gcp +''' + +EXAMPLES = ''' +- name: a trigger facts + gcp_cloudbuild_trigger_facts: + project: test_project + auth_kind: serviceaccount + service_account_file: "/tmp/auth.pem" +''' + +RETURN = ''' +items: + description: List of items + returned: always + type: complex + contains: + 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 +import json + +################################################################################ +# Main +################################################################################ + + +def main(): + module = GcpModule(argument_spec=dict()) + + if not module.params['scopes']: + module.params['scopes'] = ['https://www.googleapis.com/auth/cloud-platform'] + + items = fetch_list(module, collection(module)) + if items.get('triggers'): + items = items.get('triggers') + else: + items = [] + return_value = {'items': items} + module.exit_json(**return_value) + + +def collection(module): + return "https://cloudbuild.googleapis.com/v1/projects/{project}/triggers".format(**module.params) + + +def fetch_list(module, link): + auth = GcpSession(module, 'cloudbuild') + response = auth.get(link) + return return_if_object(module, response) + + +def return_if_object(module, response): + # If not found, return nothing. + if 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) as inst: + module.fail_json(msg="Invalid JSON response with error: %s" % inst) + + if navigate_hash(result, ['error', 'errors']): + module.fail_json(msg=navigate_hash(result, ['error', 'errors'])) + + return result + + +if __name__ == "__main__": + main()