user_api-1.0.0-beta1/tests/src/Kernel/UserApiTestTrait.php

<?php

declare(strict_types=1);

namespace Drupal\Tests\user_api\Kernel;

use Drupal\Component\Serialization\Json;
use Drupal\Core\Session\AccountInterface;
use Drupal\user\Entity\User;
use Symfony\Component\HttpFoundation\Request;

/**
 * User API test trait.
 */
trait UserApiTestTrait {

  /**
   * Creates a JSON request.
   *
   * @param string $method
   *   The HTTP method.
   * @param string $uri
   *   The URI.
   * @param array $content
   *   The content.
   * @param array $headers
   *   Additional headers for the request.
   *
   * @return \Symfony\Component\HttpFoundation\Request
   *   The request.
   */
  protected function createJsonRequest(string $method, string $uri, array $content, array $headers = []): Request {
    $encodedContent = Json::encode($content);

    $request = Request::create($uri, $method, [], [], [], [], $encodedContent);
    $request->headers->set('Content-Type', 'application/json');

    foreach ($headers as $key => $value) {
      $request->headers->set($key, $value);
    }

    return $request;
  }

  /**
   * Asserts that the given $rawPassword is the $user password.
   *
   * @param string $rawPassword
   *   The raw password.
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The user to check.
   */
  protected function assertUserPasswordEquals(string $rawPassword, AccountInterface $user) {
    // Reload user.
    $user = User::load($user->id());

    $passwordChecker = \Drupal::service('password');
    $this->assertTrue($passwordChecker->check($rawPassword, $user->getPassword()), 'User password is not set to ' . $rawPassword . '.');
  }

  /**
   * Asserts that the given $rawPassword is NOT the $user password.
   *
   * @param string $rawPassword
   *   The raw password.
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The user to check.
   */
  protected function assertUserPasswordNotEquals(string $rawPassword, AccountInterface $user) {
    // Reload user.
    $user = User::load($user->id());

    $passwordChecker = \Drupal::service('password');
    $this->assertFalse($passwordChecker->check($rawPassword, $user->getPassword()), 'User password is not set to ' . $rawPassword . '.');
  }

  /**
   * Asserts that the user has no password set.
   *
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The user to check.
   */
  protected function assertUserPasswordEmpty(AccountInterface $user) {
    $user = User::load($user->id());

    $this->assertNull($user->getPassword());
  }

}