StaticFilesTest Class Reference

Inheritance diagram for StaticFilesTest:

Public Member Functions
	testReferencesFromStaticFiles ($area, $themePath, $locale, $module, $filePath, $absolutePath)
	referencesFromStaticFilesDataProvider ()
	testLessNotConfusedWithCss ($area, $themePath, $locale, $module, $filePath)
	lessNotConfusedWithCssDataProvider ()
	testReferencesFromPhtmlFiles ($phtmlFile, $area, $themePath, $fileId)
	referencesFromPhtmlFilesDataProvider ()
	testReferencesFromLayoutFiles ($layoutFile, $area, $themePath, $fileId)
	referencesFromLayoutFilesDataProvider ()

Protected Member Functions
	setUp ()

Detailed Description

An integrity test that searches for references to static files and asserts that they are resolved via fallback @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 15 of file StaticFilesTest.php.

Member Function Documentation

lessNotConfusedWithCssDataProvider()

lessNotConfusedWithCssDataProvider

(

)

Returns

array

Definition at line 228 of file StaticFilesTest.php.

    {
        return \Magento\Framework\App\Utility\Files::init()->getStaticPreProcessingFiles('*.{less,css}');
    }

referencesFromLayoutFilesDataProvider()

referencesFromLayoutFilesDataProvider

(

)

Returns

array

Definition at line 302 of file StaticFilesTest.php.

    {
        $result = [];
        $files = \Magento\Framework\App\Utility\Files::init()->getLayoutFiles(['with_metainfo' => true], false);
        foreach ($files as $metaInfo) {
            list($area, $themePath, , , $file) = $metaInfo;
            foreach ($this->collectFileIdsFromLayout($file) as $fileId) {
                $result[] = [$file, $area, $themePath, $fileId];
            }
        }
        return $result;
    }

referencesFromPhtmlFilesDataProvider()

referencesFromPhtmlFilesDataProvider

(

)

Returns

array

Definition at line 254 of file StaticFilesTest.php.

    {
        $result = [];
        foreach (\Magento\Framework\App\Utility\Files::init()->getPhtmlFiles(true, false) as $info) {
            list($area, $themePath, , , $file) = $info;
            foreach ($this->collectGetViewFileUrl($file) as $fileId) {
                $result[] = [$file, $area, $themePath, $fileId];
            }
        }
        return $result;
    }

referencesFromStaticFilesDataProvider()

referencesFromStaticFilesDataProvider

(

)

Returns

array

Definition at line 188 of file StaticFilesTest.php.

    {
        return \Magento\Framework\App\Utility\Files::init()->getStaticPreProcessingFiles('*.{less,css}');
    }

setUp()

setUp ( )

protected

Definition at line 59 of file StaticFilesTest.php.

    {
        $om = \Magento\TestFramework\Helper\Bootstrap::getObjectmanager();
        $this->fallback = $om->get(\Magento\Framework\View\Design\FileResolution\Fallback\StaticFile::class);
        $this->explicitFallback = $om->get(
            \Magento\Framework\View\Design\FileResolution\Fallback\Resolver\Simple::class
        );
        $this->themeRepo = $om->get(\Magento\Framework\View\Design\Theme\FlyweightFactory::class);
        $this->design = $om->get(\Magento\Framework\View\DesignInterface::class);
        $this->baseTheme = $om->get(\Magento\Framework\View\Design\ThemeInterface::class);
        $this->alternativeResolver = $om->get(
            \Magento\Framework\View\Design\FileResolution\Fallback\Resolver\Alternative::class
        );
        $this->simpleFactory = $om->get(\Magento\Framework\View\Design\Fallback\Rule\SimpleFactory::class);
        $this->filesystem = $om->get(\Magento\Framework\Filesystem::class);
    }

testLessNotConfusedWithCss()

testLessNotConfusedWithCss	(		$area,
			$themePath,
			$locale,
			$module,
			$filePath
	)

There must be either .css or .less file, because if there are both, then .less will not be found by fallback

Parameters

string	$area
string	$themePath
string	$locale
string	$module
string	$filePath	@dataProvider lessNotConfusedWithCssDataProvider

Definition at line 203 of file StaticFilesTest.php.

    {
        if (false !== strpos($filePath, 'widgets.css')) {
            $filePath .= '';
        }
        $fileName = pathinfo($filePath, PATHINFO_FILENAME);
        $dirName = dirname($filePath);
        if ('.' == $dirName) {
            $dirName = '';
        } else {
            $dirName .= '/';
        }
        $cssPath = $dirName . $fileName . '.css';
        $lessPath = $dirName . $fileName . '.less';
        $cssFile = $this->getStaticFile($area, $themePath, $locale, $cssPath, $module, true);
        $lessFile = $this->getStaticFile($area, $themePath, $locale, $lessPath, $module, true);
        $this->assertFalse(
            $cssFile && $lessFile,
            "A resource file of only one type must exist. Both found: '$cssFile' and '$lessFile'"
        );
    }

