RawUserContext::entityType() - Code Metrics - Inspection of "Add Drupal 8 support" - BR0kEN-/TqExtension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Sergii

created 2017-01-04 21:40 UTC

RawUserContext::entityType() A

↳ Parent: RawUserContext

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	0
cts	1
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php
/**
 * @author Sergii Bondarenko, <[email protected]>
 */
namespace Drupal\TqExtension\Context\User;

// Contexts.
use Drupal\TqExtension\Context\RawTqContext;
// Utils.
use Drupal\TqExtension\Utils\BaseEntity;
use Drupal\TqExtension\Utils\EntityDrupalWrapper;
use Drupal\TqExtension\Utils\Database\FetchField;
use Drupal\TqExtension\Cores\DrupalKernelPlaceholder;

class RawUserContext extends RawTqContext
{
    use BaseEntity;

    /**
     * {@inheritdoc}
     */
    protected function entityType()
    {
        return 'user';
    }

    /**
     * {@inheritdoc}
     */
    public function getCurrentId()
    {
        return empty($this->user->uid) ? 0 : $this->user->uid;
    }

    /**
     * @param string $column
     *   Column of a "users" table.
     * @param string $value
     *   Expected value in column.
     *
     * @return int
     */
    public function getIdByArguments($column, $value)
    {
        return (new FetchField('users', 'uid'))
            ->condition($column, $value)
            ->execute();
    }

    /**
     * @param string $roles
     *   Necessary user roles separated by comma.
     * @param array $fields
     *
     * @return \stdClass
     */
    public function createUserWithRoles($roles, array $fields = [])
    {
        $user = $this->createTestUser($fields);
        $driver = $this->getDriver();

        foreach (array_map('trim', explode(',', $roles)) as $role) {
            $driver->userAddRole($user, $role);
        }

        return $user;
    }

    /**
     * @throws \Exception
     */
    public function loginUser()
    {
        $this->logoutUser();

        if (empty($this->user)) {
            throw new \Exception('Tried to login without a user.');
        }

        $this->fillLoginForm([
            'username' => $this->user->name,
            'password' => $this->user->pass,
        ]);
    }

    /**
     * @param array $props
     *   An array with two keys: "username" and "password". Both of them are required.
     * @param string $message
     *   An error message, that will be thrown when user cannot be authenticated.
     *
     * @throws \Behat\Mink\Exception\ElementNotFoundException
     *   When one of a fields cannot be not found.
     * @throws \Exception
     *   When login process failed.
     * @throws \WebDriver\Exception\NoSuchElement
     *   When log in button cannot be found.
     */
    public function fillLoginForm(array $props, $message = '')
    {
        $this->getRedirectContext()->visitPage('user/login');
        $formContext = $this->getFormContext();

        foreach (['username', 'password'] as $prop) {
            $formContext->fillField($this->getDrupalText($prop . '_field'), $props[$prop]);
        }

        $this->getWorkingElement()->pressButton($this->getDrupalText('log_in'));

        if (!$this->isLoggedIn()) {
            throw new \Exception($message ?: sprintf(
                'Failed to login as a user "%s" with password "%s".',
                $props['username'],
                $props['password']
            ));
        }

        $this->user = user_load_by_name($props['username']);

        DrupalKernelPlaceholder::setCurrentUser($this->user);
    }

    /**
     * Cookies are set when at least one page of the site has been visited. This
     * action done in "beforeScenario" hook of TqContext.
     *
     * @see TqContext::beforeScenario()
     *
     * @return bool
     */
    public function isLoggedIn()
    {
        $cookieName = session_name();
        $baseUrl = parse_url($this->locatePath());

        // When "base_url" has "https" scheme, then secure cookie (SSESS) will be set to
        // mark authentication. "session_name()" will return unsecure name (SESS) since it
        // run programmatically. Correct a cookie name if Behat configured for using secure
        // URL and name is not "secure".
        // "scheme" may not exist in case if, for instance, "127.0.0.1:1234" used as base URL.
        if (strpos($cookieName, 'SS') !== 0 && isset($baseUrl['scheme']) && 'https' === $baseUrl['scheme']) {
            $cookieName = "S$cookieName";
        }

        $cookie = $this->getSession()->getCookie($cookieName);

        if (null !== $cookie) {
            // "goutte" session using for checking HTTP status codes.
            $this->getSession('goutte')->setCookie($cookieName, $cookie);

            return true;
        }

        return false;
    }

