Added tests to cover ldap group mapping

Also updated .env.example formatting.
Updated how LdapRepo uses Ldap so can be mocked by testing.

diff --git a/.env.example b/.env.example
index 57e6af6a925c1b0ee33b209375e8e4e316bd0f38..4bb2555b0b03c30c063dbe82457016bafb862591 100644 (file)
--- a/.env.example
+++ b/.env.example
@@ -67,14 +67,14 @@ LDAP_DN=false
 LDAP_PASS=false
 LDAP_USER_FILTER=false
 LDAP_VERSION=false
 LDAP_PASS=false
 LDAP_USER_FILTER=false
 LDAP_VERSION=false

-#do you want to sync LDAP groups to BookStack roles for a user
+# Do you want to sync LDAP groups to BookStack roles for a user

 LDAP_USER_TO_GROUPS=false
 LDAP_USER_TO_GROUPS=false

-#what is the LDAP attribute for group memberships
+# What is the LDAP attribute for group memberships

 LDAP_GROUP_ATTRIBUTE="memberOf"
 LDAP_GROUP_ATTRIBUTE="memberOf"

-#what LDAP group should the user be a part of to be an admin on BookStack
+# What LDAP group should the user be a part of to be an admin on BookStack

 LDAP_ADMIN_GROUP="Domain Admins"
 LDAP_ADMIN_GROUP="Domain Admins"

-#would you like to remove users from roles on bookstack if they do not match on LDAP
-#if false, the ldap groups-roles sync will only add users to roles
+# Would you like to remove users from roles on BookStack if they do not match on LDAP
+# If false, the ldap groups-roles sync will only add users to roles

 LDAP_REMOVE_FROM_GROUPS=false
 
 # Mail settings
 LDAP_REMOVE_FROM_GROUPS=false
 
 # Mail settings

diff --git a/app/Http/Controllers/Auth/LoginController.php b/app/Http/Controllers/Auth/LoginController.php
index 21c9dc4c56b36c3ebde8412f95647dede1223c48..08b1bce679a433191148ac6db1abf878480f9279 100644 (file)
--- a/app/Http/Controllers/Auth/LoginController.php
+++ b/app/Http/Controllers/Auth/LoginController.php
@@ -6,6 +6,7 @@ use BookStack\Exceptions\AuthException;
 use BookStack\Http\Controllers\Controller;
 use BookStack\Repos\UserRepo;
 use BookStack\Repos\LdapRepo;
 use BookStack\Http\Controllers\Controller;
 use BookStack\Repos\UserRepo;
 use BookStack\Repos\LdapRepo;

+use BookStack\Services\LdapService;

 use BookStack\Services\SocialAuthService;
 use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Foundation\Auth\AuthenticatesUsers;
 use BookStack\Services\SocialAuthService;
 use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Foundation\Auth\AuthenticatesUsers;


@@ -99,7 +100,7 @@ class LoginController extends Controller
 
         // ldap groups refresh
         if (config('services.ldap.user_to_groups') !== false && $request->filled('username')) {
 
         // ldap groups refresh
         if (config('services.ldap.user_to_groups') !== false && $request->filled('username')) {

-            $ldapRepo = new LdapRepo($this->userRepo);
+            $ldapRepo = new LdapRepo($this->userRepo, app(LdapService::class));

             $ldapRepo->syncGroups($user, $request->input('username'));
         }
 
             $ldapRepo->syncGroups($user, $request->input('username'));
         }
 

diff --git a/app/Repos/LdapRepo.php b/app/Repos/LdapRepo.php
index 12bde0cdd47839b8fc5dd9708de51cc44aff933c..e57872039c6a1599d8bf7f27cabcaaab5852c706 100644 (file)
--- a/app/Repos/LdapRepo.php
+++ b/app/Repos/LdapRepo.php
@@ -1,9 +1,7 @@
 <?php namespace BookStack\Repos;
 
 <?php namespace BookStack\Repos;
 

-use BookStack\Services\Ldap;

 use BookStack\Services\LdapService;
 use BookStack\Role;
 use BookStack\Services\LdapService;
 use BookStack\Role;

