Mocking Drupal: Unit Testing In Drupal 8 - Softpixel

Mocking Drupal:Unit Testing inDrupal 8Matthew Radcliffemradcliffe@mattkineme

Spoilers Quality Assurance PHPUnit Mocking Drupal things

Quality Assurance Prevent defects from making it to the customer: Adopt standards and specifications Review code Manage releases Test code

Some Types of Testing User Acceptance Test: Test according to specification orrequirement. Functional Test: Test one function (or feature) expected output. Unit Test: Test the smallest “unit” of testable code (in isolation). Integration Test: Test the interaction of “units” in 1 or more systems. Behavioral Test: Automated UAT or black box testing. Stress Test: Test the product under heavy load/stress.

Value of Testing Fundamental problems of software programming “I didn’t think anyone would do THAT!” “Why did it break?” Increase reliability and quality of software.Discover regressions in software.Improve confidence in our code. “I think this will work.”

Common ExcusesDroofus saysDropant saysWriting tests takes too long.Start small. 100% coverage isn’t going tocome in a day, and every bit helps.I don’t have source control / versioncontrol.Do not pass go. Do not write any morecode. Go directly to a Git repository.I don’t have any testing infrastructureRun locally, enforce social contract. Orsetup TravisCI/Jenkins.I don’t know what I’m going to writeuntil I write it.Not everyone needs to adopt Test-DrivenDevelopment, but it is “best practice”.My code is heavily integrated with state I test only what I need to and mock the(database or web services).rest.

Unit Tests A unit is the smallest testable piece of code, which is often afunction, class or method. Plug a set of inputs into that code, and confirm the expectedoutput (like behavioral and integration tests). Units should act in memory and not depend on other systems. Should be fast. Do not run Drupal installation. Run all unit tests after code change.

Drupal & Unit Tests Modules have complex dependencies and setup necessary todo what they do. Simpletest module is still a test runner for both SimpleTestand PHPUnit tests, but You may use phpunit directly instead, and core/scripts/run-tests.shis a hot mess.

PHPUnit: Getting Started phpunit.xml configuration bootstrap Test class in tests/src/Unit instead of src/Tests. Annotations Assertions Data Providers Test Doubles

?xml version "1.0" encoding "UTF-8"? phpunit php ini name "error reporting" value "32767"/ ini name "memory limit" value "-1"/ /php testsuites testsuite name "My Module Unit Test Suite" directory tests /directory exclude ./vendor /exclude exclude ./drush/tests /exclude /testsuite /testsuites !-- Filter for coverage reports. -- filter whitelist directory src /directory exclude directory src/Tests /directory /exclude /whitelist /filter /phpunit

Use Core’s Bootstrap? Add more namespaces to autoloader than are necessary i.e.increased memory. Necessary because contrib namespaces are not loaded byComposer autoloader. Can re-use core abstract test class with mockeddependencies easier.Relative path may conflict with where phpunit can be runfrom.

Abstract Test Classes Drupal\Tests\UnitTestCase Basic unit test class with some useful test doubles. sts\KernelTestBase Adds database and filesystem state, but without aninstallation at the cost of performance. Not as slow asSimpleTest functional tests.

Class Annotations Class Annotations @group Required for drupal.org testing infrastructure.

Assertions assertEquals assertArrayHasKey assertEmpty assertArrayHasSubset assertSame assertCount assertInstanceOf assertFileExists assertXmlStringEqualsXmlFile assertNullPHPUnit Manual. sertions.html

Data Providers A data provider is a method that returns an array ofparameters to pass into a test method. A test method may test several inputs.Important to note that data provider methods are run beforeany setup so this cannot depend on any test doubles.

function sequenceProvider() {return [[0, 0],[5, 8],[10, 55],[100, 354224848179261915075],[-5, 5],[-6, 8]];}/*** Test class with data provider.** @dataProvider sequenceProvider*/function testFibonacciWithProvider( number, output) { this- assertEquals( output, fibonacci( number));}

setUp The setUp method is executed for every test method in aclass. Configure fixtures or setting up known state such asdatabase or test files. Configure test doubles or mocks, which are dependencies ofa unit that you do not need to test in that test class. Advice: Add you own abstract test classes to create fixturesor test double commonly used across your test classes.

Test Doubles Test doubles (or mock objects) allow to focus a unit test onthe code that needs to be tested without bootstrappingdependencies. Example: I don’t want to load Drupal 8’s Entity system whenI test my unrelated code. Instead PHPUnit allows to create amock via Reflection so that I get an object that looks like anEntity. Reflection or introspection allows a program to knowabout and modify itself at runtime.

Test Doubles getMockBuilder() disableOriginalConstructor()method() with() callback() withConsecutive() will() onConsecutive() returnValueMap()

Prophecy Drupal’s dev requirements include the prophecy test doublelibrary and integrated into the UnitTestBase class. Prophecy provides more readable test code But it is “opinionated” in that it will never be able to mockthings such as magic methods or method chaining.

Prophecy A prophecy returned by prophesize() is an object thatyou can call the same methods as the Class or Interface youare mocking. Once the prophecy object has its methods and return valuesmocked, the reveal() method will return the mockedobject. This reduces the complexity of mocking somewhat.

