feature/mx-1455-document-ldap-extractor

[rababerladuseladim]

This adds general documentation for the ldap extractor.

While reviewing the tests I noticed that they cover none of the convenience functions (ldap.extract). Should I create a ticket for that?

[mr-kamran-ali]

Very clear to me.

[mr-kamran-ali]

I think there should be tests for ldap.extract convenience functions. yes, please create a ticket.

[rababerladuseladim]

I think there should be tests for ldap.extract convenience functions. yes, please create a ticket.

See https://jira.rki.local/browse/MX-1477

[erichesse]

mex/common/ldap/README.md::line28ff

I'm irritated by the fact, that ldap.extract is described as a module for convenience functions only. the naming implies that the extract part of the ETL pipeline happens here. But actually that happens in ldap.connect.

if ldap.extract is for helper functions to build a mapping, maybe it should be rename to map.py or something. And ldap.connector should be renamed to ldap.extract.

I am open to other solutions, but right now, I find the structure to be misleading.

Otherwise I like the README, good work

@rababerladuseladim

[rababerladuseladim]

That is indeed a point. I noticed that, too while writing the docs but did not know how to address this. Connectors are a common theme, so I'd rather leave the connector module untouched. Regarding the helper functions: In the organigram extractor these also reside in extract.py, hence I'd like to leave that in sync, too. One idea might be to add a new utils.py module and move any helper functionality in there. What do you think?

[erichesse]

yes, sounds good to me

[rababerladuseladim]

I created a ticket: https://jira.rki.local/browse/MX-1479