Skip to content

Basic Cept Test case format support #31

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.

Sign up for GitHub

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
baev merged 2 commits into from
Aug 18, 2017
Merged

Basic Cept Test case format support #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7233045
Update AllureAdapter.php
esteban-serfe Aug 9, 2017
3abb2a6
Update AllureAdapter.php
esteban-serfe Aug 9, 2017
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
127 changes: 109 additions & 18 deletions src/Yandex/Allure/Adapter/AllureAdapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use Codeception\Event\SuiteEvent;
use Codeception\Event\TestEvent;
use Codeception\Event\FailEvent;
use Codeception\Test\Cest;
use Codeception\Events;
use Codeception\Platform\Extension;
use Codeception\Exception\ConfigurationException;
Expand All @@ -29,7 +28,6 @@

const OUTPUT_DIRECTORY_PARAMETER = 'outputDirectory';
const DELETE_PREVIOUS_RESULTS_PARAMETER = 'deletePreviousResults';
const IGNORED_ANNOTATION_PARAMETER = 'ignoredAnnotations';
const DEFAULT_RESULTS_DIRECTORY = 'allure-results';
const DEFAULT_REPORT_DIRECTORY = 'allure-report';

Expand Down Expand Up @@ -73,16 +71,16 @@ class AllureAdapter extends Extension

/**
* Extra annotations to ignore in addition to standard PHPUnit annotations.
*
* @param array $ignoredAnnotations
*/
public function _initialize()
public function _initialize(array $ignoredAnnotations = [])
{
parent::_initialize();
Annotation\AnnotationProvider::registerAnnotationNamespaces();
// Add standard PHPUnit annotations
Annotation\AnnotationProvider::addIgnoredAnnotations($this->ignoredAnnotations);
// Add custom ignored annotations
$ignoredAnnotations =
$this->tryGetOption(IGNORED_ANNOTATION_PARAMETER, []);
Annotation\AnnotationProvider::addIgnoredAnnotations($ignoredAnnotations);
$outputDirectory = $this->getOutputDirectory();
$deletePreviousResults =
Expand Down Expand Up @@ -201,29 +199,43 @@ public function testBefore(TestEvent $testEvent)
{
$test = $testEvent->getTest();
$testName = $test->getName();
$testClass = $test instanceof Cest
? get_class($test->getTestClass())
: get_class($test);
$event = new TestCaseStartedEvent($this->uuid, $testName);
if (class_exists($testClass, false)) {
$annotationManager = new Annotation\AnnotationManager(Annotation\AnnotationProvider::getClassAnnotations($testClass));
$annotationManager->updateTestCaseEvent($event);
if ($test instanceof \Codeception\Test\Cest) {
$testClass = get_class($test->getTestClass());
if (class_exists($testClass, false)) {
$annotationManager = new Annotation\AnnotationManager(Annotation\AnnotationProvider::getClassAnnotations($testClass));
$annotationManager->updateTestCaseEvent($event);
}
} else if ($test instanceof \Codeception\Test\Cept) {
$annotations = $this->getCeptAnnotations($test);
if (count($annotations) > 0) {
$annotationManager = new Annotation\AnnotationManager($annotations);
$annotationManager->updateTestCaseEvent($event);
}
}

$this->getLifecycle()->fire($event);
}

public function testStart(TestEvent $testEvent)
{
$test = $testEvent->getTest();
$testName = $test->getName(false);
$className = $test instanceof Cest
? get_class($test->getTestClass())
: get_class($test);
$testName = $test->getName();
$event = new TestCaseStartedEvent($this->uuid, $testName);
if (method_exists($className, $testName)){
$annotationManager = new Annotation\AnnotationManager(Annotation\AnnotationProvider::getMethodAnnotations($className, $testName));
$annotationManager->updateTestCaseEvent($event);
if ($test instanceof \Codeception\Test\Cest) {
$className = get_class($test->getTestClass());
if (method_exists($className, $testName)){
$annotationManager = new Annotation\AnnotationManager(Annotation\AnnotationProvider::getMethodAnnotations($className, $testName));
$annotationManager->updateTestCaseEvent($event);
}
} else if ($test instanceof \Codeception\Test\Cept) {
$annotations = $this->getCeptAnnotations($test);
if (count($annotations) > 0) {
$annotationManager = new Annotation\AnnotationManager($annotations);
$annotationManager->updateTestCaseEvent($event);
}
}

$this->getLifecycle()->fire($event);
}

Expand Down Expand Up @@ -304,4 +316,83 @@ public function setLifecycle(Allure $lifecycle)
$this->lifecycle = $lifecycle;
}

/**
*
* @param \Codeception\TestInterface $test
* @return array
*/
private function getCeptAnnotations($test)
{
$tokens = token_get_all($test->getSourceCode());
$comments = array();
$annotations = [];
foreach($tokens as $token) {
if($token[0] == T_DOC_COMMENT || $token[0] == T_COMMENT) {
$comments[] = $token[1];
}
}
foreach($comments as $comment) {
$lines = preg_split ('/$\R?^/m', $comment);
foreach($lines as $line) {
$output = [];
if (preg_match('/\*\s\@(.*)\((.*)\)/', $line, $output) > 0) {
\Codeception\Util\Debug::debug($output);
if ($output[1] == "Features") {
$feature = new \Yandex\Allure\Adapter\Annotation\Features();
$features = $this->splitAnnotationContent($output[2]);
foreach($features as $featureName) {
$feature->featureNames[] = $featureName;
}
$annotations[get_class($feature)] = $feature;
} else if ($output[1] == 'Title') {
$title = new \Yandex\Allure\Adapter\Annotation\Title();
$title_content = str_replace('"', '', $output[2]);
$title->value = $title_content;
$annotations[get_class($title)] = $title;
} else if ($output[1] == 'Description') {
$description = new \Yandex\Allure\Adapter\Annotation\Description();
$description_content = str_replace('"', '', $output[2]);
$description->value = $description_content;
$annotations[get_class($description)] = $description;
} else if ($output[1] == 'Stories') {
$stories = $this->splitAnnotationContent($output[2]);
$story = new \Yandex\Allure\Adapter\Annotation\Stories();
foreach($stories as $storyName) {
$story->stories[] = $storyName;
}
$annotations[get_class($story)] = $story;
} else if ($output[1] == 'Issues') {
$issues = $this->splitAnnotationContent($output[2]);
$issue = new \Yandex\Allure\Adapter\Annotation\Stories();
foreach($issues as $issueName) {
$issues->issuesKeys[] = $issueName;
}
$annotations[get_class($issue)] = $issue;
} else {
\Codeception\Util\Debug::debug("Tag not detected: ".$output[1]);
}
}
}
}
return $annotations;
}

/**
*
* @param string $string
* @return array
*/
private function splitAnnotationContent($string)
{
$parts = [];
$detected = str_replace('{', '', $string);
$detected = str_replace('}', '', $detected);
$detected = str_replace('"', '', $detected);
$parts = explode(',', $detected);
if (count($parts) == 0 && count($detected) > 0) {
$parts[] = $detected;
}
return $parts;
}

}