Skip to content

[Workflow] Method buildTransitionBlockerList returns TransitionBlockerList of expected transition #28493

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.

Sign up for GitHub

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

Closed
wants to merge 7 commits into from
Closed

[Workflow] Method buildTransitionBlockerList returns TransitionBlockerList of expected transition #28493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
94142c1
method buildTransitionBlockerList returns TransitionBlockerList of ex…
Tetragramat Sep 17, 2018
009d3b2
cs fix
Tetragramat Sep 17, 2018
0b54afd
added test
Tetragramat Oct 15, 2018
6922793
added descriptions of test and fix
Tetragramat Oct 19, 2018
12a46e7
replace break with exception
xabbuh Oct 25, 2018
2181b78
fixed comments
Tetragramat Oct 25, 2018
1ccc875
applied suggested changes
Tetragramat Oct 25, 2018
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
67 changes: 67 additions & 0 deletions src/Symfony/Component/Workflow/Tests/StateMachineTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
namespace Symfony\Component\Workflow\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\Workflow\Event\GuardEvent;
use Symfony\Component\Workflow\StateMachine;
use Symfony\Component\Workflow\TransitionBlocker;

class StateMachineTest extends TestCase
{
Expand Down Expand Up @@ -38,4 +41,68 @@ public function testCanWithMultipleTransition()
$this->assertTrue($net->can($subject, 't2'));
$this->assertTrue($net->can($subject, 't3'));
}

public function testBuildTransitionBlockerList()
{
$definition = $this->createComplexStateMachineDefinition();

$net = new StateMachine($definition);
$subject = new \stdClass();

$subject->marking = 'a';
$this->assertTrue($net->buildTransitionBlockerList($subject, 't1')->isEmpty());
$subject->marking = 'd';
$this->assertTrue($net->buildTransitionBlockerList($subject, 't1')->isEmpty());

$subject->marking = 'b';
$this->assertFalse($net->buildTransitionBlockerList($subject, 't1')->isEmpty());
}

public function testBuildTransitionBlockerListWithMultipleTransitions()
{
$definition = $this->createComplexStateMachineDefinition();

$net = new StateMachine($definition);
$subject = new \stdClass();

$subject->marking = 'b';
$this->assertTrue($net->buildTransitionBlockerList($subject, 't2')->isEmpty());
$this->assertTrue($net->buildTransitionBlockerList($subject, 't3')->isEmpty());
}

public function testBuildTransitionBlockerListReturnsExpectedReasonOnBranchMerge()
{
$definition = $this->createComplexStateMachineDefinition();

$dispatcher = new EventDispatcher();
$net = new StateMachine($definition, null, $dispatcher);

$dispatcher->addListener('workflow.guard', function (GuardEvent $event) {
$event->addTransitionBlocker(new TransitionBlocker(\sprintf('Transition blocker of place %s', $event->getTransition()->getFroms()[0]), 'blocker'));
});

$subject = new \stdClass();

// There may be multiple transitions with the same name. Make sure that transitions
// that are not enabled by the marking are evaluated.
// see https://github.com/symfony/symfony/issues/28432

// Test if when you are in place "a" applying transition "t1" then returned blocker list contains guard blocker instead blockedByMarking
$subject->marking = 'a';
$transitionBlockerList = $net->buildTransitionBlockerList($subject, 't1');
$this->assertCount(1, $transitionBlockerList);
$blockers = iterator_to_array($transitionBlockerList);

$this->assertSame('Transition blocker of place a', $blockers[0]->getMessage());
$this->assertSame('blocker', $blockers[0]->getCode());

// Test if when you are in place "d" applying transition "t1" then returned blocker list contains guard blocker instead blockedByMarking
$subject->marking = 'd';
$transitionBlockerList = $net->buildTransitionBlockerList($subject, 't1');
$this->assertCount(1, $transitionBlockerList);
$blockers = iterator_to_array($transitionBlockerList);

$this->assertSame('Transition blocker of place d', $blockers[0]->getMessage());
$this->assertSame('blocker', $blockers[0]->getCode());
}
}
26 changes: 26 additions & 0 deletions src/Symfony/Component/Workflow/Tests/WorkflowTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,32 @@ public function testBuildTransitionBlockerListReturnsUndefinedTransition()
$workflow->buildTransitionBlockerList($subject, '404 Not Found');
}

