ObsoleteCodeTest Class Reference

Inheritance diagram for ObsoleteCodeTest:

Public Member Functions
	testPhpFiles ()
	testClassFiles ()
	testTemplateMageCalls ()
	testXmlFiles ()
	testJsFiles ()
	testMageMethodsObsolete ()

Static Public Member Functions
static	setUpBeforeClass ()

Protected Member Functions
	_testObsoleteClasses ($content)
	_testObsoleteNamespaces ($content)
	_testObsoleteMethods ($content, $file)
	_testObsoletePaths ($file)
	_testGetChildSpecialCase ($content, $file)
	_testGetOptionsSpecialCase ($content)
	_testObsoleteMethodArguments ($content)
	_testObsoleteProperties ($content)
	_testObsoleteActions ($content)
	_testObsoleteConstants ($content)
	_isClassConstantDefined ($content, $constant)
	_getClassConstantDefinitionRegExp ($constant)
	_testObsoletePropertySkipCalculate ($content)
	_isClassOrInterface ($content, $name)
	_isDirectDescendant ($content, $name)
	_assertNotRegexp ($regex, $content, $message)

Static Protected Member Functions
static	_populateList (array &$list, array &$errors, $filePattern, $hasScope=true)
static	_padRow ($row, $hasScope)

Static Protected Attributes
static	$_classes = []
static	$_constants = []
static	$_methods = []
static	$_attributes = []
static	$_namespaces = []
static	$_paths = []

Detailed Description

@SuppressWarnings(PHPMD.ExcessiveClassComplexity)

Definition at line 21 of file ObsoleteCodeTest.php.

Member Function Documentation

_assertNotRegexp()

_assertNotRegexp (   $regex,   $content,   $message  )

protected

Custom replacement for assertNotRegexp()

In this particular test the original assertNotRegexp() cannot be used because of too large text $content, which obfuscates tests output

Parameters

string	$regex
string	$content
string	$message

Definition at line 874 of file ObsoleteCodeTest.php.

    {
        $this->assertSame(0, preg_match($regex, $content), $message);
    }

_getClassConstantDefinitionRegExp()

_getClassConstantDefinitionRegExp (   $constant )

protected

Retrieve a PCRE matching a class constant definition

Parameters

string

$constant

Returns

string

Definition at line 803 of file ObsoleteCodeTest.php.

    {
        return '\bconst\s+' . preg_quote($constant, '/') . '\b';
    }

_isClassConstantDefined()

_isClassConstantDefined (   $content,   $constant  )

protected

Whether a class constant is defined in the content or not

Parameters

string	$content
string	$constant

Returns

bool

Definition at line 792 of file ObsoleteCodeTest.php.

    {
        return (bool)preg_match('/' . $this->_getClassConstantDefinitionRegExp($constant) . '/S', $content);
    }

_isClassOrInterface()

_isClassOrInterface (   $content,   $name  )

protected

Analyze contents to determine whether this is declaration of specified class/interface

Parameters

string	$content
string	$name

Returns

bool

Definition at line 827 of file ObsoleteCodeTest.php.

    {
        $name = preg_quote($name, '/');
        return (bool)preg_match('/\b(?:class|interface)\s+' . $name . '\b[^{]*\{/iS', $content);
    }

_isDirectDescendant()

_isDirectDescendant (   $content,   $name  )

protected

Analyze contents to determine whether this is a direct descendant of specified class/interface

Parameters

string	$content
string	$name

Returns

bool

Definition at line 840 of file ObsoleteCodeTest.php.

    {
        $name = preg_quote($name, '/');
        return (bool)preg_match(
            '/\s+extends\s+' . $name . '\b|\s+implements\s+[^{]*\b' . $name . '\b[^{^\\\\]*\{/iS',
            $content
        );
    }

_padRow()

static _padRow (   $row,   $hasScope  )

staticprotected

Populate insufficient row elements regarding to whether the row supposed to have scope value

Parameters

array	$row
bool	$hasScope

Returns

array

Definition at line 100 of file ObsoleteCodeTest.php.

    {
        if ($hasScope) {
            return array_pad($row, 4, '');
        }
        list($item, $replacement) = array_pad($row, 2, '');
        return [$item, '', $replacement, ''];
    }

