ControllerAclTest Class Reference

Inheritance diagram for ControllerAclTest:

Public Member Functions
	testAcl ()

Data Fields
const	ACL_FUNC_NAME = '_isAllowed'
const	ACL_CONST_NAME = 'ADMIN_RESOURCE'
const	DEFAULT_BACKEND_RESOURCE = 'Magento_Backend::admin'

Protected Member Functions
	setUp ()

Detailed Description

Definition at line 12 of file ControllerAclTest.php.

Member Function Documentation

setUp()

setUp ( )

protected

Set up before test execution.

Definition at line 46 of file ControllerAclTest.php.

    {
        $whitelistedClasses = [];
        $path = sprintf('%s/_files/controller_acl_test_whitelist_*.txt', __DIR__);
        foreach (glob($path) as $listFile) {
            $whitelistedClasses = array_merge(
                $whitelistedClasses,
                file($listFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES)
            );
        }
        foreach ($whitelistedClasses as $item) {
            if (substr($item, 0, 1) === '#') {
                continue;
            }
            $this->whiteListedBackendControllers[$item] = 1;
        }
    }

testAcl()

testAcl

(

)

Test ACL in the admin area by various assertions.

Definition at line 67 of file ControllerAclTest.php.

    {
        $errorMessages = [];
        $pathMask = sprintf('%s/../../../_files/changed_files*', __DIR__, DIRECTORY_SEPARATOR);
        $changedFiles = ChangedFiles::getPhpFiles($pathMask);
        foreach ($changedFiles as $line) {
            $relativeFilePath = $line[0];
            // we don't have to check tests,
            if ($this->isItTest($relativeFilePath)) {
                continue;
            }

            $controllerPath = $this->getControllerPath($relativeFilePath);
            if (!$controllerPath) {
                continue;
            }

            $controllerClass = $this->getClassByFilePath($controllerPath);
            // skip whitelisted controllers.
            if (isset($this->whiteListedBackendControllers[$controllerClass->getName()])) {
                continue;
            }
            // we don't have to check abstract classes.
            if ($controllerClass->isAbstract()) {
                continue;
            }

            $className = $controllerClass->getName();

            if (!$this->isClassExtendsBackendClass($controllerClass)) {
                $inheritanceMessage = "Backend controller $className have to inherit " . AbstractAction::class;
                $errorMessages[] = $inheritanceMessage;
                continue;
            };

            $isAclRedefinedInTheChildClass = $this->isConstantOverwritten($controllerClass)
                || $this->isMethodOverwritten($controllerClass);
            if (!$isAclRedefinedInTheChildClass) {
                $errorMessages[] = "Backend controller $className have to overwrite _isAllowed method or "
                    . 'ADMIN_RESOURCE constant';
            }

            $errorMessages = array_merge($errorMessages, $this->collectAclErrorsInTheXml($controllerClass));
        }
        sort($errorMessages);
        $this->assertEmpty($errorMessages, implode("\n", $errorMessages));
    }

Field Documentation

ACL_CONST_NAME

const ACL_CONST_NAME = 'ADMIN_RESOURCE'

Name of the const. that contains ACL resource path.

Definition at line 22 of file ControllerAclTest.php.

ACL_FUNC_NAME

const ACL_FUNC_NAME = '_isAllowed'

Default function for checking accessibility of the ACL resource.

Definition at line 17 of file ControllerAclTest.php.

DEFAULT_BACKEND_RESOURCE

const DEFAULT_BACKEND_RESOURCE = 'Magento_Backend::admin'

Default value from the AbstractResource.

Definition at line 27 of file ControllerAclTest.php.

---

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

• vendor/magento/magento2-base/dev/tests/static/testsuite/Magento/Test/Integrity/Magento/Backend/ControllerAclTest.php