Add error handling for when LDAP "Full Name Attribute" has no white space.

Review Request #9211 - Created Sept. 23, 2017 and submitted

Riley Creaghan
Review Board
release-2.5.x
4489
3096001...
reviewboard, students

When setting up LDAP authentication, an uncaught exception may be thrown
when splitting the full name into first name and last name. This happens
when the full name contains no space.

If this exception occurs it will now assign the full name to the first
name, and make the last name an empty string.
Because there was a comment just above my changes explaining how full
name is split between first and last name, I added to it to explain what
happens to first and last name in this situation.

I was not able to properly reproduce and test this manually because I
could not get a LDAP server up and running.

I have written a unit test that provides the modified function,
get_or_create_user(), with a user that has a full name containing no
spaces and verifies that the first and last name are assigned as
expected.
This test passes with this fix, and fails on 2.5.x without the fix.

  • 0
  • 0
  • 5
  • 0
  • 5
Description From Last Updated
Christian Hammond
  1. 
      
  2. The description looks great, though it needs to wrap to 70-75 characters.

    I do want to see some testing in here, though. I understand the issue with setting up an LDAP server (no fun), but we do have infrastructure for simulating LDAP connections in our unit tests, so you should at least have a unit test for this (one that fails prior to your fix and succeeds after).

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

    Blank line between these (any time you have a block-creating statement like try, if/else, etc. and another statement).

  4. 
      
Riley Creaghan
Review request changed

Summary:

-Add error handling for exception thrown when LDAP "Full Name Attribute" has no white space.
+Add error handling for when LDAP "Full Name Attribute" has no white space.

Description:

~  

When setting up LDAP authentication, an uncaught exception may be thrown when splitting the full name into first name and last name. This happens when the full name contains no space.

  ~

When setting up LDAP authentication, an uncaught exception may be thrown when

  + splitting the full name into first name and last name. This happens when the
  + full name contains no space.

   
~  

If this exception occurs it will now assign the full name to the first name, and make the last name an empty string.

  ~

If this exception occurs it will now assign the full name to the first name,

  + and make the last name an empty string.
  + Because there was a comment just above my changes explaining how full name
  + is split between first and last name, I added to it to explain what happens
  + to first and last name in this situation.

Testing Done:

~  

Unfortunately this has not been tested. I was told to skip setting up a LDAP server, which is needed to properly reproduce the bug and test this fix, because my efforts to get one working properly were unsuccessful.

~   The only "testing" that was done was to create a new file with the same situation of using str.split(' ',1) on a string containing no space, finding out the exact error, and catching it.

  ~

I was not able to properly reproduce and test this manually because I could

  ~ not get a LDAP server up and running.

  +
  +

I plan on writing a unit test for this fix, but I'm still working on

  + figuring out how to do so.

Commit:

-abc2eeb4f35f3bdc8dd6c710b5dc912688db8886
+d114a8d0c35de59be3767e4d25c50c69723e5057

Diff:

Revision 2 (+10 -1)

Show changes

Checks run (1 failed, 1 succeeded)

flake8 failed.
JSHint passed.

flake8

Riley Creaghan
Riley Creaghan
Riley Creaghan
David Trowbridge
  1. 
      
  2. reviewboard/accounts/backends.py (Diff revision 4)
     
     
     

    Can we add a blank line (with just a #) between these to separate the paragraphs?

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

    Should end in a period.

  4. 
      
Riley Creaghan
Barret Rennie
  1. Ship It!
  2. 
      
David Trowbridge
  1. Ship It!
  2. 
      
Riley Creaghan
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.5.x (d7e9803)
Loading...