public function testBuildTransitionBlockerList()
{
$definition = $this->createComplexWorkflowDefinition();
$subject = new \stdClass();
$subject->marking = null;
$workflow = new Workflow($definition, new MultipleStateMarkingStore());

$this->assertTrue($workflow->buildTransitionBlockerList($subject, 't1')->isEmpty());
$this->assertFalse($workflow->buildTransitionBlockerList($subject, 't2')->isEmpty());

$subject->marking = array('b' => 1);

$this->assertFalse($workflow->buildTransitionBlockerList($subject, 't1')->isEmpty());
$this->assertFalse($workflow->buildTransitionBlockerList($subject, 't2')->isEmpty());

$subject->marking = array('b' => 1, 'c' => 1);

$this->assertFalse($workflow->buildTransitionBlockerList($subject, 't1')->isEmpty());
$this->assertTrue($workflow->buildTransitionBlockerList($subject, 't2')->isEmpty());

$subject->marking = array('f' => 1);

$this->assertFalse($workflow->buildTransitionBlockerList($subject, 't5')->isEmpty());
$this->assertTrue($workflow->buildTransitionBlockerList($subject, 't6')->isEmpty());
}

public function testBuildTransitionBlockerListReturnsReasonsProvidedByMarking()
{
$definition = $this->createComplexWorkflowDefinition();
Expand Down
38 changes: 26 additions & 12 deletions src/Symfony/Component/Workflow/Workflow.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,11 @@ public function can($subject, $transitionName)
continue;
}

$transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
try {
$transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
} catch (NotEnabledTransitionException $e) {
$transitionBlockerList = $e->getTransitionBlockerList();
}

if ($transitionBlockerList->isEmpty()) {
return true;
Expand All @@ -116,10 +120,13 @@ public function buildTransitionBlockerList($subject, string $transitionName): Tr
continue;
}

$transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
try {
$transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);

if ($transitionBlockerList->isEmpty()) {
continue;
return $transitionBlockerList;
} catch (NotEnabledTransitionException $e) {
// a transition with the same name is defined for other places too
$transitionBlockerList = $e->getTransitionBlockerList();
}
}

Expand All @@ -146,11 +153,15 @@ public function apply($subject, $transitionName)
continue;
}

$transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
if (!$transitionBlockerList->isEmpty()) {
continue;
try {
$transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
} catch (NotEnabledTransitionException $e) {
$transitionBlockerList = $e->getTransitionBlockerList();
}

if ($transitionBlockerList->isEmpty()) {
$approvedTransitionQueue[] = $transition;
}
$approvedTransitionQueue[] = $transition;
}

foreach ($approvedTransitionQueue as $transition) {
Expand Down Expand Up @@ -191,7 +202,12 @@ public function getEnabledTransitions($subject)
$marking = $this->getMarking($subject);

foreach ($this->definition->getTransitions() as $transition) {
$transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
try {
$transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
} catch (NotEnabledTransitionException $e) {
$transitionBlockerList = $e->getTransitionBlockerList();
}

if ($transitionBlockerList->isEmpty()) {
$enabledTransitions[] = $transition;
}
Expand Down Expand Up @@ -236,9 +252,7 @@ private function buildTransitionBlockerListForTransition($subject, Marking $mark
{
foreach ($transition->getFroms() as $place) {
if (!$marking->has($place)) {
return new TransitionBlockerList(array(
TransitionBlocker::createBlockedByMarking($marking),
));
throw new NotEnabledTransitionException($subject, $transition->getName(), $this, new TransitionBlockerList(array(TransitionBlocker::createBlockedByMarking($marking))));
}
}

Expand Down