Skip to content

Asynchronous operation validate #25940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion app/code/Magento/AsynchronousOperations/Model/Operation.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,33 @@
namespace Magento\AsynchronousOperations\Model;

use Magento\AsynchronousOperations\Api\Data\OperationInterface;
use Magento\AsynchronousOperations\Model\OperationStatusValidator;
use Magento\Framework\DataObject;

/**
* Class Operation
* Class Operation encapsulates methods for Operation Model Object
*/
class Operation extends DataObject implements OperationInterface
{
/**
* @var OperationStatusValidator
*/
private $operationStatusValidator;

/**
* Operation constructor.
*
* @param OperationStatusValidator $operationStatusValidator
* @param array $data
*/
public function __construct(
OperationStatusValidator $operationStatusValidator,
array $data = []
) {
$this->operationStatusValidator = $operationStatusValidator;
parent::__construct($data);
}

/**
* @inheritDoc
*/
Expand Down Expand Up @@ -106,6 +126,7 @@ public function getStatus()
*/
public function setStatus($status)
{
$this->operationStatusValidator->validate($status);
return $this->setData(self::STATUS, $status);
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\AsynchronousOperations\Model;

/**
* Class OperationStatusPool
*
* Pool of statuses that require validate
*/
class OperationStatusPool
{
/**
* @var array
*/
private $statuses;

/**
* @param array $statuses
*/
public function __construct(array $statuses = [])
{
$this->statuses = $statuses;
}

/**
* Retrieve statuses that require validate
*
* @return array
*/
public function getStatuses()
{
return $this->statuses;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\AsynchronousOperations\Model;

use Magento\AsynchronousOperations\Model\OperationStatusPool;
use Magento\Framework\Exception\NoSuchEntityException;
use Doctrine\Instantiator\Exception\InvalidArgumentException;

/**
* Class OperationStatusValidator to validate operation status
*/
class OperationStatusValidator
{
/**
* @var OperationStatusPool
*/
private $operationStatusPool;

/**
* OperationStatusValidator constructor.
*
* @param OperationStatusPool $operationStatusPool
*/
public function __construct(OperationStatusPool $operationStatusPool)
{
$this->operationStatusPool = $operationStatusPool;
}

/**
* Validate method
*
* @param int $status
* @throws \InvalidArgumentException
* @return void
*/
public function validate($status)
{
$statuses = $this->operationStatusPool->getStatuses();

if (!in_array($status, $statuses)) {
throw new \InvalidArgumentException('Invalid Operation Status.');
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\AsynchronousOperations\Test\Unit\Model;

use Magento\AsynchronousOperations\Model\OperationStatusValidator;
use Magento\AsynchronousOperations\Model\Operation;
use Magento\AsynchronousOperations\Model\OperationStatusPool;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use PHPUnit\Framework\TestCase;

/**
* Class OperationStatusValidatorTest implements logic for testing Operation::setStatus() method
*/
class OperationStatusValidatorTest extends TestCase
{
/**
* @var OperationStatusPool
*/
private $operationStatusPool;

/**
* @var OperationStatusValidator
*/
private $operationStatusValidator;

/**
* @var Operation
*/
private $operation;

protected function setUp()
{
$this->operationStatusPool = $this->getMockBuilder(OperationStatusPool::class)
->disableOriginalConstructor()
->getMock();

$objectManager = new ObjectManager($this);

$this->operationStatusValidator = $objectManager->getObject(
OperationStatusValidator::class,
[
'operationStatusPool' => $this->operationStatusPool
]
);

$this->operation = $objectManager->getObject(
Operation::class,
[
'operationStatusValidator' => $this->operationStatusValidator
]
);
}

/**
* @param string $status
* @param array $statusPool
* @param string $expectedResult
* @dataProvider dataProviderForTestSetStatus
*/
public function testSetStatus(
string $status,
array $statusPool,
string $expectedResult
) {
$this->operationStatusPool
->expects($this->any())
->method('getStatuses')
->willReturn($statusPool);

try {
$this->operation->setStatus($status);
$this->assertEquals($expectedResult, $this->operation->getStatus());
} catch (\Exception $exception) {
$this->assertEquals($expectedResult, $exception->getMessage());
}
}

/**
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
public function dataProviderForTestSetStatus()
{
return [
[
'status' => 0,
'statusPool' => [
'complete' => 1,
'retriablyFailed' => 2,
'notRetriablyFailed' => 3,
'open' => 4,
'rejected' => 5
],
'expectedResult' => 'Invalid Operation Status.'
],
[
'status' => 1,
'statusPool' => [
'complete' => 1,
'retriablyFailed' => 2,
'notRetriablyFailed' => 3,
'open' => 4,
'rejected' => 5
],
'expectedResult' => 1
],
[
'status' => 2,
'statusPool' => [
'complete' => 1,
'retriablyFailed' => 2,
'notRetriablyFailed' => 3,
'open' => 4,
'rejected' => 5
],
'expectedResult' => 2
],
[
'status' => 3,
'statusPool' => [
'complete' => 1,
'retriablyFailed' => 2,
'notRetriablyFailed' => 3,
'open' => 4,
'rejected' => 5
],
'expectedResult' => 3
],
[
'status' => 4,
'statusPool' => [
'complete' => 1,
'retriablyFailed' => 2,
'notRetriablyFailed' => 3,
'open' => 4,
'rejected' => 5
],
'expectedResult' => 4
],
[
'status' => 5,
'statusPool' => [
'complete' => 1,
'retriablyFailed' => 2,
'notRetriablyFailed' => 3,
'open' => 4,
'rejected' => 5
],
'expectedResult' => 5
]
];
}
}
11 changes: 11 additions & 0 deletions app/code/Magento/AsynchronousOperations/etc/di.xml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,17 @@
</argument>
</arguments>
</type>
<type name="Magento\AsynchronousOperations\Model\OperationStatusPool">
<arguments>
<argument name="statuses" xsi:type="array">
<item name="complete" xsi:type="string">1</item>
<item name="retriablyFailed" xsi:type="string">2</item>
<item name="notRetriablyFailed" xsi:type="string">3</item>
<item name="open" xsi:type="string">4</item>
<item name="rejected" xsi:type="string">5</item>
</argument>
</arguments>
</type>
<virtualType
name="Magento\AsynchronousOperations\Ui\Component\DataProvider"
type="Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider"/>
Expand Down