LDAPAuthenticatorTest::tearDown() - Code Metrics - Inspection of "Test cover auth" - silverstripe/silverstripe-activedirectory - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#133)

by Stig

created 2019-11-05 03:40 UTC

LDAPAuthenticatorTest::tearDown() A

↳ Parent: LDAPAuthenticatorTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

use Mockery\MockInterface;

class LDAPAuthenticatorTest extends SapphireTest
{
    /**
     * @var MockInterface
     */
    protected $service;

    protected $usesDatabase = true;

    /**
     * For mocking fallback authenticator return value.
     *
     * @var Member
     */
    private static $fallback_auth_value;

    public function setUp()
    {
        parent::setUp();

        $this->service = Mockery::mock(LDAPService::class);
        $this->service->shouldReceive('setGateway');
        Injector::inst()->registerService($this->service, 'LDAPService');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        Config::inst()->nest();
        Config::inst()->remove('Member', 'extensions');
        Config::inst()->remove('Group', 'extensions');
        Config::inst()->update('Member', 'update_ldap_from_local', false);
        Config::inst()->update('Member', 'create_users_in_ldap', false);
        Config::inst()->update('Group', 'extensions', ['LDAPGroupExtension']);
        Config::inst()->update('Member', 'extensions', ['LDAPMemberExtension']);
    }

    public function tearDown()
    {
        self::$fallback_auth_value = null;
        parent::tearDown();

        Config::inst()->unnest();
    }

