AC-672: Create phpcs static check for LicenseTest

Author: eliseacornejo

Magento2/Sniffs/Legacy/LicenseSniff.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types = 1);
+
+namespace Magento2\Sniffs\Legacy;
+
+use Magento2\Sniffs\Less\TokenizerSymbolsInterface;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class LicenseSniff implements Sniff
+{
+    private const WARNING_CODE = 'FoundLegacyTextInCopyright';
+    
+    public $supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS, 'PHP'];
+    
+    /**
+     * @inheritdoc
+     */
+    public function register()
+    {
+        return [
+            T_DOC_COMMENT_STRING,
+            T_INLINE_HTML
+        ];
+    }
+    
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $content = null;
+        
+        if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_STRING) {
+            $content = $tokens[$stackPtr]['content'];
+        }
+        if ($tokens[$stackPtr]['code'] === T_INLINE_HTML) {
+            $content = $phpcsFile->getTokensAsString($stackPtr, 1);
+        }
+        if ($content != null){
+            $this->checkLicense($content, $stackPtr, $phpcsFile); 
+        }
+    }
+
+    /**
+     * @param string $content
+     * @param int $stackPtr
+     * @param File $phpcsFile
+     */
+    private function checkLicense(string $content, int $stackPtr, File $phpcsFile): void
+    {
+        $commentContent = $content;
+        if (stripos($commentContent, 'copyright') === false) {
+            return;
+        }
+        foreach (['Irubin Consulting Inc', 'DBA Varien', 'Magento Inc'] as $legacyText) {
+            if (stripos($commentContent, $legacyText) !== false) {
+                $phpcsFile->addWarning(
+                    sprintf("The copyright license contains legacy text: %s.", $legacyText),
+                    $stackPtr,
+                    self::WARNING_CODE
+                );
+            }
+        }
+    }
+}

Magento2/Tests/Legacy/LicenseUnitTest.1.inc

@@ -0,0 +1,5 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */

Magento2/Tests/Legacy/LicenseUnitTest.2.inc

@@ -0,0 +1,5 @@
+<?php
+/**
+ * Copyright © Magento Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */

Magento2/Tests/Legacy/LicenseUnitTest.3.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright My testing text
+ * See COPYING.txt for license details.
+ */
+-->
+<tag>
+
+</tag>

Magento2/Tests/Legacy/LicenseUnitTest.4.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * @copyright DBA Varien
+ * See COPYING.txt for license details.
+ */
+-->
+<tag>
+
+</tag>

Magento2/Tests/Legacy/LicenseUnitTest.5.less

@@ -0,0 +1,4 @@
+/**
+ * @copyright Copyright Irubin Consulting Inc
+ * See COPYING.txt for license details.
+ */

Magento2/Tests/Legacy/LicenseUnitTest.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\Legacy;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class LicenseUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList(): array
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList($testFile = ''): array
+    {
+        if ($testFile === 'LicenseUnitTest.1.inc' || $testFile === 'LicenseUnitTest.3.xml') {
+            return [];
+        }
+        
+        if ($testFile === 'LicenseUnitTest.2.inc') {
+            return [
+                3 => 1,
+            ];
+        }
+
+        if ($testFile === 'LicenseUnitTest.4.xml') {
+            return [
+                4 => 1,
+            ];
+        }
+
+        if ($testFile === 'LicenseUnitTest.5.less') {
+            return [
+                2 => 1,
+            ];
+        }
+
+        return [];
+    }
+}

Magento2/ruleset.xml

@@ -194,6 +194,10 @@
         <type>warning</type>
         <exclude-pattern>*\.xml$</exclude-pattern>
     </rule>
+    <rule ref="Magento2.Legacy.License">
+        <severity>9</severity>
+        <type>warning</type>
+    </rule>
 
     <!-- Severity 8 warnings: Magento specific code issues and design violations. -->
     <rule ref="Magento2.Classes.AbstractApi">