Add xdg_mime module by mhalano · Pull Request #10007 · ansible-collections/community.general

mhalano · 2025-04-18T10:04:29Z

SUMMARY

Adds a new module called xdg_mime. It's based on gio_mime module, but it uses xdg-mime instead of gio to do the configuration.
My first idea was to create a more generic module called mime, but @russoz suggested creating a separated module. Maybe the could merge in the future.

ISSUE TYPE

New Module/Plugin Pull Request

COMPONENT NAME

xdg_mime

ADDITIONAL INFORMATION

russoz

hi @mhalano thanks for pursuing this.

There are some adjustments to be made, please check the comments below.

Also, you will need to:

add yourself to the BOTMETA file as the owner of the two files (in module_utils and modules, respectively), and
add tests - which I again encourage you to replicate the logic for unit testing gio_mime.

plugins/module_utils/xdg_mime.py

plugins/modules/xdg_mime.py

mhalano · 2025-04-19T13:32:09Z

Added myself to BOTMETA. Now I fixing the unit tests.

mhalano · 2025-04-19T13:42:00Z

Tests passing (a.k.a. "works on my machine")

mhalano · 2025-04-19T13:43:40Z

I found out that xdg-mime won't set the handler when we are dealing with an invalid handler, let's say firefox2.desktop or firefox.desktop2, instead of the correct one, firefox.desktop. It will always try to change it. If the handler is valid, like firefox.desktop, idempotency will work ok.

felixfontein · 2025-04-23T19:33:43Z

@felixfontein May I add a comment at the beginning of the file with a dedicatory to my grandma? She passed away on Easters Day when I was doing this, and I would like to dedicate to her.
I will understand If I can't.

Sincere condolences!

That's fine for me. I would place it after the copyright/license statements (separated by at least one empty line).

plugins/modules/xdg_mime.py

Co-authored-by: Felix Fontein <felix@fontein.de>

ansibullbot · 2025-04-23T19:56:39Z

@mhalano This PR was evaluated as a potentially problematic PR for the following reasons:

More than 50 commits.

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on Libera.chat IRC

click here for bot help

russoz · 2025-04-23T20:06:07Z

@mhalano meus sentimentos a você e sua família! Espero que esta distração tenha ajudado a aliviar um pouco do peso desses dias.

By all means, add it there.

plugins/modules/xdg_mime.py

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

russoz

LGTM

patchback · 2025-04-26T10:34:07Z

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/373334d6684139dbf2ce5aca1de2cce019a816e0/pr-10007

Backported as #10072

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

* Add version of xdg_mime module * Fix xdg_mime_get since the command is different * Add query parameter * Fix order of parameters * Add myself to BOTMETA * Add unit tests * Fix the way we deal when there is no handler set * Improve documentation * Remove unused import * Fix documentation * Strip xdg-mime from version string * Fix information about version * Add error message sample * Add test to invalid handler * Add support to multiple mime-types * Change the output parameter from handlers to handler * Change tests related to multiple mime-type support * Small fixes * Stop using constant to enable changed state * Add before_handlers and after_handlers * Change tests to use before and after structures * Add a stronger message about using a non-installed handler * Manage some edge cases * Change error message to match the new value * Add some fixes * Change some tests * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Remove a blank line * Remove single quote * Add xdg-mime to the version in the mocks * Remove after_handlers and make code simpler * Update tests to work without after_handlers * Remove diff_params and clean output_params * Make mime_type plural since it supports multiple items * Move the handler check to module init * Use anchors in the test to make yaml simpler * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Add blank line to separe examples * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Add a small homage to my late grandma * Update plugins/modules/xdg_mime.py Co-authored-by: Felix Fontein <felix@fontein.de> * Fix pep8 problem with the homage * Remove trailing whitespace * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --------- Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 373334d)

felixfontein · 2025-04-26T10:35:59Z

@mhalano thanks for your contribution!
@russoz thanks for reviewing!

