Rossmitchell\Twofactor\Tests\Integration\Abstracts\AbstractTestClass

Complexity

Total Complexity

11

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	1	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getFormKey()	0	8	1
A	login()	0	12	2
A	loginAdmin()	0	20	2
A	createObject()	0	8	2
A	assertRedirectsToHomePage()	0	4	1
A	getAdminSession()	0	9	2
A	disableSecretKeys()	0	4	1

<?php
/**
 * A two factor authentication module that protects both the admin and customer logins
 * Copyright (C) 2017  Ross Mitchell
 *
 * This file is part of Rossmitchell/Twofactor.
 *
 * Rossmitchell/Twofactor is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace Rossmitchell\Twofactor\Tests\Integration\Abstracts;

use Magento\Backend\Model\Auth;
use Magento\Backend\Model\UrlInterface;
use Magento\Customer\Model\Customer;
use Magento\Customer\Model\Session;
use Magento\Framework\Data\Form\FormKey;
use Magento\Security\Model\Plugin\Auth as AuthPlugin;
use Magento\TestFramework\TestCase\AbstractController;
use Magento\Backend\Model\Auth\Session\Proxy;
use Magento\User\Model\User;

class AbstractTestClass extends AbstractController
{

    public function getFormKey()
    {
        $formKeyClass = $this->createObject(FormKey::class, false);
        $formKey      = $formKeyClass->getFormKey();
        $formKeyClass->set($formKey);

        return $formKey;
    }

    /**
     * Login the user
     *
     * @param string $customerEmail Customer to mark as logged in for the session
     *
     * @param int    $websiteId
     *
     * @return void
     * @throws \Exception
     */
    public function login($customerEmail, $websiteId = 1)
    {
        /** @var Session $session */
        $session = $this->createObject(Session::class, false);
        /** @var Customer $customer */
        $customer = $this->createObject(Customer::class);
        $customer->setWebsiteId($websiteId);
        $customerId = $customer->loadByEmail($customerEmail);
        if ($session->loginById($customerId->getId()) === false) {
            throw new \Exception("Could not log customer in");

Direct throw of Exception is discouraged. Use \Magento\Framework\Exception\LocalizedException instead.

        }
    }

    public function loginAdmin($username, $password)
    {
        /*$session = $this->getAdminSession();*/

60% of this comment could be valid code. Did you maybe forget this after debugging?

        /** @var User $user */
        $user = $this->createObject(User::class);
        $user->loadByUsername($username);
        if (null === $user->getId()) {
            throw new \Exception('Could not find the admin user');

Direct throw of Exception is discouraged. Use \Magento\Framework\Exception\LocalizedException instead.

        }
        /*$session->setUser($user);

79% of this comment could be valid code. Did you maybe forget this after debugging?

        $session->processLogin();*/

Code must not contain multiple empty lines in a row; found 2 empty lines.

        $auth = $this->createObject(Auth::class, false);
        #$session = $auth->getAuthStorage();

60% of this comment could be valid code. Did you maybe forget this after debugging?

        $auth->login($username, $password);
        $this->createObject(AuthPlugin::class, false)->afterLogin($auth);

    }

Function closing brace must go on the next line following the body; found 1 blank lines before brace

    public function createObject($className, $new = true)
    {
        if ($new === true) {
            return $this->_objectManager->create($className);

The direct use of ObjectManager is discouraged. Inject necessary dependencies via constructor.

        }

        return $this->_objectManager->get($className);

The direct use of ObjectManager is discouraged. Inject necessary dependencies via constructor.

    }

    public function assertRedirectsToHomePage()
    {
        $this->assertRedirect($this->stringEndsWith('index.php/'));
    }

    /**
     * @return Proxy
     */
    public function getAdminSession()
    {
        $session = $this->createObject(Proxy::class, false);
        if ($session->isSessionExists() === false) {
            $session->start();
        }

        return $session;
    }

    public function disableSecretKeys()
    {
        $this->createObject(UrlInterface::class, false)->turnOffSecretKey();
    }
}