mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-04 07:51:50 +00:00
1eca76969a
remove required=false from docs (#11055)
(cherry picked from commit a9a4f89033)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
120 lines
3.2 KiB
Python
120 lines
3.2 KiB
Python
#!/usr/bin/python
|
|
#
|
|
# Copyright Ansible Project
|
|
# 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: grove
|
|
short_description: Sends a notification to a grove.io channel
|
|
description:
|
|
- The C(grove) module sends a message for a service to a Grove.io channel.
|
|
extends_documentation_fragment:
|
|
- community.general.attributes
|
|
attributes:
|
|
check_mode:
|
|
support: none
|
|
diff_mode:
|
|
support: none
|
|
options:
|
|
channel_token:
|
|
type: str
|
|
description:
|
|
- Token of the channel to post to.
|
|
required: true
|
|
service:
|
|
type: str
|
|
description:
|
|
- Name of the service (displayed as the "user" in the message).
|
|
default: ansible
|
|
message_content:
|
|
type: str
|
|
description:
|
|
- Message content.
|
|
- The alias O(ignore:message) has been removed in community.general 4.0.0.
|
|
required: true
|
|
url:
|
|
type: str
|
|
description:
|
|
- Service URL for the web client.
|
|
icon_url:
|
|
type: str
|
|
description:
|
|
- Icon for the service.
|
|
validate_certs:
|
|
description:
|
|
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
|
|
certificates.
|
|
default: true
|
|
type: bool
|
|
author: "Jonas Pfenniger (@zimbatm)"
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: Sends a notification to a grove.io channel
|
|
community.general.grove:
|
|
channel_token: 6Ph62VBBJOccmtTPZbubiPzdrhipZXtg
|
|
service: my-app
|
|
message: 'deployed {{ target }}'
|
|
"""
|
|
|
|
from urllib.parse import urlencode
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.urls import fetch_url
|
|
|
|
|
|
BASE_URL = "https://grove.io/api/notice/%s/"
|
|
|
|
# ==============================================================
|
|
# do_notify_grove
|
|
|
|
|
|
def do_notify_grove(module, channel_token, service, message, url=None, icon_url=None):
|
|
my_url = BASE_URL % (channel_token,)
|
|
|
|
my_data = dict(service=service, message=message)
|
|
if url is not None:
|
|
my_data["url"] = url
|
|
if icon_url is not None:
|
|
my_data["icon_url"] = icon_url
|
|
|
|
data = urlencode(my_data)
|
|
response, info = fetch_url(module, my_url, data=data)
|
|
if info["status"] != 200:
|
|
module.fail_json(msg=f"failed to send notification: {info['msg']}")
|
|
|
|
|
|
# ==============================================================
|
|
# main
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
channel_token=dict(type="str", required=True, no_log=True),
|
|
message_content=dict(type="str", required=True),
|
|
service=dict(type="str", default="ansible"),
|
|
url=dict(type="str"),
|
|
icon_url=dict(type="str"),
|
|
validate_certs=dict(default=True, type="bool"),
|
|
)
|
|
)
|
|
|
|
channel_token = module.params["channel_token"]
|
|
service = module.params["service"]
|
|
message = module.params["message_content"]
|
|
url = module.params["url"]
|
|
icon_url = module.params["icon_url"]
|
|
|
|
do_notify_grove(module, channel_token, service, message, url, icon_url)
|
|
|
|
# Mission complete
|
|
module.exit_json(msg="OK")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|