class PrivateKeyTest in Drupal 8

Tests the PrivateKey class.

@group PrivateKeyTest

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\PrivateKeyTest

File

core/tests/Drupal/Tests/Core/PrivateKeyTest.php, line 14

Namespace

Drupal\Tests\Core

class PrivateKeyTest extends UnitTestCase {

  /**
   * The state mock class.
   *
   * @var \Drupal\Core\State\StateInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $state;

  /**
   * The private key service mock.
   *
   * @var \Drupal\Core\PrivateKey
   */
  protected $privateKey;

  /**
   * The random key to use in tests.
   *
   * @var string
   */
  protected $key;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->key = Crypt::randomBytesBase64(55);
    $this->state = $this
      ->createMock('Drupal\\Core\\State\\StateInterface');
    $this->privateKey = new PrivateKey($this->state);
  }

  /**
   * Tests PrivateKey::get().
   */
  public function testGet() {
    $this->state
      ->expects($this
      ->once())
      ->method('get')
      ->with('system.private_key')
      ->will($this
      ->returnValue($this->key));
    $this
      ->assertEquals($this->key, $this->privateKey
      ->get());
  }

  /**
   * Tests PrivateKey::get() with no private key from state.
   */
  public function testGetNoState() {
    $this
      ->assertIsString($this->privateKey
      ->get());
  }

  /**
   * Tests PrivateKey::setPrivateKey().
   */
  public function testSet() {
    $random_name = $this
      ->randomMachineName();
    $this->state
      ->expects($this
      ->once())
      ->method('set')
      ->with('system.private_key', $random_name)
      ->will($this
      ->returnValue(TRUE));
    $this->privateKey
      ->set($random_name);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
PrivateKeyTest::$key	protected	property	The random key to use in tests.
PrivateKeyTest::$privateKey	protected	property	The private key service mock.
PrivateKeyTest::$state	protected	property	The state mock class.
PrivateKeyTest::setUp	protected	function	Overrides UnitTestCase::setUp
PrivateKeyTest::testGet	public	function	Tests PrivateKey::get().
PrivateKeyTest::testGetNoState	public	function	Tests PrivateKey::get() with no private key from state.
PrivateKeyTest::testSet	public	function	Tests PrivateKey::setPrivateKey().
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.