_populateList()

static _populateList ( array &  $list, array &  $errors,   $filePattern,   $hasScope = true  )

staticprotected

Read the specified file pattern and merge it with the list

Duplicate entries will be recorded into errors array.

Parameters

array	$list
array	$errors
string	$filePattern
bool	$hasScope

Definition at line 77 of file ObsoleteCodeTest.php.

    {
        foreach (glob(__DIR__ . '/_files/' . $filePattern) as $file) {
            $readList = include $file;
            foreach ($readList as $row) {
                list($item, $scope, $replacement, $isDeprecated) = self::_padRow($row, $hasScope);
                $key = "{$item}|{$scope}";
                if (isset($list[$key])) {
                    $errors[$file][] = $key;
                } else {
                    $list[$key] = [$item, $scope, $replacement, $isDeprecated];
                }
            }
        }
    }

_testGetChildSpecialCase()

_testGetChildSpecialCase (   $content,   $file  )

protected

Special case: don't allow usage of getChild() method anywhere within app directory

In Magento 1.x it used to belong only to abstract block (therefore all blocks) At the same time, the name is pretty generic and can be encountered in other directories, such as lib

Parameters

string	$content
string	$file

Definition at line 327 of file ObsoleteCodeTest.php.

    {
        $componentRegistrar = new ComponentRegistrar();
        foreach ($componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $modulePath) {
            if (0 === strpos($file, $modulePath)) {
                $this->_assertNotRegexp(
                    '/[^a-z\d_]getChild\s*\(/iS',
                    $content,
                    'Block method getChild() is obsolete. ' .
                    'Replacement suggestion: \Magento\Framework\View\Element\AbstractBlock::getChildBlock()'
                );
            }
        }
    }

_testGetOptionsSpecialCase()

_testGetOptionsSpecialCase (   $content )

protected

Special case for ->getConfig()->getOptions()->

Parameters

string

$content

Definition at line 347 of file ObsoleteCodeTest.php.

    {
        $this->_assertNotRegexp(
            '/getOptions\(\)\s*->get(Base|App|Code|Design|Etc|Lib|Locale|Js|Media' .
            '|Var|Tmp|Cache|Log|Session|Upload|Export)?Dir\(/S',
            $content,
            'The class \Magento\Core\Model\Config\Options is obsolete. '
            . 'Replacement suggestion: \Magento\Framework\Filesystem'
        );
    }

_testObsoleteActions()

_testObsoleteActions (   $content )

protected

Parameters

string

$content

Definition at line 409 of file ObsoleteCodeTest.php.

    {
        $suggestion = 'Resizing images upon the client request is obsolete, use server-side resizing instead';
        $this->_assertNotRegExp(
            '#[^a-z\d_/]catalog/product/image[^a-z\d_/]#iS',
            $content,
            "Action 'catalog/product/image' is obsolete. {$suggestion}"
        );
    }

_testObsoleteClasses()

_testObsoleteClasses (   $content )

protected

Assert that obsolete classes are not used in the content

Parameters

string

$content

Definition at line 197 of file ObsoleteCodeTest.php.

    {
        /* avoid collision between obsolete class name and valid namespace and package tag */
        $content = preg_replace('/namespace[^;]+;/', '', $content);
        $content = preg_replace('/\@package\s[a-zA-Z0-9\\\_]+/', '', $content);
        foreach (self::$_classes as $row) {
            list($class, , $replacement) = $row;
            $this->_assertNotRegExp(
                '/[^a-z\d_]' . preg_quote($class, '/') . '[^a-z\d_\\\\]/iS',
                $content,
                $this->_suggestReplacement(sprintf("Class '%s' is obsolete.", $class), $replacement)
            );
        }
    }

_testObsoleteConstants()

_testObsoleteConstants (   $content )

protected

Assert that obsolete constants are not defined/used in the content

Without class context, only presence of the literal will be checked.

In context of a class, match:

• fully qualified constant notation (with class)
• usage with self::/parent::/static:: notation

Parameters

string

$content

