class PrivateKeyTest

Same name in other branches
  1. 9 core/tests/Drupal/Tests/Core/PrivateKeyTest.php \Drupal\Tests\Core\PrivateKeyTest
  2. 8.9.x core/tests/Drupal/Tests/Core/PrivateKeyTest.php \Drupal\Tests\Core\PrivateKeyTest
  3. 10 core/tests/Drupal/Tests/Core/PrivateKeyTest.php \Drupal\Tests\Core\PrivateKeyTest

Tests the PrivateKey class.

@group PrivateKeyTest

Hierarchy

Expanded class hierarchy of PrivateKeyTest

File

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

Namespace

Drupal\Tests\Core
View source
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() : void {
        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() : void {
        $this->state
            ->expects($this->once())
            ->method('get')
            ->with('system.private_key')
            ->willReturn($this->key);
        $this->assertEquals($this->key, $this->privateKey
            ->get());
    }
    
    /**
     * Tests PrivateKey::get() with no private key from state.
     */
    public function testGetNoState() : void {
        $this->assertIsString($this->privateKey
            ->get());
    }
    
    /**
     * Tests PrivateKey::setPrivateKey().
     */
    public function testSet() : void {
        $random_name = $this->randomMachineName();
        $this->state
            ->expects($this->once())
            ->method('set')
            ->with('system.private_key', $random_name)
            ->willReturn(TRUE);
        $this->privateKey
            ->set($random_name);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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().
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
UnitTestCase::$root protected property The app root.
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::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUpBeforeClass public static function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.