Merge pull request #22 from magento-commerce/MQE-2463

MQE-2463: Mftf test extends from a skipped parent should be skipped

Author: jilu1

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

@@ -346,6 +346,41 @@ public function testExtendingExtendedActionGroup()
         }
     }
 
+    /**
+     * Tests generating a test that extends a skipped parent test
+     *
+     * @throws \Exception
+     */
+    public function testExtendedTestSkippedParent()
+    {
+        $testDataArrayBuilder = new TestDataArrayBuilder();
+        $mockParentTest = $testDataArrayBuilder
+            ->withName('baseTest')
+            ->withAnnotations([
+                'skip' => ['nodeName' => 'skip', 'issueId' => [['nodeName' => 'issueId', 'value' => 'someIssue']]]
+            ])
+            ->build();
+
+        $testDataArrayBuilder->reset();
+        $mockExtendedTest = $testDataArrayBuilder
+            ->withName('extendTest')
+            ->withTestReference("baseTest")
+            ->build();
+
+        $mockTestData = array_merge($mockParentTest, $mockExtendedTest);
+        $this->setMockTestOutput($mockTestData);
+
+        // parse and generate test object with mocked data
+        TestObjectHandler::getInstance()->getObject('extendTest');
+
+        // validate log statement
+        TestLoggingUtil::getInstance()->validateMockLogStatement(
+            'debug',
+            "extendTest is skipped due to ParentTestIsSkipped",
+            []
+        );
+    }
+
     /**
      * Function used to set mock for parser return and force init method to run between tests.
      *

dev/tests/unit/Util/TestDataArrayBuilder.php

@@ -232,6 +232,28 @@ public function withTestReference($reference = null)
         return $this;
     }
 
+    /**
+     * Reset data array builder
+     *
+     * @return void
+     */
+    public function reset()
+    {
+        // reset
+        $this->testName = 'testTest';
+        $this->filename = null;
+        $this->testActionBeforeName = 'testActionBefore';
+        $this->testActionAfterName = 'testActionAfter';
+        $this->testActionFailedName = 'testActionFailed';
+        $this->testActionType = 'testAction';
+        $this->annotations = [];
+        $this->beforeHook = [];
+        $this->afterHook = [];
+        $this->failedHook = [];
+        $this->testReference = null;
+        $this->testActions = [];
+    }
+
     /**
      * Output the resulting test data array based on parameters set in the object
      *

dev/tests/verification/Resources/ExtendingSkippedTest.txt

@@ -19,33 +19,6 @@ use Yandex\Allure\Adapter\Annotation\TestCaseId;
  */
 class ExtendingSkippedTestCest
 {
-	/**
-	  * @param AcceptanceTester $I
-	  * @throws \Exception
-	  */
-	public function _before(AcceptanceTester $I)
-	{
-		$I->amOnPage("/beforeUrl"); // stepKey: beforeAmOnPageKey
-	}
-
-	/**
-	  * @param AcceptanceTester $I
-	  * @throws \Exception
-	  */
-	public function _after(AcceptanceTester $I)
-	{
-		$I->amOnPage("/afterUrl"); // stepKey: afterAmOnPageKey
-	}
-
-	/**
-	  * @param AcceptanceTester $I
-	  * @throws \Exception
-	  */
-	public function _failed(AcceptanceTester $I)
-	{
-		$I->saveScreenshot(); // stepKey: saveScreenshot
-	}
-
 	/**
 	 * @Severity(level = SeverityLevel::CRITICAL)
 	 * @Features({"TestModule"})
@@ -55,9 +28,8 @@ class ExtendingSkippedTestCest
 	 * @return void
 	 * @throws \Exception
 	 */
-	public function ExtendingSkippedTest(AcceptanceTester $I)
+	public function ExtendingSkippedTest(AcceptanceTester $I, \Codeception\Scenario $scenario)
 	{
-		$I->comment("text");
-		$I->comment("child");
+		$scenario->skip("This test is skipped due to the following issues:\nParentTestIsSkipped");
 	}
 }

docs/extending.md

@@ -15,6 +15,11 @@ Specify needed variations for a parent object and produce a copy of the original
 Unlike merging, the parent test (or action group) will still exist after the test generation.
 </div>
 
+<div class="bs-callout-warning" markdown="1">
+<br>
+Note: The extended test will be skipped if the parent test is skipped.
+</div>
+
 ## Extending tests
 
 ### Update a test step

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

@@ -42,13 +42,13 @@ public function extendTest($testObject)
         try {
             $parentTest = TestObjectHandler::getInstance()->getObject($testObject->getParentName());
         } catch (TestReferenceException $error) {
+            $skippedTest = $this->skipTest($testObject, 'ParentTestDoesNotExist');
             if (MftfApplicationConfig::getConfig()->verboseEnabled()) {
                 LoggingUtil::getInstance()->getLogger(ObjectExtensionUtil::class)->debug(
                     "parent test not defined. test will be skipped",
                     ["parent" => $testObject->getParentName(), "test" => $testObject->getName()]
                 );
             }
-            $skippedTest = $this->skipTest($testObject);
             return $skippedTest;
         }
 
@@ -64,6 +64,11 @@ public function extendTest($testObject)
                 ->debug("extending test", ["parent" => $parentTest->getName(), "test" => $testObject->getName()]);
         }
 
+        // Skip test if parent is skipped
+        if ($parentTest->isSkipped()) {
+            return $this->skipTest($testObject);
+        }
+
         // Get steps for both the parent and the child tests
         $referencedTestSteps = $parentTest->getUnresolvedSteps();
         $newSteps = $this->processRemoveActions(array_merge($referencedTestSteps, $testObject->getUnresolvedSteps()));
@@ -207,17 +212,19 @@ private function processRemoveActions($actions)
      * This method returns a skipped form of the Test Object
      *
      * @param TestObject $testObject
+     * @param string     $skipReason
      * @return TestObject
      */
-    public function skipTest($testObject)
+    public function skipTest($testObject, $skipReason = null)
     {
         $annotations = $testObject->getAnnotations();
+        $skipReason = $skipReason ?? 'ParentTestIsSkipped';
 
         // Add skip to the group array if it doesn't already exist
         if (array_key_exists('skip', $annotations)) {
             return $testObject;
         } elseif (!array_key_exists('skip', $annotations)) {
-            $annotations['skip'] = ['issueId' => "ParentTestDoesNotExist"];
+            $annotations['skip'] = ['issueId' => $skipReason];
         }
 
         $skippedTest = new TestObject(
@@ -229,6 +236,12 @@ public function skipTest($testObject)
             $testObject->getParentName()
         );
 
+        if (MftfApplicationConfig::getConfig()->verboseEnabled()) {
+            LoggingUtil::getInstance()->getLogger(ObjectExtensionUtil::class)->debug(
+                "{$testObject->getName()} is skipped due to {$skipReason}"
+            );
+        }
+
         return $skippedTest;
     }
 }