My talk on integration tests in Magento 2 at Meet Magento Serbia 2016

1. Magento 2
Integration Tests
Dusan Lukic
@LDusan
http://www.dusanlukic.com

2. Magento 2

3. Magento 2 is a huge step forward

4. Magento 2 is a huge step forward
● Dependency injection

5. Magento 2 is a huge step forward
● Dependency injection
● Composer

6. Magento 2 is a huge step forward
● Dependency injection
● Composer
● Automated tests

7. What is testing?
Software testing is the process of validating and verifying that a
software program or application or product works as expected.
http://istqbexamcertification.com/what-is-a-software-testing/

8. Automated and manual tests

9. Automated testing vs manual testing
More info: http://www.base36.com/2013/03/automated-vs-manual-testing-the-pros-and-cons-of-each/
Automated testing Manual testing
Fast Slow
Costs less Costs more
Interesting Boring
Reusable
Improve code design

10. Integration tests

11. “Integration tests show that the major parts of a system work well
together”
- The Pragmatic Programmer Book

13. WHY?

14. Have you ever?

15. Have you ever?
● Installed a 3rd party module and it broke something else
on your project?

16. Have you ever?
● Installed a 3rd party module and it broke something else
on your project?
● Had a module that worked on local but not on production?
● Had 2 modules that have a conflict?
● Upgraded a project and it broke?
● Experienced problems with layout?
● Had an edge case?

17. Where do they fit?

19. Unit tests and integration tests difference
● Unit tests test the smallest units of code, integration tests test
how those units work together
● Integration tests touch more code
● Integration tests have less mocking and less isolation
● Unit tests are faster
● Unit tests are easier to debug

20. Functional tests and integration tests difference
● Functional tests compare against the specification
● Functional tests are slower
● Functional tests can tell us if something visible to the customer
broke

21. Integration tests in Magento 2
● Based on PHPUnit
● Can touch the database and filesystem
● Have separate database
● Deployed on close to real environment
● Separated into modules
● Magento core code is tested with integration tests

22. Setup
● bin/magento dev:test:run integration
● cd dev/tests/integration && phpunit -c phpunit.xml
● Separate database: dev/tests/integration/etc/install-config-mysql.php.dist
● Configuration in dev/tests/integration/phpunit.xml.dist
● TESTS_CLEANUP
● TESTS_MAGENTO_MODE
● TESTS_ERROR_LOG_LISTENER_LEVEL

23. Annotations

24. Annotations
/**
* Test something
*
* @magentoConfigFixture currency/options/allow USD
* @magentoAppIsolation enabled
* @magentoDbIsolation enabled
*/
public function testSomething()
{
}

25. What are annotations
● Meta data used to inject some behaviour
● Placed in docblocks
● Change test behaviour
● PHPUnit_Framework_TestListener
● onTestStart, onTestSuccess, onTestFailure, etc
More info: http://dusanlukic.com/annotations-in-magento-2-integration-tests

26. @magentoDbIsolation
● when enabled wraps the test in a transaction
● enabled - makes sure that the tests don’t affect each other
● disabled - useful for debugging as data remains in database
● can be applied on class level and on method level
/**
* @magentoDbIsolation enabled
*/

27. @magentoConfigFixture
/**
* @magentoConfigFixture current_store sales_email/order/attachagreement 1
*/
● Sets the config value

28. @magentoDataFixture
/dev/tests/integration/testsuite/Magento/Catalog/_files/product_special_price.php
$product =
MagentoTestFrameworkHelperBootstrap::getObjectManager()
->create('MagentoCatalogModelProduct');
$product->setTypeId('simple')
->setAttributeSetId(4)
->setWebsiteIds([1])
->setName('Simple Product')
->setSku('simple')
->setPrice(10)
->setStockData(['use_config_manage_stock' => 0])
->save();

29. Rollback script
$product = MagentoTestFrameworkHelperBootstrap::getObjectManager()
->create('MagentoCatalogModelProduct');
$product->load(1);
if ($product->getId()) {
$product->delete();
}
/dev/tests/integration/testsuite/Magento/Catalog/_files/product_special_price_rollback.php

30. Some examples

31. Some examples
But first!

32. Some examples
Don’t test Magento framework in your tests, test your
own code
But first!

33. Test that non existing category goes to 404
class CategoryTest extends
MagentoTestFrameworkTestCaseAbstractController
{
/*...*/
public function testViewActionInactiveCategory()
{
$this->dispatch('catalog/category/view/id/8');
$this->assert404NotFound();
}
/*...*/
}

34. Save and load entity
$obj = MagentoTestFrameworkHelperBootstrap::getObjectManager()
->get('LDusanSampleModelExampleFactory')
->create();
$obj->setVar('value');
$obj->save();
$id = $obj->getId();
$repo = MagentoTestFrameworkHelperBootstrap::getObjectManager()
->get('LDusanSampleApiExampleRepositoryInterface');
$example = $repo->getById($id);
$this->assertSame($example->getVar(), 'value');

35. Real life example, Fooman_EmailAttachments
● Most of the stores have terms and agreement
● An email is sent to the customer after each successful order
● Goal: Attach terms and agreement to order success email

36. Send an email and check contents
/**
* @magentoDataFixture Magento/Sales/_files/order.php
* @magentoDataFixture Magento/CheckoutAgreements/_files/agreement_active_with_html_content.php
* @magentoConfigFixture current_store sales_email/order/attachagreement 1
*/
public function testWithHtmlTermsAttachment()
{
$orderSender = $this->objectManager->create('MagentoSalesModelOrderEmailSenderOrderSender');
$orderSender->send($order);
$termsAttachment = $this->getAttachmentOfType($this->getLastEmail(), 'text/html; charset=UTF-8');
$this->assertContains('Checkout agreement content', base64_decode($termsAttachment['Body']));
}
public function getLastEmail()
{
$this->mailhogClient->setUri(self::BASE_URL . 'v2/messages?limit=1');
$lastEmail = json_decode($this->mailhogClient->request()->getBody(), true);
$lastEmailId = $lastEmail['items'][0]['ID'];
$this->mailhogClient->setUri(self::BASE_URL . 'v1/messages/' . $lastEmailId);
return json_decode($this->mailhogClient->request()->getBody(), true);
}

37. The View
Goal: Insert a block into catalog product view page
<XML />

38. Layout
<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configu
ration.xsd">
<body>
<referenceContainer name="content">
<block class="MagentoFrameworkViewElementTemplate" name="ldusan-
sample-block" template="LDusan_Sample::sample.phtml" />
</referenceContainer>
</body>
</page>
/app/code/LDusan/Sample/view/frontend/layout/catalog_product_view.xml

39. Template
<p>This should appear in catalog product view page!</p>
/app/code/LDusan/Sample/view/frontend/templates/sample.phtml

40. Test if block is added correctly
namespace LDusanSampleController;
class ActionTest extends MagentoTestFrameworkTestCaseAbstractController
{
/**
* @magentoDataFixture Magento/Catalog/_files/product_special_price.php
*/
public function testBlockAdded()
{
$this->dispatch('catalog/product/view/id/' . $product->getId());
$layout = MagentoTestFrameworkHelperBootstrap::getObjectManager()->get(
'MagentoFrameworkViewLayoutInterface'
);
$this->assertArrayHasKey('ldusan-sample-block', $layout->getAllBlocks());
}
}

41. At the end...
● Integration tests are not:
● The only tests that you should write
● Integration tests are:
● A way to check if something really works as expected
● Proof that our code works well with the environment

42. Thanks!
Slides on Twitter: @LDusan
Questions?
http://www.dusanlukic.com