Entity Class Reference

Public Member Functions
	__construct (\Magento\Framework\Model\AbstractModel $model, array $updateData, $modelClass=null)
	testCrud ()

Protected Member Functions
	_getEmptyModel ()
	_testCreate ()
	_testRead ()
	_testUpdate ()
	_testDelete ()

Protected Attributes
	$_model
	$_updateData
	$_modelClass

Detailed Description

Class that implements CRUD tests for \Magento\Framework\Model\AbstractModel based objects

Definition at line 12 of file Entity.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Model\AbstractModel	$model,
		array	$updateData,
			$modelClass = null
	)

Parameters

\Magento\Framework\Model\AbstractModel	$model
array	$updateData
string | null	$modelClass	Class of a model to use when creating new instances, or NULL for auto-detection

Exceptions

Definition at line 35 of file Entity.php.

    {
        $this->_model       = $model;
        $this->_updateData  = $updateData;
        if ($modelClass) {
            if (!$model instanceof $modelClass) {
                throw new \InvalidArgumentException("Class '$modelClass' is irrelevant to the tested model.");
            }
            $this->_modelClass = $modelClass;
        } else {
            $this->_modelClass = get_class($this->_model);
        }
    }

Member Function Documentation

_getEmptyModel()

_getEmptyModel ( )

protected

Retrieve new instance of not yet loaded model

Returns

\Magento\Framework\Model\AbstractModel

Definition at line 70 of file Entity.php.

    {
        return \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create($this->_modelClass);
    }

_testCreate()

_testCreate ( )

protected

Definition at line 75 of file Entity.php.

    {
        if ($this->_model->getId()) {
            \PHPUnit\Framework\Assert::fail("Can't run creation test for models with defined id");
        }
        $this->_model->save();
        \PHPUnit\Framework\Assert::assertNotEmpty($this->_model->getId(), 'CRUD Create error');
    }

_testDelete()

_testDelete ( )

protected

Definition at line 109 of file Entity.php.

    {
        $modelId = $this->_model->getId();
        $this->_model->delete();

        $model = $this->_getEmptyModel();
        $model->load($modelId);
        \PHPUnit\Framework\Assert::assertEmpty($model->getId(), 'CRUD Delete error');
    }

_testRead()

_testRead ( )

protected

Definition at line 84 of file Entity.php.

    {
        $model = $this->_getEmptyModel();
        $model->load($this->_model->getId());
        \PHPUnit\Framework\Assert::assertEquals($this->_model->getId(), $model->getId(), 'CRUD Read error');
    }

_testUpdate()

_testUpdate ( )

protected

Definition at line 91 of file Entity.php.

    {
        foreach ($this->_updateData as $key => $value) {
            $this->_model->setDataUsingMethod($key, $value);
        }
        $this->_model->save();

        $model = $this->_getEmptyModel();
        $model->load($this->_model->getId());
        foreach ($this->_updateData as $key => $value) {
            \PHPUnit\Framework\Assert::assertEquals(
                $value,
                $model->getDataUsingMethod($key),
                'CRUD Update "' . $key . '" error'
            );
        }
    }

testCrud()

testCrud

(

)

Test Create -> Read -> Update -> Delete operations

Definition at line 52 of file Entity.php.

    {
        $this->_testCreate();
        try {
            $this->_testRead();
            $this->_testUpdate();
            $this->_testDelete();
        } catch (\Exception $e) {
            $this->_model->delete();
            throw $e;
        }
    }

Field Documentation

$_model

$_model

protected

Definition at line 17 of file Entity.php.

$_modelClass

$_modelClass

protected

Definition at line 27 of file Entity.php.

$_updateData

$_updateData

protected

Definition at line 22 of file Entity.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/integration/framework/Magento/TestFramework/Entity.php