testReferencesFromLayoutFiles()

testReferencesFromLayoutFiles	(		$layoutFile,
			$area,
			$themePath,
			$fileId
	)

Parameters

string	$layoutFile
string	$area
string	$themePath
string	$fileId	@dataProvider referencesFromLayoutFilesDataProvider

Definition at line 290 of file StaticFilesTest.php.

    {
        list($module, $filePath) = \Magento\Framework\View\Asset\Repository::extractModule($fileId);
        $this->assertNotEmpty(
            $this->getStaticFile($area, $themePath, 'en_US', $filePath, $module),
            "Unable to locate '{$fileId}' reference from layout XML in {$layoutFile}"
        );
    }

testReferencesFromPhtmlFiles()

testReferencesFromPhtmlFiles	(		$phtmlFile,
			$area,
			$themePath,
			$fileId
	)

Test if references $this->getViewFileUrl() in .phtml-files are correct

Parameters

string	$phtmlFile
string	$area
string	$themePath
string	$fileId	@dataProvider referencesFromPhtmlFilesDataProvider

Definition at line 242 of file StaticFilesTest.php.

    {
        list($module, $filePath) = \Magento\Framework\View\Asset\Repository::extractModule($fileId);
        $this->assertNotEmpty(
            $this->getStaticFile($area, $themePath, 'en_US', $filePath, $module),
            "Unable to locate '{$fileId}' reference from {$phtmlFile}"
        );
    }

testReferencesFromStaticFiles()

testReferencesFromStaticFiles	(		$area,
			$themePath,
			$locale,
			$module,
			$filePath,
			$absolutePath
	)

Scan references to files from other static files and assert they are correct

The CSS or LESS files may refer to other resources using @import or url() notation We want to check integrity of all these references Note that the references may have syntax specific to the Magento preprocessing subsystem

Parameters

string	$area
string	$themePath
string	$locale
string	$module
string	$filePath
string	$absolutePath	@dataProvider referencesFromStaticFilesDataProvider

The LESS library treats the related resources with relative links not in the same way as CSS: when another LESS file is included, it is embedded directly into the resulting document, but the relative paths of related resources are not adjusted accordingly to the new root file. Probably it is a bug of the LESS library.

Definition at line 91 of file StaticFilesTest.php.

    {
        $contents = file_get_contents($absolutePath);
        preg_match_all(
            \Magento\Framework\View\Url\CssResolver::REGEX_CSS_RELATIVE_URLS,
            $contents,
            $matches
        );
        foreach ($matches[1] as $relatedResource) {
            if (false !== strpos($relatedResource, '@')) { // unable to parse paths with LESS variables/mixins
                continue;
            }
            list($relatedModule, $relatedPath) =
                \Magento\Framework\View\Asset\Repository::extractModule($relatedResource);
            if ($relatedModule) {
                $fallbackModule = $relatedModule;
            } else {
                if ('less' == pathinfo($filePath, PATHINFO_EXTENSION)) {
                    $this->markTestSkipped("Due to LESS library specifics, the '{$relatedResource}' cannot be tested.");
                }
                $fallbackModule = $module;
                $relatedPath = \Magento\Framework\View\FileSystem::getRelatedPath($filePath, $relatedResource);
            }
            // the $relatedPath will be suitable for feeding to the fallback system
            $staticFile = $this->getStaticFile($area, $themePath, $locale, $relatedPath, $fallbackModule);
            if (empty($staticFile) && substr($relatedPath, 0, 2) === '..') {
                //check if static file exists on lib level
                $path = substr($relatedPath, 2);
                $libDir = rtrim($this->filesystem->getDirectoryRead(DirectoryList::LIB_WEB)->getAbsolutePath(), '/');
                $rule = $this->simpleFactory->create(['pattern' => $libDir]);
                $params = ['area' => $area, 'theme' => $themePath, 'locale' => $locale];
                $staticFile = $this->alternativeResolver->resolveFile($rule, $path, $params);
            }
            $this->assertNotEmpty(
                $staticFile,
                "The related resource cannot be resolved through fallback: '{$relatedResource}'"
            );
        }
    }

---

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

• vendor/magento/magento2-base/dev/tests/integration/testsuite/Magento/Test/Integrity/StaticFilesTest.php