Converted another couple of tests from browserkit

This commit is contained in:
Dan Brown 2021-05-29 23:42:21 +01:00
parent d62cdd58d3
commit 1fa90e4f12
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
5 changed files with 160 additions and 128 deletions

View File

@ -12,6 +12,7 @@ use BookStack\Http\Controllers\Controller;
use BookStack\Theming\ThemeEvents; use BookStack\Theming\ThemeEvents;
use Illuminate\Foundation\Auth\AuthenticatesUsers; use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\Validation\ValidationException;
class LoginController extends Controller class LoginController extends Controller
{ {
@ -198,4 +199,19 @@ class LoginController extends Controller
return redirect('/login'); return redirect('/login');
} }
/**
* Get the failed login response instance.
*
* @param \Illuminate\Http\Request $request
* @return \Symfony\Component\HttpFoundation\Response
*
* @throws \Illuminate\Validation\ValidationException
*/
protected function sendFailedLoginResponse(Request $request)
{
throw ValidationException::withMessages([
$this->username() => [trans('auth.failed')],
])->redirectTo('/login');
}
} }

View File

@ -5,11 +5,11 @@ use BookStack\Auth\Role;
use BookStack\Auth\Access\Ldap; use BookStack\Auth\Access\Ldap;
use BookStack\Auth\User; use BookStack\Auth\User;
use Mockery\MockInterface; use Mockery\MockInterface;
use Tests\BrowserKitTest; use Tests\TestCase;
use Tests\TestResponse;
class LdapTest extends BrowserKitTest class LdapTest extends TestCase
{ {
/** /**
* @var MockInterface * @var MockInterface
*/ */
@ -51,25 +51,24 @@ class LdapTest extends BrowserKitTest
protected function mockEscapes($times = 1) protected function mockEscapes($times = 1)
{ {
$this->mockLdap->shouldReceive('escape')->times($times)->andReturnUsing(function($val) { $this->mockLdap->shouldReceive('escape')->times($times)->andReturnUsing(function ($val) {
return ldap_escape($val); return ldap_escape($val);
}); });
} }
protected function mockExplodes($times = 1) protected function mockExplodes($times = 1)
{ {
$this->mockLdap->shouldReceive('explodeDn')->times($times)->andReturnUsing(function($dn, $withAttrib) { $this->mockLdap->shouldReceive('explodeDn')->times($times)->andReturnUsing(function ($dn, $withAttrib) {
return ldap_explode_dn($dn, $withAttrib); return ldap_explode_dn($dn, $withAttrib);
}); });
} }
protected function mockUserLogin() protected function mockUserLogin(?string $email = null): TestResponse
{ {
return $this->visit('/login') return $this->post('/login', [
->see('Username') 'username' => $this->mockUser->name,
->type($this->mockUser->name, '#username') 'password' => $this->mockUser->password,
->type($this->mockUser->password, '#password') ] + ($email ? ['email' => $email] : []));
->press('Log In');
} }
/** /**
@ -96,14 +95,20 @@ class LdapTest extends BrowserKitTest
'dn' => ['dc=test' . config('services.ldap.base_dn')] 'dn' => ['dc=test' . config('services.ldap.base_dn')]
]]); ]]);
$this->mockUserLogin() $resp = $this->mockUserLogin();
->seePageIs('/login')->see('Please enter an email to use for this account.'); $resp->assertRedirect('/login');
$resp = $this->followRedirects($resp);
$resp->assertSee('Please enter an email to use for this account.');
$resp->assertSee($this->mockUser->name);
$this->type($this->mockUser->email, '#email') $resp = $this->followingRedirects()->mockUserLogin($this->mockUser->email);
->press('Log In') $resp->assertElementExists('#home-default');
->seePageIs('/') $resp->assertSee($this->mockUser->name);
->see($this->mockUser->name) $this->assertDatabaseHas('users', [
->seeInDatabase('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $this->mockUser->name]); 'email' => $this->mockUser->email,
'email_confirmed' => false,
'external_auth_id' => $this->mockUser->name
]);
} }
public function test_email_domain_restriction_active_on_new_ldap_login() public function test_email_domain_restriction_active_on_new_ldap_login()
@ -121,17 +126,17 @@ class LdapTest extends BrowserKitTest
'dn' => ['dc=test' . config('services.ldap.base_dn')] 'dn' => ['dc=test' . config('services.ldap.base_dn')]
]]); ]]);
$this->mockUserLogin() $resp = $this->mockUserLogin();
->seePageIs('/login') $resp->assertRedirect('/login');
->see('Please enter an email to use for this account.'); $this->followRedirects($resp)->assertSee('Please enter an email to use for this account.');
$email = 'tester@invaliddomain.com'; $email = 'tester@invaliddomain.com';
$resp = $this->mockUserLogin($email);
$resp->assertRedirect('/login');
$this->followRedirects($resp)->assertSee('That email domain does not have access to this application');
$this->type($email, '#email') $this->assertDatabaseMissing('users', ['email' => $email]);
->press('Log In')
->seePageIs('/login')
->see('That email domain does not have access to this application')
->dontSeeInDatabase('users', ['email' => $email]);
} }
public function test_login_works_when_no_uid_provided_by_ldap_server() public function test_login_works_when_no_uid_provided_by_ldap_server()
@ -147,10 +152,10 @@ class LdapTest extends BrowserKitTest
'mail' => [$this->mockUser->email] 'mail' => [$this->mockUser->email]
]]); ]]);
$this->mockUserLogin() $resp = $this->mockUserLogin();
->seePageIs('/') $resp->assertRedirect('/');
->see($this->mockUser->name) $this->followRedirects($resp)->assertSee($this->mockUser->name);
->seeInDatabase('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $ldapDn]); $this->assertDatabaseHas('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $ldapDn]);
} }
public function test_a_custom_uid_attribute_can_be_specified_and_is_used_properly() public function test_a_custom_uid_attribute_can_be_specified_and_is_used_properly()
@ -169,10 +174,10 @@ class LdapTest extends BrowserKitTest
]]); ]]);
$this->mockUserLogin() $resp = $this->mockUserLogin();
->seePageIs('/') $resp->assertRedirect('/');
->see($this->mockUser->name) $this->followRedirects($resp)->assertSee($this->mockUser->name);
->seeInDatabase('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => 'cooluser456']); $this->assertDatabaseHas('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => 'cooluser456']);
} }
public function test_initial_incorrect_credentials() public function test_initial_incorrect_credentials()
@ -187,9 +192,10 @@ class LdapTest extends BrowserKitTest
]]); ]]);
$this->mockLdap->shouldReceive('bind')->times(2)->andReturn(true, false); $this->mockLdap->shouldReceive('bind')->times(2)->andReturn(true, false);
$this->mockUserLogin() $resp = $this->mockUserLogin();
->seePageIs('/login')->see('These credentials do not match our records.') $resp->assertRedirect('/login');
->dontSeeInDatabase('users', ['external_auth_id' => $this->mockUser->name]); $this->followRedirects($resp)->assertSee('These credentials do not match our records.');
$this->assertDatabaseMissing('users', ['external_auth_id' => $this->mockUser->name]);
} }
public function test_login_not_found_username() public function test_login_not_found_username()
@ -199,49 +205,59 @@ class LdapTest extends BrowserKitTest
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array')) ->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 0]); ->andReturn(['count' => 0]);
$this->mockUserLogin() $resp = $this->mockUserLogin();
->seePageIs('/login')->see('These credentials do not match our records.') $resp->assertRedirect('/login');
->dontSeeInDatabase('users', ['external_auth_id' => $this->mockUser->name]); $this->followRedirects($resp)->assertSee('These credentials do not match our records.');
$this->assertDatabaseMissing('users', ['external_auth_id' => $this->mockUser->name]);
} }
public function test_create_user_form() public function test_create_user_form()
{ {
$this->asAdmin()->visit('/settings/users/create') $userForm = $this->asAdmin()->get('/settings/users/create');
->dontSee('Password') $userForm->assertDontSee('Password');
->type($this->mockUser->name, '#name')
->type($this->mockUser->email, '#email') $save = $this->post('/settings/users/create', [
->press('Save') 'name' => $this->mockUser->name,
->see('The external auth id field is required.') 'email' => $this->mockUser->email,
->type($this->mockUser->name, '#external_auth_id') ]);
->press('Save') $save->assertSessionHasErrors(['external_auth_id' => 'The external auth id field is required.']);
->seePageIs('/settings/users')
->seeInDatabase('users', ['email' => $this->mockUser->email, 'external_auth_id' => $this->mockUser->name, 'email_confirmed' => true]); $save = $this->post('/settings/users/create', [
'name' => $this->mockUser->name,
'email' => $this->mockUser->email,
'external_auth_id' => $this->mockUser->name,
]);
$save->assertRedirect('/settings/users');
$this->assertDatabaseHas('users', ['email' => $this->mockUser->email, 'external_auth_id' => $this->mockUser->name, 'email_confirmed' => true]);
} }
public function test_user_edit_form() public function test_user_edit_form()
{ {
$editUser = $this->getNormalUser(); $editUser = $this->getNormalUser();
$this->asAdmin()->visit('/settings/users/' . $editUser->id) $editPage = $this->asAdmin()->get("/settings/users/{$editUser->id}");
->see('Edit User') $editPage->assertSee('Edit User');
->dontSee('Password') $editPage->assertDontSee('Password');
->type('test_auth_id', '#external_auth_id')
->press('Save') $update = $this->put("/settings/users/{$editUser->id}", [
->seePageIs('/settings/users') 'name' => $editUser->name,
->seeInDatabase('users', ['email' => $editUser->email, 'external_auth_id' => 'test_auth_id']); 'email' => $editUser->email,
'external_auth_id' => 'test_auth_id',
]);
$update->assertRedirect('/settings/users');
$this->assertDatabaseHas('users', ['email' => $editUser->email, 'external_auth_id' => 'test_auth_id']);
} }
public function test_registration_disabled() public function test_registration_disabled()
{ {
$this->visit('/register') $this->followingRedirects()->get('/register')->assertElementContains('#content', 'Log In');
->seePageIs('/login');
} }
public function test_non_admins_cannot_change_auth_id() public function test_non_admins_cannot_change_auth_id()
{ {
$testUser = $this->getNormalUser(); $testUser = $this->getNormalUser();
$this->actingAs($testUser)->visit('/settings/users/' . $testUser->id) $this->actingAs($testUser)
->dontSee('External Authentication'); ->get('/settings/users/' . $testUser->id)
->assertDontSee('External Authentication');
} }
public function test_login_maps_roles_and_retains_existing_roles() public function test_login_maps_roles_and_retains_existing_roles()
@ -273,18 +289,18 @@ class LdapTest extends BrowserKitTest
] ]
]]); ]]);
$this->mockUserLogin()->seePageIs('/'); $this->mockUserLogin()->assertRedirect('/');
$user = User::where('email', $this->mockUser->email)->first(); $user = User::where('email', $this->mockUser->email)->first();
$this->seeInDatabase('role_user', [ $this->assertDatabaseHas('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $roleToReceive->id 'role_id' => $roleToReceive->id
]); ]);
$this->seeInDatabase('role_user', [ $this->assertDatabaseHas('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $roleToReceive2->id 'role_id' => $roleToReceive2->id
]); ]);
$this->seeInDatabase('role_user', [ $this->assertDatabaseHas('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $existingRole->id 'role_id' => $existingRole->id
]); ]);
@ -317,14 +333,14 @@ class LdapTest extends BrowserKitTest
] ]
]]); ]]);
$this->mockUserLogin()->seePageIs('/'); $this->mockUserLogin()->assertRedirect('/');
$user = User::where('email', $this->mockUser->email)->first(); $user = User::query()->where('email', $this->mockUser->email)->first();
$this->seeInDatabase('role_user', [ $this->assertDatabaseHas('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $roleToReceive->id 'role_id' => $roleToReceive->id
]); ]);
$this->dontSeeInDatabase('role_user', [ $this->assertDatabaseMissing('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $existingRole->id 'role_id' => $existingRole->id
]); ]);
@ -333,8 +349,8 @@ class LdapTest extends BrowserKitTest
public function test_external_auth_id_visible_in_roles_page_when_ldap_active() public function test_external_auth_id_visible_in_roles_page_when_ldap_active()
{ {
$role = factory(Role::class)->create(['display_name' => 'ldaptester', 'external_auth_id' => 'ex-auth-a, test-second-param']); $role = factory(Role::class)->create(['display_name' => 'ldaptester', 'external_auth_id' => 'ex-auth-a, test-second-param']);
$this->asAdmin()->visit('/settings/roles/' . $role->id) $this->asAdmin()->get('/settings/roles/' . $role->id)
->see('ex-auth-a'); ->assertSee('ex-auth-a');
} }
public function test_login_maps_roles_using_external_auth_ids_if_set() public function test_login_maps_roles_using_external_auth_ids_if_set()
@ -362,14 +378,14 @@ class LdapTest extends BrowserKitTest
] ]
]]); ]]);
$this->mockUserLogin()->seePageIs('/'); $this->mockUserLogin()->assertRedirect('/');
$user = User::where('email', $this->mockUser->email)->first(); $user = User::query()->where('email', $this->mockUser->email)->first();
$this->seeInDatabase('role_user', [ $this->assertDatabaseHas('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $roleToReceive->id 'role_id' => $roleToReceive->id
]); ]);
$this->dontSeeInDatabase('role_user', [ $this->assertDatabaseMissing('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $roleToNotReceive->id 'role_id' => $roleToNotReceive->id
]); ]);
@ -404,14 +420,14 @@ class LdapTest extends BrowserKitTest
] ]
]]); ]]);
$this->mockUserLogin()->seePageIs('/'); $this->mockUserLogin()->assertRedirect('/');
$user = User::where('email', $this->mockUser->email)->first(); $user = User::query()->where('email', $this->mockUser->email)->first();
$this->seeInDatabase('role_user', [ $this->assertDatabaseHas('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $roleToReceive->id 'role_id' => $roleToReceive->id
]); ]);
$this->seeInDatabase('role_user', [ $this->assertDatabaseHas('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $roleToReceive2->id 'role_id' => $roleToReceive2->id
]); ]);
@ -433,14 +449,13 @@ class LdapTest extends BrowserKitTest
'displayname' => 'displayNameAttribute' 'displayname' => 'displayNameAttribute'
]]); ]]);
$this->mockUserLogin() $this->mockUserLogin()->assertRedirect('/login');
->seePageIs('/login')->see('Please enter an email to use for this account.'); $this->get('/login')->assertSee('Please enter an email to use for this account.');
$this->type($this->mockUser->email, '#email') $resp = $this->mockUserLogin($this->mockUser->email);
->press('Log In') $resp->assertRedirect('/');
->seePageIs('/') $this->get('/')->assertSee('displayNameAttribute');
->see('displayNameAttribute') $this->assertDatabaseHas('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $this->mockUser->name, 'name' => 'displayNameAttribute']);
->seeInDatabase('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $this->mockUser->name, 'name' => 'displayNameAttribute']);
} }
public function test_login_uses_default_display_name_attribute_if_specified_not_present() public function test_login_uses_default_display_name_attribute_if_specified_not_present()
@ -458,14 +473,18 @@ class LdapTest extends BrowserKitTest
'dn' => ['dc=test' . config('services.ldap.base_dn')] 'dn' => ['dc=test' . config('services.ldap.base_dn')]
]]); ]]);
$this->mockUserLogin() $this->mockUserLogin()->assertRedirect('/login');
->seePageIs('/login')->see('Please enter an email to use for this account.'); $this->get('/login')->assertSee('Please enter an email to use for this account.');
$this->type($this->mockUser->email, '#email') $resp = $this->mockUserLogin($this->mockUser->email);
->press('Log In') $resp->assertRedirect('/');
->seePageIs('/') $this->get('/')->assertSee($this->mockUser->name);
->see($this->mockUser->name) $this->assertDatabaseHas('users', [
->seeInDatabase('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $this->mockUser->name, 'name' => $this->mockUser->name]); 'email' => $this->mockUser->email,
'email_confirmed' => false,
'external_auth_id' => $this->mockUser->name,
'name' => $this->mockUser->name
]);
} }
protected function checkLdapReceivesCorrectDetails($serverString, $expectedHost, $expectedPort) protected function checkLdapReceivesCorrectDetails($serverString, $expectedHost, $expectedPort)
@ -549,11 +568,11 @@ class LdapTest extends BrowserKitTest
'dn' => ['dc=test' . config('services.ldap.base_dn')] 'dn' => ['dc=test' . config('services.ldap.base_dn')]
]]); ]]);
$this->post('/login', [ $resp = $this->post('/login', [
'username' => $this->mockUser->name, 'username' => $this->mockUser->name,
'password' => $this->mockUser->password, 'password' => $this->mockUser->password,
]); ]);
$this->seeJsonStructure([ $resp->assertJsonStructure([
'details_from_ldap' => [], 'details_from_ldap' => [],
'details_bookstack_parsed' => [], 'details_bookstack_parsed' => [],
]); ]);
@ -571,8 +590,8 @@ class LdapTest extends BrowserKitTest
config()->set(['services.ldap.start_tls' => true]); config()->set(['services.ldap.start_tls' => true]);
$this->mockLdap->shouldReceive('startTls')->once()->andReturn(false); $this->mockLdap->shouldReceive('startTls')->once()->andReturn(false);
$this->commonLdapMocks(1, 1, 0, 0, 0); $this->commonLdapMocks(1, 1, 0, 0, 0);
$this->post('/login', ['username' => 'timmyjenkins', 'password' => 'cattreedog']); $resp = $this->post('/login', ['username' => 'timmyjenkins', 'password' => 'cattreedog']);
$this->assertResponseStatus(500); $resp->assertStatus(500);
} }
public function test_ldap_attributes_can_be_binary_decoded_if_marked() public function test_ldap_attributes_can_be_binary_decoded_if_marked()
@ -610,13 +629,12 @@ class LdapTest extends BrowserKitTest
]]); ]]);
// First user login // First user login
$this->mockUserLogin()->seePageIs('/'); $this->mockUserLogin()->assertRedirect('/');
// Second user login // Second user login
auth()->logout(); auth()->logout();
$this->post('/login', ['username' => 'bscott', 'password' => 'pass'])->followRedirects(); $resp = $this->followingRedirects()->post('/login', ['username' => 'bscott', 'password' => 'pass']);
$resp->assertSee('A user with the email tester@example.com already exists but with different credentials');
$this->see('A user with the email tester@example.com already exists but with different credentials');
} }
public function test_login_with_email_confirmation_required_maps_groups_but_shows_confirmation_screen() public function test_login_with_email_confirmation_required_maps_groups_but_shows_confirmation_screen()
@ -645,20 +663,20 @@ class LdapTest extends BrowserKitTest
] ]
]]); ]]);
$this->mockUserLogin()->seePageIs('/register/confirm'); $this->followingRedirects()->mockUserLogin()->assertSee('Thanks for registering!');
$this->seeInDatabase('users', [ $this->assertDatabaseHas('users', [
'email' => $user->email, 'email' => $user->email,
'email_confirmed' => false, 'email_confirmed' => false,
]); ]);
$user = User::query()->where('email', '=', $user->email)->first(); $user = User::query()->where('email', '=', $user->email)->first();
$this->seeInDatabase('role_user', [ $this->assertDatabaseHas('role_user', [
'user_id' => $user->id, 'user_id' => $user->id,
'role_id' => $roleToReceive->id 'role_id' => $roleToReceive->id
]); ]);
$homePage = $this->get('/'); $homePage = $this->get('/');
$homePage->assertRedirectedTo('/register/confirm/awaiting'); $homePage->assertRedirect('/register/confirm/awaiting');
} }
public function test_failed_logins_are_logged_when_message_configured() public function test_failed_logins_are_logged_when_message_configured()
@ -686,9 +704,9 @@ EBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k=')],
]]); ]]);
$this->mockUserLogin() $this->mockUserLogin()
->seePageIs('/'); ->assertRedirect('/');
$user = User::query()->where('email', '=' , $this->mockUser->email)->first(); $user = User::query()->where('email', '=', $this->mockUser->email)->first();
$this->assertNotNull($user->avatar); $this->assertNotNull($user->avatar);
$this->assertEquals('8c90748342f19b195b9c6b4eff742ded', md5_file(public_path($user->avatar->path))); $this->assertEquals('8c90748342f19b195b9c6b4eff742ded', md5_file(public_path($user->avatar->path)));
} }

View File

@ -47,14 +47,6 @@ abstract class BrowserKitTest extends TestCase
} }
/**
* Get a user that's not a system user such as the guest user.
*/
public function getNormalUser()
{
return User::where('system_name', '=', null)->get()->last();
}
/** /**
* Quickly sets an array of settings. * Quickly sets an array of settings.
* @param $settingsArray * @param $settingsArray

View File

@ -1,35 +1,33 @@
<?php namespace Tests\Entity; <?php namespace Tests\Entity;
use BookStack\Entities\Models\Page; use BookStack\Entities\Models\Page;
use Tests\BrowserKitTest; use Tests\TestCase;
class CommentSettingTest extends BrowserKitTest class CommentSettingTest extends TestCase
{ {
protected $page; protected $page;
public function setUp(): void public function setUp(): void
{ {
parent::setUp(); parent::setUp();
$this->page = Page::first(); $this->page = Page::query()->first();
} }
public function test_comment_disable() public function test_comment_disable()
{ {
$this->setSettings(['app-disable-comments' => 'true']);
$this->asAdmin(); $this->asAdmin();
$this->setSettings(['app-disable-comments' => 'true']); $this->asAdmin()->get($this->page->getUrl())
->assertElementNotExists('.comments-list');
$this->asAdmin()->visit($this->page->getUrl())
->pageNotHasElement('.comments-list');
} }
public function test_comment_enable() public function test_comment_enable()
{ {
$this->setSettings(['app-disable-comments' => 'false']);
$this->asAdmin(); $this->asAdmin();
$this->setSettings(['app-disable-comments' => 'false']); $this->asAdmin()->get($this->page->getUrl())
->assertElementExists('.comments-list');
$this->asAdmin()->visit($this->page->getUrl())
->pageHasElement('.comments-list');
} }
} }

View File

@ -82,6 +82,14 @@ trait SharedTestHelpers
return $user; return $user;
} }
/**
* Get a user that's not a system user such as the guest user.
*/
public function getNormalUser()
{
return User::query()->where('system_name', '=', null)->get()->last();
}
/** /**
* Regenerate the permission for an entity. * Regenerate the permission for an entity.
*/ */