mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
9489a1ea1c
* gio_mime: new module * multiple changes - fixed gio_mime module utils handler detection - add message to test helper assertion - add unit test * gio mime output uses unicode smart quotes * test helper: do not use skip/xfail reason messages - break in old pytest * Update plugins/modules/gio_mime.py Co-authored-by: Felix Fontein <felix@fontein.de> * change exist variables to meet standards --------- Co-authored-by: Felix Fontein <felix@fontein.de>
108 lines
3.2 KiB
Python
108 lines
3.2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2022, Alexei Znamensky <russoz@gmail.com>
|
|
# 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 absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
module: gio_mime
|
|
author:
|
|
- "Alexei Znamensky (@russoz)"
|
|
short_description: Set default handler for MIME type, for applications using Gnome GIO
|
|
version_added: 7.5.0
|
|
description:
|
|
- This module allows configuring the default handler for a specific MIME type, to be used by applications built with th Gnome GIO API.
|
|
extends_documentation_fragment:
|
|
- community.general.attributes
|
|
attributes:
|
|
check_mode:
|
|
support: full
|
|
diff_mode:
|
|
support: full
|
|
options:
|
|
mime_type:
|
|
description:
|
|
- MIME type for which a default handler will be set.
|
|
type: str
|
|
required: true
|
|
handler:
|
|
description:
|
|
- Default handler will be set for the MIME type.
|
|
type: str
|
|
required: true
|
|
notes:
|
|
- This module is a thin wrapper around the C(gio mime) command (and subcommand).
|
|
- See man gio(1) for more details.
|
|
seealso:
|
|
- name: GIO Documentation
|
|
description: Reference documentation for the GIO API..
|
|
link: https://docs.gtk.org/gio/
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
- name: Set chrome as the default handler for https
|
|
community.general.gio_mime:
|
|
mime_type: x-scheme-handler/https
|
|
handler: google-chrome.desktop
|
|
register: result
|
|
"""
|
|
|
|
RETURN = '''
|
|
handler:
|
|
description:
|
|
- The handler set as default.
|
|
returned: success
|
|
type: str
|
|
sample: google-chrome.desktop
|
|
stdout:
|
|
description:
|
|
- The output of the C(gio) command.
|
|
returned: success
|
|
type: str
|
|
sample: Set google-chrome.desktop as the default for x-scheme-handler/https
|
|
stderr:
|
|
description:
|
|
- The error output of the C(gio) command.
|
|
returned: failure
|
|
type: str
|
|
sample: 'gio: Failed to load info for handler "never-existed.desktop"'
|
|
'''
|
|
|
|
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
|
|
from ansible_collections.community.general.plugins.module_utils.gio_mime import gio_mime_runner, gio_mime_get
|
|
|
|
|
|
class GioMime(ModuleHelper):
|
|
output_params = ['handler']
|
|
module = dict(
|
|
argument_spec=dict(
|
|
mime_type=dict(type='str', required=True),
|
|
handler=dict(type='str', required=True),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
def __init_module__(self):
|
|
self.runner = gio_mime_runner(self.module, check_rc=True)
|
|
self.vars.set_meta("handler", initial_value=gio_mime_get(self.runner, self.vars.mime_type), diff=True, change=True)
|
|
|
|
def __run__(self):
|
|
check_mode_return = (0, 'Module executed in check mode', '')
|
|
if self.vars.has_changed("handler"):
|
|
with self.runner.context(args_order=["mime_type", "handler"], check_mode_skip=True, check_mode_return=check_mode_return) as ctx:
|
|
rc, out, err = ctx.run()
|
|
self.vars.stdout = out
|
|
self.vars.stderr = err
|
|
if self.verbosity >= 4:
|
|
self.vars.run_info = ctx.run_info
|
|
|
|
|
|
def main():
|
|
GioMime.execute()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|