fix link template and model provider issues (fixes #16, fixes #18, via …

…#19)
allure-framework · Oct 21, 2021 · e419d75 · e419d75
1 parent dd3ec99
commit e419d75
Show file tree

Hide file tree

Showing 19 changed files with 264 additions and 92 deletions.
diff --git a/composer.json b/composer.json
@@ -35,9 +35,9 @@
   },
   "require-dev": {
     "jetbrains/phpstorm-attributes": "^1",
-    "phpunit/phpunit": "^9.5.9",
+    "phpunit/phpunit": "^9.5.10",
     "psalm/plugin-phpunit": "^0.16.1",
-    "squizlabs/php_codesniffer": "^3.6",
+    "squizlabs/php_codesniffer": "^3.6.1",
     "vimeo/psalm": "^4.10"
   },
   "autoload": {

diff --git a/src/Allure.php b/src/Allure.php
@@ -19,7 +19,6 @@
 use Qameta\Allure\Model\LinkType;
 use Qameta\Allure\Model\Parameter;
 use Qameta\Allure\Model\ParameterMode;
-use Qameta\Allure\Model\ResultFactoryInterface;
 use Qameta\Allure\Model\Severity;
 use Qameta\Allure\Model\Status;
 use Qameta\Allure\Model\StepResult;
@@ -28,7 +27,6 @@
 use Qameta\Allure\Setup\LifecycleConfigInterface;
 use Qameta\Allure\Setup\LifecycleConfiguratorInterface;
 use Qameta\Allure\Setup\LifecycleFactoryInterface;
-use Qameta\Allure\Setup\StatusDetectorInterface;
 use ReflectionException;
 use ReflectionFunction;
 use ReflectionMethod;
@@ -72,14 +70,9 @@ public static function getLifecycleConfigurator(): LifecycleConfiguratorInterfac
         return self::getInstance()->getLifecycleBuilder();
     }
 
-    public static function getResultFactory(): ResultFactoryInterface
+    public static function getConfig(): LifecycleConfigInterface
     {
-        return self::getInstance()->getLifecycleConfig()->getResultFactory();
-    }
-
-    public static function getStatusDetector(): StatusDetectorInterface
-    {
-        return self::getInstance()->getLifecycleConfig()->getStatusDetector();
+        return self::getInstance()->getLifecycleConfig();
     }
 
     /**
@@ -239,12 +232,30 @@ public static function parameter(
 
     public static function issue(string $name, ?string $url = null): void
     {
-        self::getInstance()->doLink(Link::issue($name, $url));
+        self::getInstance()->doLink(
+            Link::issue(
+                $name,
+                $url ?? self::getInstance()
+                    ->getLifecycleConfig()
+                    ->getLinkTemplates()
+                    ->get(LinkType::issue())
+                    ?->buildUrl($name),
+            ),
+        );
     }
 
     public static function tms(string $name, ?string $url = null): void
     {
-        self::getInstance()->doLink(Link::tms($name, $url));
+        self::getInstance()->doLink(
+            Link::tms(
+                $name,
+                $url ?? self::getInstance()
+                    ->getLifecycleConfig()
+                    ->getLinkTemplates()
+                    ->get(LinkType::tms())
+                    ?->buildUrl($name),
+            ),
+        );
     }
 
     public static function link(string $url, ?string $name = null, ?LinkType $type = null): void
@@ -414,7 +425,7 @@ private function readCallableAttributes(callable $callable): AttributeParser
             $attributes = $attributeReader->getFunctionAnnotations(new ReflectionFunction($callable));
         }
 
-        return new AttributeParser($attributes);
+        return new AttributeParser($attributes, $this->getLifecycleConfig()->getLinkTemplates());
     }
 
     private function doLabel(Label $label): void

diff --git a/src/Attribute/AttributeParser.php b/src/Attribute/AttributeParser.php
@@ -9,6 +9,8 @@
 use Qameta\Allure\Exception\InvalidMethodNameException;
 use Qameta\Allure\Model;
 use Qameta\Allure\Model\ModelProviderInterface;
+use Qameta\Allure\Setup\LinkTemplateCollection;
+use Qameta\Allure\Setup\LinkTemplateCollectionInterface;
 use ReflectionClass;
 use ReflectionException;
 use ReflectionFunction;
@@ -18,8 +20,9 @@
 use function array_merge;
 use function is_string;
 
-class AttributeParser implements ModelProviderInterface
+final class AttributeParser implements ModelProviderInterface
 {
+    use Model\ModelProviderTrait;
 
     private ?string $displayName = null;
 
@@ -43,12 +46,12 @@ class AttributeParser implements ModelProviderInterface
     private array $parameters = [];
 
     /**
-     * @param array<AttributeInterface>            $attributes
-     * @param array<string, LinkTemplateInterface> $linkTemplates
+     * @param array<AttributeInterface>       $attributes
+     * @param LinkTemplateCollectionInterface $linkTemplates
      */
     public function __construct(
         array $attributes,
-        private array $linkTemplates = [],
+        private LinkTemplateCollectionInterface $linkTemplates,
     ) {
         $this->processAnnotations(...$attributes);
     }
