MC-19921: Create static tests for object variables inside E-mail templates

Author: nathanjosiah

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

@@ -22,6 +22,11 @@ class HtmlDirectiveSniff implements Sniff
      */
     private $usedVariables = [];
 
+    /**
+     * @var array
+     */
+    private $unfilteredVariables = [];
+
     /**
      * @inheritDoc
      */
@@ -40,6 +45,7 @@ public function register()
     public function process(File $phpcsFile, $stackPtr)
     {
         $this->usedVariables = [];
+        $this->unfilteredVariables = [];
         if ($stackPtr !== 0) {
             return;
         }
@@ -172,6 +178,9 @@ private function validateDirectiveBody(File $phpcsFile, string $body): void
     private function validateVariableUsage(File $phpcsFile, string $body): void
     {
         $this->usedVariables[] = 'var ' . trim($body);
+        if (strpos($body, '|') !== false) {
+            $this->unfilteredVariables[] = 'var ' . trim(explode('|', $body, 2)[0]);
+        }
         $variableTokenizer = new Template\Tokenizer\Variable();
         $variableTokenizer->setString($body);
         $stack = $variableTokenizer->tokenize();
@@ -228,9 +237,14 @@ private function validateDefinedVariables(File $phpcsFile, string $templateText)
             }
 
             $definedVariables = array_keys($definedVariables);
+            foreach ($definedVariables as $definedVariable) {
+                if (strpos($definedVariable, '|') !== false) {
+                    $definedVariables[] = trim(explode('|', $definedVariable, 2)[0]);
+                }
+            }
         }
 
-        $undefinedVariables = array_diff($this->usedVariables, $definedVariables);
+        $undefinedVariables = array_diff($this->usedVariables, $definedVariables, $this->unfilteredVariables);
         foreach ($undefinedVariables as $undefinedVariable) {
             $phpcsFile->addError(
                 'Template @vars comment block is missing a variable used in the template.' . PHP_EOL

dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Html/_files/test-html-directive.html

@@ -41,6 +41,7 @@
 "var foo.badFor()":"Some Variable",
 "var foo.badFor()|alsobad":"Some Variable",
 "foobar baz":"Some other directive as a variable",
+"var iusefilterslater|raw":"Some Variable",
 "var bad.multiline()":""
 } @-->
 
@@ -110,3 +111,7 @@
 {{for item in foo.badForLoop()}}
 <div>this loop has a bad variable</div>
 {{/for}}
+
+{{depend iusefilterslater}}
+    {{var iusefilterslater|raw}}
+{{/depend}}