    public function logoutUser()
    {
        if ($this->isLoggedIn()) {
            $this->logout();
            $this->user = false;
        }
    }

    /**
     * @param array $fields
     *   Additional data for user account.
     *
     * @throws \Exception
     *
     * @return \stdClass
     */
    public function createTestUser(array $fields = [])
    {
        $random = $this->getRandom();
        $username = $random->name(8);
        $user = [
            'name' => $username,
            'pass' => $random->name(16),
            'mail' => "[email protected]",
            'roles' => [
                DRUPAL_AUTHENTICATED_RID => 'authenticated user',
            ],
        ];

        if (!empty($fields)) {
            $entity = new EntityDrupalWrapper('user');
            // Remove fields such as "name", "pass", "mail" if they are required.
            $required = array_diff_key($entity->getRequiredFields(), $user);

            // Fill fields. Field can be found by name or label.
            foreach ($fields as $fieldName => $value) {
                $fieldName = $entity->getFieldNameByLocator($fieldName);

                $user[$fieldName] = $value;
                // Remove field from $required if it was there and filled.
                unset($required[$fieldName]);
            }

            // Throw an exception when one of required fields was not filled.
            if (!empty($required)) {
                throw new \Exception(sprintf(
                    'The following fields "%s" are required and has not filled.',
                    implode('", "', $required)
                ));
            }
        }

        $user = (object) $user;
        $userId = DrupalKernelPlaceholder::getUidByName($user->name);

        // User is already exists, remove it to create again.
        if ($userId > 0) {
            DrupalKernelPlaceholder::deleteUser($userId);
        }

        // $this->user always exist but when no user created it has "false" as a value.
        // Variable stored to another because RawDrupalContext::userCreate() will modify
        // it and this will affect for future actions.
        if (!empty($this->user)) {
            $tmp = $this->user;
        }

        $this->userCreate($user);

        if (isset($tmp)) {
            $this->user = $tmp;
        }

        return $user;
    }
}


