Getting your hands dirty testing Magento 2 (at MageTitansIT)

GETTING YOUR HANDS DIRTY
TESTING
MAGENTO 2
Getting your hands dirty Testing Magento 2 - Magento London Meetup, Feb. 2016 - ! - contact@vinaikopp.com - twitter://@VinaiKopp

ME
Freelance Developer & Trainer
https://github.com/vinai
https://twitter.com/vinaikopp
Dev since 1998
PHP WebDev since PHP3 (1999)
Magento since 2008-01-01

TESTING

WHO IS DOING IT?

WHAT TOOL?
> PHPUnit?
> Behat && PHPSpec?
> Selenium?
> Codeception?

BUZZWORD
BINGO

BUZZWORD I:
UNIT TEST

$ vendor/bin/phpunit -c "dev/tests/unit/phpunit.xml.dist"

$ alias unit-test="$(pwd)/vendor/bin/phpunit
-c $(pwd)/dev/tests/unit/phpunit.xml.dist"

$ unit-test

$ unit-test "app/code/My/Module/Test/Unit"

TRY IT
vendor/bin/phpunit
-c "dev/tests/unit/phpunit.xml.dist"
vendor/magento/module-catalog/Test/Unit/Block

BUZZWORD II:
INTEGRATION
TEST

WHAT IS THE
DIFFERENCE?

REAL OBJECTS INTERACT

INTEGRATION TESTS NEED THE
RUNTIME ENVIRONMENT

A failing unit test tells me
exactly where my code is broken.

A failing integration test only
tells me that something is broken.

Separate DB
dev/tests/integration/etc/install-config-mysql.php.dist

$ vendor/bin/phpunit -c dev/tests/integration/phpunit.xml
Could not read "dev/tests/integration/phpunit.xml".

$ cd dev/tests/integration
$ ../../../vendor/bin/phpunit

Every run gets it's own
etc, pub and var dirs
dev/tests/integration/tmp/
sandbox-0-b79c13eb842cf3211459b11c775bfbde/

BUZZWORD III:
TDD

WHAT IS TDD?

THE 3 RULES

I. No production code without
a failing unit test

II. Once there is a failing unit test,
stop and make it pass
by writing production code

III. Once the test passes,
stop writing production code
until you have a failing unit test again

TDD FOR MAGENTO 2

NO DIFFERENCE

</TDD>

To learn more about TDD,
check out the Clean Coders
Videos from Robert C. Martin
http://cleancoders.com
(or do a training)

INTEGRATION TESTS
FOR MAGENTO 2

VERY SPECIFIC

PLATFORM KNOWLEDGE

Magento 2 Testing Framework
dev/tests/integration/framework

Test Framework ObjectManager
MagentoTestFrameworkObjectManager::getInstance()

Dependencies
$configReader = $objectManager->create(Reader::class);
$deploymentConfig = $objectManager->create(
DeploymentConfig::class,
['reader' => $configReader]
);

BUZZWORD IV
FIXTURES

Fix the system into a known state
before a test is executed.

Simple PHP Scripts
Relative to
dev/tests/integration/testsuite

