MAGETWO-34509: Collector for OptionsInterfaces

- removed recursive searching logic
- added integration test

Author: eddielau

dev/tests/integration/testsuite/Magento/Setup/Model/ConfigOptionsCollectorTest.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Setup\Model;
+
+class ConfigOptionsCollectorTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var \Magento\Framework\ObjectManagerInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $objectManagerProvider;
+
+    /**
+     * @var array
+     */
+    private $expected;
+
+    public function setUp()
+    {
+        $this->objectManagerProvider = $this->getMock('Magento\Setup\Model\ObjectManagerProvider', [], [], '', false);
+        $this->objectManagerProvider
+            ->expects($this->any())
+            ->method('get')
+            ->willReturn(\Magento\TestFramework\Helper\Bootstrap::getObjectManager());
+        $setupOptions = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
+            ->get('Magento\Setup\Model\ConfigOptions');
+        $backendOptions = new \Magento\Backend\Setup\ConfigOptions();
+        $this->expected = [
+            'Magento\Setup\Model\ConfigOptions' => ['options' => $setupOptions->getOptions(), 'enabled' => true],
+            'Magento\Backend\Setup\ConfigOptions' => ['options' => $backendOptions->getOptions()],
+        ];
+    }
+
+    public function testCollectOptions()
+    {
+        $objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+        /** @var \Magento\Setup\Model\ConfigOptionsCollector $object */
+        $object = $objectManager->create(
+            'Magento\Setup\Model\ConfigOptionsCollector',
+            ['objectManagerProvider' => $this->objectManagerProvider]
+        );
+        $result = $object->collectOptions();
+        $this->assertOptions($result, true);
+
+    }
+
+    public function testCollectOptionsDisabledModules()
+    {
+        $objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+        $moduleListMock = $this->getMock('Magento\Framework\Module\ModuleList', [], [], '', false);
+        $moduleListMock->expects($this->any())->method('has')->willReturn(false);
+        $object = $objectManager->create(
+            'Magento\Setup\Model\ConfigOptionsCollector',
+            [
+                'objectManagerProvider' => $this->objectManagerProvider,
+                'moduleList' => $moduleListMock,
+            ]
+        );
+        $result = $object->collectOptions();
+        $this->assertOptions($result, false);
+    }
+
+    /**
+     * Assert options array
+     *
+     * @param $actual
+     * @param $enabled
+     */
+    private function assertOptions($actual, $enabled)
+    {
+        $expected = [];
+        foreach ($this->expected as $key => $value) {
+            $expected[$key] = $value;
+            if (!isset($value['enabled'])) {
+                $expected[$key]['enabled'] = $enabled;
+            }
+        }
+        $this->assertEquals($expected, $actual);
+    }
+}

setup/src/Magento/Setup/Model/ConfigOptionsCollector.php

@@ -1,4 +1,8 @@
 <?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 namespace Magento\Setup\Model;
 
 use Magento\Framework\App\Filesystem\DirectoryList;
@@ -7,7 +11,7 @@
 use Magento\Framework\Module\ModuleList;
 
 /**
- * Collects all ConfigOptions throughout modules, framework and setup
+ * Collects all ConfigOptions class in modules and setup
  */
 class ConfigOptionsCollector
 {
@@ -53,6 +57,7 @@ class ConfigOptionsCollector
      * @param Filesystem $filesystem
      * @param FullModuleList $fullModuleList
      * @param ModuleList $moduleList
+     * @param ObjectManagerProvider $objectManagerProvider
      */
     public function __construct(
         DirectoryList $directoryList,
@@ -78,7 +83,7 @@ public function collectOptions()
         $optionsList = [];
 
         // go through modules
-        foreach ($this->moduleList->getNames() as $moduleName) {
+        foreach ($this->fullModuleList->getNames() as $moduleName) {
             $optionsClassName = str_replace('_', '\\', $moduleName) . '\Setup\ConfigOptions';
             if (class_exists($optionsClassName)) {
                 $optionsClass = $this->objectManagerProvider->get()->create($optionsClassName);
@@ -91,66 +96,18 @@ public function collectOptions()
             }
         }
 
-        // go through framework
-        $frameworkOptionsFiles = [];
-        $this->collectRecursively(
-            $this->filesystem->getDirectoryRead(DirectoryList::LIB_INTERNAL),
-            'Magento/Framework',
-            $frameworkOptionsFiles
-        );
-        foreach ($frameworkOptionsFiles as $frameworkOptionsFile) {
-            // remove .php
-            $frameworkOptionsFile = substr($frameworkOptionsFile, 0, -4);
-            $frameworkOptionsClassName = str_replace('/', '\\', $frameworkOptionsFile);
-            $optionsClass = $this->objectManagerProvider->get()->create($frameworkOptionsClassName);
-            if ($optionsClass instanceof \Magento\Framework\Setup\ConfigOptionsInterface) {
-                $optionsList[$frameworkOptionsClassName] = [
-                    'options' => $optionsClass->getOptions(),
-                    'enabled' => true,
-                ];
-            }
-        }
-
-        // go through setup
-        $setupOptionsFiles = [];
-        $this->collectRecursively(
-            $this->filesystem->getDirectoryRead(DirectoryList::ROOT),
-            'setup/src',
-            $setupOptionsFiles
-        );
-        foreach ($setupOptionsFiles as $setupOptionsFile) {
-            // remove setup/src/ and .php
-            $setupOptionsFile = substr($setupOptionsFile, 10, -4);
-            $setupOptionsClassName = str_replace('/', '\\', $setupOptionsFile);
-            $optionsClass = $this->objectManagerProvider->get()->create($setupOptionsClassName);
-            if ($optionsClass instanceof \Magento\Framework\Setup\ConfigOptionsInterface) {
+        // check setup
+        $setupOptionsClassName = 'Magento\Setup\Model\ConfigOptions';
+        if (class_exists($setupOptionsClassName)) {
+            $setupOptionsClass = $this->objectManagerProvider->get()->create($setupOptionsClassName);
+            if ($setupOptionsClass instanceof \Magento\Framework\Setup\ConfigOptionsInterface) {
                 $optionsList[$setupOptionsClassName] = [
-                    'options' => $optionsClass->getOptions(),
+                    'options' => $setupOptionsClass->getOptions(),
                     'enabled' => true,
                 ];
             }
         }
 
         return $optionsList;
     }
-
-    /**
-     * Collects Options files recursively
-     *
-     * @param Filesystem\Directory\ReadInterface $dir
-     * @param string $path
-     * @param array $result
-     */
-    private function collectRecursively(\Magento\Framework\Filesystem\Directory\ReadInterface $dir, $path, &$result)
-    {
-        $localResult = $dir->search($path . '/Setup/ConfigOptions.php');
-        foreach ($localResult as $optionFile) {
-            $result[] = $optionFile;
-        }
-
-        // goes deeper if current search is successful or next depth level exists
-        if ($localResult || $dir->search($path . '/*')) {
-            $this->collectRecursively($dir, $path . '/*', $result);
-        }
-    }
 }