allure-framework · baev · Feb 17, 2022 · Oct 19, 2021 · Oct 19, 2021 · Feb 15, 2022
diff --git a/README.md b/README.md
@@ -31,15 +31,42 @@ extensions:
     enabled:
         - Qameta\Allure\Codeception\AllureCodeception
     config:
-      Qameta\Allure\Codeception\AllureCodeception:
+        Qameta\Allure\Codeception\AllureCodeception:
             outputDirectory: allure-results
+            linkTemplates:
+                issue: https://example.org/issues/%s
+            setipHook: My\SetupHook
 ```
 
 `outputDirectory` is used to store Allure results and will be calculated
 relatively to Codeception output directory (also known as `paths: log` in
 codeception.yml) unless you specify an absolute path. You can traverse up using
 `..` as usual. `outputDirectory` defaults to `allure-results`.
 
+`linkTemplates` is used to process links and generate URLs for them. You can put
+here an `sprintf()`-like template or a name of class to be constructed; such class
+must implement `Qameta\Allure\Setup\LinkTemplateInterface`.
+
+`setupHook` allows to execute some bootstrapping code during initialization. You can
+put here a name of the class that implements magic `__invoke()` method - and that method
+will be called. For example, it can be used to ignore unnecessary docblock annotations:
+
+```php
+<?php
+
+namespace My;
+
+use Doctrine\Common\Annotations\AnnotationReader;
+
+class SetupHook
+{
+    public function __invoke(): void
+    {
+        AnnotationReader::addGlobalIgnoredName('annotationToIgnore');
+    }
+}
+```
+
 To generate report from your favourite terminal,
 [install](https://github.com/allure-framework/allure-cli#installation)
 allure-cli and run following command (assuming you're in project root and using

diff --git a/codeception.yml b/codeception.yml
@@ -13,5 +13,5 @@ extensions:
   config:
     Qameta\Allure\Codeception\AllureCodeception:
       outputDirectory: allure-results
-
-
+      linkTemplates:
+        issue: https://example.org/issues/%s
diff --git a/composer.json b/composer.json
@@ -24,16 +24,15 @@
 	    "php": "^8",
         "ext-json": "*",
         "codeception/codeception": "^4.1",
-        "allure-framework/allure-php-commons": "2.0.0-rc3"
+        "allure-framework/allure-php-commons": "^2"
     },
     "require-dev": {
-        "ext-dom": "*",
         "phpunit/phpunit": "^9",
         "psalm/plugin-phpunit": "^0.16.1",
         "remorhaz/php-json-data": "^0.5.3",
         "remorhaz/php-json-path": "^0.7.7",
-        "squizlabs/php_codesniffer": "^3.6.1",
-        "vimeo/psalm": "^4.10"
+        "squizlabs/php_codesniffer": "^3.6.2",
+        "vimeo/psalm": "^4.20"
     },
     "conflict": {
         "codeception/phpunit-wrapper": "<9.0.1"

diff --git a/src/AllureCodeception.php b/src/AllureCodeception.php
@@ -15,18 +15,22 @@
 use Codeception\Step;
 use Qameta\Allure\Allure;
 use Qameta\Allure\Allure as QametaAllure;
-use Qameta\Allure\Attribute\LinkTemplateInterface;
 use Qameta\Allure\Codeception\Internal\DefaultThreadDetector;
 use Qameta\Allure\Codeception\Internal\SuiteInfo;
 use Qameta\Allure\Codeception\Internal\TestLifecycle;
 use Qameta\Allure\Codeception\Internal\TestLifecycleInterface;
 use Qameta\Allure\Codeception\Setup\ThreadDetectorInterface;
+use Qameta\Allure\Model\LinkType;
 use Qameta\Allure\Model\Status;
 use Qameta\Allure\Model\StatusDetails;
 use Qameta\Allure\Setup\DefaultStatusDetector;
+use Qameta\Allure\Setup\LinkTemplate;
+use Qameta\Allure\Setup\LinkTemplateInterface;
 use Throwable;
 
 use function class_exists;
+use function is_a;
+use function is_array;
 use function is_callable;
 use function is_string;
 use function trim;
@@ -35,9 +39,9 @@
 
 final class AllureCodeception extends Extension
 {
-
     private const SETUP_HOOK_PARAMETER = 'setupHook';
     private const OUTPUT_DIRECTORY_PARAMETER = 'outputDirectory';
+    private const LINK_TEMPLATES_PARAMETER = 'linkTemplates';
 
     private const DEFAULT_RESULTS_DIRECTORY = 'allure-results';
 
@@ -55,11 +59,6 @@ final class AllureCodeception extends Extension
         Events::STEP_AFTER => 'stepAfter'
     ];
 
-    /**
-     * @var array<string, LinkTemplateInterface>
-     */
-    private array $linkTemplates = [];
-
     private ?ThreadDetectorInterface $threadDetector = null;
 
     private ?TestLifecycleInterface $testLifecycle = null;
@@ -76,9 +75,12 @@ public function _initialize(): void
         parent::_initialize();
         QametaAllure::reset();
         QametaAllure::getLifecycleConfigurator()
-            ->setStatusDetector(new StatusDetector(new DefaultStatusDetector()));
+            ->setStatusDetector(new StatusDetector(new DefaultStatusDetector()))
+            ->setOutputDirectory($this->getOutputDirectory());
+        foreach ($this->getLinkTemplates() as $linkType => $linkTemplate) {
+            QametaAllure::getLifecycleConfigurator()->addLinkTemplate($linkType, $linkTemplate);
+        }
         $this->callSetupHook();
-        QametaAllure::setOutputDirectory($this->getOutputDirectory());
     }
 
     private function callSetupHook(): void
@@ -115,6 +117,31 @@ private function getOutputDirectory(): string
         return Configuration::outputDir() . ($outputLocal ?? self::DEFAULT_RESULTS_DIRECTORY) . DIRECTORY_SEPARATOR;
     }
 
+    /**
+     * @psalm-suppress MoreSpecificReturnType
+     * @return iterable<LinkType, LinkTemplate>
+     */
+    private function getLinkTemplates(): iterable
+    {
+        /**
+         * @var mixed $templatesConfig
+         * @psalm-var array $this->config
+         */
+        $templatesConfig = $this->config[self::LINK_TEMPLATES_PARAMETER] ?? [];
+        if (!is_array($templatesConfig)) {
+            $templatesConfig = [];
+        }
+        foreach ($templatesConfig as $linkTypeName => $linkConfig) {
+            if (!is_string($linkConfig) || !is_string($linkTypeName)) {
+                continue;
+            }
+            yield LinkType::fromOptionalString($linkTypeName) =>
+                class_exists($linkConfig) && is_a($linkConfig, LinkTemplateInterface::class, true)
+                    ? new $linkConfig()
+                    : new LinkTemplate($linkConfig);
+        }
+    }
+
     /**
      * @psalm-suppress MissingDependency
      */
@@ -270,10 +297,10 @@ private function getTestLifecycle(): TestLifecycleInterface
     {
         return $this->testLifecycle ??= new TestLifecycle(
             Allure::getLifecycle(),
-            Allure::getResultFactory(),
-            Allure::getStatusDetector(),
+            Allure::getConfig()->getResultFactory(),
+            Allure::getConfig()->getStatusDetector(),
             $this->getThreadDetector(),
-            $this->linkTemplates,
+            Allure::getConfig()->getLinkTemplates(),
         );
     }
 }
diff --git a/src/Internal/ArgumentAsString.php b/src/Internal/ArgumentAsString.php
@@ -8,6 +8,7 @@
 use Stringable;
 
 use function array_map;
+use function class_exists;
 use function is_a;
 use function is_array;
 use function is_object;
@@ -22,7 +23,6 @@
  */
 final class ArgumentAsString implements Stringable
 {
-
     public function __construct(
         private mixed $argument,
     ) {
@@ -75,7 +75,8 @@ private function prepareObject(object $argument): string
             return (string) $argument;
         }
 
-        if (is_a($argument, 'Facebook\WebDriver\WebDriverBy')) {
+        $webdriverByClass = '\Facebook\WebDriver\WebDriverBy';
+        if (class_exists($webdriverByClass) && is_a($argument, $webdriverByClass)) {
             return Locator::humanReadableString($argument);
         }
 

diff --git a/src/Internal/CeptInfoBuilder.php b/src/Internal/CeptInfoBuilder.php
@@ -8,7 +8,6 @@
 
 final class CeptInfoBuilder implements TestInfoBuilderInterface
 {
-
     public function __construct(
         private Cept $test,
     ) {

diff --git a/src/Internal/CeptProvider.php b/src/Internal/CeptProvider.php
@@ -5,7 +5,7 @@
 namespace Qameta\Allure\Codeception\Internal;
 
 use Codeception\Test\Cept;
-use Qameta\Allure\Attribute\LinkTemplateInterface;
+use Qameta\Allure\Setup\LinkTemplateCollectionInterface;
 use Qameta\Allure\Model\Label;
 use Qameta\Allure\Model\Link;
 use Qameta\Allure\Model\LinkType;
@@ -27,7 +27,6 @@
  */
 final class CeptProvider implements ModelProviderInterface
 {
-
     private bool $isLoaded = false;
 
     /**
@@ -45,21 +44,21 @@ final class CeptProvider implements ModelProviderInterface
     private ?string $legacyDescription = null;
 
     /**
-     * @param Cept                                 $test
-     * @param array<string, LinkTemplateInterface> $linkTemplates
+     * @param Cept                            $test
+     * @param LinkTemplateCollectionInterface $linkTemplates
      */
     public function __construct(
         private Cept $test,
-        private array $linkTemplates = [],
+        private LinkTemplateCollectionInterface $linkTemplates,
     ) {
     }
 
     /**
-     * @param Cept                                 $test
-     * @param array<string, LinkTemplateInterface> $linkTemplates
+     * @param Cept                            $test
+     * @param LinkTemplateCollectionInterface $linkTemplates
      * @return list<ModelProviderInterface>
      */
-    public static function createForChain(Cept $test, array $linkTemplates): array
+    public static function createForChain(Cept $test, LinkTemplateCollectionInterface $linkTemplates): array
     {
         return [new self($test, $linkTemplates)];
     }
@@ -83,14 +82,6 @@ public function getParameters(): array
         return [];
     }
 
-    /**
-     * @deprecated Please use {@see getDisplayName()} method
-     */
-    public function getTitle(): ?string
-    {
-        return $this->getDisplayName();
-    }
-
     public function getDisplayName(): ?string
     {
         $this->loadLegacyModels();
@@ -107,6 +98,11 @@ public function getDisplayName(): ?string
             : null;
     }
 
+    public function getFullName(): ?string
+    {
+        return (string) $this->test->getSignature();
+    }
+
     public function getDescription(): ?string
     {
         $this->loadLegacyModels();
@@ -179,7 +175,7 @@ private function loadLegacyModels(): void
                 $this->getLegacyAnnotations('Stories'),
             ),
         ];
-        $linkTemplate = $this->linkTemplates[(string) LinkType::issue()] ?? null;
+        $linkTemplate = $this->linkTemplates->get(LinkType::issue()) ?? null;
         $this->legacyLinks = array_map(
             fn (string $value): Link => Link::issue($value, $linkTemplate?->buildUrl($value)),
             $this->getLegacyAnnotations('Issues'),

diff --git a/src/Internal/CestInfoBuilder.php b/src/Internal/CestInfoBuilder.php
@@ -12,7 +12,6 @@
 
 final class CestInfoBuilder implements TestInfoBuilderInterface
 {
-
     public function __construct(
         private Cest $test,
     ) {

diff --git a/src/Internal/CestProvider.php b/src/Internal/CestProvider.php
@@ -6,7 +6,7 @@
 
 use Codeception\Test\Cest;
 use Qameta\Allure\Attribute\AttributeParser;
-use Qameta\Allure\Attribute\LinkTemplateInterface;
+use Qameta\Allure\Setup\LinkTemplateCollectionInterface;
 use Qameta\Allure\Model\ModelProviderInterface;
 use Qameta\Allure\Model\Parameter;
 use ReflectionException;
@@ -24,19 +24,18 @@
  */
 final class CestProvider implements ModelProviderInterface
 {
-
     public function __construct(
         private Cest $test,
     ) {
     }
 
     /**
-     * @param Cest                                 $test
-     * @param array<string, LinkTemplateInterface> $linkTemplates
+     * @param Cest                            $test
+     * @param LinkTemplateCollectionInterface $linkTemplates
      * @return list<ModelProviderInterface>
      * @throws ReflectionException
      */
-    public static function createForChain(Cest $test, array $linkTemplates = []): array
+    public static function createForChain(Cest $test, LinkTemplateCollectionInterface $linkTemplates): array
     {
         /** @var mixed $testClass */
         $testClass = $test->getTestClass();
@@ -86,14 +85,6 @@ public function getParameters(): array
         );
     }
 
-    /**
-     * @deprecated Please, use {@see getDisplayName()} method
-     */
-    public function getTitle(): ?string
-    {
-        return $this->getDisplayName();
-    }
-
     public function getDisplayName(): ?string
     {
         /** @psalm-var mixed $displayName */
@@ -113,4 +104,9 @@ public function getDescriptionHtml(): ?string
     {
         return null;
     }
+
+    public function getFullName(): ?string
+    {
+        return null;
+    }
 }
diff --git a/src/Internal/DefaultThreadDetector.php b/src/Internal/DefaultThreadDetector.php
@@ -10,7 +10,6 @@
 
 final class DefaultThreadDetector implements ThreadDetectorInterface
 {
-
     private string|false|null $host = null;
 
     public function getHost(): ?string

diff --git a/src/Internal/GherkinInfoBuilder.php b/src/Internal/GherkinInfoBuilder.php
@@ -10,7 +10,6 @@
 
 final class GherkinInfoBuilder implements TestInfoBuilderInterface
 {
-
     public function __construct(
         private Gherkin $test,
     ) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,6 @@ @@
     final class CeptInfoBuilder implements TestInfoBuilderInterface
     {
         public function __construct(
             private Cept $test,
         ) {
@@ Expand Down @@