make gio_mime XDG-compliant

[mhalano]

Summary

My idea is to add to gio_mime module support to use xdg-mime command as well, so if a system doesn't have gio available it will use xdg-mime instead.
Of course, gio should be the first choice and fallback to xdg-mime when gio isn't present.
Possible it would be necessary to change the name from gio_mime to something like just mime, but I couldn't find a module with this name, and also we could think to add other functions, like mime detection or opening a file using mime, like xdg-open or gio open.

Issue Type

Feature Idea

Component Name

gio_mime

Additional Information

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibullbot]

Files identified in the description:

• plugins/modules/gio_mime.py

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibullbot]

cc @russoz
click here for bot help

[russoz]

Hi @mhalano

Bah guri! 🇧‍🇷 Well, thanks for the pointer to xdg-mime, it definitely looks like a better way to manage the mime handlers, but I don't think we should make one module to handle both commands. I think this should be a new module - I am happy to take it upon myself to write, but I cannot promise when, or - if you would like to give it a go at writing a module (you can replicate the sutff from gio mime), I'd be happy to help you along the way.

[mhalano]

I understand. You can develop when you have time. No hush. I just suggested to use one or the other as fallback, but if you think we need a xdg_mime module that's also fine. I think the person who will use the module can deal with the logic to check what option is available in the system.
But the suggestion to add other functions, like open and mime detection, is still valid for both modules.

[mhalano]

@russoz I did a first try as you suggested, replacing "gio" by "xdg", but I got stuck here:

➜ ANSIBLE_LIBRARY=. ansible localhost -m xdg_mime -a 'mime_type=x-scheme-handler/https handler=google-chrome.desktop' --playbook-dir=$PWD 
[WARNING]: No inventory was parsed, only implicit localhost is available
localhost | FAILED! => {
    "changed": false,
    "msg": "New-style module did not handle its own exit"
}

I really don't know what to do to work around this. It seems necessary to add exit_json() and/or fail_json() calls, but I don't know exactly where.
Anyway, if you want to take the code and work from it, here are my changes.

Thanks.

[mhalano]

@russoz I have an idea, please let me know what you think about it: if you modernize the code for your module with the newer changes, like this one about treating the exit, I can use it to develop my code.
There is no much change between using gio and xdg-mime directly, I thinl.

[russoz]

Hi @mhalano May you please submit the PR, so that the CI tests run and it's easier for us to make suggestions to your code?

BTW, thanks for working on it.

I believe you are talking about modernizing the code because of the message referring to "New-style module" - if that's the case, the new style it refers to was new many years ago. The gio_mime module (and others here) use ModuleHelper to take care of that part. It is not clear to me why your code is failing right now but as mentioned before, it is easier to deal with that situation in a pull request.

You might want to consider reading about ModuleHelper. See more in https://docs.ansible.com/ansible/latest/collections/community/general/docsite/guide_modulehelper.html

And also about CmdRunner, used to run the CLI command. See https://docs.ansible.com/ansible/latest/collections/community/general/docsite/guide_cmdrunner.html for more details.

[russoz]

BTW, you will need to write tests for a new module, I suggest you replicate the gio_mime unit tests, and if you are, by any chance excited about the reading 😆 , we have docs for that as well:
https://docs.ansible.com/ansible/latest/collections/community/general/docsite/guide_uthelper.html

[mhalano]

@russoz As requested: #10007