rft labels from environment utility (fixes #59, via #60)

Author: remorhaz

src/Attribute/AttributeReaderInterface.php

@@ -4,6 +4,7 @@
 
 namespace Qameta\Allure\Attribute;
 
+use Qameta\Allure\Model\EnvProvider;
 use ReflectionClass;
 use ReflectionFunction;
 use ReflectionMethod;
@@ -42,6 +43,7 @@ public function getFunctionAnnotations(ReflectionFunction $function, ?string $na
     /**
      * @param array $variables
      * @return list<AttributeInterface>
+     * @deprecated Use {@see EnvProvider} instead.
      */
     public function getEnvironmentAnnotations(array $variables): array;
 }

src/Model/EnvProvider.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Qameta\Allure\Model;
+
+use function is_scalar;
+use function is_string;
+use function str_starts_with;
+use function strlen;
+use function strtolower;
+use function substr;
+
+final class EnvProvider implements ModelProviderInterface
+{
+    use ModelProviderTrait;
+
+    private const ENV_LABEL_PREFIX = 'ALLURE_LABEL_';
+
+    /**
+     * @var array<string, string>
+     */
+    private array $env;
+
+    public function __construct(array $env)
+    {
+        $this->env = $this->normalizeEnv($env);
+    }
+
+    /**
+     * @param array $env
+     * @return array<string, string>
+     */
+    private function normalizeEnv(array $env): array
+    {
+        $normalizedEnv = [];
+        /** @psalm-var mixed $value */
+        foreach ($env as $key => $value) {
+            if (is_string($key) && is_scalar($value)) {
+                $normalizedEnv[$key] = (string) $value;
+            }
+        }
+
+        return $normalizedEnv;
+    }
+
+    /**
+     * @return list<Label>
+     */
+    public function getLabels(): array
+    {
+        $labels = [];
+        $prefixLength = strlen(self::ENV_LABEL_PREFIX);
+        foreach ($this->env as $key => $value) {
+            $name = str_starts_with($key, self::ENV_LABEL_PREFIX)
+                ? substr($key, $prefixLength)
+                : '';
+            if ('' != $name) {
+                $labels[] = new Label(strtolower($name), $value);
+            }
+        }
+
+        return $labels;
+    }
+}

test/Model/EnvProviderTest.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Qameta\Allure\Test\Model;
+
+use PHPUnit\Framework\TestCase;
+use Qameta\Allure\Model\EnvProvider;
+
+use function json_encode;
+
+/**
+ * @covers \Qameta\Allure\Model\EnvProvider
+ */
+class EnvProviderTest extends TestCase
+{
+    /**
+     * @param array $env
+     * @return void
+     * @dataProvider providerInvalidLabels
+     */
+    public function testInvalidLabels(array $env): void
+    {
+        $provider = new EnvProvider($env);
+        self::assertEmpty($provider->getLabels());
+    }
+
+    /**
+     * @return iterable<string, array{array}>
+     */
+    public static function providerInvalidLabels(): iterable
+    {
+        return [
+            'Absent' => [[]],
+            'Empty name' => [['' => 'a']],
+            'Nothing after prefix' => [['ALLURE_LABEL_' => 'a']],
+            'Text before prefix' => [['AALLURE_LABEL_B' => 'c']],
+            'Prefix with wrong case' => [['Allure_Label_A' => 'b']],
+            'Non-scalar value' => [['ALLURE_LABEL_A' => []]],
+            'Null value' => [['ALLURE_LABEL_A' => null]],
+        ];
+    }
+
+    /**
+     * @param array  $env
+     * @param string $expectedValue
+     * @return void
+     * @dataProvider providerValidLabels
+     */
+    public function testValidLabels(array $env, string $expectedValue): void
+    {
+        $provider = new EnvProvider($env);
+        $actualValue = json_encode($provider->getLabels());
+        self::assertJsonStringEqualsJsonString($expectedValue, $actualValue);
+    }
+
+    /**
+     * @return iterable<string, array{array, string}>
+     */
+    public static function providerValidLabels(): iterable
+    {
+        return [
+            'Single label' => [
+                ['ALLURE_LABEL_A' => 'b'],
+                <<<JSON
+[
+  {"name": "a", "value": "b"}
+]
+JSON,
+            ],
+            'Two labels' => [
+                ['ALLURE_LABEL_A' => 'b', 'ALLURE_LABEL_C' => 'd'],
+                <<<JSON
+[
+  {"name": "a", "value": "b"},
+  {"name": "c", "value": "d"}
+]
+JSON,
+            ],
+        ];
+    }
+}