feat(DependenciesArray): Ensure module dependencies are an array in .info.yml (#3166470)

Author: jonathan1055

coder_sniffer/Drupal/Sniffs/InfoFiles/DependenciesArraySniff.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * \Drupal\Sniffs\InfoFiles\DependenciesArraySniff.
+ *
+ * @category PHP
+ * @package  PHP_CodeSniffer
+ * @link     http://pear.php.net/package/PHP_CodeSniffer
+ */
+namespace Drupal\Sniffs\InfoFiles;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use Symfony\Component\Yaml\Yaml;
+use Symfony\Component\Yaml\Exception\ParseException;
+
+/**
+ * Dependencies should be an array in .info.yml files.
+ *
+ * @category PHP
+ * @package  PHP_CodeSniffer
+ * @link     http://pear.php.net/package/PHP_CodeSniffer
+ */
+class DependenciesArraySniff implements Sniff
+{
+
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array<int|string>
+     */
+    public function register()
+    {
+        return [T_INLINE_HTML];
+
+    }//end register()
+
+
+    /**
+     * Processes this test when one of its tokens is encountered.
+     *
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+     * @param int                         $stackPtr  The position of the current token in the stack passed in $tokens.
+     *
+     * @return int
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Only run this sniff on .info.yml files.
+        if (strtolower(substr($phpcsFile->getFilename(), -9)) !== '.info.yml') {
+            return ($phpcsFile->numTokens + 1);
+        }
+
+        try {
+            $info = Yaml::parse(file_get_contents($phpcsFile->getFilename()));
+        } catch (ParseException $e) {
+            // If the YAML is invalid we ignore this file.
+            return ($phpcsFile->numTokens + 1);
+        }
+
+        if (isset($info['dependencies']) === true && is_array($info['dependencies']) === false) {
+            // The $stackPtr will always indicate line 1, but we can get the actual line by
+            // searching $tokens to find the dependencies item.
+            $tokens = $phpcsFile->getTokens();
+            // $tokens cannot be empty at this point, but PHPStan 10.1.4 does not know this and gives the error
+            // "Variable $key might not be defined". So initialise it here.
+            $key = $stackPtr;
+            foreach ($tokens as $key => $token) {
+                if (preg_match('/dependencies\s*\:/', $token['content']) === 1) {
+                    break;
+                }
+            }
+
+            $error = '"dependencies" should be an array in the info yaml file';
+            $phpcsFile->addError($error, $key, 'Dependencies');
+        }
+
+        return ($phpcsFile->numTokens + 1);
+
+    }//end process()
+
+
+}//end class

tests/Drupal/InfoFiles/DependenciesArrayUnitTest.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Drupal\Test\InfoFiles;
+
+use Drupal\Test\CoderSniffUnitTest;
+
+/**
+ * Unit test class for the DependenciesArray sniff.
+ */
+class DependenciesArrayUnitTest extends CoderSniffUnitTest
+{
+
+
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @param string $testFile The name of the file being tested.
+     *
+     * @return array<int, int>
+     */
+    protected function getErrorList(string $testFile): array
+    {
+        return [3 => 1];
+
+    }//end getErrorList()
+
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of warnings that should occur on that line.
+     *
+     * @param string $testFile The name of the file being tested.
+     *
+     * @return array<int, int>
+     */
+    protected function getWarningList(string $testFile): array
+    {
+        return [];
+
+    }//end getWarningList()
+
+
+    /**
+     * Returns a list of test files that should be checked.
+     *
+     * @param string $testFileBase The base path that the unit tests files will have.
+     *
+     * @return array<string>
+     */
+    protected function getTestFiles($testFileBase): array
+    {
+        return [
+            __DIR__.'/drupal8/dependencies_array.info.yml',
+        ];
+
+    }//end getTestFiles()
+
+
+}//end class

tests/Drupal/InfoFiles/drupal8/dependencies_array.info.yml

@@ -0,0 +1,4 @@
+core: 8.x
+name: Dependencies Array Test
+dependencies : 
+  drupal:taxonomy