@@ -57,15 +60,15 @@ public function __construct(
      * @param class-string|object|null             $classOrObject
      * @param callable-string|Closure|null         $methodOrFunction
      * @param string|null                          $property
-     * @param array<string, LinkTemplateInterface> $linkTemplates
+     * @param LinkTemplateCollectionInterface|null $linkTemplates
      * @return list<ModelProviderInterface>
      * @throws ReflectionException
      */
     public static function createForChain(
         string|object|null $classOrObject,
         string|Closure|null $methodOrFunction = null,
         ?string $property = null,
-        array $linkTemplates = [],
+        ?LinkTemplateCollectionInterface $linkTemplates = null,
     ): array {
         $reader = new LegacyAttributeReader(
             new AnnotationReader(),
@@ -96,7 +99,7 @@ public static function createForChain(
         return [
             new self(
                 array_merge(...$annotations),
-                $linkTemplates,
+                $linkTemplates ?? new LinkTemplateCollection(),
             )
         ];
     }
@@ -128,22 +131,15 @@ private function processAnnotations(AttributeInterface ...$attributes): void
 
     private function createLink(LinkInterface $link): Model\Link
     {
-        $linkType = $link->getType();
+        $linkType = Model\LinkType::fromOptionalString($link->getType());
 
         return new Model\Link(
             name: $link->getName(),
-            url: $link->getUrl() ?? $this->getLinkUrl($link->getName(), $linkType),
-            type: Model\LinkType::fromOptionalString($linkType),
+            url: $link->getUrl() ?? $this->linkTemplates->get($linkType)?->buildUrl($link->getName()),
+            type: $linkType,
         );
     }
 
-    private function getLinkUrl(?string $name, ?string $type): ?string
-    {
-        return isset($type, $this->linkTemplates[$type])
-            ? $this->linkTemplates[$type]->buildUrl($name)
-            : $name;
-    }
-
     /**
      * @return list<Model\Link>
      */
@@ -186,14 +182,6 @@ public function getParameters(): array
         return $this->parameters;
     }
 
-    /**
-     * @deprecated Please use {@see getDisplayName()} method.
-     */
-    public function getTitle(): ?string
-    {
-        return $this->getDisplayName();
-    }
-
     public function getDisplayName(): ?string
     {
         return $this->displayName;

diff --git a/src/Attribute/LinkTemplateInterface.php b/src/Attribute/LinkTemplateInterface.php
diff --git a/src/Attribute/ParameterMode.php b/src/Attribute/ParameterMode.php
@@ -6,7 +6,7 @@
 
 use Qameta\Allure\Model;
 
-class ParameterMode
+final class ParameterMode
 {
 
     public const HIDDEN = Model\ParameterMode::HIDDEN;

diff --git a/src/Attribute/Title.php b/src/Attribute/Title.php
diff --git a/src/Internal/LifecycleBuilder.php b/src/Internal/LifecycleBuilder.php
@@ -13,10 +13,15 @@
 use Qameta\Allure\Io\FileSystemResultsWriter;
 use Qameta\Allure\Io\ResultsWriterInterface;
 use Qameta\Allure\Io\SystemClock;
+use Qameta\Allure\Model\LinkType;
 use Qameta\Allure\Model\ResultFactory;
 use Qameta\Allure\Model\ResultFactoryInterface;
 use Qameta\Allure\Setup\DefaultStatusDetector;
 use Qameta\Allure\Setup\LifecycleBuilderInterface;
+use Qameta\Allure\Setup\LifecycleConfiguratorInterface;
+use Qameta\Allure\Setup\LinkTemplateCollection;
+use Qameta\Allure\Setup\LinkTemplateCollectionInterface;
+use Qameta\Allure\Setup\LinkTemplateInterface;
 use Qameta\Allure\Setup\StatusDetectorInterface;
 use Ramsey\Uuid\UuidFactory;
 use Ramsey\Uuid\UuidFactoryInterface;
@@ -39,6 +44,13 @@ final class LifecycleBuilder implements LifecycleBuilderInterface
      */
     private array $lifecycleHooks = [];
 
+    /**
+     * @var array<string, LinkTemplateInterface>
+     */
+    private array $linkTemplates = [];
+
+    private ?LinkTemplateCollectionInterface $linkTemplateCollection = null;
+
     private ?StatusDetectorInterface $statusDetector = null;
 
     public function createLifecycle(ResultsWriterInterface $resultsWriter): AllureLifecycleInterface
@@ -84,6 +96,18 @@ public function addHooks(
         return $this;
     }
 
+    public function addLinkTemplate(LinkType $type, LinkTemplateInterface $template): LifecycleConfiguratorInterface
+    {
+        $this->linkTemplates[(string) $type] = $template;
+
+        return $this;
+    }
+
+    public function getLinkTemplates(): LinkTemplateCollectionInterface
+    {
+        return $this->linkTemplateCollection ??= new LinkTemplateCollection($this->linkTemplates);
+    }
+
     public function setStatusDetector(StatusDetectorInterface $statusDetector): self
     {
         $this->statusDetector = $statusDetector;

diff --git a/src/Model/ModelProviderChain.php b/src/Model/ModelProviderChain.php
@@ -100,4 +100,14 @@ public function getDescriptionHtml(): ?string
 
         return $descriptionHtml;
     }
+
+    public function getFullName(): ?string
+    {
+        $fullName = null;
+        foreach ($this->providers as $provider) {
+            $fullName ??= $provider->getFullName();
+        }
+
+        return $fullName;
+    }
 }
diff --git a/src/Model/ModelProviderInterface.php b/src/Model/ModelProviderInterface.php
@@ -22,14 +22,11 @@ public function getLabels(): array;
      */
     public function getParameters(): array;
 
-    /**
-     * @deprecated Please use {@see getDisplayName()} method.
-     */
-    public function getTitle(): ?string;
-
     public function getDisplayName(): ?string;
 
     public function getDescription(): ?string;
 
     public function getDescriptionHtml(): ?string;
+
+    public function getFullName(): ?string;
 }
diff --git a/src/Model/ModelProviderTrait.php b/src/Model/ModelProviderTrait.php
@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Qameta\Allure\Model;
+
+trait ModelProviderTrait
+{
+
+    /**
+     * @return list<Link>
+     */
+    public function getLinks(): array
+    {
+        return [];
+    }
+
+    /**
+     * @return list<Label>
+     */
+    public function getLabels(): array
+    {
+        return [];
+    }
+
+    /**
+     * @return list<Parameter>
+     */
+    public function getParameters(): array
+    {
+        return [];
+    }
+
+    public function getDisplayName(): ?string
+    {
+        return null;
+    }
+
+    public function getDescription(): ?string
+    {
+        return null;
+    }
+
+    public function getDescriptionHtml(): ?string
+    {
+        return null;
+    }
+
+    public function getFullName(): ?string
+    {
+        return null;
+    }
+}
diff --git a/src/Setup/LifecycleConfigInterface.php b/src/Setup/LifecycleConfigInterface.php
@@ -11,4 +11,6 @@ interface LifecycleConfigInterface
     public function getResultFactory(): ResultFactoryInterface;
 
     public function getStatusDetector(): StatusDetectorInterface;
+
+    public function getLinkTemplates(): LinkTemplateCollectionInterface;
 }
diff --git a/src/Setup/LifecycleConfiguratorInterface.php b/src/Setup/LifecycleConfiguratorInterface.php
@@ -7,6 +7,7 @@
 use Psr\Log\LoggerInterface;
 use Qameta\Allure\Hook\LifecycleHookInterface;
 use Qameta\Allure\Io\ClockInterface;
+use Qameta\Allure\Model\LinkType;
 use Qameta\Allure\Model\ResultFactoryInterface;
 use Ramsey\Uuid\UuidFactoryInterface;
 
@@ -27,4 +28,6 @@ public function addHooks(
         LifecycleHookInterface $hook,
         LifecycleHookInterface ...$moreHooks,
     ): self;
+
+    public function addLinkTemplate(LinkType $type, LinkTemplateInterface $template): self;
 }