PublicCodeTest Class Reference

Inheritance diagram for PublicCodeTest:

Public Member Functions
	layoutFilesDataProvider ()
	testAllPHPClassesReferencedFromPublicClassesArePublic ($class)
	publicPHPTypesDataProvider ()

Detailed Description

Tests @api annotated code integrity

Definition at line 13 of file PublicCodeTest.php.

Member Function Documentation

layoutFilesDataProvider()

layoutFilesDataProvider

(

)

Find all layout update files in magento modules and themes.

Returns

array

Exceptions

Definition at line 92 of file PublicCodeTest.php.

    {
        return Files::init()->getLayoutFiles([], true);
    }

publicPHPTypesDataProvider()

publicPHPTypesDataProvider

(

)

Retrieve list of all interfaces and classes in Magento codebase that are marked with @api annotation.

Returns

array

Exceptions

Definition at line 147 of file PublicCodeTest.php.

    {
        $files = Files::init()->getPhpFiles(Files::INCLUDE_LIBS | Files::INCLUDE_APP_CODE);
        $result = [];
        foreach ($files as $file) {
            $fileContents = \file_get_contents($file);
            if (strpos($fileContents, '@api') !== false) {
                foreach ($this->getDeclaredClassesAndInterfaces($file) as $class) {
                    if (!in_array($class->getName(), $this->getWhitelist())
                        && (class_exists($class->getName()) || interface_exists($class->getName()))
                    ) {
                        $result[$class->getName()] = [$class->getName()];
                    }
                }
            }
        }
        return $result;
    }

testAllPHPClassesReferencedFromPublicClassesArePublic()

testAllPHPClassesReferencedFromPublicClassesArePublic

(

$class

)

We want to avoid situation when a type is marked public (@api annotated) but one of its methods returns or accepts the value of non-public type. This test walks through all public PHP types and makes sure that all their method arguments and return values are public types.

Parameters

string

$class

Exceptions

Definition at line 107 of file PublicCodeTest.php.

    {
        $nonPublishedClasses = [];
        $reflection = new \ReflectionClass($class);
        $filter = \ReflectionMethod::IS_PUBLIC;
        if ($reflection->isAbstract()) {
            $filter = $filter | \ReflectionMethod::IS_PROTECTED;
        }
        $methods = $reflection->getMethods($filter);
        foreach ($methods as $method) {
            if ($method->isConstructor()) {
                continue;
            }
            $nonPublishedClasses = $this->checkParameters($class, $method, $nonPublishedClasses);
            /* Taking into account docblock return types since this code
             is written on early php 7 when return types are not actively used */
            $returnTypes = [];
            if ($method->hasReturnType()) {
                if (!$method->getReturnType()->isBuiltin()) {
                    $returnTypes = [trim($method->getReturnType()->__toString(), '?[]')];
                }
            } else {
                $returnTypes = $this->getReturnTypesFromDocComment($method->getDocComment());
            }
            $nonPublishedClasses = $this->checkReturnValues($class, $returnTypes, $nonPublishedClasses);
        }

        if (count($nonPublishedClasses)) {
            $this->fail(
                "Public type '" . $class . "' references following non-public types:\n"
                . implode("\n", array_unique($nonPublishedClasses))
            );
        }
    }

---

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

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