General refactor: ext-curl dependency + review of singletones (refactor constructs)

composer.json

@@ -10,6 +10,7 @@
     },
     "require": {
         "php": "7.0.2|7.0.4|~7.0.6|~7.1.0|~7.2.0",
+        "ext-curl": "*",
         "allure-framework/allure-codeception": "~1.2.6",
         "codeception/codeception": "~2.3.4",
         "consolidation/robo": "^1.0.0",

dev/tests/unit/Magento/FunctionalTestFramework/Suite/Handlers/SuiteObjectHandlerTest.php

@@ -85,7 +85,7 @@ private function setMockTestAndSuiteParserOutput($testData, $suiteData)
         $property->setValue(null);
 
         // clear suite object handler value to inject parsed content
-        $property = new \ReflectionProperty(SuiteObjectHandler::class, 'SUITE_OBJECT_HANLDER_INSTANCE');
+        $property = new \ReflectionProperty(SuiteObjectHandler::class, 'instance');
         $property->setAccessible(true);
         $property->setValue(null);
 

dev/tests/unit/Magento/FunctionalTestFramework/Suite/SuiteGeneratorTest.php

@@ -149,7 +149,7 @@ public function testGenerateEmptySuite()
      */
     private function setMockTestAndSuiteParserOutput($testData, $suiteData)
     {
-        $property = new \ReflectionProperty(SuiteGenerator::class, 'SUITE_GENERATOR_INSTANCE');
+        $property = new \ReflectionProperty(SuiteGenerator::class, 'instance');
         $property->setAccessible(true);
         $property->setValue(null);
 
@@ -159,7 +159,7 @@ private function setMockTestAndSuiteParserOutput($testData, $suiteData)
         $property->setValue(null);
 
         // clear suite object handler value to inject parsed content
-        $property = new \ReflectionProperty(SuiteObjectHandler::class, 'SUITE_OBJECT_HANLDER_INSTANCE');
+        $property = new \ReflectionProperty(SuiteObjectHandler::class, 'instance');
         $property->setAccessible(true);
         $property->setValue(null);
 

dev/tests/unit/Magento/FunctionalTestFramework/Test/Util/ObjectExtensionUtilTest.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace tests\unit\Magento\FunctionalTestFramework\Test\Util;
 
 use AspectMock\Proxy\Verifier;
@@ -31,26 +32,35 @@ public function setUp()
         TestLoggingUtil::getInstance()->setMockLoggingUtil();
     }
 
+    /**
+     * After class functionality
+     * @return void
+     */
+    public static function tearDownAfterClass()
+    {
+        TestLoggingUtil::getInstance()->clearMockLoggingUtil();
+    }
+
     /**
      * Tests generating a test that extends another test
      * @throws \Exception
      */
     public function testGenerateExtendedTest()
     {
         $mockActions = [
-          "mockStep" => ["nodeName" => "mockNode", "stepKey" => "mockStep"]
+            "mockStep" => ["nodeName" => "mockNode", "stepKey" => "mockStep"]
         ];
 
         $testDataArrayBuilder = new TestDataArrayBuilder();
         $mockSimpleTest = $testDataArrayBuilder
             ->withName('simpleTest')
-            ->withAnnotations(['title'=>[['value' => 'simpleTest']]])
+            ->withAnnotations(['title' => [['value' => 'simpleTest']]])
             ->withTestActions($mockActions)
             ->build();
 
         $mockExtendedTest = $testDataArrayBuilder
             ->withName('extendedTest')
-            ->withAnnotations(['title'=>[['value' => 'extendedTest']]])
+            ->withAnnotations(['title' => [['value' => 'extendedTest']]])
             ->withTestReference("simpleTest")
             ->build();
 
@@ -88,14 +98,14 @@ public function testGenerateExtendedWithHooks()
         $testDataArrayBuilder = new TestDataArrayBuilder();
         $mockSimpleTest = $testDataArrayBuilder
             ->withName('simpleTest')
-            ->withAnnotations(['title'=>[['value' => 'simpleTest']]])
+            ->withAnnotations(['title' => [['value' => 'simpleTest']]])
             ->withBeforeHook($mockBeforeHooks)
             ->withAfterHook($mockAfterHooks)
             ->build();
 
         $mockExtendedTest = $testDataArrayBuilder
             ->withName('extendedTest')
-            ->withAnnotations(['title'=>[['value' => 'extendedTest']]])
+            ->withAnnotations(['title' => [['value' => 'extendedTest']]])
             ->withTestReference("simpleTest")
             ->build();
 
@@ -117,7 +127,7 @@ public function testGenerateExtendedWithHooks()
         $this->assertArrayHasKey("mockStepBefore", $testObject->getHooks()['before']->getActions());
         $this->assertArrayHasKey("mockStepAfter", $testObject->getHooks()['after']->getActions());
     }
-    
+
     /**
      * Tests generating a test that extends another test
      * @throws \Exception
@@ -158,14 +168,14 @@ public function testExtendingExtendedTest()
 
         $mockSimpleTest = $testDataArrayBuilder
             ->withName('simpleTest')
-            ->withAnnotations(['title'=>[['value' => 'simpleTest']]])
+            ->withAnnotations(['title' => [['value' => 'simpleTest']]])
             ->withTestActions()
             ->withTestReference("anotherTest")
             ->build();
 
         $mockExtendedTest = $testDataArrayBuilder
             ->withName('extendedTest')
-            ->withAnnotations(['title'=>[['value' => 'extendedTest']]])
+            ->withAnnotations(['title' => [['value' => 'extendedTest']]])
             ->withTestReference("simpleTest")
             ->build();
 
@@ -347,7 +357,7 @@ private function setMockTestOutput($testData = null, $actionGroupData = null)
         $property->setValue(null);
 
         // clear test object handler value to inject parsed content
-        $property = new \ReflectionProperty(ActionGroupObjectHandler::class, 'ACTION_GROUP_OBJECT_HANDLER');
+        $property = new \ReflectionProperty(ActionGroupObjectHandler::class, 'instance');
         $property->setAccessible(true);
         $property->setValue(null);
 
@@ -358,28 +368,21 @@ private function setMockTestOutput($testData = null, $actionGroupData = null)
         )->make();
         $instance = AspectMock::double(
             ObjectManager::class,
-            ['create' => function ($clazz) use (
-                $mockDataParser,
-                $mockActionGroupParser
-            ) {
-                if ($clazz == TestDataParser::class) {
-                    return $mockDataParser;
+            [
+                'create' => function ($className) use (
+                    $mockDataParser,
+                    $mockActionGroupParser
+                ) {
+                    if ($className == TestDataParser::class) {
+                        return $mockDataParser;
+                    }
+                    if ($className == ActionGroupDataParser::class) {
+                        return $mockActionGroupParser;
+                    }
                 }
-                if ($clazz == ActionGroupDataParser::class) {
-                    return $mockActionGroupParser;
-                }
-            }]
+            ]
         )->make();
         // bypass the private constructor
         AspectMock::double(ObjectManagerFactory::class, ['getObjectManager' => $instance]);
     }
-
-    /**
-     * After class functionality
-     * @return void
-     */
-    public static function tearDownAfterClass()
-    {
-        TestLoggingUtil::getInstance()->clearMockLoggingUtil();
-    }
 }

