#!/usr/bin/python # Copyright 2014, Max Riveiro, # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import annotations DOCUMENTATION = r""" module: rollbar_deployment author: "Max Riveiro (@kavu)" short_description: Notify Rollbar about app deployments description: - Notify Rollbar about app deployments (see U(https://rollbar.com/docs/deploys_other/)). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: token: type: str description: - Your project access token. required: true environment: type: str description: - Name of the environment being deployed, for example V(production). required: true revision: type: str description: - Revision number/sha being deployed. required: true user: type: str description: - User who deployed. rollbar_user: type: str description: - Rollbar username of the user who deployed. comment: type: str description: - Deploy comment (for example what is being deployed). url: type: str description: - Optional URL to submit the notification to. default: 'https://api.rollbar.com/api/1/deploy/' validate_certs: description: - If V(false), SSL certificates for the target URL are not validated. This should only be used on personally controlled sites using self-signed certificates. default: true type: bool """ EXAMPLES = r""" - name: Rollbar deployment notification community.general.rollbar_deployment: token: AAAAAA environment: staging user: ansible revision: '4.2' rollbar_user: admin comment: Test Deploy - name: Notify rollbar about current git revision deployment by current user community.general.rollbar_deployment: token: "{{ rollbar_access_token }}" environment: production revision: "{{ lookup('pipe', 'git rev-parse HEAD') }}" user: "{{ lookup('env', 'USER') }}" """ import traceback from urllib.parse import urlencode from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url def main(): module = AnsibleModule( argument_spec=dict( token=dict(required=True, no_log=True), environment=dict(required=True), revision=dict(required=True), user=dict(), rollbar_user=dict(), comment=dict(), url=dict(default="https://api.rollbar.com/api/1/deploy/"), validate_certs=dict(default=True, type="bool"), ), supports_check_mode=True, ) if module.check_mode: module.exit_json(changed=True) params = dict( access_token=module.params["token"], environment=module.params["environment"], revision=module.params["revision"], ) if module.params["user"]: params["local_username"] = module.params["user"] if module.params["rollbar_user"]: params["rollbar_username"] = module.params["rollbar_user"] if module.params["comment"]: params["comment"] = module.params["comment"] url = module.params.get("url") try: data = urlencode(params) response, info = fetch_url(module, url, data=data, method="POST") except Exception as e: module.fail_json(msg=f"Unable to notify Rollbar: {e}", exception=traceback.format_exc()) else: if info["status"] == 200: module.exit_json(changed=True) else: module.fail_json(msg=f"HTTP result code: {info['status']} connecting to {url}") if __name__ == "__main__": main()