MC-17489: Require specific suffix for HTML binding

Author: Oleksandr Gorkun

app/code/Magento/Ui/view/base/web/templates/grid/filters/elements/ui-select.html

@@ -141,7 +141,9 @@
         </div>
         <div ifnot="options().length"
              class="admin__action-multiselect-empty-area">
-            <ul data-bind="html: emptyOptionsHtml"/>
+            <ul data-bind="
+                html: emptyOptionsHtml
+                "/>
         </div>
         <!-- /ko -->
         <ul class="admin__action-multiselect-menu-inner _root"

dev/tests/static/framework/Magento/Sniffs/Html/HtmlBindingSniff.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Sniffs\Html;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+class HtmlBindingSniff implements Sniff
+{
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_INLINE_HTML];
+    }
+
+    /**
+     * @inheritDoc
+     *
+     * Find HTML data bindings and check variables used.
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if ($stackPtr === 0) {
+            $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+            $dom = new \DOMDocument();
+            try {
+                @$dom->loadHTML($html);
+                $loaded = true;
+            } catch (\Throwable $exception) {
+                //Invalid HTML, skipping
+                $loaded = false;
+            }
+            if ($loaded) {
+                $domXpath = new \DOMXPath($dom);
+                $dataBindAttributes = $domXpath->query('//@*[name() = "data-bind"]');
+                foreach ($dataBindAttributes as $dataBindAttribute) {
+                    $knockoutBinding = $dataBindAttribute->nodeValue;
+                    preg_match('/^(.+\s+)*?html\:\s*?([a-z0-9\.\_\(\)]+)/i', $knockoutBinding, $htmlBinding);
+                    if ($htmlBinding && !preg_match('/UnsanitizedHtml[\(\)]*?$/', $htmlBinding[2])) {
+                        $phpcsFile->addError(
+                            'Variables/functions used for HTML binding must have UnsanitizedHtml suffix, '
+                            .'consider using text binding if the value is supposed to be text',
+                            null,
+                            'UIComponentTemplate.HtmlSuffix'
+                        );
+                    }
+                }
+            }
+        }
+    }
+}

dev/tests/static/framework/Magento/TestFramework/CodingStandard/Tool/CodeSniffer/HtmlWrapper.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\TestFramework\CodingStandard\Tool\CodeSniffer;
+
+/**
+ * Add HTML files extension to config.
+ */
+class HtmlWrapper extends Wrapper
+{
+    const FILE_EXTENSION = 'html';
+
+    private const TOKENIZER = 'PHP';
+
+    /**
+     * @inheritDoc
+     */
+    public function init()
+    {
+        parent::init();
+
+        $this->config->extensions += [self::FILE_EXTENSION => self::TOKENIZER];
+    }
+}

dev/tests/static/testsuite/Magento/Test/Html/LiveCodeTest.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Test\Html;
+
+use Magento\Framework\App\Utility;
+use Magento\TestFramework\CodingStandard\Tool\CodeSniffer;
+use Magento\Framework\App\Utility\Files;
+use Magento\Test\Php\LiveCodeTest as PHPCodeTest;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Set of tests for static code style
+ */
+class LiveCodeTest extends TestCase
+{
+    /**
+     * @var string
+     */
+    private static $reportDir = '';
+
+    /**
+     * Setup basics for all tests
+     *
+     * @return void
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$reportDir = BP . '/dev/tests/static/report';
+        if (!is_dir(self::$reportDir)) {
+            mkdir(self::$reportDir, 0770);
+        }
+    }
+
+    /**
+     * Run the magento specific coding standards on the code
+     *
+     * @return void
+     */
+    public function testCodeStyle(): void
+    {
+        $reportFile = self::$reportDir . '/html_report.txt';
+        $wrapper = new CodeSniffer\HtmlWrapper();
+        $codeSniffer = new CodeSniffer(realpath(__DIR__ . '/_files/html'), $reportFile, $wrapper);
+        if (!$codeSniffer->canRun()) {
+            $this->markTestSkipped('PHP Code Sniffer is not installed.');
+        }
+        $codeSniffer->setExtensions([CodeSniffer\HtmlWrapper::FILE_EXTENSION]);
+        //Looking for changed .html files
+        $fileList = PHPCodeTest::getWhitelist([CodeSniffer\HtmlWrapper::FILE_EXTENSION], __DIR__, __DIR__);
+
+        $result = $codeSniffer->run($fileList);
+
+        $report = file_exists($reportFile) ? file_get_contents($reportFile) : "";
+        $this->assertEquals(
+            0,
+            $result,
+            "PHP Code Sniffer has found {$result} error(s): " . PHP_EOL . $report
+        );
+    }
+}

dev/tests/static/testsuite/Magento/Test/Html/_files/html/ruleset.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<ruleset name="Magento">
+    <description>UI Component Coding Standard</description>
+    <rule ref="Internal.NoCodeFound">
+        <severity>0</severity>
+    </rule>
+    <rule ref="../../../../../../framework/Magento/Sniffs/Html"/>
+</ruleset>

dev/tests/static/testsuite/Magento/Test/Html/_files/whitelist/common.txt

@@ -0,0 +1,2 @@
+# Format: <componentType=module|library|theme|language|*> <componentName> <globPattern> or simply <globPattern>
+* * /