RestrictedCodeTest Class Reference

Inheritance diagram for RestrictedCodeTest:

Public Member Functions
	testPhpFiles ()

Static Public Member Functions
static	setUpBeforeClass ()

Protected Member Functions
	setUp ()
	_testRestrictedClasses ($file)

Static Protected Member Functions
static	_loadData (array &$data, $filePattern)
static	_readList ($file)

Detailed Description

Tests to find usage of restricted code

Definition at line 13 of file RestrictedCodeTest.php.

Member Function Documentation

_loadData()

static _loadData ( array &  $data,   $filePattern  )

staticprotected

Loads and merges data from fixtures

Parameters

array	$data
string	$filePattern

Returns

void

Definition at line 57 of file RestrictedCodeTest.php.

    {
        foreach (glob(__DIR__ . '/_files/' . $filePattern) as $file) {
            $relativePath = str_replace(
                '\\',
                '/',
                str_replace(BP . DIRECTORY_SEPARATOR, '', $file)
            );
            array_push(self::$_fixtureFiles, $relativePath);
            $data = array_merge_recursive($data, self::_readList($file));
        }
    }

_readList()

static _readList (   $file )

staticprotected

Isolate including a file into a method to reduce scope

Parameters

string

$file

Returns

array

Definition at line 76 of file RestrictedCodeTest.php.

    {
        return include $file;
    }

_testRestrictedClasses()

_testRestrictedClasses (   $file )

protected

Assert that restricted classes are not used in the file

Parameters

string

$file

Returns

void

Definition at line 109 of file RestrictedCodeTest.php.

    {
        $content = file_get_contents($file);
        foreach (self::$_classes as $restrictedClass => $classRules) {
            foreach ($classRules['exclude'] as $skippedPathInfo) {
                if (strpos($file, $this->getExcludedFilePath($skippedPathInfo)) === 0) {
                    continue 2;
                }
            }

            $this->assertFalse(
                \Magento\TestFramework\Utility\CodeCheck::isClassUsed($restrictedClass, $content),
                sprintf(
                    "Class '%s' is restricted in %s. Suggested replacement: %s",
                    $restrictedClass,
                    $file,
                    $classRules['replacement']
                )
            );
        }
    }

setUp()

setUp ( )

protected

Definition at line 35 of file RestrictedCodeTest.php.

    {
        $this->componentRegistrar = new ComponentRegistrar();
    }

setUpBeforeClass()

static setUpBeforeClass ( )

static

Read fixtures into memory as arrays

Returns

void

Definition at line 45 of file RestrictedCodeTest.php.

    {
        self::_loadData(self::$_classes, 'restricted_classes*.php');
    }

testPhpFiles()

testPhpFiles

(

)

Test that restricted entities are not used in PHP files

Returns

void

Definition at line 86 of file RestrictedCodeTest.php.

    {
        $invoker = new \Magento\Framework\App\Utility\AggregateInvoker($this);
        $testFiles = \Magento\TestFramework\Utility\ChangedFiles::getPhpFiles(__DIR__ . '/../_files/changed_files*');
        foreach (self::$_fixtureFiles as $fixtureFile) {
            if (array_key_exists($fixtureFile, $testFiles)) {
                unset($testFiles[$fixtureFile]);
            }
        }
        $invoker(
            function ($file) {
                $this->_testRestrictedClasses($file);
            },
            $testFiles
        );
    }

---

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

• vendor/magento/magento2-base/dev/tests/static/testsuite/Magento/Test/Legacy/RestrictedCodeTest.php