AllPurposeActionTest.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace Magento\CodeMessDetector\Test\Unit\Rule\Design;

use Magento\CodeMessDetector\Rule\Design\AllPurposeAction;
use Magento\Framework\App\Action\HttpGetActionInterface;
use Magento\Framework\App\ActionInterface;
use PHPUnit\Framework\TestCase as TestCase;
use PHPUnit_Framework_MockObject_MockObject as MockObject;
use PHPUnit\Framework\MockObject\Builder\InvocationMocker as InvocationMocker;
use PHPMD\Report;
use PHPMD\Node\ClassNode;

class AllPurposeActionTest extends TestCase
{
    public function testApply($fakeAction, bool $violates)
    {
        $node = $this->createNodeMock($fakeAction);
        $rule = new AllPurposeAction();
        $this->expectsRuleViolation($rule, $violates);
        $rule->apply($node);
    }

    public function getCases(): array
    {
        return [
            [
                new class implements ActionInterface, HttpGetActionInterface {
                    public function execute()
                    {
                        return null;
                    }
                },
                false
            ],
            [
                new class implements ActionInterface {
                    public function execute()
                    {
                        return null;
                    }
                },
                true
            ],
            [
                new class implements HttpGetActionInterface {
                    public function execute()
                    {
                        return null;
                    }
                },
                false
            ],
            [
                new class {

                },
                false
            ]
        ];
    }

    private function createNodeMock($dynamicObject): MockObject
    {
        $node = $this->getMockBuilder(ClassNode::class)
            ->disableOriginalConstructor()
            ->disableProxyingToOriginalMethods()
            ->setMethods([
                // disable name lookup from AST artifact
                'getNamespaceName',
                'getParentName',
                'getName',
                'getFullQualifiedName',
            ])
            ->getMock();
        $node->expects($this->any())
            ->method('getFullQualifiedName')
            ->willReturn(get_class($dynamicObject));

        return $node;
    }

    private function expectsRuleViolation(
        AllPurposeAction $rule,
        bool $expects
    ): InvocationMocker {
        $report = $this->getMockBuilder(Report::class)->getMock();
        if ($expects) {
            $violationExpectation = $this->atLeastOnce();
        } else {
            $violationExpectation = $this->never();
        }
        $invokation = $report->expects($violationExpectation)
            ->method('addRuleViolation');
        $rule->setReport($report);

        return $invokation;
    }
}