AC-669: Create phpcs static check for InstallUpgradeTest

Magento2/Sniffs/Legacy/InstallUpgradeSniff.php

@@ -0,0 +1,125 @@
+<?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 InstallUpgradeSniff implements Sniff
+{
+ private const ERROR_CODE = 'obsoleteScript';
+
+ /**
+ * @inheritdoc
+ */
+ public function register(): array
+ {
+ return [
+ T_OPEN_TAG
+ ];
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function process(File $phpcsFile, $stackPtr)
+ {
+ if ($stackPtr > 0) {
+ return;
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'install-') === 0) {
+ $phpcsFile->addError(
+ 'Install scripts are obsolete. '
+ . 'Please use declarative schema approach in module\'s etc/db_schema.xml file',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'InstallSchema') === 0) {
+ $phpcsFile->addError(
+ 'InstallSchema scripts are obsolete. '
+ . 'Please use declarative schema approach in module\'s etc/db_schema.xml file',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'InstallData') === 0) {
+ $phpcsFile->addError(
+ 'InstallData scripts are obsolete. '
+ . 'Please use data patches approach in module\'s Setup/Patch/Data dir',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'data-install-') === 0) {
+ $phpcsFile->addError(
+ 'Install scripts are obsolete. Please create class InstallData in module\'s Setup folder',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'upgrade-') === 0) {
+ $phpcsFile->addError(
+ 'Upgrade scripts are obsolete. '
+ . 'Please use declarative schema approach in module\'s etc/db_schema.xml file',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'UpgradeSchema') === 0) {
+ $phpcsFile->addError(
+ 'UpgradeSchema scripts are obsolete. '
+ . 'Please use declarative schema approach in module\'s etc/db_schema.xml file',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'UpgradeData') === 0) {
+ $phpcsFile->addError(
+ 'UpgradeSchema scripts are obsolete. '
+ . 'Please use data patches approach in module\'s Setup/Patch/Data dir',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'data-upgrade-') === 0) {
+ $phpcsFile->addError(
+ 'Upgrade scripts are obsolete. '
+ . 'Please use data patches approach in module\'s Setup/Patch/Data dir',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (strpos(basename($phpcsFile->getFilename()), 'recurring') === 0) {
+ $phpcsFile->addError(
+ 'Recurring scripts are obsolete. Please create class Recurring in module\'s Setup folder',
+ 0,
+ self::ERROR_CODE
+ );
+ }
+
+ if (preg_match('/(sql|data)/', dirname($phpcsFile->getFilename())) === 1) {
+ $phpcsFile->addError(
+ $phpcsFile->getFilename()." is in an invalid directory ".dirname($phpcsFile->getFilename()).":\n"
+ . "- Create a data patch within module's Setup/Patch/Data folder for data upgrades.\n"
+ . "- Use declarative schema approach in module's etc/db_schema.xml file for schema changes.",
+ 0,
+ self::ERROR_CODE
+ );
+ }
+ }
+}

Magento2/Tests/Legacy/InstallUpgradeUnitTest.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\Legacy;
+
+use DirectoryIterator;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+
+class InstallUpgradeUnitTest extends AbstractSniffUnitTest
+{
+ private $wrongFileNames = [
+ 'data-install-.inc',
+ 'data-upgrade-.inc',
+ 'install-sample.inc',
+ 'InstallData.inc',
+ 'InstallSchema.inc',
+ 'recurring.inc',
+ 'upgrade-.inc',
+ 'UpgradeData.inc',
+ 'UpgradeSchema.inc',
+ 'file.inc',
+ 'file2.inc',
+ ];
+
+ /**
+ * @inheritdoc
+ */
+ protected function getTestFiles($testFileBase): array
+ {
+ $testFiles = [];
+
+ $dir = __DIR__.'/_files/InstallUpgradeUnitTest';
+ $di = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir));
+
+ foreach ($di as $file) {
+ $path = $file->getPathname();
+ if ($path !== $testFileBase.'php' && substr($path, -5) !== 'fixed' && substr($path, -4) !== '.bak') {
+ $testFiles[] = $path;
+ }
+ }
+
+ // Put them in order.
+ sort($testFiles);
+
+ return $testFiles;
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function getErrorList($testFile = '')
+ {
+ if (in_array($testFile, $this->wrongFileNames)) {
+ return [
+ 1 => 1
+ ];
+ }
+ return [];
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function getWarningList()
+ {
+ return [];
+ }
+}

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/InstallData.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/InstallSchema.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/UpgradeData.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/UpgradeSchema.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/data-install-.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/data-upgrade-.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/data/file2.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/install-sample.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/recurring.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/sql/file.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/upgrade-.inc

@@ -0,0 +1 @@
+<?php

Magento2/Tests/Legacy/_files/InstallUpgradeUnitTest/valid-file.inc

@@ -0,0 +1 @@
+<?php

Magento2/ruleset.xml

@@ -127,6 +127,8 @@
  <include-pattern>etc/config.xml</include-pattern>
  <include-pattern>etc/config.*.xml</include-pattern>
  <include-pattern>etc/*/config.xml</include-pattern>
+ </rule>
+ <rule ref="Magento2.Legacy.InstallUpgrade">
  <severity>10</severity>
  <type>error</type>
  </rule>