ecomdev/magento2-test-essentials

Magento 2 Test Essentials

dev-main 2021-06-22 19:53 UTC

Requires

• php: ~7.2|~8.0
• magento/framework: ~102.0|~103.0
• magento/module-catalog: ~103.0|~104.0
• magento/module-customer: ~102.0|~103.0
• magento/module-quote: ~101.0
• magento/module-store: ~101.0

Requires (Dev)

• phpunit/phpunit: ~9.5
• squizlabs/php_codesniffer: ^3.6.0

MIT

• testing
• magento2
• fake objects

README

Using mocking frameworks for testing Magento 2 modules is counterproductive as you replicate line by line your actual calls to a magento implementation.

Binding your tests to the details of implementation leads to very fragile test suite that no-one wants to work with afterwards as a small change in underlying code like extraction of the class requires complete rewrite of the test case.

This package solves this problem by providing fake objects for most common operations you might want to interact with core.

As well as set of fake objects there is an ObjectManagerInterface implementation that automatically instantiates dependencies if you use create method and allows specifying custom factories for creation of deep dependency.

Each fake object is covered by automated tests to make sure that behaviour is correct your tests can test your code specific behaviour by using different scenarios.

Installation

composer require --dev ecomdev/magento2-test-essentials

Examples

Testing functionality that tries to resolve a default store

use EcomDev\Magento2TestEssentials\ObjectManager;
use EcomDev\Magento2TestEssentials\Store\StoreManager;
use EcomDev\Magento2TestEssentials\Store\Store;
use Magento\Store\Model\StoreManagerInterface;
use Magento\Catalog\Model\Product;

class YourTestedClass 
{
    private $storeManager;
    
    public function __construct(StoreManagerInterface $storeManager) 
    {
        $this->storeManager = $storeManager;
    }
    
    public function applyCurrentStoreToProduct(Product $product) 
    {
        $product->setStoreId($this->storeManager->getStore()->getId());
    }
}

class YourTestedClassTest extends \PHPUnit\Framework\TestCase
{
    /** @test */
    public function appliesStoreIdToProduct() 
    { 
        $applier = new YourTestedClass(
            StoreManager::new()
                ->withStore(Store::new(3, 'store_three'))
                ->setCurrentStore('store_three')
        );
        
        // Creates product without any constructor but if you rely on data fields, it works great
        $product = ObjectManager::new()->get(Product::class); 
        
        $applier->applyCurrentStoreToProduct(
            $product
        );
        
        $this->assertEquals(3, $product->getStoreId());
    }
}

Features

• ObjectManagerInterface implementation which mimics platform's behaviour
• StoreInterface implementation as a simple data object for testing store related behaviour
• GroupInterface implementation as a simple data object for testing store group related behaviour
• WebsiteInterface implementation as a simple data object for testing website related behaviour
• ScopeConfigurationInterface implementation for testing configuration dependent functionality
• ShoppingCartInterface implementation for testing shopping cart related functionalities
• CustomerInterface implementation for testing customer related functionalities
• Customer/Session implementation for testing functionalities that depend on current customer data
• Checkout/Session implementation for testing functionalities that depend on current checkout data