GSoC2015 Week seven and writing some unit test

This post is about the progress which I have made while porting print module to Drupal 8 as part of GSoC 2015. Below is an excerpts about the work done in week seven while work done in week six can be tracked over here.

Last week I managed to finish work on mPDF and TCPDF generator and also most of the requirements for the pdf sub module were completed. So this week I started writing some unit test for the module. Writing tests for the module was a totally new experience for me because earlier the tests which I had written were mostly for the issues on drupal.org hence they were not that much complicated.

Ofcourse before starting to write some unit tests I tried to understand the concept by going through several resources but the best material is present over here in my opinion so any one willing to learn the concept of unit testing may refer to same. Going through the unit test present in module residing within the core will also help. Refer to this link if you want to learn how to run them.

Currently it is one of the issues of the core in Drupal 8 that the unit test present within a module residing inside the custom folder will not be identified by this command ./vendor/bin/phpunit/phpunit/phpunit –list-groups. The problem lies inside the phpunit.xml.dist file present within the core. If you change the line which says ../modules/custom/tests/src/Unit to ../modules/custom/*/tests/src/Unit then your problem will be solved and unit test written for your module will be identified by the core.

Most of the concept and knowledge required for writing unit test can be obtained through above links hence I do not intend to write about them but some code for which I had to do some additional search I would like to mention about them below:

Mock object which support chaining methods:

$routematch = $this->getMockBuilder('Drupal\Core\Routing\CurrentRouteMatch')
  ->disableOriginalConstructor()
  ->setMethods(array('getMasterRouteMatch', 'getParameter'))
  ->getMock();
$routematch->expects($this->exactly(2))
  ->method('getMasterRouteMatch')
  ->will($this->returnSelf());
$routematch->expects($this->exactly(2))
  ->method('getParameter')
  ->will($this->returnValue($this->getMock('Drupal\Core\Entity\EntityInterface')));

Disabling original constructor of class while calling them:

$entity_definition = $this->getMockBuilder('Drupal\Core\Entity\EntityType')
  ->disableOriginalConstructor()
  ->getMock();

I would recommend anyone willing to learn more about this code refer to this link where unit tests for printable module are being actively written. Next week I will be writing some more unit tests and then try to wrap up PDF sub module.

Some progress of PDF part of module can be viewed over here and remaining over here.