Merge pull request #62 from magento-commerce/imported-magento-magento-coding-standard-269

[Imported] AC-666: Copyright test for another extensions files

Author: eliseacornejo

Diff for: Magento2/Sniffs/Legacy/CopyrightAnotherExtensionsFilesSniff.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types = 1);
+
+namespace Magento2\Sniffs\Legacy;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class CopyrightAnotherExtensionsFilesSniff implements Sniff
+{
+    private const WARNING_CODE = 'FoundCopyrightMissingOrWrongFormat';
+
+    private const COPYRIGHT_MAGENTO_TEXT = 'Copyright © Magento, Inc. All rights reserved.';
+    private const COPYRIGHT_ADOBE = '/Copyright \d+ Adobe/';
+    
+    /**
+     * @inheritDoc
+     */
+    public function register(): array
+    {
+        return [
+            T_INLINE_HTML
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if ($stackPtr > 0) {
+            return;
+        }
+        
+        $fileText = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+        $adobeCopyrightFound = preg_match(self::COPYRIGHT_ADOBE, $fileText);
+
+        if (strpos($fileText, self::COPYRIGHT_MAGENTO_TEXT) !== false || $adobeCopyrightFound) {
+            return;
+        }
+
+        $phpcsFile->addWarningOnLine(
+            'Copyright is missing or has wrong format',
+            null,
+            self::WARNING_CODE
+        );
+    }
+}

Diff for: Magento2/Tests/Legacy/AbstractJsSniffUnitTestCase.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\Legacy;
+
+use PHP_CodeSniffer\Config;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Implements an abstract base for unit tests that cover less sniffs.
+ */
+abstract class AbstractJsSniffUnitTestCase extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritDoc
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+        
+        $config = new Config();
+        $config->extensions = array_merge(
+            $config->extensions,
+            [
+                'js' => 'PHP'
+            ]
+        );
+        
+        $GLOBALS['PHP_CODESNIFFER_CONFIG'] = $config;
+    }
+}

Diff for: Magento2/Tests/Legacy/CopyrightAnotherExtensionsFilesUnitTest.1.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights another text to test.
+ * See COPYING.txt for license details.
+ */
+-->
+<tag>
+    
+</tag>

Diff for: Magento2/Tests/Legacy/CopyrightAnotherExtensionsFilesUnitTest.2.js

@@ -0,0 +1,10 @@
+/**
+ * Copyright Adobe.
+ * See COPYING.txt for license details.
+ */
+
+define([
+    'jquery'
+], function (){
+    
+});

Diff for: Magento2/Tests/Legacy/CopyrightAnotherExtensionsFilesUnitTest.4.js

@@ -0,0 +1,10 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+define([
+    'jquery'
+], function (){
+    
+});

Diff for: Magento2/Tests/Legacy/CopyrightAnotherExtensionsFilesUnitTest.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\Legacy;
+
+class CopyrightAnotherExtensionsFilesUnitTest extends AbstractJsSniffUnitTestCase
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList()
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList($testFile = '')
+    {
+        if ($testFile === 'CopyrightAnotherExtensionsFilesUnitTest.1.xml') {
+            return [
+                null => 1,
+            ];
+        }
+        if ($testFile === 'CopyrightAnotherExtensionsFilesUnitTest.2.js') {
+            return [
+                null => 1,
+            ];
+        }
+        if ($testFile === 'CopyrightAnotherExtensionsFilesUnitTest.3.xml') {
+            return [];
+        }
+        if ($testFile === 'CopyrightAnotherExtensionsFilesUnitTest.4.js') {
+            return [];
+        }
+        return [];
+    }
+}

Diff for: Magento2/Tests/Legacy/CopyrightAnotherExtensionsFilesUnitTest.xml

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

Diff for: Magento2/ruleset.xml

@@ -3,7 +3,7 @@
     <description>Magento Coding Standard</description>
 
     <!-- File extensions to be checked. -->
-    <arg name="extensions" value="php,phtml,graphqls/GraphQL,less/CSS,html/PHP,xml"/>
+    <arg name="extensions" value="php,phtml,graphqls/GraphQL,less/CSS,html/PHP,xml,js/PHP"/>
 
     <!-- Severity 10 errors: Critical code issues. -->
     <rule ref="Generic.Functions.CallTimePassByReference">
@@ -634,6 +634,10 @@
         <exclude-pattern>*/Test/*</exclude-pattern>
         <exclude-pattern>*Test.php</exclude-pattern>
     </rule>
+    <rule ref="Magento2.Legacy.CopyrightAnotherExtensionsFiles">
+        <severity>5</severity>
+        <type>warning</type>
+    </rule>
     <rule ref="Magento2.Legacy.Copyright">
         <severity>5</severity>
         <type>warning</type>