Object manager helper

Block and model class constructors declare many dependencies. Adobe Commerce and Magento Open Source use constructor dependency injection. To unit test such classes, you must manually create mocks for all constructor parameters before you can instantiate the class objects. If the number of dependencies is ten or greater, this task is time-consuming.

Use the \Magento\Framework\TestFramework\Unit\Helper\ObjectManager helper class to simplify this task. Its methods automatically create mocks for all required dependencies. You can then instantiate a testing object by passing these mocks to a class constructor. You can still create your custom mocks, if needed.

Methods

The ObjectManager public interface methods are:

• getObject method. Creates class instances with automatically mocked dependencies.
• getCollectionMock method. Lists mocked constructor arguments.
• getConstructArguments method. Creates collection instances that contain specified elements.

getObject

Creates mocks for all constructor dependencies and applies any specified custom mocks from $arguments array. Also, instantiates the required $className by using constructor with already existing mocks.

Syntax:

Copy
public function getObject($className,
     array $arguments = []);
Copied to your clipboard
public function getObject($className,
     array $arguments = []);

Example:

Copy
$objectManagerHelper = new \Magento\TestFramework\Helper\ObjectManager($this);

// default constructor arguments
$scopePool = $objectManagerHelper->getObject('\Magento\App\Config\ScopePool');

// custom constructor arguments
$cacheMock = $this->getMock('\Magento\Cache\FrontendInterface');
...
$arguments = ['cache' => $cacheMock];
$scopePool = $objectManagerHelper->getObject('\Magento\App\Config\ScopePool',
     $arguments);
Copied to your clipboard
$objectManagerHelper = new \Magento\TestFramework\Helper\ObjectManager($this);

// default constructor arguments
$scopePool = $objectManagerHelper->getObject('\Magento\App\Config\ScopePool');

// custom constructor arguments
$cacheMock = $this->getMock('\Magento\Cache\FrontendInterface');
...
$arguments = ['cache' => $cacheMock];
$scopePool = $objectManagerHelper->getObject('\Magento\App\Config\ScopePool',
     $arguments);

getCollectionMock

Retrieves a collection instance with mocked getIterator method.

Syntax:

Copy
public function getCollectionMock($className,
     array $data);
Copied to your clipboard
public function getCollectionMock($className,
     array $data);

The collection contains elements from the $data array.

Example:

Copy
$objectManagerHelper = new \Magento\TestFramework\Helper\ObjectManager($this);
// Prepare mock for collection elements
$option = $this->getMock(
    'Magento\Bundle\Model\Option',
    ['getSelections', '__wakeup', 'getData'],
    [],
    '',
    false
);
$optionCollection =
     $this->objectManagerHelper->getCollectionMock('Magento\Bundle\Model\Resource\Option\Collection',
          [$options]);
Copied to your clipboard
$objectManagerHelper = new \Magento\TestFramework\Helper\ObjectManager($this);
// Prepare mock for collection elements
$option = $this->getMock(
    'Magento\Bundle\Model\Option',
    ['getSelections', '__wakeup', 'getData'],
    [],
    '',
    false
);
$optionCollection =
     $this->objectManagerHelper->getCollectionMock('Magento\Bundle\Model\Resource\Option\Collection',
          [$options]);

getConstructArguments

Lists dependency mocks for a specified class.

Syntax:

Copy
public function getConstructArguments($className,
     array $arguments = []);
Copied to your clipboard
public function getConstructArguments($className,
     array $arguments = []);

In Adobe Commerce and Magento Open Source, several tests introduced mocks for abstract models and blocks.

Example:

Copy
$attributeData = [
    'store_label' => 'Test',
    'attribute_code' => 'test',
    'is_required' => 1,
    'validate_rules' => [
        'min_text_length' => 0,
        'max_text_length' => 0,
        'input_validation' => 0,
    ]
];
$objectManagerHelper = new \Magento\TestFramework\Helper\ObjectManager($this);
$attributeClass = '\Magento\Eav\Model\Entity\Attribute\AbstractAttribute';
$objectManagerHelper = new \Magento\TestFramework\Helper\ObjectManager($this);
// Retrieve mocked constructor arguments
$arguments = $objectManagerHelper->getConstructArguments(
    $attributeClass,
    [
        'data' => $attributeData,
    ]
);

/** @var $attribute \Magento\Eav\Model\Entity\Attribute\AbstractAttribute|\PHPUnit\Framework\MockObject\MockObject */
$attribute = $this->getMockForAbstractClass($attributeClass,
    $arguments);
Copied to your clipboard
$attributeData = [
    'store_label' => 'Test',
    'attribute_code' => 'test',
    'is_required' => 1,
    'validate_rules' => [
        'min_text_length' => 0,
        'max_text_length' => 0,
        'input_validation' => 0,
    ]
];
$objectManagerHelper = new \Magento\TestFramework\Helper\ObjectManager($this);
$attributeClass = '\Magento\Eav\Model\Entity\Attribute\AbstractAttribute';
$objectManagerHelper = new \Magento\TestFramework\Helper\ObjectManager($this);
// Retrieve mocked constructor arguments
$arguments = $objectManagerHelper->getConstructArguments(
    $attributeClass,
    [
        'data' => $attributeData,
    ]
);

/** @var $attribute \Magento\Eav\Model\Entity\Attribute\AbstractAttribute|\PHPUnit\Framework\MockObject\MockObject */
$attribute = $this->getMockForAbstractClass($attributeClass,
    $arguments);

Last updated 9/8/2023

Was this helpful?

Yes

No