Test Double Risks Assume too much about the framework. Tests can pass when the framework changes. Could assume one thing leading to breaking actual codeusage. Ouch. :(Having to mock a lot is a sign of architecture issues.

Mocking Drupal“You’re crazy.”–webçick (June, 2015)

Mocking Drupal Entity Plugin Database Form Other services

Mocking Entities Mock low-level classes that entities use: Config Entity Config: The immutable config is useful to mock forconfig forms.

Xero ModuleDrupal\Tests\Unit\xero\Form\SettingsFormTest

protected function setUp() {parent::setUp();// Mock config object. this- config this- g')- disableOriginalConstructor()- getMock();// Mock ConfigFactory service. configFactory this- - disableOriginalConstructor()- getMock(); configFactory- expects( this- any())- method('getEditable')- with('xero.settings')- will( this- returnValue( this- config));

public function testNoPrivateKey() { key this- createToken(); secret this- createToken();// Mock the getter. this- config- expects( this- any())- method('get')- withConsecutive([‘oauth.consumer key'],[‘oauth.consumer secret'],['oauth.key path'])- will( this- onConsecutiveCalls( key, secret, ''));

public function testNoPrivateKey() { key this- createToken(); secret this- createToken(); values ['oauth.consumer key' key,'oauth.consumer secret' secret,'oauth.key path' '',]; configProphecy this- prophesize('\Drupal\Core\Config\ImmutableConfig'); configProphecy- get(Argument::type('string'))- will(function( args) use( values) {return values[ args[0]];}); this- configFactory- expects( this- any())- method('getEditable')- with('xero.settings')- will( this- returnValue( configProphecy- reveal()));

Xero ModuleDrupal\xero\Form\SettingsForm

public function buildForm(array form, FormStateInterface form state) { config self::config('xero.settings');// . form['oauth']['consumer key'] array('#type' 'textfield','#title' this- t('Xero Consumer Key'),'#default value' config- get('oauth.consumer key'),); form['oauth']['consumer secret'] array('#type' 'textfield','#title' this- t('Xero Consumer Secret'),'#default value' config- get('oauth.consumer secret'),); form['oauth']['key path'] array('#type' 'textfield','#title' this- t('Xero Key Path'),'#default value' config- get('oauth.key path'),'#element validate' array(array( this, 'validateFileExists')),);return parent::buildForm( form, form state);}

Mocking Entities Mock low-level classes that entities use: Content Entity Entity Manager: getDefinition, getStorage,getFieldDefinitions Entity Storage: loadMultiple, load configuration entities would mock ConfigStorageNode: getTitle, get

class MockingDrupalFormTest extends FormTestBase {protected function setUp() {parent::setUp(); this- node title this- getRandomGenerator()- word(10); this- node this- getMockBuilder('Drupal\node\Entity\Node')- disableOriginalConstructor()- getMock(); this- node- expects( this- any())- method('getTitle')- will( this- returnValue( this- node title)); this- nodeStorage this- getMockBuilder('Drupal\node\NodeStorage')- disableOriginalConstructor()- getMock(); this- nodeStorage- expects( this- any())- method('load')- will( this- returnValueMap([[1, this- node],[500, NULL],])); entityManager this- terface')- disableOriginalConstructor()- getMock(); entityManager- expects( this- any())- method('getStorage')- with('node')- willReturn( this- nodeStorage);

Mocking Plugins? No mock necessary: instantiate the plugin class depends onplugin type: Create via initialize ( construct) with definition array andany additional settings for the plugin type.Mock the plugin manager for the plugin type, if necessary Typed Data Manager requires getDefinitions to beconsecutively mocked if dealing with composite datatypes.

Key ModuleDrupal\Tests\Unit\key\KeyRepositoryTest

public function defaultKeyContentProvider() { defaults ['key value' this- createToken()]; definition ['id' 'config','class' 'title' 'Configuration',]; KeyProvider new ConfigKeyProvider( defaults, 'config', definition);return [[ defaults, KeyProvider]];}

Xero ase

public function setUp() {// Typed Data Manager setup. this- typedDataManager this- nager')- disableOriginalConstructor()- getMock(); this- typedDataManager- expects( this- any())- method('getDefinition')- with(static::XERO TYPE, TRUE)- will( this- returnValue(['id' ‘xero employee', 'definition class' nition’]));// Snip. . . . . . . . . . . .// Mock the container. container new ContainerBuilder(); container- set('typed data manager', this- typedDataManager);\Drupal::setContainer( container);// Create data definition definition class static::XERO DEFINITION CLASS; this- dataDefinition definition class::create(static::XERO TYPE);}

Typed Widgets ModuleDrupal\Tests\Unit\typed widget\TypedElementTestBase

protected function getEntityTypeManagerMock() { prophecy this- nterface');return prophecy- reveal();}protected function getTypedDataMock(DataDefinitionInterface definition, array constraints []){ typedDataProphecy this- rInterface'); typedDataProphecy- createDataDefinition( definition- getDataType())- willReturn( definition); typedDataProphecy- getDefaultConstraints( definition)- willReturn( constraints); typedDataProphecy- getDefinition( definition- getDataType())- willReturn( definition); typedDataProphecy- getDefinitions()- willReturn([ definition- getDataType() definition]);if ( definition instanceof ComplexDataDefinitionInterface) {foreach ( definition- getPropertyDefinitions() as name child definition) { typedDataProphecy- createDataDefinition( child definition- getDataType())- willReturn( child definition); typedDataProphecy- getDefaultConstraints( child definition)- willReturn([]); typedDataProphecy- getDefinition( child definition- getDataType())- willReturn( child definition);}}elseif ( definition instanceof ListDataDefinitionInterface) { typedDataProphecy- createDataDefinition('string')- willReturn( definition- getItemDefinition()); typedDataProphecy- getDefaultConstraints( definition- getItemDefinition())- willReturn([]); typedDataProphecy- getDefinition('string')- willReturn( definition- getItemDefinition());}return typedDataProphecy- reveal();}