MQE-779: Default Directory exists for tests not referenced in other suites

magterskine · magterskine · commit cfb142b01c17 · 2018-03-22T14:18:23.000-05:00
- Non-suite tests generate to _generate/default directory
- Error is thrown if suite name = default
- Manifest.txt and group directories generate under _generated
- Verification tests updated

MQE-799: Default Directory exists for tests not referenced in other suites

- Updated phpDocs
- Changed constructor for SingleRunTestManifest.php to call correct parameters for parent DefaultTestManifest and set singleRun config

MQE-779: Default Directory exists for tests not referenced in other suites

- Added underscore to namespacing for cests in TestGenerator
- Removed unncessary manifest path setting in SingleRunManifest which is handled by parent constructor

MQE-779: Default Directory exists for tests not referenced in other suites

- Fixed static check failures

MQE-779: Default Directory exists for tests not referenced in other suites

- Updated namespace in verification tests to _default from default to match TestGenerator changes for same.
diff --git a/dev/tests/verification/Resources/ActionGroupWithDataOverrideTest.txt b/dev/tests/verification/Resources/ActionGroupWithDataOverrideTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithDataTest.txt b/dev/tests/verification/Resources/ActionGroupWithDataTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithDefaultArgumentAndStringSelectorParam.txt b/dev/tests/verification/Resources/ActionGroupWithDefaultArgumentAndStringSelectorParam.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithMultipleParameterSelectorsFromDefaultArgument.txt b/dev/tests/verification/Resources/ActionGroupWithMultipleParameterSelectorsFromDefaultArgument.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithNoArguments.txt b/dev/tests/verification/Resources/ActionGroupWithNoArguments.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithNoDefaultTest.txt b/dev/tests/verification/Resources/ActionGroupWithNoDefaultTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithPassedArgumentAndStringSelectorParam.txt b/dev/tests/verification/Resources/ActionGroupWithPassedArgumentAndStringSelectorParam.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithPersistedData.txt b/dev/tests/verification/Resources/ActionGroupWithPersistedData.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithSimpleDataUsageFromDefaultArgument.txt b/dev/tests/verification/Resources/ActionGroupWithSimpleDataUsageFromDefaultArgument.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithSimpleDataUsageFromPassedArgument.txt b/dev/tests/verification/Resources/ActionGroupWithSimpleDataUsageFromPassedArgument.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithSingleParameterSelectorFromDefaultArgument.txt b/dev/tests/verification/Resources/ActionGroupWithSingleParameterSelectorFromDefaultArgument.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithSingleParameterSelectorFromPassedArgument.txt b/dev/tests/verification/Resources/ActionGroupWithSingleParameterSelectorFromPassedArgument.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithStepKeyReferences.txt b/dev/tests/verification/Resources/ActionGroupWithStepKeyReferences.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ActionGroupWithTopLevelPersistedData.txt b/dev/tests/verification/Resources/ActionGroupWithTopLevelPersistedData.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ArgumentWithSameNameAsElement.txt b/dev/tests/verification/Resources/ArgumentWithSameNameAsElement.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/AssertTest.txt b/dev/tests/verification/Resources/AssertTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/BasicActionGroupTest.txt b/dev/tests/verification/Resources/BasicActionGroupTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/BasicFunctionalTest.txt b/dev/tests/verification/Resources/BasicFunctionalTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/BasicMergeTest.txt b/dev/tests/verification/Resources/BasicMergeTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/CharacterReplacementTest.txt b/dev/tests/verification/Resources/CharacterReplacementTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/DataReplacementTest.txt b/dev/tests/verification/Resources/DataReplacementTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/HookActionsTest.txt b/dev/tests/verification/Resources/HookActionsTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/LocatorFunctionTest.txt b/dev/tests/verification/Resources/LocatorFunctionTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/MergedActionGroupTest.txt b/dev/tests/verification/Resources/MergedActionGroupTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/MergedReferencesTest.txt b/dev/tests/verification/Resources/MergedReferencesTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/MultipleActionGroupsTest.txt b/dev/tests/verification/Resources/MultipleActionGroupsTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/PageReplacementTest.txt b/dev/tests/verification/Resources/PageReplacementTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/ParameterArrayTest.txt b/dev/tests/verification/Resources/ParameterArrayTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/PersistedReplacementTest.txt b/dev/tests/verification/Resources/PersistedReplacementTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/PersistenceCustomFieldsTest.txt b/dev/tests/verification/Resources/PersistenceCustomFieldsTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Resources/SectionReplacementTest.txt b/dev/tests/verification/Resources/SectionReplacementTest.txt
@@ -1,5 +1,5 @@
 <?php
