UserControllerTest::testGetLayoutTemplates() - Code Metrics - Inspection of "Fixed templates not loading into a layout area" - FSWebWorks/silverstripe-user-invitation - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#5)

by Matthew
created 2019-04-18 14:10 UTC
UserControllerTest::testGetLayoutTemplates() A

↳ Parent: UserControllerTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	24
Code Lines	17
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	17
nc	1
nop	0
dl	0
loc	24
rs	9.7
c	0
b	0
f	0
<?php

namespace FSWebWorks\SilverStripe\UserInvitations\Tests;

use FSWebWorks\SilverStripe\UserInvitations\Control\UserController;
use FSWebWorks\SilverStripe\UserInvitations\Model\UserInvitation;
use SilverStripe\Control\Director;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Convert;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\Forms\Form;
use SilverStripe\ORM\FieldType\DBHTMLText;
use SilverStripe\Security\Group;
use SilverStripe\Security\Member;
use SilverStripe\Security\Security;

class UserControllerTest extends FunctionalTest
{

    public static $fixture_file = 'UserControllerTest.yml';

    /**
     * @var UserController $controller
     */
    private $controller;

    public function setUp()
    {
        parent::setUp();
        $this->autoFollowRedirection = false;
        $this->logInWithPermission('ADMIN');
        $this->controller = new UserController();
    }

    private function logoutMember()
    {
        Security::setCurrentUser(null);
    }

    /**
     * Tests redirected to a login screen if you're logged out.
     */
    public function testCantAccessWhenLoggedOut()
    {
        $this->logOut();
        $response = $this->get($this->controller->Link('index'));
        $this->assertFalse($response->isError());
        $this->assertEquals(302, $response->getStatusCode());
        $this->autoFollowRedirection = true;
    }

    /**
     * Tests that a user can access other actions
     */
    public function testCanAccessWhenLoggedOut()
    {
        $this->logOut();
        $response = $this->get($this->controller->Link('accept'));
        $this->assertFalse($response->isError());
        $this->assertEquals(200, $response->getStatusCode());
    }

    /**
     * Tests that you can't access the index action without the requisite permission
     */
    public function testCantAccessWithoutPermission()
    {
        $this->loginInAsSomeone('john');
        $response = $this->get($this->controller->Link('index'));
        $this->assertEquals(403, $response->getStatusCode());
        $this->autoFollowRedirection = true;
    }

    /**
     * Tests if a form is returned and that expected fields are present
     */
    public function testInvitationForm()
    {
        $form = $this->controller->InvitationForm();
        $this->assertInstanceOf(Form::class, $form);
        $this->assertNotNull($form->Fields()->fieldByName('FirstName'));
        $this->assertNotNull($form->Fields()->fieldByName('Email'));
        $this->assertNotNull($form->Fields()->fieldByName('Groups'));
    }

    /**
     * Tests whether an email is sent and that an invitation record is created
     */
    public function testSendInvite()
    {
        $this->loginInAsSomeone('jane');
        /** @var Form $form */
        $data = $this->invitationData();
        $response = $this->controller->sendInvite($data,
            $this->controller->InvitationForm()->loadDataFrom($data));
        $invitation = UserInvitation::get()->filter('Email', $data['Email']);
        $this->assertCount(1, $invitation);
        /** @var UserInvitation $invitation */
        $joe = $invitation->first();
        $this->assertEquals('Joe', $joe->FirstName);
        $this->assertEquals('[email protected]', $joe->Email);
        $this->assertEquals("[\"test1\",\"test2\"]", $joe->Groups);
        $this->assertEquals(302, $response->getStatusCode());
    }

    public function invitationData()
    {
        return [
            'FirstName' => 'Joe',
            'Email' => '[email protected]',
            'Groups' => ['test1', 'test2']
        ];
    }

    /**
     * Tests that no invitation gets sent out without requisite permissions.
     */
    public function testSendInvitePermissionDenied()
    {
        $this->loginInAsSomeone('john');
        /** @var Form $form */
        $data = $this->invitationData();
        $response = $this->controller->sendInvite($data,
            $this->controller->InvitationForm()->loadDataFrom($data));
        $invitation = UserInvitation::get()->filter('Email', $data['Email']);
        $this->assertCount(0, $invitation);
        $this->assertEquals(302, $response->getStatusCode());
    }

