silverstripe-behat-extension/src/Context/LoginContext.php

<?php

namespace SilverStripe\BehatExtension\Context;

use Behat\Behat\Context\Context;
use Behat\Mink\Element\NodeElement;
use PHPUnit\Framework\Assert;
use SilverStripe\Security\Authenticator;
use SilverStripe\Security\Group;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use SilverStripe\Security\Security;

/**
 * LoginContext
 *
 * Context used to define steps related to login and logout functionality
 */
class LoginContext implements Context
{
    use MainContextAwareTrait;

    /**
     * @Given /^I am logged in$/
     */
    public function stepIAmLoggedIn()
    {
        $c = $this->getMainContext();
        $adminUrl = $c->joinUrlParts($c->getBaseUrl(), $c->getAdminUrl());
        $loginUrl = $c->joinUrlParts($c->getBaseUrl(), $c->getLoginUrl());

        $this->getMainContext()->getSession()->visit($adminUrl);

        if (0 == strpos($this->getMainContext()->getSession()->getCurrentUrl(), $loginUrl)) {
            $this->stepILogInWith('admin', 'password');
            Assert::assertStringStartsWith($adminUrl, $this->getMainContext()->getSession()->getCurrentUrl());
        }
    }

    /**
     * Creates a member in a group with the correct permissions.
     * Example: Given I am logged in with "ADMIN" permissions
     *
     * @Given /^I am logged in with "([^"]*)" permissions$/
     * @param string $permCode
     */
    public function iAmLoggedInWithPermissions($permCode)
    {
        $email = "{$permCode}@example.org";
        $password = 'Secret!123';
        $this->generateMemberWithPermission($email, $password, $permCode);
        $this->stepILogInWith($email, $password);
    }

    /**
     * @Given /^I am not logged in$/
     */
    public function stepIAmNotLoggedIn()
    {
        $c = $this->getMainContext();

        // We're missing a security token, so we'll be presented with a form
        $this->getMainContext()->getSession()->visit($c->joinUrlParts($c->getBaseUrl(), 'Security/logout/'));

        $page = $this->getMainContext()->getSession()->getPage();
        $form = $page->findById('LogoutForm_Form');
        Assert::assertNotNull($form, 'Logout form not found');

        $submitButton = $form->find('css', '[type=submit]');
        $securityID = $form->find('css', '[name=SecurityID]');

        Assert::assertNotNull($submitButton, 'Submit button on logout form not found');
        Assert::assertNotNull($securityID, 'CSRF token not found');

        $submitButton->press();
    }

    /**
     * @When /^I log in with "([^"]*)" and "([^"]*)"$/
     * @param string $email
     * @param string $password
     */
    public function stepILogInWith($email, $password)
    {
        $c = $this->getMainContext();
        $loginUrl = $c->joinUrlParts($c->getBaseUrl(), $c->getLoginUrl());
        $this->getMainContext()->getSession()->visit($loginUrl);
        $page = $this->getMainContext()->getSession()->getPage();
        $form = $page->findById('MemberLoginForm_LoginForm');
        Assert::assertNotNull($form, 'Login form not found');

        // Try to find visible forms again on login page.
        $visibleForm = null;
        /** @var NodeElement $form */
        if ($form->isVisible() && $form->find('css', '[name=Email]')) {
            $visibleForm = $form;
        }
        Assert::assertNotNull($visibleForm, 'Could not find login email field');

        $emailField = $visibleForm->find('css', '[name=Email]');
        $passwordField = $visibleForm->find('css', '[name=Password]');
        $submitButton = $visibleForm->find('css', '[type=submit]');
        $securityID = $visibleForm->find('css', '[name=SecurityID]');

        Assert::assertNotNull($emailField, 'Email field on login form not found');
        Assert::assertNotNull($passwordField, 'Password field on login form not found');
        Assert::assertNotNull($submitButton, 'Submit button on login form not found');
        Assert::assertNotNull($securityID, 'CSRF token not found');

        $emailField->setValue($email);
        $passwordField->setValue($password);
        $submitButton->press();

        // Wait 100 ms
        $this->getMainContext()->getSession()->wait(100);

        // In case of login error, throw exception
        // E.g. 'Your session has expired. Please re-submit the form.'
        // This will allow @retry
        $page = $this->getMainContext()->getSession()->getPage();
        $message = $page->find('css', '.message.error');
        $error = $message ? $message->getText() : null;
        Assert::assertNull($message, 'Could not log in with user ' . $email . '. Error: "' . $error. '""');
    }

    /**
     * @Given /^I should see a log-in form$/
     */
    public function stepIShouldSeeALogInForm()
    {
        $page = $this->getMainContext()->getSession()->getPage();
        $loginForm = $page->find('css', '#MemberLoginForm_LoginForm');
        Assert::assertNotNull($loginForm, 'I should see a log-in form');
    }

    /**
     * @Given /^I should see a log-out form$/
     */
    public function stepIShouldSeeALogOutForm()
    {
        $page = $this->getMainContext()->getSession()->getPage();
        $logoutForm = $page->find('css', '#LogoutForm_Form');
        Assert::assertNotNull($logoutForm, 'I should see a log-out form');
    }

    /**
     * @Then /^I will see a "([^"]*)" log-in message$/
     * @param string $type
     */
    public function stepIWillSeeALogInMessage($type)
    {
        $page = $this->getMainContext()->getSession()->getPage();
        $message = $page->find('css', sprintf('.message.%s', $type));
        Assert::assertNotNull($message, sprintf('%s message not found.', $type));
    }

    /**
     * @Then /^the password for "([^"]*)" should be "([^"]*)"$/
     * @skipUpgrade
     * @param string $id
     * @param string $password
     */
    public function stepPasswordForEmailShouldBe($id, $password)
    {
        /** @var Member $member */
        $member = Member::get()->filter('Email', $id)->First();
        Assert::assertNotNull($member);
        $authenticators = Security::singleton()->getApplicableAuthenticators(Authenticator::CHECK_PASSWORD);
        foreach ($authenticators as $authenticator) {
            Assert::assertTrue($authenticator->checkPassword($member, $password)->isValid());
        }
    }

    /**
     * Get or generate a member with the given permission code
     *
     * @param string $email
     * @param string $password
     * @param string $permCode
     * @return Member
     */
    protected function generateMemberWithPermission($email, $password, $permCode)
    {
        // Get or create group
        $group = Group::get()->filter('Title', "$permCode group")->first();
        if (!$group) {
            $group = Group::create();
        }

        $group->Title = "$permCode group";
        $group->write();

        // Get or create permission
        $permission = Permission::create();
        $permission->Code = $permCode;
        $permission->write();
        $group->Permissions()->add($permission);

        // Get or create member
        $member = Member::get()->filter('Email', $email)->first();
        if (!$member) {
            $member = Member::create();
        }

        // make sure any validation for password is skipped, since we're not testing complexity here
        $validator = Member::password_validator();
        Member::set_password_validator(null);
        $member->FirstName = $permCode;
        $member->Surname = "User";
        $member->Email = $email;
        $member->PasswordEncryption = "none";
        $member->changePassword($password);
        $member->write();
        $group->Members()->add($member);
        Member::set_password_validator($validator);

        return $member;
    }
}