class SharedTempStoreTest

Same name in this branch
  1. 8.9.x core/tests/Drupal/Tests/Core/TempStore/SharedTempStoreTest.php \Drupal\Tests\Core\TempStore\SharedTempStoreTest
Same name in other branches
  1. 9 core/tests/Drupal/Tests/Core/TempStore/SharedTempStoreTest.php \Drupal\Tests\Core\TempStore\SharedTempStoreTest
  2. 10 core/tests/Drupal/Tests/Core/TempStore/SharedTempStoreTest.php \Drupal\Tests\Core\TempStore\SharedTempStoreTest
  3. 11.x core/tests/Drupal/Tests/Core/TempStore/SharedTempStoreTest.php \Drupal\Tests\Core\TempStore\SharedTempStoreTest

@coversDefaultClass \Drupal\user\SharedTempStore @group user @group legacy @runTestsInSeparateProcesses @preserveGlobalState disabled

Hierarchy

Expanded class hierarchy of SharedTempStoreTest

File

core/modules/user/tests/src/Unit/SharedTempStoreTest.php, line 18

Namespace

Drupal\Tests\user\Unit
View source 
class SharedTempStoreTest extends UnitTestCase {
    
    /**
     * The mock key value expirable backend.
     *
     * @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $keyValue;
    
    /**
     * The mock lock backend.
     *
     * @var \Drupal\Core\Lock\LockBackendInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $lock;
    
    /**
     * The user temp store.
     *
     * @var \Drupal\user\SharedTempStore
     */
    protected $tempStore;
    
    /**
     * The owner used in this test.
     *
     * @var int
     */
    protected $owner = 1;
    
    /**
     * The request stack.
     *
     * @var \Symfony\Component\HttpFoundation\RequestStack
     */
    protected $requestStack;
    
    /**
     * A tempstore object belonging to the owner.
     *
     * @var \stdClass
     */
    protected $ownObject;
    