    public function testLoginSuccess()
    {
        Session::set('BackURL', '/redirect-here-after-login');
        $data = ['Login' => 'denvercoder9', 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
        $this->service->shouldReceive('authenticate')->andReturn([
            'success' => true,
            'identity' => 'denvercoder9',
        ]);
        $this->service->shouldReceive('getUserByUsername')->andReturn(['objectguid' => '123456']);
        $this->service->shouldReceive('updateMemberFromLDAP')->andReturn(true);

        $res = LDAPAuthenticator::authenticate($data, $form);

        $this->assertTrue($res instanceof Member);

        $this->assertNull(Session::get('BackURL'));

    }

    public function testLoginWithEmailSuccess()
    {
        Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');

        $data = ['Login' => '[email protected]', 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());

        $this->service->shouldReceive('getUsernameByEmail')->andReturn('denvercoder9');

        $this->service->shouldReceive('authenticate')->andReturn([
            'success' => true,
            'identity' => 'denvercoder9',
        ]);
        $this->service->shouldReceive('getUserByUsername')->andReturn(['objectguid' => '123456']);
        $this->service->shouldReceive('updateMemberFromLDAP')->andReturn(true);

        $res = LDAPAuthenticator::authenticate($data, $form);

        $this->assertTrue($res instanceof Member);

    }

    public function testUsernameOnly()
    {
        Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'no');
        $data = ['Login' => '[email protected]', 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
        $this->service->shouldReceive('getUsernameByEmail')->andReturn('denvercoder9');

        LDAPAuthenticator::authenticate($data, $form);

        $this->assertEquals('Please enter your username instead of your email to log in.', $form->Message());

    }

    public function testEmailNoUsernameNoFallbackAuth()
    {
        Session::set('BackURL', '/redirect-here-after-login');
        Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
        Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'no');
        $data = ['Login' => '[email protected]', 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
        $this->service->shouldReceive('getUsernameByEmail')->andReturn(false);

        LDAPAuthenticator::authenticate($data, $form);

        $this->assertEquals('Invalid credentials', $form->Message());

        $this->assertEquals('/redirect-here-after-login', Session::get('BackURL'));

    }

    public function testEmailLoginToFallbackAuthFailed()
    {
        Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
        Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'yes');
        $data = ['Login' => '[email protected]', 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
        $this->service->shouldReceive('getUsernameByEmail')->andReturn(false);

        LDAPAuthenticator::authenticate($data, $form);

        $this->assertEquals('Invalid credentials', $form->Message());

    }

    public function testEmailLoginToFallbackAuthSuccess()
    {
        // prevent LDAPMemberExtension from messing with Member:write()
        Config::inst()->update('Member', 'extensions', null);
        Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
        Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'yes');
        $user = Member::create(['Email' => '[email protected]']);
        $user->changePassword('Correct Horse Battery Staple');
        $data = ['Login' => $user->Email, 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
        $this->service->shouldReceive('getUsernameByEmail')->andReturn(false);

        $res = LDAPAuthenticator::authenticate($data, $form);

        $this->assertTrue(0 != $res->ID);

        $this->assertEquals($res->ID, $user->ID);

    }

    public function testUsernameLoginToFallbackAuthSuccess()
    {
        // prevent LDAPMemberExtension from messing with Member:write()
        Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
        Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'yes');
        $user = Member::create(['Email' => '[email protected]']);
        Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator_class', self::class);
        self::set_fallback_authenticator_value($user);
        $data = ['Login' => 'denvercoder', 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
        $this->service->shouldReceive('authenticate')->andReturn(['success' => false]);

        $res = LDAPAuthenticator::authenticate($data, $form);

        $this->assertEquals($res->Email, $user->Email);

    }

    public function testUsernameLoginToFallbackAuthFailure()
    {
        Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
        Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'yes');
        Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator_class', self::class);
        self::set_fallback_authenticator_value(false);
        $data = ['Login' => 'denvercoder', 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
        $this->service->shouldReceive('authenticate')->andReturn(['success' => false, 'message' => 'oh noe']);
        $res = LDAPAuthenticator::authenticate($data, $form);
        $this->assertNull($res);

        $this->assertEquals('oh noe', $form->Message());

    }

    public function testCannotFetchUserData()
    {
        $data = ['Login' => 'denvercoder9', 'Password' => 'Correct Horse Battery Staple'];
        $form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
        $this->service->shouldReceive('authenticate')->andReturn([
            'success' => true,
            'identity' => 'denvercoder9',
        ]);
        $this->service->shouldReceive('getUserByUsername')->andReturn([]);

        $res = LDAPAuthenticator::authenticate($data, $form);
        $this->assertNull($res);

        $this->assertEquals('There was a problem retrieving your user data', $form->Message());

    }

    // self shunting by setting Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator_class', 'LDAPAuthenticatorTest');
    public static function authenticate($data, Form $form = null)

    {
        return self::$fallback_auth_value;
    }

    private function set_fallback_authenticator_value($user)
    {
        self::$fallback_auth_value = $user;

    }
}


1			<?php
2
3			use Mockery\MockInterface;
4
5			class LDAPAuthenticatorTest extends SapphireTest
6			{
7			/**
8			* @var MockInterface
9			*/
10			protected $service;
11
12			protected $usesDatabase = true;
13
14			/**
15			* For mocking fallback authenticator return value.
16			*
17			* @var Member
18			*/
19			private static $fallback_auth_value;
20
21			public function setUp()
22			{
23			parent::setUp();
24
25			$this->service = Mockery::mock(LDAPService::class);
26			$this->service->shouldReceive('setGateway');
27			Injector::inst()->registerService($this->service, 'LDAPService');
			0 ignored issues – show Documentation introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report `$this->service` is of type `object<Mockery\LegacyMockInterface>`, but the function expects a `object<stdClass>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
28
29			Config::inst()->nest();
30			Config::inst()->remove('Member', 'extensions');
31			Config::inst()->remove('Group', 'extensions');
32			Config::inst()->update('Member', 'update_ldap_from_local', false);
33			Config::inst()->update('Member', 'create_users_in_ldap', false);
34			Config::inst()->update('Group', 'extensions', ['LDAPGroupExtension']);
35			Config::inst()->update('Member', 'extensions', ['LDAPMemberExtension']);
36			}
37
38			public function tearDown()
39			{
40			self::$fallback_auth_value = null;
41			parent::tearDown();
42
43			Config::inst()->unnest();
44			}
45
46			public function testLoginSuccess()
47			{
48			Session::set('BackURL', '/redirect-here-after-login');
49			$data = ['Login' => 'denvercoder9', 'Password' => 'Correct Horse Battery Staple'];
50			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
51			$this->service->shouldReceive('authenticate')->andReturn([
52			'success' => true,
53			'identity' => 'denvercoder9',
54			]);
55			$this->service->shouldReceive('getUserByUsername')->andReturn(['objectguid' => '123456']);
56			$this->service->shouldReceive('updateMemberFromLDAP')->andReturn(true);
57
58			$res = LDAPAuthenticator::authenticate($data, $form);
59
60			$this->assertTrue($res instanceof Member);
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertTrue()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
61			$this->assertNull(Session::get('BackURL'));
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertNull()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
62			}
63
64			public function testLoginWithEmailSuccess()
65			{
66			Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
67
68			$data = ['Login' => '[email protected]', 'Password' => 'Correct Horse Battery Staple'];
69			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
70
71			$this->service->shouldReceive('getUsernameByEmail')->andReturn('denvercoder9');
72
73			$this->service->shouldReceive('authenticate')->andReturn([
74			'success' => true,
75			'identity' => 'denvercoder9',
76			]);
77			$this->service->shouldReceive('getUserByUsername')->andReturn(['objectguid' => '123456']);
78			$this->service->shouldReceive('updateMemberFromLDAP')->andReturn(true);
79
80			$res = LDAPAuthenticator::authenticate($data, $form);
81
82			$this->assertTrue($res instanceof Member);
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertTrue()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
83			}
84
85			public function testUsernameOnly()
86			{
87			Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'no');
88			$data = ['Login' => '[email protected]', 'Password' => 'Correct Horse Battery Staple'];
89			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
90			$this->service->shouldReceive('getUsernameByEmail')->andReturn('denvercoder9');
91
92			LDAPAuthenticator::authenticate($data, $form);
93
94			$this->assertEquals('Please enter your username instead of your email to log in.', $form->Message());
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
95			}
96
97			public function testEmailNoUsernameNoFallbackAuth()
98			{
99			Session::set('BackURL', '/redirect-here-after-login');
100			Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
101			Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'no');
102			$data = ['Login' => '[email protected]', 'Password' => 'Correct Horse Battery Staple'];
103			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
104			$this->service->shouldReceive('getUsernameByEmail')->andReturn(false);
105
106			LDAPAuthenticator::authenticate($data, $form);
107
108			$this->assertEquals('Invalid credentials', $form->Message());
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
109			$this->assertEquals('/redirect-here-after-login', Session::get('BackURL'));
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
110			}
111
112			public function testEmailLoginToFallbackAuthFailed()
113			{
114			Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
115			Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'yes');
116			$data = ['Login' => '[email protected]', 'Password' => 'Correct Horse Battery Staple'];
117			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
118			$this->service->shouldReceive('getUsernameByEmail')->andReturn(false);
119
120			LDAPAuthenticator::authenticate($data, $form);
121
122			$this->assertEquals('Invalid credentials', $form->Message());
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
123			}
124
125			public function testEmailLoginToFallbackAuthSuccess()
126			{
127			// prevent LDAPMemberExtension from messing with Member:write()
128			Config::inst()->update('Member', 'extensions', null);
129			Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
130			Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'yes');
131			$user = Member::create(['Email' => '[email protected]']);
132			$user->changePassword('Correct Horse Battery Staple');
133			$data = ['Login' => $user->Email, 'Password' => 'Correct Horse Battery Staple'];
134			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
135			$this->service->shouldReceive('getUsernameByEmail')->andReturn(false);
136
137			$res = LDAPAuthenticator::authenticate($data, $form);
138
139			$this->assertTrue(0 != $res->ID);
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertTrue()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
140			$this->assertEquals($res->ID, $user->ID);
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
141			}
142
143			public function testUsernameLoginToFallbackAuthSuccess()
144			{
145			// prevent LDAPMemberExtension from messing with Member:write()
146			Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
147			Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'yes');
148			$user = Member::create(['Email' => '[email protected]']);
149			Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator_class', self::class);
150			self::set_fallback_authenticator_value($user);
151			$data = ['Login' => 'denvercoder', 'Password' => 'Correct Horse Battery Staple'];
152			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
153			$this->service->shouldReceive('authenticate')->andReturn(['success' => false]);
154
155			$res = LDAPAuthenticator::authenticate($data, $form);
156
157			$this->assertEquals($res->Email, $user->Email);
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
158			}
159
160			public function testUsernameLoginToFallbackAuthFailure()
161			{
162			Config::inst()->update('LDAPAuthenticator', 'allow_email_login', 'yes');
163			Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator', 'yes');
164			Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator_class', self::class);
165			self::set_fallback_authenticator_value(false);
166			$data = ['Login' => 'denvercoder', 'Password' => 'Correct Horse Battery Staple'];
167			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
168			$this->service->shouldReceive('authenticate')->andReturn(['success' => false, 'message' => 'oh noe']);
169			$res = LDAPAuthenticator::authenticate($data, $form);
170			$this->assertNull($res);
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertNull()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
171			$this->assertEquals('oh noe', $form->Message());
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
172			}
173
174			public function testCannotFetchUserData()
175			{
176			$data = ['Login' => 'denvercoder9', 'Password' => 'Correct Horse Battery Staple'];
177			$form = \Form::create(Controller::create(), 'name', new FieldList(), new FieldList());
178			$this->service->shouldReceive('authenticate')->andReturn([
179			'success' => true,
180			'identity' => 'denvercoder9',
181			]);
182			$this->service->shouldReceive('getUserByUsername')->andReturn([]);
183
184			$res = LDAPAuthenticator::authenticate($data, $form);
185			$this->assertNull($res);
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertNull()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
186			$this->assertEquals('There was a problem retrieving your user data', $form->Message());
			0 ignored issues – show Bug introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<LDAPAuthenticatorTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
187			}
188
189			// self shunting by setting Config::inst()->update('LDAPAuthenticator', 'fallback_authenticator_class', 'LDAPAuthenticatorTest');
190			public static function authenticate($data, Form $form = null)
			0 ignored issues – show Unused Code introduced 2019-11-05 03:43 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-07-26 15:35 UTC by Report Bug Copy Issue Report The parameter `$form` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
191			{
192			return self::$fallback_auth_value;
193			}
194
195			private function set_fallback_authenticator_value($user)
196			{
197			self::$fallback_auth_value = $user;
198
199			}
200			}
201

silverstripe / silverstripe-activedirectory

Pull Request — master (#133)

LDAPAuthenticatorTest::tearDown() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like