add sssd_info module #11120
Open
add sssd_info module #11120
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ansibullbot
added
module
This comment was marked as outdated.
This comment was marked as outdated.
ansibullbot
added
the
needs_revision
felixfontein
added
check-before-release
russoz
reviewed
Nov 14, 2025
Collaborator
russoz
left a comment
russoz
left a comment
There was a problem hiding this comment.
Hi @MikeyTide
Thanks for the contribution! I left some comments in there for you, and I strongly suggest you read more documentation as you proceed.
Author
|
@russoz Hi, thank you for reviewing my pull request. I have made the necessary fixes. If you have time, please take another look. |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
russoz
reviewed
Dec 2, 2025
Collaborator
There was a problem hiding this comment.
hi @MikeyTide thanks for your contribution!
Please see my initial comments.
plugins/modules/sssd_info.py
Outdated
Comment on lines
118
to
124
| DBUS_IMP_ERR = None | ||
| HAS_DBUS = False | ||
| try: | ||
| import dbus | ||
| HAS_DBUS = True | ||
| except Exception: | ||
| DBUS_IMP_ERR = traceback.format_exc() |
Collaborator
There was a problem hiding this comment.
You might want to consider using module_utils.deps, see https://docs.ansible.com/ansible/latest/collections/community/general/docsite/guide_deps.html for guidance on how to use it.
Author
There was a problem hiding this comment.
Hi @russoz, thank you so much for showing me this module. I tried using it, could you take a look at this specific comment? That way I don't have to push the entire code.
Thanks in advance for helping with my pull request.
....
....
import traceback
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
try:
from ansible_collections.community.general.plugins.module_utils import deps
with deps.declare("dbus-python"):
import dbus
HAS_DBUS = True
DBUS_IMP_ERR = None
except Exception as e:
HAS_DBUS = False
DBUS_IMP_ERR = e
....
....
def main() -> None:
....
....
try:
from ansible_collections.community.general.plugins.module_utils import deps
deps.validate(module)
except ImportError:
if not HAS_DBUS:
from ansible.module_utils.basic import missing_required_lib
module.fail_json(msg=missing_required_lib('dbus-python'))
....
....
if name == 'main':
main()
Collaborator
There was a problem hiding this comment.
hi @MikeyTide
Use "```" before and after code in GH comments, it makes the code block readable.
Now, that being said, I would suggest you go through that documentation one more time, carefully, because you are still trying to use the old mechanism together with deps and that makes it a bit confusing.
You may want to check on other modules that use deps (search for "import deps" and you will hit many of them here). In particular, one that is relatively simple is
|
|
||
| DOCUMENTATION = r''' | ||
| --- | ||
| module: sssd_info |
Collaborator
There was a problem hiding this comment.
Suggested change
| module: sssd_info | |
| module: sssd_info | |
| version_added: 12.1.0 |
Collaborator
There was a problem hiding this comment.
actually 12.1.0 was released a couple of days ago, you need to bump this up to 12.2.0 now
Comment on lines
+7
to
+14
| - id: test_domain_status_online | ||
| input: | ||
| action: domain_status | ||
| domain: example.com | ||
| output: | ||
| online: online | ||
| mocks: | ||
| run_command: [] |
Collaborator
There was a problem hiding this comment.
In the current state, uthelper is useless for modules that do not run external commands (with run_command()).
That is likely the reason why the tests are currently failing. In your case, the module interacts with D-Bus using the corresponding Python package, but you will have to mock the calls to that library, otherwise your module will actually try to contact the sssd daemon, through D-Bus, during the CI run. Which is obviously going to fail.
added 2 commits
December 2, 2025 21:05
Collaborator
|
The test The test The test The test The test The test The test The test The test The test The test The test The test The test The test The test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
This pull request adds a new module
sssd_infothat allows users to check SSSD domain status and retrieve domain information using D-Bus.The module provides the following actions:
domain_status- Check if a specific domain is onlinedomain_list- List all configured SSSD domainsactive_servers- Get active servers for a specific domain and server type (IPA/AD)list_servers- List all servers for a specific domain and server type (IPA/AD)ISSUE TYPE
COMPONENT NAME
sssd_info
ADDITIONAL INFORMATION
The module uses D-Bus to communicate with SSSD's infopipe interface, providing reliable and direct access to SSSD status information without relying on command-line tools.
Key features:
Example usage: