consolidation / robo

tests/unit/Task/CollectionTest.php

<?php
namespace unit;

// @codingStandardsIgnoreFile
// We do not want NitPick CI to report results about this file,
// as we have a couple of private test classes that appear in this file
// rather than in their own file.

use Robo\Robo;
use Robo\Result;
use Robo\State\Data;
use Robo\Task\BaseTask;
use Robo\Collection\Collection;
use Robo\Task\ValueProviderTask;
use Robo\Task\CollectionTestTask;
use Robo\Task\CountingTask;

class CollectionTest extends \Codeception\TestCase\Test
{
    /**
     * @var \CodeGuy
     */
    protected $guy;

    public function testAfterFilters()
    {
        $collection = new Collection();
        $collection->setLogger(Robo::logger());

        $taskA = new CollectionTestTask('a', 'value-a');
        $taskB = new CollectionTestTask('b', 'value-b');

        $collection
            ->add($taskA, 'a-name')
            ->add($taskB, 'b-name');

        // We add methods of our task instances as before and
        // after tasks. These methods have access to the task
        // class' fields, and may modify them as needed.
        $collection
            ->after('a-name', [$taskA, 'parenthesizer'])
            ->after('a-name', [$taskA, 'emphasizer'])
            ->after('b-name', [$taskB, 'emphasizer'])
            ->after('b-name', [$taskB, 'parenthesizer'])
            ->after('b-name', [$taskB, 'parenthesizer'], 'special-name');

        $result = $collection->run();

        // Ensure that the results have the correct key values
        $this->assertEquals(
            'a-name,b-name,special-name,time',
            implode(',', array_keys($result->getData())));

        // Verify that all of the after tasks ran in
        // the correct order.
        $this->assertEquals(
            '*(value-a)*',
            $result['a-name']['a']);
        $this->assertEquals(
            '(*value-b*)',
            $result['b-name']['b']);

        // Note that the last after task is added with a special name;
        // its results therefore show up under the name given, rather
        // than being stored under the name of the task it was added after.
        $this->assertEquals(
            '((*value-b*))',
            $result['special-name']['b']);
    }

    public function testBeforeFilters()
    {
        $collection = new Collection();
        $collection->setLogger(Robo::logger());

        $taskA = new CollectionTestTask('a', 'value-a');
        $taskB = new CollectionTestTask('b', 'value-b');

        $collection
            ->add($taskA, 'a-name')
            ->add($taskB, 'b-name');

        // We add methods of our task instances as before and
        // after tasks. These methods have access to the task
        // class' fields, and may modify them as needed.
        $collection
            ->before('b-name', [$taskA, 'parenthesizer'])
            ->before('b-name', [$taskA, 'emphasizer'], 'special-before-name');

        $result = $collection->run();

        // Ensure that the results have the correct key values
        $this->assertEquals(
            'a-name,b-name,special-before-name,time',
            implode(',', array_keys($result->getData())));

        // The result from the 'before' task is attached
        // to 'b-name', since it was called as before('b-name', ...)
        $this->assertEquals(
            '(value-a)',
            $result['b-name']['a']);
        // When a 'before' task is given its own name, then
        // its results are attached under that name.
        $this->assertEquals(
            '*(value-a)*',
            $result['special-before-name']['a']);
    }

    public function testAddCodeRollbackAndCompletion()
    {
        $collection = new Collection();
        $collection->setLogger(Robo::logger());

        $rollback1 = new CountingTask();
        $rollback2 = new CountingTask();
        $completion1 = new CountingTask();
        $completion2 = new CountingTask();

        $collection
            ->progressMessage("start collection tasks")
            ->rollback($rollback1)
            ->completion($completion1)
            ->rollbackCode(function() use($rollback1) { $rollback1->run(); } )
            ->completionCode(function() use($completion1) { $completion1->run(); } )
            ->addCode(function () { return 42; })
            ->progressMessage("not reached")
            ->rollback($rollback2)
            ->completion($completion2)
            ->addCode(function () { return 13; });

        $collection->setLogger($this->guy->logger());

        $result = $collection->run();
        // Execution stops on the first error.
        // Confirm that status code is converted to a Result object.
        $this->assertEquals(42, $result->getExitCode());
        $this->assertEquals(2, $rollback1->getCount());
        $this->assertEquals(0, $rollback2->getCount());
        $this->assertEquals(2, $completion1->getCount());
        $this->assertEquals(0, $completion2->getCount());
        $this->guy->seeInOutput('start collection tasks');
        $this->guy->doNotSeeInOutput('not reached');
    }

