Added ldap_search module for searching in LDAP servers

[eryx12o45]

SUMMARY

Add a module for executing ldap_search commands on an LDAP server to query for entries which can be filtered by attributes or filterstrings.

ISSUE TYPE

• New Module Pull Request

COMPONENT NAME

ldap_search

ADDITIONAL INFORMATION

The module returns a json-based string with elements that match the filter.
I've found an old version by Peter Sagerson, which was not Python3 compatible and was not working as intended. I've updated the module for Python3 and Ansible 2.10 compatibility.

[eryx12o45]

@gundalow Please see the latest commit. All errors from the pipeline are already fixed now :-)

[felixfontein]

All new plugins should have tests. Please add unit and/or integration tests (even if the integration tests are unsupported for now).

[ansibullbot]

cc @nerzhul
click here for bot help

[ansibullbot]

@eryx12o45 this PR contains more than one new module.

Please submit only one new module per pull request. For a detailed explanation, please read the grouped modules documentation

click here for bot help

[Andersson007]

@gundalow @felixfontein shouldn't it be _info module?

[felixfontein]

@Andersson007 good question. I've been thinking about that a bit as well. _info would be formally correct, though it doesn't really convey what the module does. Maybe _query would be better, since there at least are a few modules called that way already (or at least were in 2.9; there was none called _search), and ldap_query would still be expressive enough for users to understand what it does. (From a module called ldap_info I would expect it retrieves general information about the LDAP server, like number of entries, server version, etc.)

[Andersson007]

@felixfontein maybe ldap_search_info?
the word query can assume it can be able to modify something (in general)

[felixfontein]

_search_info sounds strange, as if the module would return information about a search (instead of doing a search). And at least the English word query does not imply changes (https://www.merriam-webster.com/dictionary/query).

[Andersson007]

@felixfontein practicaly it can imply modifications https://www.postgresql.org/docs/current/sql-update.html for example

[felixfontein]

I would argue that anyone who is familiar with LDAP wouldn't assume this :) It would be really nice to have more opinions and ideas though...

[Andersson007]

@felixfontein search or query sound equal to me in terms of proper module naming:)
Interesting point is that should it be _info module if it returns only information?
If it's ok as it is now, it can be _search or _query:)

[Andersson007]

sorry, i didn't want to close the pr:) the idea LGTM:)

[felixfontein]

I don't think _info doesn't make that much sense for modules searching in databases (for most other cases, it is). This whole thing would also make sense as a lookup plugin, but (and a very important but) these can only be run on the controller, not on the remote nodes. Which for example would make it impossible for me to use this if it were a lookup plugin.

[Andersson007]

@felixfontein ok, so ldap_search for me personally sounds good)

[felixfontein]

Ok, so if nobody else has an opinion, let's keep ldap_search :)

[eryx12o45]

@felixfontein @Andersson007 Thanks a lot four your support here. I've updated the code with your suggestions. Hopefully the way you've meant them ^^

[felixfontein]

LGTM

[Andersson007]

LGTM, thank you guys
shipit

[felixfontein]

@eryx12o45 thanks a lot for reviving and updating this module, and especially for adding tests! :)

[eryx12o45]

@felixfontein @gundalow @Andersson007 Thanks a lot. Would it be possible to get a new release 0.1.2 of the collection, because otherwise unfortunately I'm not able to install it via ansible-galaxy :-/

[felixfontein]

@eryx12o45 it definitely won't be 0.1.2, since according to semantic versioning patch releases cannot have new features :) I'm not sure when a new release will happen; the discussion how release manangement etc. should go are still going on.

[eryx12o45]

@felixfontein I see, sorry didn't had that insight before, but this absolutely makes sense.

[felixfontein]

@eryx12o45 no problem, the current versioning docs are not really there / somewhat hidden, and the whole discussion is also happening pretty hidden... there are a lot more people wondering on what's happening ;)

[felixfontein]

@eryx12o45 ansible/ansible#69154 will allow to install collections from git repositories

[eryx12o45]

@felixfontein Great! Thanks a lot.