Definition at line 430 of file ObsoleteCodeTest.php.

    {
        foreach (self::$_constants as $row) {
            list($constant, $class, $replacement) = $row;
            if ($class) {
                $class = ltrim($class, '\\');
                $this->_checkConstantWithFullClasspath($constant, $class, $replacement, $content);
                $this->_checkConstantWithClasspath($constant, $class, $replacement, $content);
            } else {
                $regex = '\b' . preg_quote($constant, '/') . '\b';
                $this->_checkExistenceOfObsoleteConstants($regex, '', $content, $constant, $replacement, $class);
            }
        }
    }

_testObsoleteMethodArguments()

_testObsoleteMethodArguments (   $content )

protected

Parameters

string

$content

Definition at line 361 of file ObsoleteCodeTest.php.

    {
        $this->_assertNotRegExp(
            '/[^a-z\d_]getTypeInstance\s*\(\s*[^\)]+/iS',
            $content,
            'Backwards-incompatible change: method getTypeInstance() is not supposed to be invoked with any arguments.'
        );
        $this->_assertNotRegExp(
            '/\->getUsedProductIds\(([^\)]+,\s*[^\)]+)?\)/',
            $content,
            'Backwards-incompatible change: method getUsedProductIds($product)' .
            ' must be invoked with one and only one argument - product model object'
        );

        $this->_assertNotRegExp(
            '#->_setActiveMenu\([\'"]([\w\d/_]+)[\'"]\)#Ui',
            $content,
            'Backwards-incompatible change: method _setActiveMenu()' .
            ' must be invoked with menu item identifier than xpath for menu item'
        );
    }

_testObsoleteMethods()

_testObsoleteMethods (   $content,   $file  )

protected

Assert that obsolete methods or functions are not used in the content

If class context is not specified, declaration/invocation of all functions or methods (of any class) will be matched across the board

If context is specified, only the methods will be matched as follows:

• usage of class::method
• usage of $this, self and static within the class and its descendants

Parameters

string	$content
string	$file

Definition at line 247 of file ObsoleteCodeTest.php.

    {
        foreach (self::$_methods as $row) {
            list($method, $class, $replacement, $isDeprecated) = $row;
            $quotedMethod = preg_quote($method, '/');
            if ($class) {
                $message = $this->_suggestReplacement(
                    "Method '{$class}::{$method}()' is obsolete in file '{$file}'.",
                    $replacement
                );
                // without opening parentheses to match static callbacks notation
                $this->_assertNotRegExp(
                    '/' . preg_quote($class, '/') . '::\s*' . $quotedMethod . '[^a-z\d_]/iS',
                    $content,
                    $message
                );
                if ($this->_isClassOrInterface($content, $class) || $this->_isDirectDescendant($content, $class)) {
                    if (!$isDeprecated) {
                        $this->_assertNotRegExp('/function\s*' . $quotedMethod . '\s*\(/iS', $content, $message);
                    }
                    $this->_assertNotRegExp('/this->' . $quotedMethod . '\s*\(/iS', $content, $message);
                    $this->_assertNotRegExp(
                        '/(self|static|parent)::\s*' . $quotedMethod . '\s*\(/iS',
                        $content,
                        $message
                    );
                }
            } else {
                $message = $this->_suggestReplacement(
                    "Function or method '{$method}()' is obsolete in file '{$file}'.",
                    $replacement
                );
                $this->_assertNotRegExp(
                    '/(?<!public|protected|private|static)\s+function\s*' . $quotedMethod . '\s*\(/iS',
                    $content,
                    $message
                );
                $this->_assertNotRegExp(
                    '/(?<![a-z\d_:]|->|function\s)' . $quotedMethod . '\s*\(/iS',
                    $content,
                    $message
                );
            }
        }
    }

_testObsoleteNamespaces()

_testObsoleteNamespaces (   $content )

protected

Assert that obsolete classes are not used in the content

Parameters

string

$content

