project_openldap: PR tracker

[simonLeary42]

This issue gives an overview for a number of open and future pull requests regarding the project_openldap plugin. I would like to limit the scope of this issue to progress, conflicts, order of operations, and future work. Specifics for any PR should be discussed in that PR.

Short Name	PR	Author	Questions?	Reviewed?	Merged?
unbind	#810	DS, SL
typo	#823	SL
owner	#826	DS
catch	#806	SL		✅	✅
archive	#812	SL	yes
utils	#825	SL	yes
generic	#807	SL		✅	✅
docs	#818	SL	yes

unbind, typo, owner, catch are all quite small and should be mergeable without much scrunity or any merge conflicts.

archive

This is a small change in terms of line count, but if merged as-is it may surprise users.

utils

This is a big change in terms of line count and error handling, but for normal usage not much should be any different. The changes are limited to utils.py, and no existing arguments or return values are changed. I say "existing" because some functions return a value (success/skipped/failure) where they used to return void.

generic

This is a pretty straightforward change, without any side effects. It is likely to conflict with utils, but the conflict resolution shouldn't be too difficult. I think conflict resolution would be easier if this is merged first and utils second.

This PR was created with the goal of allocation_openldap compatibility, but there are other obstacles and I'm unsure if it's still a worthy goal. I think the changes make sense even without this goal.

docs

This PR is much bigger than just project_openldap, but it does add documentation. Substantial merge conflicts are unlikely.

Future Work

• error handling
  • ideally, any failure in these utils should give the user an alert, where currently some fail silently and others show an "internal server error" page
  • the true/false return value from the "writing" functions can be useful here
• testing
  • https://ldap3.readthedocs.io/en/latest/mocking.html
• allocation_openldap compatibility