Add xdg_mime module (#10007) * Add version of xdg_mime module * Fix xdg_mime_get since the command is different * Add query parameter * Fix order of parameters * Add myself to BOTMETA * Add unit tests * Fix the way we deal when there is no handler set * Improve documentation * Remove unused import * Fix documentation * Strip xdg-mime from version string * Fix information about version * Add error message sample * Add test to invalid handler * Add support to multiple mime-types * Change the output parameter from handlers to handler * Change tests related to multiple mime-type support * Small fixes * Stop using constant to enable changed state * Add before_handlers and after_handlers * Change tests to use before and after structures * Add a stronger message about using a non-installed handler * Manage some edge cases * Change error message to match the new value * Add some fixes * Change some tests * Update plugins/modules/xdg_mime.py * Remove a blank line * Remove single quote * Add xdg-mime to the version in the mocks * Remove after_handlers and make code simpler * Update tests to work without after_handlers * Remove diff_params and clean output_params * Make mime_type plural since it supports multiple items * Move the handler check to module init * Use anchors in the test to make yaml simpler * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Update plugins/modules/xdg_mime.py * Add blank line to separe examples * Update plugins/modules/xdg_mime.py * Add a small homage to my late grandma * Update plugins/modules/xdg_mime.py * Fix pep8 problem with the homage * Remove trailing whitespace * Update plugins/modules/xdg_mime.py --------- (cherry picked from commit 373334d) Co-authored-by: Marcos Alano <mhalano@users.noreply.github.com> Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> Co-authored-by: Felix Fontein <felix@fontein.de>

* Add version of xdg_mime module * Fix xdg_mime_get since the command is different * Add query parameter * Fix order of parameters * Add myself to BOTMETA * Add unit tests * Fix the way we deal when there is no handler set * Improve documentation * Remove unused import * Fix documentation * Strip xdg-mime from version string * Fix information about version * Add error message sample * Add test to invalid handler * Add support to multiple mime-types * Change the output parameter from handlers to handler * Change tests related to multiple mime-type support * Small fixes * Stop using constant to enable changed state * Add before_handlers and after_handlers * Change tests to use before and after structures * Add a stronger message about using a non-installed handler * Manage some edge cases * Change error message to match the new value * Add some fixes * Change some tests * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Remove a blank line * Remove single quote * Add xdg-mime to the version in the mocks * Remove after_handlers and make code simpler * Update tests to work without after_handlers * Remove diff_params and clean output_params * Make mime_type plural since it supports multiple items * Move the handler check to module init * Use anchors in the test to make yaml simpler * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Add blank line to separe examples * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Add a small homage to my late grandma * Update plugins/modules/xdg_mime.py Co-authored-by: Felix Fontein <felix@fontein.de> * Fix pep8 problem with the homage * Remove trailing whitespace * Update plugins/modules/xdg_mime.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --------- Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> Co-authored-by: Felix Fontein <felix@fontein.de>

mhalano added 2 commits April 16, 2025 21:09

Add version of xdg_mime module

f656618

Fix xdg_mime_get since the command is different

68f99c0

mhalano mentioned this pull request Apr 18, 2025

make gio_mime XDG-compliant #9988

Open

1 task

ansibullbot added WIP Work in progress module module module_utils module_utils new_contributor Help guide this first time contributor plugins plugin (any type) labels Apr 18, 2025

This comment was marked as resolved.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI has_issue labels Apr 18, 2025

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-10 Automatically create a backport for the stable-10 branch labels Apr 18, 2025

russoz reviewed Apr 19, 2025

View reviewed changes

mhalano added 2 commits April 19, 2025 09:19

Add query parameter

2bac2c3

Fix order of parameters

8ad12d8

ansibullbot added ci_verified Push fixes to PR branch to re-run CI and removed ci_verified Push fixes to PR branch to re-run CI labels Apr 19, 2025

Add myself to BOTMETA

652c959

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Apr 19, 2025

mhalano added 3 commits April 19, 2025 10:39

Add unit tests

dc73fb5

Fix the way we deal when there is no handler set

4404de3

Improve documentation

b112e41

ansibullbot added new_plugin New plugin tests tests unit tests/unit labels Apr 19, 2025

Remove unused import

c04754b

ansibullbot removed merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Apr 23, 2025

Add a small homage to my late grandma

0c78dc7

felixfontein reviewed Apr 23, 2025

View reviewed changes

plugins/modules/xdg_mime.py Outdated Show resolved Hide resolved

Update plugins/modules/xdg_mime.py

6c745c1

Co-authored-by: Felix Fontein <felix@fontein.de>

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Apr 23, 2025

Fix pep8 problem with the homage

3421953

ansibullbot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html and removed ci_verified Push fixes to PR branch to re-run CI labels Apr 23, 2025

Remove trailing whitespace

d9cfe4b

russoz reviewed Apr 23, 2025

View reviewed changes

plugins/modules/xdg_mime.py Outdated Show resolved Hide resolved

Update plugins/modules/xdg_mime.py

1371c45

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

russoz approved these changes Apr 23, 2025

View reviewed changes

felixfontein merged commit 373334d into ansible-collections:main Apr 26, 2025
135 checks passed

patchback bot mentioned this pull request Apr 26, 2025

[PR #10007/373334d6 backport][stable-10] Add xdg_mime module #10072

Merged

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Apr 26, 2025

mhalano deleted the add-xdg-mime-module branch April 26, 2025 17:04

Conversation

mhalano commented Apr 18, 2025

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Uh oh!

This comment was marked as resolved.

russoz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mhalano commented Apr 19, 2025

Uh oh!

mhalano commented Apr 19, 2025

Uh oh!

mhalano commented Apr 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

felixfontein commented Apr 23, 2025

Uh oh!

Uh oh!

This comment was marked as outdated.

ansibullbot commented Apr 23, 2025

Uh oh!

russoz commented Apr 23, 2025

Uh oh!

Uh oh!

russoz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

patchback bot commented Apr 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Backport to stable-10: 💚 backport PR created

Uh oh!

felixfontein commented Apr 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mhalano commented Apr 19, 2025 •

edited

Loading

patchback bot commented Apr 26, 2025 •

edited

Loading