Merge pull request #209 from magento-engcom/206-static-strict-types-test

MSI: #206 - Added strict type static code test

Author: maghamed

dev/tests/static/testsuite/Magento/Test/Php/LiveCodeTest.php

@@ -70,17 +70,22 @@ private static function getChangedFilesBaseDir()
      * @param array $fileTypes
      * @param string $changedFilesBaseDir
      * @param string $baseFilesFolder
+     * @param string $whitelistFile
      * @return array
      */
-    public static function getWhitelist($fileTypes = ['php'], $changedFilesBaseDir = '', $baseFilesFolder = '')
-    {
+    public static function getWhitelist(
+        $fileTypes = ['php'],
+        $changedFilesBaseDir = '',
+        $baseFilesFolder = '',
+        $whitelistFile = '/_files/whitelist/common.txt'
+    ) {
         $changedFiles = self::getChangedFilesList($changedFilesBaseDir);
         if (empty($changedFiles)) {
             return [];
         }
 
         $globPatternsFolder = ('' !== $baseFilesFolder) ? $baseFilesFolder : self::getBaseFilesFolder();
-        $directoriesToCheck = Files::init()->readLists($globPatternsFolder . '/_files/whitelist/common.txt');
+        $directoriesToCheck = Files::init()->readLists($globPatternsFolder . $whitelistFile);
         $targetFiles = self::filterFiles($changedFiles, $fileTypes, $directoriesToCheck);
 
         return $targetFiles;
@@ -266,4 +271,29 @@ public function testCopyPaste()
             "PHP Copy/Paste Detector has found error(s):" . PHP_EOL . $output
         );
     }
+
+    /**
+     * Tests whitelisted files for strict type declarations.
+     */
+    public function testStrictTypes()
+    {
+        $toBeTestedFiles = array_diff(
+            self::getWhitelist(['php'], '', '', '/_files/whitelist/strict_type.txt'),
+            Files::init()->readLists(self::getBaseFilesFolder() . '/_files/blacklist/strict_type.txt')
+        );
+
+        $filesMissingStrictTyping = [];
+        foreach ($toBeTestedFiles as $fileName) {
+            $file = file_get_contents($fileName);
+            if (strstr($file, 'strict_types=1') === false) {
+                $filesMissingStrictTyping[] = $fileName;
+            }
+        }
+
+        $this->assertEquals(
+            0,
+            count($filesMissingStrictTyping),
+            "Following files are missing strict type declaration:" . PHP_EOL . implode(PHP_EOL, $filesMissingStrictTyping)
+        );
+    }
 }

dev/tests/static/testsuite/Magento/Test/Php/_files/blacklist/strict_type.txt

@@ -0,0 +1 @@
+# Format: <componentType=module|library|theme|language|*> <componentName> <globPattern> or simply <globPattern>

dev/tests/static/testsuite/Magento/Test/Php/_files/whitelist/strict_type.txt

@@ -0,0 +1,7 @@
+# Format: <componentType=module|library|theme|language|*> <componentName> <globPattern> or simply <globPattern>
+app/code/Magento/Inventory
+app/code/Magento/InventoryApi
+app/code/Magento/InventoryCatalog
+app/code/Magento/InventoryImportExport
+app/code/Magento/InventorySales
+app/code/Magento/InventorySalesApi