dev/tests/unit/Util/TestLoggingUtil.php

@@ -18,7 +18,7 @@ class TestLoggingUtil extends Assert
     /**
      * @var TestLoggingUtil
      */
-    private static $INSTANCE;
+    private static $instance;
 
     /**
      * @var TestHandler
@@ -40,11 +40,11 @@ private function __construct()
      */
     public static function getInstance()
     {
-        if (self::$INSTANCE == null) {
-            self::$INSTANCE = new TestLoggingUtil();
+        if (self::$instance == null) {
+            self::$instance = new TestLoggingUtil();
         }
 
-        return self::$INSTANCE;
+        return self::$instance;
     }
 
     /**
@@ -61,7 +61,7 @@ public function setMockLoggingUtil()
             LoggingUtil::class,
             ['getLogger' => $testLogger]
         )->make();
-        $property = new \ReflectionProperty(LoggingUtil::class, 'INSTANCE');
+        $property = new \ReflectionProperty(LoggingUtil::class, 'instance');
         $property->setAccessible(true);
         $property->setValue($mockLoggingUtil);
     }

src/Magento/FunctionalTestingFramework/Suite/Handlers/SuiteObjectHandler.php

@@ -23,7 +23,7 @@ class SuiteObjectHandler implements ObjectHandlerInterface
      *
      * @var SuiteObjectHandler
      */
-    private static $SUITE_OBJECT_HANLDER_INSTANCE;
+    private static $instance;
 
     /**
      * Array of suite objects keyed by suite name.
@@ -33,11 +33,19 @@ class SuiteObjectHandler implements ObjectHandlerInterface
     private $suiteObjects;
 
     /**
-     * SuiteObjectHandler constructor.
+     * Avoids instantiation of SuiteObjectHandler by new.
+     * @return void
      */
     private function __construct()
     {
-        // empty constructor
+    }
+
+    /**
+     * Avoids instantiation of SuiteObjectHandler by clone.
+     * @return void
+     */
+    private function __clone()
+    {
     }
 
     /**
@@ -46,14 +54,14 @@ private function __construct()
      * @return ObjectHandlerInterface
      * @throws XmlException
      */
-    public static function getInstance()
+    public static function getInstance(): ObjectHandlerInterface
     {
-        if (self::$SUITE_OBJECT_HANLDER_INSTANCE == null) {
-            self::$SUITE_OBJECT_HANLDER_INSTANCE = new SuiteObjectHandler();
-            self::$SUITE_OBJECT_HANLDER_INSTANCE->initSuiteData();
+        if (self::$instance == null) {
+            self::$instance = new SuiteObjectHandler();
+            self::$instance->initSuiteData();
         }
 
-        return self::$SUITE_OBJECT_HANLDER_INSTANCE;
+        return self::$instance;
     }
 
     /**
@@ -62,7 +70,7 @@ public static function getInstance()
      * @param string $objectName
      * @return SuiteObject
      */
-    public function getObject($objectName)
+    public function getObject($objectName): SuiteObject
     {
         if (!array_key_exists($objectName, $this->suiteObjects)) {
             trigger_error("Suite ${objectName} is not defined.", E_USER_ERROR);
@@ -75,7 +83,7 @@ public function getObject($objectName)
      *
      * @return array
      */
-    public function getAllObjects()
+    public function getAllObjects(): array
     {
         return $this->suiteObjects;
     }
@@ -85,7 +93,7 @@ public function getAllObjects()
      *
      * @return array
      */
-    public function getAllTestReferences()
+    public function getAllTestReferences(): array
     {
         $testsReferencedInSuites = [];
         $suites = $this->getAllObjects();

src/Magento/FunctionalTestingFramework/Suite/SuiteGenerator.php

@@ -33,7 +33,7 @@ class SuiteGenerator
      *
      * @var SuiteGenerator
      */
-    private static $SUITE_GENERATOR_INSTANCE;
+    private static $instance;
 
     /**
      * Group Class Generator initialized in constructor.
@@ -43,28 +43,37 @@ class SuiteGenerator
     private $groupClassGenerator;
 
     /**
-     * SuiteGenerator constructor.
+     * Avoids instantiation of LoggingUtil by new.
+     * @return void
      */
     private function __construct()
     {
         $this->groupClassGenerator = new GroupClassGenerator();
     }
 
+    /**
+     * Avoids instantiation of SuiteGenerator by clone.
+     * @return void
+     */
+    private function __clone()
+    {
+    }
+
     /**
      * Singleton method which is used to retrieve the instance of the suite generator.
      *
      * @return SuiteGenerator
      */
-    public static function getInstance()
+    public static function getInstance(): SuiteGenerator
     {
-        if (!self::$SUITE_GENERATOR_INSTANCE) {
+        if (!self::$instance) {
             // clear any previous configurations before any generation occurs.
             self::clearPreviousGroupPreconditions();
             self::clearPreviousSessionConfigEntries();
-            self::$SUITE_GENERATOR_INSTANCE = new SuiteGenerator();
+            self::$instance = new SuiteGenerator();
         }
 
-        return self::$SUITE_GENERATOR_INSTANCE;
+        return self::$instance;
     }
 
     /**

src/Magento/FunctionalTestingFramework/Test/Handlers/ActionGroupObjectHandler.php

@@ -27,7 +27,7 @@ class ActionGroupObjectHandler implements ObjectHandlerInterface
      *
      * @var ActionGroupObjectHandler
      */
-    private static $ACTION_GROUP_OBJECT_HANDLER;
+    private static $instance;
 
     /**
      * Array of action groups indexed by name
@@ -48,14 +48,13 @@ class ActionGroupObjectHandler implements ObjectHandlerInterface
      *
      * @return ActionGroupObjectHandler
      */
-    public static function getInstance()
+    public static function getInstance(): ActionGroupObjectHandler
     {
-        if (!self::$ACTION_GROUP_OBJECT_HANDLER) {
-            self::$ACTION_GROUP_OBJECT_HANDLER = new ActionGroupObjectHandler();
-            self::$ACTION_GROUP_OBJECT_HANDLER->initActionGroups();
+        if (!self::$instance) {
+            self::$instance = new ActionGroupObjectHandler();
         }
 
-        return self::$ACTION_GROUP_OBJECT_HANDLER;
+        return self::$instance;
     }
 
     /**
@@ -64,6 +63,7 @@ public static function getInstance()
     private function __construct()
     {
         $this->extendUtil = new ObjectExtensionUtil();
+        $this->initActionGroups();
     }
 
     /**
@@ -87,7 +87,7 @@ public function getObject($actionGroupName)
      *
      * @return array
      */
-    public function getAllObjects()
+    public function getAllObjects(): array
     {
         foreach ($this->actionGroups as $actionGroupName => $actionGroup) {
             $this->actionGroups[$actionGroupName] = $this->extendActionGroup($actionGroup);
@@ -125,7 +125,7 @@ private function initActionGroups()
      * @param ActionGroupObject $actionGroupObject
      * @return ActionGroupObject
      */
-    private function extendActionGroup($actionGroupObject)
+    private function extendActionGroup($actionGroupObject): ActionGroupObject
     {
         if ($actionGroupObject->getParentName() !== null) {
             return $this->extendUtil->extendActionGroup($actionGroupObject);