    /**
     * Tests whether switching the UserInvitation::force_require_group has an effect or not
     */
    public function testGroupFieldNotRequired()
    {
        $this->loginInAsSomeone('jane');
        $data = [
            'FirstName' => 'Joe',
            'Email' => '[email protected]',
            'Groups' => ['test1', 'test2']
        ];
        $form = $this->controller->InvitationForm()->loadDataFrom($data);
        $this->assertTrue($form->validationResult()->isValid());

        Config::inst()->update(UserInvitation::class, 'force_require_group',
        Config::inst()->/** @scrutinizer ignore-call */ update(UserInvitation::class, 'force_require_group',
            true);
        unset($data['Groups']);
        $form = $this->controller->InvitationForm()->loadDataFrom($data);
        $this->assertFalse($form->validationResult()->isValid());
    }

    private function loginInAsSomeone($name)
    {
        /** @var Member $member */
        $member = $this->objFromFixture(Member::class, $name);
        $this->logInAs($member);
    }

    /**
     * Tests for 403 if no ID parameter given
     */
    public function testAcceptForbiddenError()
    {
        $response = $this->get($this->controller->Link('accept'));
        $this->assertEquals(403, $response->getStatusCode());
    }

    /**
     * Tests for expired TempHash and that it redirects to the expired page
     */
    public function testAcceptExpiredTempHash()
    {
        /** @var UserInvitation $invitation */
        $invitation = $this->objFromFixture(UserInvitation::class, 'expired');
        $response = $this->get($this->controller->Link('accept/' . $invitation->TempHash));
        $this->assertEquals(302, $response->getStatusCode());
        $base = Director::absoluteBaseURL();
        $this->assertEquals('user/expired',
            str_replace($base, '', $response->getHeader('Location')));
    }

    /**
     * Tests if a form is returned and that expected fields are present
     */
    public function testAcceptForm()
    {
        $form = $this->controller->AcceptForm();
        $this->assertInstanceOf(Form::class, $form);
        $this->assertNotNull($form->Fields()->fieldByName('FirstName'));
        $this->assertNull($form->Fields()->fieldByName('Email'));
        $this->assertNotNull($form->Fields()->fieldByName('HashID'));
        $this->assertNotNull($form->Fields()->fieldByName('Surname'));
    }

    /**
     * Tests that redirected to not found if has not found
     */
    public function testSaveInviteWrongHashError()
    {
        $data = [
            'HashID' => '432'
        ];
        $response = $this->controller->saveInvite($data,
            $this->controller->AcceptForm()->loadDataFrom($data));
        $this->assertEquals(302, $response->getStatusCode());
        $base = Director::absoluteBaseURL();
        $this->assertEquals('user/notfound',
            str_replace($base, '', $response->getHeader('Location')));
    }

    public function testSaveInvite()
    {
        /** @var UserInvitation $invitation */
        $invitation = $this->objFromFixture(UserInvitation::class, 'joe');
        $data = [
            'HashID' => $invitation->TempHash,
            'FirstName' => $invitation->FirstName,
            'Surname' => 'Soap',
            'Password' => [
                '_Password' => 'password',
                '_ConfirmPassword' => 'password'
            ]
        ];

        $response = $this->controller->saveInvite($data,
            $this->controller->AcceptForm()->loadDataFrom($data));
        $this->assertEquals(302, $response->getStatusCode());
        $base = Director::absoluteBaseURL();
        $this->assertEquals('user/success',
            str_replace($base, '', $response->getHeader('Location')));

        // Assert that invitation is deleted
        $this->assertNull(UserInvitation::get()->filter('Email',
            $invitation->Email)->first());

        /** @var Member $joe */
        $joe = Member::get()->filter('Email', $invitation->Email)->first();
        // Assert that member is created
        $this->assertTrue($joe->exists());

        // Assert that member belongs to the groups selected
        $this->assertTrue($joe->inGroup($this->objFromFixture(Group::class,
            'test1')));
        $this->assertTrue($joe->inGroup($this->objFromFixture(Group::class,
            'test2')));
    }

    /**
     * Tests that a login link is presented to the user
     */
    public function testSuccess()
    {
        $this->logoutMember();
        $response = $this->get($this->controller->Link('success'));
        $body = Convert::nl2os($response->getBody(), '');
        $this->assertContains('Congratulations!', $body);
        $this->assertContains('You are now a registered member', $body);
        $security = Injector::inst()->get(Security::class);
        $link = $security->Link('login');
        $this->assertContains("<a href=\"{$link}\">", $body);
    }

    /**
     * Tests that the expired action is shown
     */
    public function testExpired()
    {
        $this->logoutMember();
        $response = $this->get($this->controller->Link('expired'));
        $body = Convert::nl2os($response->getBody(), '');
        $this->assertContains('Invitation expired', $body);
        $this->assertContains('Oops, you took too long to accept this invitation',
            $body);
    }

    /**
     * Tests that the notfound action is shown.
     */
    public function testNotFound()
    {
        $this->logoutMember();
        $response = $this->get($this->controller->Link('notfound'));
        $body = Convert::nl2os($response->getBody(), '');
        $this->assertContains('Invitation not found', $body);
        $this->assertContains('Oops, the invitation ID was not found.', $body);
    }

    /**
     * Tests whether links are correctly re-written.
     */
    public function testLink()
    {
        $this->assertEquals('user/accept', $this->controller->Link('accept'));
        $this->assertEquals('user/index', $this->controller->Link('index'));
    }

    /**
     * Tests that the array key is returned
     */
    public function testProvidePermissions()
    {
        $permissions = $this->controller->providePermissions();
        $this->assertArrayHasKey('ACCESS_USER_INVITATIONS', $permissions);
        $this->assertArrayHasKey('name',
            $permissions['ACCESS_USER_INVITATIONS']);
        $this->assertArrayHasKey('category',
            $permissions['ACCESS_USER_INVITATIONS']);
    }

    /**
     *
     */
    public function testRenderWithLayout()
    {
        $render = $this->controller->renderWithLayout([]);
        $this->assertInstanceOf(DBHTMLText::class, $render);
    }

    /**
     *
     */
    public function testGetLayoutTemplates()
    {
        // test string to template array
        $templates = $this->controller->getLayoutTemplates('NewPage');
        $this->assertEquals([
            'type' => 'Layout',
            'NewPage',
            'Page',
        ], $templates);

        // test empty array to template array
        $templates = $this->controller->getLayoutTemplates([]);
        $this->assertEquals([
            'type' => 'Layout',
            'Page',
        ], $templates);

        // test empty array to template array
        $templates = $this->controller->getLayoutTemplates(['NewPage']);
        $this->assertEquals([
            'type' => 'Layout',
            'NewPage',
            'Page',
        ], $templates);
    }
}

FSWebWorks / silverstripe-user-invitation

Pull Request — master (#5)

UserControllerTest::testGetLayoutTemplates() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