-use BookStack\Repos\UserRepo;

 
 class LdapRepo
 {
 
 class LdapRepo
 {


@@ -16,8 +14,9 @@ class LdapRepo
     /**
      * LdapRepo constructor.
      * @param \BookStack\Repos\UserRepo $userRepo
     /**
      * LdapRepo constructor.
      * @param \BookStack\Repos\UserRepo $userRepo

+     * @param LdapService $ldapService

      */
      */

-    public function __construct(UserRepo $userRepo)
+    public function __construct(UserRepo $userRepo, LdapService $ldapService)

     {
         $this->config = config('services.ldap');
 
     {
         $this->config = config('services.ldap');
 


@@ -25,7 +24,7 @@ class LdapRepo
             return false;
         }
 
             return false;
         }
 

-        $this->ldapService = new LdapService(new Ldap);
+        $this->ldapService = $ldapService;

         $this->userRepo = $userRepo;
     }
 
         $this->userRepo = $userRepo;
     }
 

diff --git a/tests/Auth/LdapTest.php b/tests/Auth/LdapTest.php
index 8880c7b652b9b2452188c963e698f156656a082a..ada33d692cd9d5544fd436fb8fedf1af64f457dd 100644 (file)
--- a/tests/Auth/LdapTest.php
+++ b/tests/Auth/LdapTest.php
@@ -1,10 +1,17 @@
 <?php namespace Tests;
 <?php namespace Tests;

+use BookStack\Role;
+use BookStack\Services\Ldap;

 use BookStack\User;
 use BookStack\User;

+use Mockery\MockInterface;

 
 class LdapTest extends BrowserKitTest
 {
 
 
 class LdapTest extends BrowserKitTest
 {
 

+    /**
+     * @var MockInterface
+     */

     protected $mockLdap;
     protected $mockLdap;

+

     protected $mockUser;
     protected $resourceId = 'resource-test';
 
     protected $mockUser;
     protected $resourceId = 'resource-test';
 


@@ -12,9 +19,15 @@ class LdapTest extends BrowserKitTest
     {
         parent::setUp();
         if (!defined('LDAP_OPT_REFERRALS')) define('LDAP_OPT_REFERRALS', 1);
     {
         parent::setUp();
         if (!defined('LDAP_OPT_REFERRALS')) define('LDAP_OPT_REFERRALS', 1);

-        app('config')->set(['auth.method' => 'ldap', 'services.ldap.base_dn' => 'dc=ldap,dc=local', 'auth.providers.users.driver' => 'ldap']);
-        $this->mockLdap = \Mockery::mock(\BookStack\Services\Ldap::class);
-        $this->app['BookStack\Services\Ldap'] = $this->mockLdap;
+        app('config')->set([
+            'auth.method' => 'ldap',
+            'services.ldap.base_dn' => 'dc=ldap,dc=local',
+            'services.ldap.email_attribute' => 'mail',
+            'services.ldap.user_to_groups' => false,
+            'auth.providers.users.driver' => 'ldap',
+        ]);
+        $this->mockLdap = \Mockery::mock(Ldap::class);
+        $this->app[Ldap::class] = $this->mockLdap;

         $this->mockUser = factory(User::class)->make();
     }
 
         $this->mockUser = factory(User::class)->make();
     }
 


@@ -133,4 +146,104 @@ class LdapTest extends BrowserKitTest
             ->dontSee('External Authentication');
     }
 
             ->dontSee('External Authentication');
     }
 

