Skip to content

MQE-830: Output error details about test failure #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ class ActionGroupWithDataOverrideTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ class ActionGroupWithDataTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ class ActionGroupWithNoDefaultTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ class ActionGroupWithPersistedDataCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ class ActionGroupWithTopLevelPersistedDataCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ class ArgumentWithSameNameAsElementCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
1 change: 0 additions & 1 deletion dev/tests/verification/Resources/BasicFunctionalTest.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ class BasicFunctionalTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
1 change: 0 additions & 1 deletion dev/tests/verification/Resources/BasicMergeTest.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ class BasicMergeTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
1 change: 0 additions & 1 deletion dev/tests/verification/Resources/HookActionsTest.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ class HookActionsTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
1 change: 0 additions & 1 deletion dev/tests/verification/Resources/MergedActionGroupTest.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ class MergedActionGroupTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
1 change: 0 additions & 1 deletion dev/tests/verification/Resources/MergedReferencesTest.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ class MergedReferencesTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ class MultipleActionGroupsTestCest
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot();
$this->_after($I);
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace Magento\FunctionalTestingFramework\Extension;

use \Codeception\Events;

/**
* Class TestContextExtension
* @SuppressWarnings(PHPMD.UnusedPrivateField)
*/
class TestContextExtension extends \Codeception\Extension
{
const TEST_PHASE_AFTER = "_after";

/**
* Codeception Events Mapping to methods
* @var array
*/
public static $events = [
Events::TEST_FAIL => 'testFail',
];

/**
* Codeception event listener function, triggered on test failure.
* @param \Codeception\Event\FailEvent $e
* @return void
*/
public function testFail(\Codeception\Event\FailEvent $e)
{
$cest = $e->getTest();
$context = $this->extractContext($e->getFail()->getTrace(), $cest->getTestMethod());
// Do not attempt to run _after if failure was in the _after block
// Try to run _after but catch exceptions to prevent them from overwriting original failure.
if ($context != TestContextExtension::TEST_PHASE_AFTER) {
try {
$actorClass = $e->getTest()->getMetadata()->getCurrent('actor');
$I = new $actorClass($cest->getScenario());
call_user_func(\Closure::bind(
function () use ($cest, $I) {
$cest->executeHook($I, 'after');
},
null,
$cest
));
} catch (\Exception $e) {
// Do not rethrow Exception
}
}
}

/**
* Extracts hook method from trace, looking specifically for the cest class given.
* @param array $trace
* @param string $class
* @return string
*/
public function extractContext($trace, $class)
{
foreach ($trace as $entry) {
$traceClass = $entry["class"] ?? null;
if (strpos($traceClass, $class) != 0) {
return $entry["function"];
}
}
return null;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -1373,6 +1373,7 @@ private function stripAndSplitReference($reference, $delimiter)
* @return string
* @throws TestReferenceException
* @throws \Exception
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
private function generateHooksPhp($hookObjects)
{
Expand Down Expand Up @@ -1414,12 +1415,6 @@ private function generateHooksPhp($hookObjects)
throw new TestReferenceException($e->getMessage() . " in Element \"" . $type . "\"");
}

if ($hookObject->getType() == TestObjectExtractor::TEST_FAILED_HOOK) {
$steps.="\t\t";
$steps.='$this->_after($I);';
$steps.="\n";
}

$hooks .= sprintf("\tpublic function _{$type}(%s)\n", $dependencies);
$hooks .= "\t{\n";
$hooks .= $steps;
Expand Down