    public function testStateWithAddCode()
    {
        $collection = new Collection();
        $collection->setLogger(Robo::logger());

        $result = $collection

$result is not used, you could remove the assignment.

            ->addCode(
                function (Data $state) {
                    $state['one'] = 'first';
                })
            ->addCode(
                function (Data $state) {
                    $state['two'] = 'second';
                })
            ->addCode(
                function (Data $state) {
                    $state['three'] = "{$state['one']} and {$state['two']}";
                })
            ->run();

        $state = $collection->getState();
        $this->assertEquals(
            'first and second',
            $state['three']);
    }

    public function testStateWithTaskResult()
    {
        $collection = new Collection();
        $collection->setLogger(Robo::logger());

        $first = new ValueProviderTask();
        $first->provideData('one', 'First');

        $second = new ValueProviderTask();
        $second->provideData('two', 'Second');

        $result = $collection

$result is not used, you could remove the assignment.

            ->add($first)
            ->add($second)
            ->addCode(
                function (Data $state) {
                    $state['three'] = "{$state['one']} and {$state['two']}";
                })
            ->run();

        $state = $collection->getState();
        $this->assertEquals(
            'First',
            $state['one']);
        $this->assertEquals(
            'First and Second',
            $state['three']);
    }

    public function testDeferredInitialization()
    {
        $collection = new Collection();
        $collection->setLogger(Robo::logger());

        $first = new ValueProviderTask();
        $first->provideData('one', 'First');

        $second = new ValueProviderTask();
        $second->provideData('two', 'Second');

        $third = new ValueProviderTask();

        $result = $collection

$result is not used, you could remove the assignment.

            ->add($first)
            ->add($second)
            ->add($third)
                ->defer(
                    $third,
                    function ($task, $state) {
                        $task->provideData('three', "{$state['one']} and {$state['two']}");
                    }
                )
            ->run();

        $state = $collection->getState();
        $this->assertEquals(
            'First',
            $state['one']);
        $this->assertEquals(
            'First and Second',
            $state['three']);
    }

    public function testDeferredInitializationWithMessageStorage()
    {
        $collection = new Collection();
        $collection->setLogger(Robo::logger());

        $first = new ValueProviderTask();
        $first->provideMessage('1st');

        $second = new ValueProviderTask();
        $second->provideData('other', '2nd');

        $third = new ValueProviderTask();

        $result = $collection

$result is not used, you could remove the assignment.

            ->add($first)
                ->storeState($first, 'one')
            ->add($second)
                ->storeState($second, 'two', 'other')
            ->add($third)
                ->defer(
                    $third,
                    function ($task, $state) {
                        $task->provideData('three', "{$state['one']} and {$state['two']}");
                    }
                )
            ->run();

        $state = $collection->getState();
        $this->assertEquals(
            '1st',
            $state['one']);
        $this->assertEquals(
            '1st and 2nd',
            $state['three']);
    }
    public function testDeferredInitializationWithChainedInitialization()
    {
        $collection = new Collection();
        $collection->setLogger(Robo::logger());

        // This task sets the Result message to '1st'
        $first = new ValueProviderTask();
        $first->provideMessage('1st');

        $second = new ValueProviderTask();
        $second->provideMessage('2nd');

        $third = new ValueProviderTask();

        $result = $collection

$result is not used, you could remove the assignment.

            // $first will set its Result's message to '1st' at `run()` time
            ->add($first)
                // This will copy the message from $first's result to $state['one'] after $first runs.
                // Note that it does not matter what order the `storeState` messages are called in;
                // their first parameter determines when they run. This differs from CollectionBuilder,
                // which manages order.
                ->storeState($first, 'one')
            ->add($second)
                // This will copy the message from $second's result to $state['two']
                ->storeState($second, 'two')
            ->add($third)
                ->deferTaskConfiguration($third, 'provideItem', 'one')
                ->deferTaskConfiguration($third, 'provideMessage', 'two')
                ->storeState($third, 'final')
            ->progressMessage('The final result is {final}')
            ->run();

        $state = $collection->getState();
        $this->assertEquals(
            '1st',
            $state['one']);
        $this->assertEquals(
            '1st',
            $state['item']);
        $this->assertEquals(
            '2nd',
            $state['final']);

        $this->guy->seeInOutput("The final result is 2nd");
    }
}