MQE-1376: [SPIKE] Investigate Self-Documentation for MFTF

- Making requested review changes

Author: aljcalandra

dev/tests/_bootstrap.php

@@ -60,7 +60,7 @@
 defined('TESTS_BP') || define('TESTS_BP', __DIR__);
 defined('TESTS_MODULE_PATH') || define('TESTS_MODULE_PATH', TESTS_BP . $RELATIVE_TESTS_MODULE_PATH);
 defined('MAGENTO_BP') || define('MAGENTO_BP', __DIR__);
-define('OUTPUT_DIR',
+define('DOCS_OUTPUT_DIR',
     FW_BP .
     DIRECTORY_SEPARATOR .
     "dev" .

dev/tests/unit/Magento/FunctionalTestFramework/Util/DocGeneratorTest.php

@@ -32,11 +32,11 @@ public function testBasicCreateDocumentation()
             ->build();
         DocGenerator::getInstance()->createDocumentation(
             [$actionGroupUnderTest->getName() => $actionGroupUnderTest],
-            OUTPUT_DIR,
+            DOCS_OUTPUT_DIR,
             true
         );
 
-        $docFile = OUTPUT_DIR . DIRECTORY_SEPARATOR . self::DOC_FILENAME . ".md";
+        $docFile = DOCS_OUTPUT_DIR . DIRECTORY_SEPARATOR . self::DOC_FILENAME . ".md";
 
         $this->assertTrue(file_exists($docFile));
 
@@ -63,7 +63,7 @@ public function testCreateDocumentationWithOverwrite()
             ->build();
         DocGenerator::getInstance()->createDocumentation(
             [$actionGroupUnderTest->getName() => $actionGroupUnderTest],
-            OUTPUT_DIR,
+            DOCS_OUTPUT_DIR,
             true
         );
 
@@ -77,11 +77,11 @@ public function testCreateDocumentationWithOverwrite()
             ->build();
         DocGenerator::getInstance()->createDocumentation(
             [$actionGroupUnderTest->getName() => $actionGroupUnderTest],
-            OUTPUT_DIR,
+            DOCS_OUTPUT_DIR,
             true
         );
 
-        $docFile = OUTPUT_DIR . DIRECTORY_SEPARATOR . self::DOC_FILENAME . ".md";
+        $docFile = DOCS_OUTPUT_DIR . DIRECTORY_SEPARATOR . self::DOC_FILENAME . ".md";
 
         $this->assertTrue(file_exists($docFile));
 
@@ -108,18 +108,18 @@ public function testCreateDocumentationNotCleanException()
             ->build();
         DocGenerator::getInstance()->createDocumentation(
             [$actionGroupUnderTest->getName() => $actionGroupUnderTest],
-            OUTPUT_DIR,
+            DOCS_OUTPUT_DIR,
             true
         );
 
-        $docFile = OUTPUT_DIR . DIRECTORY_SEPARATOR . self::DOC_FILENAME . ".md";
+        $docFile = DOCS_OUTPUT_DIR . DIRECTORY_SEPARATOR . self::DOC_FILENAME . ".md";
 
         $this->expectException(TestFrameworkException::class);
         $this->expectExceptionMessage("$docFile already exists, please add --clean if you want to overwrite it.");
 
         DocGenerator::getInstance()->createDocumentation(
             [$actionGroupUnderTest->getName() => $actionGroupUnderTest],
-            OUTPUT_DIR,
+            DOCS_OUTPUT_DIR,
             false
         );
     }

dev/tests/unit/Util/MagentoTestCase.php

@@ -16,8 +16,8 @@ class MagentoTestCase extends TestCase
 {
     public static function setUpBeforeClass()
     {
-        if (!self::fileExists(OUTPUT_DIR)) {
-            mkdir(OUTPUT_DIR, 0755, true);
+        if (!self::fileExists(DOCS_OUTPUT_DIR)) {
+            mkdir(DOCS_OUTPUT_DIR, 0755, true);
         }
         parent::setUpBeforeClass();
     }
@@ -29,9 +29,9 @@ public static function setUpBeforeClass()
     public static function tearDownAfterClass()
     {
         AspectMock::clean();
-        array_map('unlink', glob(OUTPUT_DIR . DIRECTORY_SEPARATOR . "*"));
-        if (file_exists(OUTPUT_DIR)) {
-            rmdir(OUTPUT_DIR);
+        array_map('unlink', glob(DOCS_OUTPUT_DIR . DIRECTORY_SEPARATOR . "*"));
+        if (file_exists(DOCS_OUTPUT_DIR)) {
+            rmdir(DOCS_OUTPUT_DIR);
         }
     }
 }

src/Magento/FunctionalTestingFramework/Console/GenerateDocsCommand.php

@@ -37,7 +37,12 @@ protected function configure()
                 'c',
                 InputOption::VALUE_NONE,
                 'Clean Output Directory'
-            );
+            )->addOption(
+        "force",
+        'f',
+        InputOption::VALUE_NONE,
+        'Force Document Generation For All Action Groups'
+    );
     }
 
     /**
@@ -55,17 +60,18 @@ protected function execute(InputInterface $input, OutputInterface $output)
         defined('COMMAND') || define('COMMAND', 'generate:docs');
         $config = $input->getOption('output');
         $clean = $input->getOption('clean');
+        $force = $input->getOption('force');
 
         MftfApplicationConfig::create(
-            true,
+            $force,
             MftfApplicationConfig::GENERATION_PHASE,
             false,
             false
         );
 
         $allActionGroups = ActionGroupObjectHandler::getInstance()->getAllObjects();
 
-        DocGenerator::getInstance()->createDocumentation($allActionGroups, $config, $clean);
+        DocGenerator::createDocumentation($allActionGroups, $config, $clean);
 
         $output->writeln("Generate Docs Command Run");
     }

src/Magento/FunctionalTestingFramework/Test/Util/ActionGroupAnnotationExtractor.php

@@ -33,8 +33,6 @@ public function extractAnnotations($testAnnotations, $filename)
         $annotationObjects = [];
         $annotations = $this->stripDescriptorTags($testAnnotations, parent::NODE_NAME);
 
-        // parse the Test annotations
-
         foreach ($annotations as $annotationKey => $annotationData) {
             $annotationObjects[$annotationKey] = $annotationData[parent::ANNOTATION_VALUE];
         }

src/Magento/FunctionalTestingFramework/Util/DocGenerator.php

@@ -26,40 +26,11 @@ class DocGenerator
         DIRECTORY_SEPARATOR .
         "docs";
     const DOC_NAME = "documentation.md";
-    const ANNOTATION_MODULE = "";
     const ANNOTATION_PAGE = "page";
     const ANNOTATION_DESCRIPTION = "description";
     const FILENAMES = "filenames";
     const ARGUMENTS = "arguments";
 
-    /**
-     * Single instance of class var
-     *
-     * @var ActionGroupObjectHandler
-     */
-    private static $instance;
-
-    /**
-     * Array of action groups
-     *
-     * @var ActionGroupObjectHandler
-     */
-    private $actionGroups;
-
-    /**
-     * Singleton getter for instance of ActionGroupObjectHandler
-     *
-     * @return ActionGroupObjectHandler
-     */
-    public static function getInstance(): DocGenerator
-    {
-        if (!self::$instance) {
-            self::$instance = new DocGenerator();
-        }
-
-        return self::$instance;
-    }
-
     /**
      * DocGenerator constructor.
      *