-namespace Magento\AcceptanceTest\_generated\Backend;
+namespace Magento\AcceptanceTest\_default\Backend;
 
 use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
diff --git a/dev/tests/verification/Tests/SuiteGenerationTest.php b/dev/tests/verification/Tests/SuiteGenerationTest.php
@@ -6,6 +6,7 @@
 
 namespace tests\verification\Tests;
 
+use Magento\Framework\Module\Dir;
 use Magento\FunctionalTestingFramework\Suite\SuiteGenerator;
 use Magento\FunctionalTestingFramework\Util\TestManifest;
 use Symfony\Component\Yaml\Yaml;
@@ -79,7 +80,7 @@ public function testSuiteGeneration1()
             DIRECTORY_SEPARATOR;
 
         // Validate test manifest contents
-        $actualManifest = $suiteResultBaseDir . 'testManifest.txt';
+        $actualManifest = dirname($suiteResultBaseDir). DIRECTORY_SEPARATOR . 'testManifest.txt';
         $actualTestReferences = explode(PHP_EOL, file_get_contents($actualManifest));
 
         for ($i = 0; $i < count($actualTestReferences); $i++) {
diff --git a/src/Magento/FunctionalTestingFramework/Suite/Util/SuiteObjectExtractor.php b/src/Magento/FunctionalTestingFramework/Suite/Util/SuiteObjectExtractor.php
@@ -49,6 +49,9 @@ public function parseSuiteDataIntoObjects($parsedSuiteData)
                 // skip non array items parsed from suite (suite objects will always be arrays)
                 continue;
             }
+            if ($parsedSuite[self::NAME] == 'default') {
+                throw new XmlException("A Suite can not have the name \"default\"");
+            }
 
             $suiteHooks = [];
 
diff --git a/src/Magento/FunctionalTestingFramework/Util/Manifest/DefaultTestManifest.php b/src/Magento/FunctionalTestingFramework/Util/Manifest/DefaultTestManifest.php
@@ -28,13 +28,13 @@ class DefaultTestManifest extends BaseTestManifest
 
     /**
      * DefaultTestManifest constructor.
-     * @param string $path
+     * @param string $manifestPath
+     * @param string $testPath
      */
-    public function __construct($path)
+    public function __construct($manifestPath, $testPath)
     {
-        $this->manifestPath = $path . DIRECTORY_SEPARATOR . 'testManifest.txt';
-        parent::__construct($path, self::DEFAULT_CONFIG);
-
+        $this->manifestPath = $manifestPath . DIRECTORY_SEPARATOR . 'testManifest.txt';
+        parent::__construct($testPath, self::DEFAULT_CONFIG);
         $fileResource = fopen($this->manifestPath, 'w');
         fclose($fileResource);
     }
diff --git a/src/Magento/FunctionalTestingFramework/Util/Manifest/ParallelTestManifest.php b/src/Magento/FunctionalTestingFramework/Util/Manifest/ParallelTestManifest.php
@@ -31,12 +31,13 @@ class ParallelTestManifest extends BaseTestManifest
     /**
      * TestManifest constructor.
      *
-     * @param string $path
+     * @param string $manifestPath
+     * @param string $testPath
      */
-    public function __construct($path)
+    public function __construct($manifestPath, $testPath)
     {
-        $this->dirPath = $path . DIRECTORY_SEPARATOR . 'groups';
-        parent::__construct($path, self::PARALLEL_CONFIG);
+        $this->dirPath = $manifestPath . DIRECTORY_SEPARATOR . 'groups';
+        parent::__construct($testPath, self::PARALLEL_CONFIG);
     }
 
     /**
diff --git a/src/Magento/FunctionalTestingFramework/Util/Manifest/SingleRunTestManifest.php b/src/Magento/FunctionalTestingFramework/Util/Manifest/SingleRunTestManifest.php
@@ -12,13 +12,13 @@ class SingleRunTestManifest extends DefaultTestManifest
 
     /**
      * SingleRunTestManifest constructor.
-     * @param string $path
+     * @param string $manifestPath
+     * @param string $testPath
      */
