class ExtensionSerializationTest in Drupal 8

Tests Extension serialization.

@coversDefaultClass \Drupal\Core\Extension\Extension @group Extension

Hierarchy

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

File

core/tests/Drupal/Tests/Core/Extension/ExtensionSerializationTest.php, line 16

Namespace

Drupal\Tests\Core\Extension

class ExtensionSerializationTest extends UnitTestCase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    vfsStream::setup('dummy_app_root');
    vfsStream::create([
      'core' => [
        'modules' => [
          'system' => [
            'system.info.yml' => file_get_contents($this->root . '/core/modules/system/system.info.yml'),
          ],
        ],
      ],
    ]);
  }

  /**
   * Tests that the Extension class unserialize method uses the preferred root.
   *
   * When the Extension unserialize method is called on serialized Extension
   * object data, test that the Extension object's root property is set to the
   * container's app.root and not the DRUPAL_ROOT constant if the service
   * container app.root is available.
   *
   * @covers ::__sleep
   * @covers ::__wakeup
   */
  public function testServiceAppRouteUsage() {

    // The assumption of our test is that DRUPAL_ROOT is not defined.
    $this
      ->assertFalse(defined('DRUPAL_ROOT'), 'Constant DRUPAL_ROOT is defined.');
    $container = new ContainerBuilder();

    // Set a dummy container app.root to test against.
    $container
      ->set('app.root', 'vfs://dummy_app_root');
    \Drupal::setContainer($container);

    // Instantiate an Extension object for testing unserialization.
    $extension = new Extension($container
      ->get('app.root'), 'module', 'core/modules/system/system.info.yml', 'system.module');
    $extension = unserialize(serialize($extension));
    $this
      ->assertEquals('vfs://dummy_app_root', $this
      ->readAttribute($extension, 'root'));
  }

  /**
   * Tests dynamically assigned public properties kept when serialized.
   *
   * @covers ::__sleep
   * @covers ::__wakeup
   */
  public function testPublicProperties() {
    $container = new ContainerBuilder();

    // Set a dummy container app.root to test against.
    $container
      ->set('app.root', 'vfs://dummy_app_root');
    \Drupal::setContainer($container);
    $extension = new Extension($container
      ->get('app.root'), 'module', 'core/modules/system/system.info.yml', 'system.module');

    // Assign a public property dynamically.
    $extension->test = 'foo';
    $extension = unserialize(serialize($extension));
    $this
      ->assertSame('foo', $extension->test);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExtensionSerializationTest::setUp	protected	function	Overrides UnitTestCase::setUp
ExtensionSerializationTest::testPublicProperties	public	function	Tests dynamically assigned public properties kept when serialized.
ExtensionSerializationTest::testServiceAppRouteUsage	public	function	Tests that the Extension class unserialize method uses the preferred root.
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.
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.