+    public function test_login_maps_roles_and_retains_existsing_roles()
+    {
+        $roleToRecieve = factory(Role::class)->create(['name' => 'ldaptester']);
+        $roleToRecieve2 = factory(Role::class)->create(['name' => 'ldaptester-second']);
+        $existingRole = factory(Role::class)->create(['name' => 'ldaptester-existing']);
+        $this->mockUser->forceFill(['external_auth_id' => $this->mockUser->name])->save();
+        $this->mockUser->attachRole($existingRole);
+
+        app('config')->set([
+            'services.ldap.user_to_groups' => true,
+            'services.ldap.group_attribute' => 'memberOf',
+            'services.ldap.remove_from_groups' => false,
+        ]);
+        $this->mockLdap->shouldReceive('connect')->times(2)->andReturn($this->resourceId);
+        $this->mockLdap->shouldReceive('setVersion')->times(2);
+        $this->mockLdap->shouldReceive('setOption')->times(5);
+        $this->mockLdap->shouldReceive('searchAndGetEntries')->times(5)
+            ->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
+            ->andReturn(['count' => 1, 0 => [
+                'uid' => [$this->mockUser->name],
+                'cn' => [$this->mockUser->name],
+                'dn' => ['dc=test' . config('services.ldap.base_dn')],
+                'mail' => [$this->mockUser->email],
+                'memberof' => [
+                    'count' => 2,
+                    0 => "cn=ldaptester,ou=groups,dc=example,dc=com",
+                    1 => "cn=ldaptester-second,ou=groups,dc=example,dc=com",
+                ]
+            ]]);
+        $this->mockLdap->shouldReceive('bind')->times(6)->andReturn(true);
+
+        $this->visit('/login')
+            ->see('Username')
+            ->type($this->mockUser->name, '#username')
+            ->type($this->mockUser->password, '#password')
+            ->press('Log In')
+            ->seePageIs('/');
+
+        $user = User::where('email', $this->mockUser->email)->first();
+        $this->seeInDatabase('role_user', [
+            'user_id' => $user->id,
+            'role_id' => $roleToRecieve->id
+        ]);
+        $this->seeInDatabase('role_user', [
+            'user_id' => $user->id,
+            'role_id' => $roleToRecieve2->id
+        ]);
+        $this->seeInDatabase('role_user', [
+            'user_id' => $user->id,
+            'role_id' => $existingRole->id
+        ]);
+    }
+
+    public function test_login_maps_roles_and_removes_old_roles_if_set()
+    {
+        $roleToRecieve = factory(Role::class)->create(['name' => 'ldaptester']);
+        $existingRole = factory(Role::class)->create(['name' => 'ldaptester-existing']);
+        $this->mockUser->forceFill(['external_auth_id' => $this->mockUser->name])->save();
+        $this->mockUser->attachRole($existingRole);
+
+        app('config')->set([
+            'services.ldap.user_to_groups' => true,
+            'services.ldap.group_attribute' => 'memberOf',
+            'services.ldap.remove_from_groups' => true,
+        ]);
+        $this->mockLdap->shouldReceive('connect')->times(2)->andReturn($this->resourceId);
+        $this->mockLdap->shouldReceive('setVersion')->times(2);
+        $this->mockLdap->shouldReceive('setOption')->times(4);
+        $this->mockLdap->shouldReceive('searchAndGetEntries')->times(4)
+            ->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
+            ->andReturn(['count' => 1, 0 => [
+                'uid' => [$this->mockUser->name],
+                'cn' => [$this->mockUser->name],
+                'dn' => ['dc=test' . config('services.ldap.base_dn')],
+                'mail' => [$this->mockUser->email],
+                'memberof' => [
+                    'count' => 1,
+                    0 => "cn=ldaptester,ou=groups,dc=example,dc=com",
+                ]
+            ]]);
+        $this->mockLdap->shouldReceive('bind')->times(5)->andReturn(true);
+
+        $this->visit('/login')
+            ->see('Username')
+            ->type($this->mockUser->name, '#username')
+            ->type($this->mockUser->password, '#password')
+            ->press('Log In')
+            ->seePageIs('/');
+
+        $user = User::where('email', $this->mockUser->email)->first();
+        $this->seeInDatabase('role_user', [
+            'user_id' => $user->id,
+            'role_id' => $roleToRecieve->id
+        ]);
+        $this->dontSeeInDatabase('role_user', [
+            'user_id' => $user->id,
+            'role_id' => $existingRole->id
+        ]);
+    }
+

 }
 }