Summary

Modernize the LDAP backend.

Review Request #11355 — Created Dec. 29, 2020 and submitted Jan. 6, 2021, 11:44 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-4.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This fixes up the LDAP backend to work correctly with Python 2 and 3. We
now initialize LDAP with bytes_mode=False, which will ensure that
python-ldap will use Unicode strings for all input and output on both
Python 2 and 3. It's the rough equivalent of a unicode_literals
import. That allows us to remove all the casting, which didn't work on
Python 3 anyway without emitting warnings.

Log output has been cleaned up, with some improved log output and a
dedicated logger.

The unit tests have been improved considerably. We now use spies to
track calls, rather than overriding the LDAPObject with a per-test
subclass. This allows us to ensure these overridden functions are
actually called, which was just an assumption we made before.

We didn't require LDAP support for development in the past, which meant
that some tests recently regressed. It's now a development-time
dependency. We also require a modern version for production.

Testing Done

Unit tests pass for all versions of Python.

Commits

Summary	ID
Modernize the LDAP backend. This fixes up the LDAP backend to work correctly with Python 2 and 3. We now initialize LDAP with `bytes_mode=False`, which will ensure that `python-ldap` will use Unicode strings for all input and output on both Python 2 and 3. It's the rough equivalent of a `unicode_literals` import. That allows us to remove all the casting, which didn't work on Python 3 anyway without emitting warnings. Log output has been cleaned up, with some improved log output and a dedicated logger. The unit tests have been improved considerably. We now use spies to track calls, rather than overriding the `LDAPObject` with a per-test subclass. This allows us to ensure these overridden functions are actually called, which was just an assumption we made before. We didn't require LDAP support for development in the past, which meant that some tests recently regressed. It's now a development-time dependency. We also require a modern version for production.	ca77e76fbf4fefd2b4e75485c4855458943e0bdd

Summary

Modernize the LDAP backend.

This fixes up the LDAP backend to work correctly with Python 2 and 3. We now initialize LDAP with `bytes_mode=False`, which will ensure that `python-ldap` will use Unicode strings for all input and output on both Python 2 and 3. It's the rough equivalent of a `unicode_literals` import. That allows us to remove all the casting, which didn't work on Python 3 anyway without emitting warnings. Log output has been cleaned up, with some improved log output and a dedicated logger. The unit tests have been improved considerably. We now use spies to track calls, rather than overriding the `LDAPObject` with a per-test subclass. This allows us to ensure these overridden functions are actually called, which was just an assumption we made before. We didn't require LDAP support for development in the past, which meant that some tests recently regressed. It's now a development-time dependency. We also require a modern version for production.

ca77e76fbf4fefd2b4e75485c4855458943e0bdd

Issues

Description	From	Last Updated
F811 redefinition of unused 'test_get_or_create_user_with_given_name_attr' from line 271	reviewbot	Dec. 29, 2020, 8:24 p.m.
Wrapping here is a little weird--I'd say either every arg on its own line or wrap to width, but not …	david	Jan. 6, 2021, 11:43 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/accounts/tests/test_ldap_auth_backend.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F811 redefinition of unused 'test_get_or_create_user_with_given_name_attr' from line 271
```

Change Summary:

Added missing parts of the commit.

Commits:

	Summary	ID
	Modernize the LDAP backend. This fixes up the LDAP backend to work correctly with Python 2 and 3. We now initialize LDAP with `bytes_mode=False`, which will ensure that `python-ldap` will use Unicode strings for all input and output on both Python 2 and 3. It's the rough equivalent of a `unicode_literals` import. That allows us to remove all the casting, which didn't work on Python 3 anyway without emitting warnings. Log output has been cleaned up, with some improved log output and a dedicated logger. The unit tests have been improved considerably. We now use spies to track calls, rather than overriding the `LDAPObject` with a per-test subclass. This allows us to ensure these overridden functions are actually called, which was just an assumption we made before. We didn't require LDAP support for development in the past, which meant that some tests recently regressed. It's now a development-time dependency. We also require a modern version for production.	f15bd91f7e2c194cc1d0eaa894424b19a4722e37
	Modernize the LDAP backend. This fixes up the LDAP backend to work correctly with Python 2 and 3. We now initialize LDAP with `bytes_mode=False`, which will ensure that `python-ldap` will use Unicode strings for all input and output on both Python 2 and 3. It's the rough equivalent of a `unicode_literals` import. That allows us to remove all the casting, which didn't work on Python 3 anyway without emitting warnings. Log output has been cleaned up, with some improved log output and a dedicated logger. The unit tests have been improved considerably. We now use spies to track calls, rather than overriding the `LDAPObject` with a per-test subclass. This allows us to ensure these overridden functions are actually called, which was just an assumption we made before. We didn't require LDAP support for development in the past, which meant that some tests recently regressed. It's now a development-time dependency. We also require a modern version for production.	ce8fb24401e199b4c91da134337b3179bf3f3e7c

Diff:

Revision 2 (+742 -454)

Show changes

	dev-requirements.txt
	setup.py
	reviewboard/accounts/backends/ldap.py
	reviewboard/accounts/tests/test_ldap_auth_backend.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Fixed up some of the fake return values for search_s to always be a tuple with attributes, even if the caller doesn't care.

Commits:

	Summary	ID
	Modernize the LDAP backend. This fixes up the LDAP backend to work correctly with Python 2 and 3. We now initialize LDAP with `bytes_mode=False`, which will ensure that `python-ldap` will use Unicode strings for all input and output on both Python 2 and 3. It's the rough equivalent of a `unicode_literals` import. That allows us to remove all the casting, which didn't work on Python 3 anyway without emitting warnings. Log output has been cleaned up, with some improved log output and a dedicated logger. The unit tests have been improved considerably. We now use spies to track calls, rather than overriding the `LDAPObject` with a per-test subclass. This allows us to ensure these overridden functions are actually called, which was just an assumption we made before. We didn't require LDAP support for development in the past, which meant that some tests recently regressed. It's now a development-time dependency. We also require a modern version for production.	ce8fb24401e199b4c91da134337b3179bf3f3e7c
	Modernize the LDAP backend. This fixes up the LDAP backend to work correctly with Python 2 and 3. We now initialize LDAP with `bytes_mode=False`, which will ensure that `python-ldap` will use Unicode strings for all input and output on both Python 2 and 3. It's the rough equivalent of a `unicode_literals` import. That allows us to remove all the casting, which didn't work on Python 3 anyway without emitting warnings. Log output has been cleaned up, with some improved log output and a dedicated logger. The unit tests have been improved considerably. We now use spies to track calls, rather than overriding the `LDAPObject` with a per-test subclass. This allows us to ensure these overridden functions are actually called, which was just an assumption we made before. We didn't require LDAP support for development in the past, which meant that some tests recently regressed. It's now a development-time dependency. We also require a modern version for production.	ca77e76fbf4fefd2b4e75485c4855458943e0bdd

Diff:

Revision 3 (+744 -466)

Show changes

	dev-requirements.txt
	setup.py
	reviewboard/accounts/backends/ldap.py
	reviewboard/accounts/tests/test_ldap_auth_backend.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Nice cleanup.
```

reviewboard/accounts/backends/ldap.py (Diff revision 3)

The issue has been resolved. Show all issues

Wrapping here is a little weird--I'd say either every arg on its own line or wrap to width, but not halfsies.

Status: Closed (submitted)

Change Summary:

Pushed to release-4.0.x (3c7b76e)