Definition at line 217 of file ObsoleteCodeTest.php.

    {
        foreach (self::$_namespaces as $row) {
            list($namespace, , $replacement) = $row;
            $this->_assertNotRegExp(
                '/namespace\s+' . preg_quote($namespace, '/') . ';/S',
                $content,
                $this->_suggestReplacement(sprintf("Namespace '%s' is obsolete.", $namespace), $replacement)
            );
            $this->_assertNotRegExp(
                '/[^a-zA-Z\d_]' . preg_quote($namespace . '\\', '/') . '/S',
                $content,
                $this->_suggestReplacement(sprintf("Namespace '%s' is obsolete.", $namespace), $replacement)
            );
        }
    }

_testObsoletePaths()

_testObsoletePaths (   $file )

protected

Assert that obsolete paths are not used in the content

This method will search the content for references to class that start with obsolete namespace

Parameters

string

$file

Definition at line 301 of file ObsoleteCodeTest.php.

    {
        foreach (self::$_paths as $row) {
            list($obsoletePath, , $replacementPath) = $row;
            $relativePath = str_replace(BP, '', $file);
            $message = $this->_suggestReplacement(
                "Path '{$obsoletePath}' is obsolete.",
                $replacementPath
            );
            $this->assertStringStartsNotWith($obsoletePath . '/', $relativePath, $message);
            $this->assertStringStartsNotWith($obsoletePath . '.', $relativePath, $message);
            $this->assertStringStartsNotWith($obsoletePath . 'Factory.', $relativePath, $message);
            $this->assertStringStartsNotWith($obsoletePath . 'Interface.', $relativePath, $message);
            $this->assertStringStartsNotWith($obsoletePath . 'Test.', $relativePath, $message);
        }
    }

_testObsoleteProperties()

_testObsoleteProperties (   $content )

protected

Parameters

string

$content

Definition at line 386 of file ObsoleteCodeTest.php.

    {
        foreach (self::$_attributes as $row) {
            list($attribute, $class, $replacement) = $row;
            if ($class) {
                if (!$this->_isClassOrInterface($content, $class) && !$this->_isDirectDescendant($content, $class)) {
                    continue;
                }
                $fullyQualified = "{$class}::\${$attribute}";
            } else {
                $fullyQualified = $attribute;
            }
            $this->_assertNotRegExp(
                '/[^a-z\d_]' . preg_quote($attribute, '/') . '[^a-z\d_]/iS',
                $content,
                $this->_suggestReplacement(sprintf("Class attribute '%s' is obsolete.", $fullyQualified), $replacement)
            );
        }
    }

_testObsoletePropertySkipCalculate()

_testObsoletePropertySkipCalculate (   $content )

protected

Parameters

string

$content

Definition at line 811 of file ObsoleteCodeTest.php.

    {
        $this->_assertNotRegExp(
            '/[^a-z\d_]skipCalculate[^a-z\d_]/iS',
            $content,
            "Configuration property 'skipCalculate' is obsolete."
        );
    }

setUpBeforeClass()

static setUpBeforeClass ( )

static

#- Read fixtures into memory as arrays

Definition at line 45 of file ObsoleteCodeTest.php.

    {
        $errors = [];
        self::_populateList(self::$_classes, $errors, 'obsolete_classes*.php', false);
        self::_populateList(self::$_constants, $errors, 'obsolete_constants*.php');
        self::_populateList(self::$_methods, $errors, 'obsolete_methods*.php');
        self::_populateList(self::$_paths, $errors, 'obsolete_paths*.php', false);
        self::_populateList(self::$_namespaces, $errors, 'obsolete_namespaces*.php', false);
        self::_populateList(self::$_attributes, $errors, 'obsolete_properties*.php');
        if ($errors) {
            $message = 'Duplicate patterns identified in list declarations:' . PHP_EOL . PHP_EOL;
            foreach ($errors as $file => $list) {
                $message .= $file . PHP_EOL;
                foreach ($list as $key) {
                    $message .= "    {$key}" . PHP_EOL;
                }
                $message .= PHP_EOL;
            }
            throw new \Exception($message);
        }
    }

testClassFiles()

testClassFiles

(

)

Definition at line 135 of file ObsoleteCodeTest.php.

    {
        $invoker = new AggregateInvoker($this);
        $invoker(
            function ($file) {
                $this->_testObsoletePaths($file);
            },
            Files::init()->getPhpFiles()
        );
    }