1			<?php
2			/**
3			* @author Sergii Bondarenko, <[email protected]>
4			*/
5			namespace Drupal\TqExtension\Context\User;
6
7			// Contexts.
8			use Drupal\TqExtension\Context\RawTqContext;
9			// Utils.
10			use Drupal\TqExtension\Utils\BaseEntity;
11			use Drupal\TqExtension\Utils\EntityDrupalWrapper;
12			use Drupal\TqExtension\Utils\Database\FetchField;
13			use Drupal\TqExtension\Cores\DrupalKernelPlaceholder;
14
15			class RawUserContext extends RawTqContext
16			{
17			use BaseEntity;
18
19			/**
20			* {@inheritdoc}
21			*/
22			protected function entityType()
23			{
24			return 'user';
25			}
26
27			/**
28			* {@inheritdoc}
29			*/
30			public function getCurrentId()
31			{
32			return empty($this->user->uid) ? 0 : $this->user->uid;
33			}
34
35			/**
36			* @param string $column
37			* Column of a "users" table.
38			* @param string $value
39			* Expected value in column.
40			*
41			* @return int
42			*/
43			public function getIdByArguments($column, $value)
44			{
45			return (new FetchField('users', 'uid'))
46			->condition($column, $value)
47			->execute();
48			}
49
50			/**
51			* @param string $roles
52			* Necessary user roles separated by comma.
53			* @param array $fields
54			*
55			* @return \stdClass
56			*/
57			public function createUserWithRoles($roles, array $fields = [])
58			{
59			$user = $this->createTestUser($fields);
60			$driver = $this->getDriver();
61
62			foreach (array_map('trim', explode(',', $roles)) as $role) {
63			$driver->userAddRole($user, $role);
64			}
65
66			return $user;
67			}
68
69			/**
70			* @throws \Exception
71			*/
72			public function loginUser()
73			{
74			$this->logoutUser();
75
76			if (empty($this->user)) {
77			throw new \Exception('Tried to login without a user.');
78			}
79
80			$this->fillLoginForm([
81			'username' => $this->user->name,
82			'password' => $this->user->pass,
83			]);
84			}
85
86			/**
87			* @param array $props
88			* An array with two keys: "username" and "password". Both of them are required.
89			* @param string $message
90			* An error message, that will be thrown when user cannot be authenticated.
91			*
92			* @throws \Behat\Mink\Exception\ElementNotFoundException
93			* When one of a fields cannot be not found.
94			* @throws \Exception
95			* When login process failed.
96			* @throws \WebDriver\Exception\NoSuchElement
97			* When log in button cannot be found.
98			*/
99			public function fillLoginForm(array $props, $message = '')
100			{
101			$this->getRedirectContext()->visitPage('user/login');
102			$formContext = $this->getFormContext();
103
104			foreach (['username', 'password'] as $prop) {
105			$formContext->fillField($this->getDrupalText($prop . '_field'), $props[$prop]);
106			}
107
108			$this->getWorkingElement()->pressButton($this->getDrupalText('log_in'));
109
110			if (!$this->isLoggedIn()) {
111			throw new \Exception($message ?: sprintf(
112			'Failed to login as a user "%s" with password "%s".',
113			$props['username'],
114			$props['password']
115			));
116			}
117
118			$this->user = user_load_by_name($props['username']);
119
120			DrupalKernelPlaceholder::setCurrentUser($this->user);
121			}
122
123			/**
124			* Cookies are set when at least one page of the site has been visited. This
125			* action done in "beforeScenario" hook of TqContext.
126			*
127			* @see TqContext::beforeScenario()
128			*
129			* @return bool
130			*/
131			public function isLoggedIn()
132			{
133			$cookieName = session_name();
134			$baseUrl = parse_url($this->locatePath());
135
136			// When "base_url" has "https" scheme, then secure cookie (SSESS) will be set to
137			// mark authentication. "session_name()" will return unsecure name (SESS) since it
138			// run programmatically. Correct a cookie name if Behat configured for using secure
139			// URL and name is not "secure".
140			// "scheme" may not exist in case if, for instance, "127.0.0.1:1234" used as base URL.
141			if (strpos($cookieName, 'SS') !== 0 && isset($baseUrl['scheme']) && 'https' === $baseUrl['scheme']) {
142			$cookieName = "S$cookieName";
143			}
144
145			$cookie = $this->getSession()->getCookie($cookieName);
146
147			if (null !== $cookie) {
148			// "goutte" session using for checking HTTP status codes.
149			$this->getSession('goutte')->setCookie($cookieName, $cookie);
150
151			return true;
152			}
153
154			return false;
155			}
156
157			public function logoutUser()
158			{
159			if ($this->isLoggedIn()) {
160			$this->logout();
161			$this->user = false;
162			}
163			}
164
165			/**
166			* @param array $fields
167			* Additional data for user account.
168			*
169			* @throws \Exception
170			*
171			* @return \stdClass
172			*/
173			public function createTestUser(array $fields = [])
174			{
175			$random = $this->getRandom();
176			$username = $random->name(8);
177			$user = [
178			'name' => $username,
179			'pass' => $random->name(16),
180			'mail' => "[email protected]",
181			'roles' => [
182			DRUPAL_AUTHENTICATED_RID => 'authenticated user',
183			],
184			];
185
186			if (!empty($fields)) {
187			$entity = new EntityDrupalWrapper('user');
188			// Remove fields such as "name", "pass", "mail" if they are required.
189			$required = array_diff_key($entity->getRequiredFields(), $user);
190
191			// Fill fields. Field can be found by name or label.
192			foreach ($fields as $fieldName => $value) {
193			$fieldName = $entity->getFieldNameByLocator($fieldName);
194
195			$user[$fieldName] = $value;
196			// Remove field from $required if it was there and filled.
197			unset($required[$fieldName]);
198			}
199
200			// Throw an exception when one of required fields was not filled.
201			if (!empty($required)) {
202			throw new \Exception(sprintf(
203			'The following fields "%s" are required and has not filled.',
204			implode('", "', $required)
205			));
206			}
207			}
208
209			$user = (object) $user;
210			$userId = DrupalKernelPlaceholder::getUidByName($user->name);
211
212			// User is already exists, remove it to create again.
213			if ($userId > 0) {
214			DrupalKernelPlaceholder::deleteUser($userId);
215			}
216
217			// $this->user always exist but when no user created it has "false" as a value.
218			// Variable stored to another because RawDrupalContext::userCreate() will modify
219			// it and this will affect for future actions.
220			if (!empty($this->user)) {
221			$tmp = $this->user;
222			}
223
224			$this->userCreate($user);
225
226			if (isset($tmp)) {
227			$this->user = $tmp;
228			}
229
230			return $user;
231			}
232			}
233

BR0kEN- / TqExtension

Pull Request — master (#16)

RawUserContext::entityType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like