    /**
     * A tempstore object not belonging to the owner.
     *
     * @var \stdClass
     */
    protected $otherObject;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        $this->keyValue = $this->createMock('Drupal\\Core\\KeyValueStore\\KeyValueStoreExpirableInterface');
        $this->lock = $this->createMock('Drupal\\Core\\Lock\\LockBackendInterface');
        $this->requestStack = new RequestStack();
        $request = Request::createFromGlobals();
        $this->requestStack
            ->push($request);
        $this->tempStore = new SharedTempStore($this->keyValue, $this->lock, $this->owner, $this->requestStack, 604800);
        $this->ownObject = (object) [
            'data' => 'test_data',
            'owner' => $this->owner,
            'updated' => (int) $request->server
                ->get('REQUEST_TIME'),
        ];
        // Clone the object but change the owner.
        $this->otherObject = clone $this->ownObject;
        $this->otherObject->owner = 2;
    }
    
    /**
     * @covers ::get
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testGet() {
        $this->keyValue
            ->expects($this->at(0))
            ->method('get')
            ->with('test_2')
            ->will($this->returnValue(FALSE));
        $this->keyValue
            ->expects($this->at(1))
            ->method('get')
            ->with('test')
            ->will($this->returnValue($this->ownObject));
        $this->assertNull($this->tempStore
            ->get('test_2'));
        $this->assertSame($this->ownObject->data, $this->tempStore
            ->get('test'));
    }
    
    /**
     * Tests the getIfOwner() method.
     *
     * @covers ::getIfOwner
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testGetIfOwner() {
        $this->keyValue
            ->expects($this->at(0))
            ->method('get')
            ->with('test_2')
            ->will($this->returnValue(FALSE));
        $this->keyValue
            ->expects($this->at(1))
            ->method('get')
            ->with('test')
            ->will($this->returnValue($this->ownObject));
        $this->keyValue
            ->expects($this->at(2))
            ->method('get')
            ->with('test')
            ->will($this->returnValue($this->otherObject));
        $this->assertNull($this->tempStore
            ->getIfOwner('test_2'));
        $this->assertSame($this->ownObject->data, $this->tempStore
            ->getIfOwner('test'));
        $this->assertNull($this->tempStore
            ->getIfOwner('test'));
    }
    
    /**
     * Tests the set() method with no lock available.
     *
     * @covers ::set
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testSetWithNoLockAvailable() {
        $this->lock
            ->expects($this->at(0))
            ->method('acquire')
            ->with('test')
            ->will($this->returnValue(FALSE));
        $this->lock
            ->expects($this->at(1))
            ->method('wait')
            ->with('test');
        $this->lock
            ->expects($this->at(2))
            ->method('acquire')
            ->with('test')
            ->will($this->returnValue(FALSE));
        $this->keyValue
            ->expects($this->once())
            ->method('getCollectionName');
        $this->expectException(TempStoreException::class);
        $this->tempStore
            ->set('test', 'value');
    }
    
    /**
     * Tests a successful set() call.
     *
     * @covers ::set
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testSet() {
        $this->lock
            ->expects($this->once())
            ->method('acquire')
            ->with('test')
            ->will($this->returnValue(TRUE));
        $this->lock
            ->expects($this->never())
            ->method('wait');
        $this->lock
            ->expects($this->once())
            ->method('release')
            ->with('test');
        $this->keyValue
            ->expects($this->once())
            ->method('setWithExpire')
            ->with('test', $this->ownObject, 604800);
        $this->tempStore
            ->set('test', 'test_data');
    }
    
    /**
     * Tests the setIfNotExists() methods.
     *
     * @covers ::setIfNotExists
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testSetIfNotExists() {
        $this->keyValue
            ->expects($this->once())
            ->method('setWithExpireIfNotExists')
            ->with('test', $this->ownObject, 604800)
            ->will($this->returnValue(TRUE));
        $this->assertTrue($this->tempStore
            ->setIfNotExists('test', 'test_data'));
    }
    
    /**
     * Tests the setIfOwner() method when no key exists.
     *
     * @covers ::setIfOwner
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testSetIfOwnerWhenNotExists() {
        $this->keyValue
            ->expects($this->once())
            ->method('setWithExpireIfNotExists')
            ->will($this->returnValue(TRUE));
        $this->assertTrue($this->tempStore
            ->setIfOwner('test', 'test_data'));
    }
    
    /**
     * Tests the setIfOwner() method when a key already exists but no object.
     *
     * @covers ::setIfOwner
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testSetIfOwnerNoObject() {
        $this->keyValue
            ->expects($this->once())
            ->method('setWithExpireIfNotExists')
            ->will($this->returnValue(FALSE));
        $this->keyValue
            ->expects($this->once())
            ->method('get')
            ->with('test')
            ->will($this->returnValue(FALSE));
        $this->assertFalse($this->tempStore
            ->setIfOwner('test', 'test_data'));
    }
    
    /**
     * Tests the setIfOwner() method with matching and non matching owners.
     *
     * @covers ::setIfOwner
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testSetIfOwner() {
        $this->lock
            ->expects($this->once())
            ->method('acquire')
            ->with('test')
            ->will($this->returnValue(TRUE));
        $this->keyValue
            ->expects($this->exactly(2))
            ->method('setWithExpireIfNotExists')
            ->will($this->returnValue(FALSE));
        $this->keyValue
            ->expects($this->exactly(2))
            ->method('get')
            ->with('test')
            ->will($this->onConsecutiveCalls($this->ownObject, $this->otherObject));
        $this->assertTrue($this->tempStore
            ->setIfOwner('test', 'test_data'));
        $this->assertFalse($this->tempStore
            ->setIfOwner('test', 'test_data'));
    }
    
    /**
     * Tests the getMetadata() method.
     *
     * @covers ::getMetadata
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testGetMetadata() {
        $this->keyValue
            ->expects($this->at(0))
            ->method('get')
            ->with('test')
            ->will($this->returnValue($this->ownObject));
        $this->keyValue
            ->expects($this->at(1))
            ->method('get')
            ->with('test')
            ->will($this->returnValue(FALSE));
        $metadata = $this->tempStore
            ->getMetadata('test');
        $this->assertObjectHasAttribute('updated', $metadata);
        // Data should get removed.
        $this->assertObjectNotHasAttribute('data', $metadata);
        $this->assertNull($this->tempStore
            ->getMetadata('test'));
    }
    
    /**
     * Tests the delete() method.
     *
     * @covers ::delete
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testDelete() {
        $this->lock
            ->expects($this->once())
            ->method('acquire')
            ->with('test')
            ->will($this->returnValue(TRUE));
        $this->lock
            ->expects($this->never())
            ->method('wait');
        $this->lock
            ->expects($this->once())
            ->method('release')
            ->with('test');
        $this->keyValue
            ->expects($this->once())
            ->method('delete')
            ->with('test');
        $this->tempStore
            ->delete('test');
    }
    
    /**
     * Tests the delete() method with no lock available.
     *
     * @covers ::delete
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testDeleteWithNoLockAvailable() {
        $this->lock
            ->expects($this->at(0))
            ->method('acquire')
            ->with('test')
            ->will($this->returnValue(FALSE));
        $this->lock
            ->expects($this->at(1))
            ->method('wait')
            ->with('test');
        $this->lock
            ->expects($this->at(2))
            ->method('acquire')
            ->with('test')
            ->will($this->returnValue(FALSE));
        $this->keyValue
            ->expects($this->once())
            ->method('getCollectionName');
        $this->expectException(TempStoreException::class);
        $this->tempStore
            ->delete('test');
    }
    
    /**
     * Tests the deleteIfOwner() method.
     *
     * @covers ::deleteIfOwner
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testDeleteIfOwner() {
        $this->lock
            ->expects($this->once())
            ->method('acquire')
            ->with('test_2')
            ->will($this->returnValue(TRUE));
        $this->keyValue
            ->expects($this->at(0))
            ->method('get')
            ->with('test_1')
            ->will($this->returnValue(FALSE));
        $this->keyValue
            ->expects($this->at(1))
            ->method('get')
            ->with('test_2')
            ->will($this->returnValue($this->ownObject));
        $this->keyValue
            ->expects($this->at(2))
            ->method('delete')
            ->with('test_2');
        $this->keyValue
            ->expects($this->at(3))
            ->method('get')
            ->with('test_3')
            ->will($this->returnValue($this->otherObject));
        $this->assertTrue($this->tempStore
            ->deleteIfOwner('test_1'));
        $this->assertTrue($this->tempStore
            ->deleteIfOwner('test_2'));
        $this->assertFalse($this->tempStore
            ->deleteIfOwner('test_3'));
    }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title 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.
SharedTempStoreTest::$keyValue protected property The mock key value expirable backend.
SharedTempStoreTest::$lock protected property The mock lock backend.
SharedTempStoreTest::$otherObject protected property A tempstore object not belonging to the owner.
SharedTempStoreTest::$owner protected property The owner used in this test.
SharedTempStoreTest::$ownObject protected property A tempstore object belonging to the owner.
SharedTempStoreTest::$requestStack protected property The request stack.
SharedTempStoreTest::$tempStore protected property The user temp store.
SharedTempStoreTest::setUp protected function Overrides UnitTestCase::setUp
SharedTempStoreTest::testDelete public function Tests the delete() method.
SharedTempStoreTest::testDeleteIfOwner public function Tests the deleteIfOwner() method.
SharedTempStoreTest::testDeleteWithNoLockAvailable public function Tests the delete() method with no lock available.
SharedTempStoreTest::testGet public function @covers ::get
@expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
SharedTempStoreTest::testGetIfOwner public function Tests the getIfOwner() method.
SharedTempStoreTest::testGetMetadata public function Tests the getMetadata() method.
SharedTempStoreTest::testSet public function Tests a successful set() call.
SharedTempStoreTest::testSetIfNotExists public function Tests the setIfNotExists() methods.
SharedTempStoreTest::testSetIfOwner public function Tests the setIfOwner() method with matching and non matching owners.
SharedTempStoreTest::testSetIfOwnerNoObject public function Tests the setIfOwner() method when a key already exists but no object.
SharedTempStoreTest::testSetIfOwnerWhenNotExists public function Tests the setIfOwner() method when no key exists.
SharedTempStoreTest::testSetWithNoLockAvailable public function Tests the set() method with no lock available.
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.

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