testJsFiles()

testJsFiles

(

)

Definition at line 180 of file ObsoleteCodeTest.php.

    {
        $invoker = new AggregateInvoker($this);
        $invoker(
            function ($file) {
                $content = file_get_contents($file);
                $this->_testObsoletePropertySkipCalculate($content);
            },
            Files::init()->getJsFiles()
        );
    }

testMageMethodsObsolete()

testMageMethodsObsolete

(

)

Check absence of obsolete Mage class usages

Parameters

string

$file

Definition at line 879 of file ObsoleteCodeTest.php.

    {
        $ignored = $this->getBlacklistFiles(true);
        $files = Files::init()->getPhpFiles(
            Files::INCLUDE_APP_CODE
            | Files::INCLUDE_TESTS
            | Files::INCLUDE_DEV_TOOLS
            | Files::INCLUDE_LIBS
        );
        $files = array_map('realpath', $files);
        $files = array_diff($files, $ignored);
        $files = Files::composeDataSets($files);

        $invoker = new AggregateInvoker($this);
        $invoker(
            function ($file) {
                $this->_assertNotRegExp(
                    '/[^a-z\d_]Mage\s*::/i',
                    file_get_contents($file),
                    '"Mage" class methods are obsolete'
                );
            },
            $files
        );
    }

testPhpFiles()

testPhpFiles

(

)

Definition at line 109 of file ObsoleteCodeTest.php.

    {
        $invoker = new AggregateInvoker($this);
        $changedFiles = ChangedFiles::getPhpFiles(__DIR__ . '/../_files/changed_files*');
        $blacklistFiles = $this->getBlacklistFiles();
        foreach ($blacklistFiles as $blacklistFile) {
            unset($changedFiles[$blacklistFile]);
        }
        $invoker(
            function ($file) {
                $content = file_get_contents($file);
                $this->_testObsoleteClasses($content);
                $this->_testObsoleteNamespaces($content);
                $this->_testObsoleteMethods($content, $file);
                $this->_testGetChildSpecialCase($content, $file);
                $this->_testGetOptionsSpecialCase($content);
                $this->_testObsoleteMethodArguments($content);
                $this->_testObsoleteProperties($content);
                $this->_testObsoleteActions($content);
                $this->_testObsoleteConstants($content);
                $this->_testObsoletePropertySkipCalculate($content);
            },
            $changedFiles
        );
    }

testTemplateMageCalls()

testTemplateMageCalls

(

)

Definition at line 146 of file ObsoleteCodeTest.php.

    {
        $invoker = new AggregateInvoker($this);
        $invoker(
            function ($file) {
                $content = file_get_contents($file);
                $this->_assertNotRegExp(
                    '/\bMage::(\w+?)\(/iS',
                    $content,
                    "Static Method of 'Mage' class is obsolete."
                );
            },
            Files::init()->getPhpFiles(
                Files::INCLUDE_TEMPLATES
                | Files::INCLUDE_TESTS
                | Files::AS_DATA_SET
            )
        );
    }

testXmlFiles()

testXmlFiles

(

)

Definition at line 166 of file ObsoleteCodeTest.php.

    {
        $invoker = new AggregateInvoker($this);
        $invoker(
            function ($file) {
                $content = file_get_contents($file);
                $this->_testObsoleteClasses($content, $file);
                $this->_testObsoleteNamespaces($content);
                $this->_testObsoletePaths($file);
            },
            Files::init()->getXmlFiles()
        );
    }

Field Documentation

$_attributes

$_attributes = []

staticprotected

Definition at line 34 of file ObsoleteCodeTest.php.

$_classes

$_classes = []

staticprotected

Definition at line 28 of file ObsoleteCodeTest.php.

$_constants

$_constants = []

staticprotected

Definition at line 30 of file ObsoleteCodeTest.php.

$_methods

$_methods = []

staticprotected

Definition at line 32 of file ObsoleteCodeTest.php.

$_namespaces

$_namespaces = []

staticprotected

Definition at line 36 of file ObsoleteCodeTest.php.

$_paths

$_paths = []

staticprotected

Definition at line 38 of file ObsoleteCodeTest.php.

---

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

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