Merge pull request #5079 from magento-engcom/coding-standard-update

ENGCOM-6317: Bump coding standard version

Author: lenaorobei

composer.json

@@ -87,7 +87,7 @@
         "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0",
         "friendsofphp/php-cs-fixer": "~2.14.0",
         "lusitanian/oauth": "~0.8.10",
-        "magento/magento-coding-standard": "~4.0.0",
+        "magento/magento-coding-standard": "*",
         "magento/magento2-functional-testing-framework": "2.5.3",
         "pdepend/pdepend": "2.5.2",
         "phpcompatibility/php-compatibility": "^9.3",

composer.lock

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

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

@@ -15,25 +15,4 @@
         <exclude-pattern>*/Test/*</exclude-pattern>
         <exclude-pattern>*Test.php</exclude-pattern>
     </rule>
-    <rule ref="Magento2.Files.LineLength.MaxExceeded">
-        <exclude-pattern>*.phtml</exclude-pattern>
-    </rule>
-    <rule ref="Squiz.Operators.IncrementDecrementUsage">
-        <exclude-pattern>*.phtml</exclude-pattern>
-    </rule>
-    <rule ref="PEAR.ControlStructures.ControlSignature">
-        <exclude-pattern>*.phtml</exclude-pattern>
-    </rule>
-    <rule ref="Squiz.WhiteSpace.ScopeClosingBrace">
-        <exclude-pattern>*.phtml</exclude-pattern>
-    </rule>
-    <rule ref="PEAR.Functions.FunctionCallSignature">
-        <exclude-pattern>*.phtml</exclude-pattern>
-    </rule>
-    <rule ref="Squiz.ControlStructures.ControlSignature.NewlineAfterOpenBrace">
-        <exclude-pattern>*.phtml</exclude-pattern>
-    </rule>
-    <rule ref="Magento2.Security.LanguageConstruct.DirectOutput">
-        <exclude-pattern>*.phtml</exclude-pattern>
-    </rule>
 </ruleset>

dev/tests/static/framework/Magento/ruleset.xml

@@ -21,6 +21,9 @@
         <testsuite name="HTML Static Code Analysis">
             <file>testsuite/Magento/Test/Html/LiveCodeTest.php</file>
         </testsuite>
+        <testsuite name="GraphQL Static Code Analysis">
+            <file>testsuite/Magento/Test/GraphQl/LiveCodeTest.php</file>
+        </testsuite>
         <testsuite name="PHP Coding Standard Verification">
             <file>testsuite/Magento/Test/Php/LiveCodeTest.php</file>
         </testsuite>

dev/tests/static/phpunit.xml.dist

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Test\GraphQl;
+
+use Magento\TestFramework\CodingStandard\Tool\CodeSniffer;
+use Magento\TestFramework\CodingStandard\Tool\CodeSniffer\Wrapper;
+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
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$reportDir = BP . '/dev/tests/static/report';
+        if (!is_dir(self::$reportDir)) {
+            mkdir(self::$reportDir, 0770);
+        }
+    }
+
+    /**
+     * Test GraphQL schema files code style using phpcs
+     */
+    public function testCodeStyle(): void
+    {
+        $reportFile = self::$reportDir . '/graphql_phpcs_report.txt';
+        $codeSniffer = new CodeSniffer('Magento', $reportFile, new Wrapper());
+        $codeSniffer->setExtensions([CodeSniffer\GraphQlWrapper::FILE_EXTENSION]);
+        $result = $codeSniffer->run(PHPCodeTest::getWhitelist([CodeSniffer\GraphQlWrapper::FILE_EXTENSION]));
+        $report = file_exists($reportFile) ? file_get_contents($reportFile) : '';
+        $this->assertEquals(
+            0,
+            $result,
+            "PHP Code Sniffer detected {$result} violation(s): " . PHP_EOL . $report
+        );
+    }
+}