class DisplayManagerTest in Examples for Developers 8

DisplayManager unit test with doubles.

@group phpunit_example @group examples

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\phpunit_example\Unit\DisplayManagerTest

Related topics

Example: PHPUnit

This example demonstrates PHPUnit for Drupal 8 unit testing.

File

phpunit_example/tests/src/Unit/DisplayManagerTest.php, line 17

Namespace

Drupal\Tests\phpunit_example\Unit

class DisplayManagerTest extends UnitTestCase {

  /**
   * Test for DisplayManager's DisplayableItemInterface handling.
   *
   * This method sets up a mock DisplayableItemInterface object
   * and then feeds it to a DisplayManager object to test
   * the behavior of DisplayManager.
   *
   * See the inline comments for a thorough walk-through.
   */
  public function testSimpleMockDisplayManager() {

    // Setting up:
    // Get a mock object belonging to our desired interface.
    // Note that we have to fully qualify the domain name
    // for PHPUnit's benefit.
    $mock = $this
      ->getMockBuilder(DisplayInfoInterface::class)
      ->getMockForAbstractClass();

    // Here we're illustrating that the mock object belongs to
    // our interface.
    $this
      ->assertTrue($mock instanceof DisplayInfoInterface);

    // 'Program' our mock object to return a value for getDisplayName().
    // expects($this->any()) tells the mock to return this value any time
    // the method is called.
    $mock
      ->expects($this
      ->any())
      ->method('getDisplayName')
      ->will($this
      ->returnValue('the display name'));

    // Create a DisplayManager, the class we're actually testing here.
    $dm = new DisplayManager();

    // Give it the mocked info object.
    $dm
      ->addDisplayableItem($mock);

    // Assert that our DisplayManager has exactly one display object (our mock).
    $this
      ->assertEquals(1, $dm
      ->countDisplayableItems());

    // Assert that the DisplayManager can find our mocked info object.
    $this
      ->assertSame($mock, $dm
      ->item('the display name'));

    // Assert that the DisplayManager can't find an info object
    // that it shouldn't have.
    $this
      ->assertNull($dm
      ->item('nonexistant'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DisplayManagerTest::testSimpleMockDisplayManager	public	function	Test for DisplayManager's DisplayableItemInterface handling.
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.
UnitTestCase::setUp	protected	function		340