class SharedTempStoreTest in Zircon Profile 8

@coversDefaultClass \Drupal\user\SharedTempStore @group user

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
  • class \Drupal\Tests\user\Unit\SharedTempStoreTest

File

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

Contains \Drupal\Tests\user\Unit\SharedTempStoreTest.

Namespace

Drupal\Tests\user\Unit

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
      ->getMock('Drupal\\Core\\KeyValueStore\\KeyValueStoreExpirableInterface');
    $this->lock = $this
      ->getMock('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) array(
      '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
   */
  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
   */
  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
   * @expectedException \Drupal\user\TempStoreException
   */
  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->tempStore
      ->set('test', 'value');
  }

  /**
   * Tests a successful set() call.
   *
   * @covers ::set
   */
  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
   */
  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
   */
  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
   */
  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
   */
  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
   */
  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('owner', $metadata);

    // Data should get removed.
    $this
      ->assertObjectNotHasAttribute('data', $metadata);
    $this
      ->assertNull($this->tempStore
      ->getMetadata('test'));
  }

  /**
   * Tests the delete() method.
   *
   * @covers ::delete
   */
  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
   * @expectedException \Drupal\user\TempStoreException
   */
  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->tempStore
      ->delete('test');
  }

  /**
   * Tests the deleteIfOwner() method.
   *
   * @covers ::deleteIfOwner
   */
  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

Name	Modifiers	Type	Description	Overrides
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
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.
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName	protected	function	Mocks a block with a block plugin.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed in 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.