class DisplayManagerTest

Same name in other branches
  1. 4.0.x modules/phpunit_example/tests/src/Unit/DisplayManagerTest.php \Drupal\Tests\phpunit_example\Unit\DisplayManagerTest

DisplayManager unit test with doubles.

@group phpunit_example @group examples

Hierarchy

Expanded class hierarchy of DisplayManagerTest

Related topics

File

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

Namespace

Drupal\Tests\phpunit_example\Unit
View source
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

Title Sort descending Deprecated Modifiers Object type Summary Overrides
DisplayManagerTest::testSimpleMockDisplayManager public function Test for DisplayManager's DisplayableItemInterface handling.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
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 338
UnitTestCase::setUpBeforeClass public static function