-    public function __construct($path)
+    public function __construct($manifestPath, $testPath)
     {
-        $this->manifestPath = $path . DIRECTORY_SEPARATOR . 'testManifest.txt';
-        parent::__construct($path, self::SINGLE_RUN_CONFIG);
-
+        parent::__construct($manifestPath, $testPath);
+        $this->runTypeConfig = self::SINGLE_RUN_CONFIG;
         $fileResource = fopen($this->manifestPath, 'w');
         fclose($fileResource);
     }
diff --git a/src/Magento/FunctionalTestingFramework/Util/Manifest/TestManifestFactory.php b/src/Magento/FunctionalTestingFramework/Util/Manifest/TestManifestFactory.php
@@ -19,21 +19,22 @@ private function __construct()
     /**
      * Static function which takes path and config to return the appropriate manifest output type.
      *
-     * @param String $path
+     * @param String $manifestPath
+     * @param String $testPath
      * @param String $runConfig
      * @return BaseTestManifest
      */
-    public static function makeManifest($path, $runConfig)
+    public static function makeManifest($manifestPath, $testPath, $runConfig)
     {
         switch ($runConfig) {
             case 'singleRun':
-                return new SingleRunTestManifest($path);
+                return new SingleRunTestManifest($manifestPath, $testPath);
 
             case 'parallel':
-                return new ParallelTestManifest($path);
+                return new ParallelTestManifest($manifestPath, $testPath);
 
             default:
-                return new DefaultTestManifest($path);
+                return new DefaultTestManifest($manifestPath, $testPath);
 
         }
     }
diff --git a/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php b/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php
@@ -29,6 +29,7 @@ class TestGenerator
 {
     const REQUIRED_ENTITY_REFERENCE = 'createDataKey';
     const GENERATED_DIR = '_generated';
+    const DEFAULT_DIR = 'default';
 
     /**
      * Path to the export dir.
@@ -60,11 +61,13 @@ class TestGenerator
     private function __construct($exportDir, $tests)
     {
         // private constructor for factory
-        $this->exportDirName = $exportDir ?? self::GENERATED_DIR;
-        $this->exportDirectory = rtrim(
-            TESTS_MODULE_PATH . DIRECTORY_SEPARATOR . self::GENERATED_DIR . DIRECTORY_SEPARATOR . $exportDir,
-            DIRECTORY_SEPARATOR
-        );
+        $this->exportDirName = $exportDir ?? self::DEFAULT_DIR;
+        $exportDir = $exportDir ?? self::DEFAULT_DIR;
+        $this->exportDirectory = TESTS_MODULE_PATH
+            . DIRECTORY_SEPARATOR
+            . self::GENERATED_DIR
+            . DIRECTORY_SEPARATOR
+            . $exportDir;
         $this->tests = $tests;
     }
 
@@ -141,7 +144,11 @@ public function createAllTestFiles($runConfig = null, $nodes = null)
         DirSetupUtil::createGroupDir($this->exportDirectory);
 
         // create our manifest file here
-        $testManifest = TestManifestFactory::makeManifest($this->exportDirectory, $runConfig);
+        $testManifest = TestManifestFactory::makeManifest(
+            dirname($this->exportDirectory),
+            $this->exportDirectory,
+            $runConfig
+        );
         $testPhpArray = $this->assembleAllTestPhp($testManifest, $nodes);
 
         foreach ($testPhpArray as $testPhpFile) {
@@ -172,7 +179,7 @@ private function assembleTestPhp($testObject)
         }
 
         $cestPhp = "<?php\n";
-        $cestPhp .= "namespace Magento\AcceptanceTest\\" . $this->exportDirName . "\Backend;\n\n";
+        $cestPhp .= "namespace Magento\AcceptanceTest\\_" . $this->exportDirName . "\Backend;\n\n";
         $cestPhp .= $usePhp;
         $cestPhp .= $classAnnotationsPhp;
         $cestPhp .= sprintf("class %s\n", $className);