/**
* @magentoDataFixture Magento/Sales/_files/order.php
* @magentoDataFixture Magento/Customer/_files/customer.php
*/
public function testSomethingWithAnOrderAndACustomer()
{
// ...

CONFIG FIXTURES

Store Scope
/**
* @magentoConfigFixture current_store catalog/price/scope 1
*/
public function testDoesSomeoneReadThisHelpMeLetMeOut()
{
// ...

Global Scope
/**
* @magentoConfigFixture currency/options/allow USD
*/
public function testHowMashAndPieTastes()
{
// ...

BUZZWORD V
TEST ISOLATION

FRESH INSTALL
FOR EACH TEST RUN

dev/tests/integration/phpunit.xml.dist
<phpunit>
...
<php>
...
<const name="TESTS_CLEANUP" value="enabled"/>
...
</php>
...
</phpunit>

TESTS_CLEANUP
== disabled
SPEEDS THINGS UP

TESTS_CLEANUP
== disabled
MANUAL CLEANUP REQUIRED

integration/tmp/sandbox-*

DATABASE ISOLATION

TRANSACTIONS
OR
ROLLBACK SCRIPTS

TRANSACTIONS
/**
* @magentoDbIsolation enabled
*/
public function testWithoutSideEffects
{
// ...

TRANSACTIONS
/**
* @magentoDataFixture Magento/Foo/_files/bar.php
*/
public function testTheFixtureIsAppliedWithinATransaction
{
// ...

ROLLBACK SCRIPTS
/**
* @magentoDataFixture Magento/Customer/_files/customer.php
* @magentoDbIsolation disabled
*/
public function testTransactionalCode()
{
// ...

Before Test
include 'Magento/Customer/_files/customer.php';

After Test
include 'Magento/Customer/_files/customer_rollback.php';

APPLICATION ISOLATION

REINSTANTIATE
ALMOST EVERYTHING

RESET MAGENTO AFTER TEST
/**
* @magentoAppIsolation enabled
*/
public function testTestWithSingletons()
{

Controller Tests: Automatic reset
class FooBarIndexActionTest extends
MagentoTestFrameworkTestCaseAbstractController
{
public function testTheLayoutIsRendered()
{
$this->dispatch('foo/bar/index');

REMEMBER
THIS

ISOLATE
YOUR TESTS

AND ALL WILL BE
GOOD

[breathing pause]

APPLICATION AREA

APP AREAS
global
frontend
adminhtml

/**
* @magentoAppArea frontend
*/
class AddressesTest extends PHPUnit_Framework_TestCase
{

MORE AREAS

webapi_rest
webapi_soap
cron

MagentoTestFrameworkAppState

public function testPluginInWebapiRestScope()
{
$class = MagentoTestFrameworkAppState::class;
$appAreaState = $this->objectManager->get($class);
$appAreaState->setAreaCode('webapi_rest');

protected function tearDown()
{
// ...
$appAreaState->setAreaCode(null);
}

ACTION
[CONTROLLER]
TESTS

FRONTEND
MagentoTestFrameworkTestCase
AbstractController
ADMINHTML
MagentoTestFrameworkTestCase
AbstractBackendController

EXAMPLE!

Event Observer for:
sales_order_place_after

I. TESTING THE
CONFIGURATION

public function testTheModuleRegistersASalesOrderPlaceAfterObserver()
{
$class = MagentoFrameworkEventConfig::class;
$eventConfig = ObjectManager::getInstance()->create($class);
$observers = $eventConfig->getObservers('sales_order_place_after');
$this->assertArrayHasKey('meetup_observer', $observers);
$expectedClass = MeetupObserverObserverSalesOrderPlaceAfter::class;
$this->assertSame($expectedClass, $observers['meetup_observer']['instance']);
$this->assertFalse($observers['meetup_observer']['shared']);
}

1/2) Get the config in array format
$class = MagentoFrameworkEventConfig::class;
$eventConfig = ObjectManager::getInstance()->create($class);
$event = 'sales_order_place_after';
$observers = $eventConfig->getObservers($event);

2/2) Assert config values
$this->assertArrayHasKey('meetup_observer', $observers);
$this->assertSame(
SalesOrderPlaceAfter::class,
$observers['meetup_observer']['instance']
);
$this->assertFalse($observers['meetup_observer']['shared']);

II. TESTING THE OBSERVER

O_0(NOTHING TO TEST)

III. INTEGRATION TEST

Our observer has no side effects.
We have to improvise...

/**
*/
public function testSalesOrderPlaceAfterObserverIsCalled()
{
$this->injectMockObserverWithExpectation();
$order = $this->getOrderFixture();
$this->objectManager
->create(OrderManagementInterface::class)
->place($order);
}

public function injectMockObserverWithExpectation()
{
$mockObserver = $this->getMock(SalesOrderPlaceAfter::class);
$mockObserver->expects($this->once())->method('execute');
$this->registerObserverTestDouble($mockObserver);
}

private function registerObserverTestDouble($mockObserver)
{
$class = MagentoFrameworkEventConfigData::class;
$eventConfigData = $this->objectManager->get($class);
$event = 'sales_order_place_after';
$name = 'meetup_observer';
$eventConfigData->merge(
[$event => [$name => ['shared' => true]]]
);
// ...
}

private function registerObserverTestDouble($mockObserver)
{
// ...
$this->objectManager->addSharedInstance(
$mockObserver,
SalesOrderPlaceAfter::class
);
}

/**
*/
public function testSalesOrderPlaceAfterObserverIsCalled()
{
// ...
$order = $this->getOrderFixture();
// ...

private function getOrderFixture()
{
$class = OrderRepositoryInterface::class;
$orderRepository = $this->objectManager->create($class);
$criteria = $this->objectManager
->create(SearchCriteriaBuilder::class)
->addFilter('increment_id', '100000001')
->create();
$result = $orderRepository->getList($criteria);
return array_values($result->getItems())[0];
}

GO FORTH
AND TESTALL THINGS!

ONE MORE THING...

MAGE2KATAS

MAGE2KATAS
> Screencast Series
> Examples
> Code Katas
mage2katas.com

THANK YOU <3

Getting your hands dirty testing Magento 2 (at MageTitansIT)

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Ähnlich wie Getting your hands dirty testing Magento 2 (at MageTitansIT)

Ähnlich wie Getting your hands dirty testing Magento 2 (at MageTitansIT) (20)

Mehr von vinaikopp

Mehr von vinaikopp (12)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Getting your hands dirty testing Magento 2 (at MageTitansIT)