Merge pull request #348 from keboola/erik-SOX-391

JobResult supports variables

Author: ErikZigo

src/Result/JobResult.php

@@ -7,6 +7,8 @@
 use JsonSerializable;
 use Keboola\JobQueueInternalClient\Exception\ClientException;
 use Keboola\JobQueueInternalClient\Result\InputOutput\TableCollection;
+use Keboola\JobQueueInternalClient\Result\Variable\Variable;
+use Keboola\JobQueueInternalClient\Result\Variable\VariableCollection;
 
 class JobResult implements JsonSerializable
 {
@@ -23,6 +25,7 @@ class JobResult implements JsonSerializable
     private ?TableCollection $outputTables = null;
 
     private ?JobArtifacts $artifacts = null;
+    private ?VariableCollection $variables = null;
 
     public function jsonSerialize(): array
     {
@@ -46,6 +49,9 @@ public function jsonSerialize(): array
         if ($this->artifacts) {
             $result['artifacts'] = $this->artifacts->jsonSerialize();
         }
+        if ($this->variables) {
+            $result['variables'] = $this->variables->jsonSerialize();
+        }
         if ($this->errorType) {
             $result['error']['type'] = $this->errorType;
         }
@@ -151,4 +157,15 @@ public function getArtifacts(): ?JobArtifacts
     {
         return $this->artifacts;
     }
+
+    public function setVariables(VariableCollection $variables): JobResult
+    {
+        $this->variables = $variables;
+        return $this;
+    }
+
+    public function getVariables(): ?VariableCollection
+    {
+        return $this->variables;
+    }
 }

src/Result/Variable/Variable.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\JobQueueInternalClient\Result\Variable;
+
+use JsonSerializable;
+
+class Variable implements JsonSerializable
+{
+    public function __construct(
+        private readonly string $name,
+        private readonly string $value,
+    ) {
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    public function jsonSerialize(): array
+    {
+        return [
+            'name' => $this->name,
+            'value' => $this->value,
+        ];
+    }
+}

src/Result/Variable/VariableCollection.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\JobQueueInternalClient\Result\Variable;
+
+use Countable;
+use Generator;
+use IteratorAggregate;
+use JsonSerializable;
+
+/**
+ * @implements IteratorAggregate<Variable>
+ */
+class VariableCollection implements Countable, IteratorAggregate, JsonSerializable
+{
+    /** @var Variable[] */
+    private array $items = [];
+
+    /**
+     * @return Generator<int, Variable>
+     */
+    public function getIterator(): Generator
+    {
+        foreach ($this->items as $item) {
+            yield $item;
+        }
+    }
+
+    public function count(): int
+    {
+        return count($this->items);
+    }
+
+    public function jsonSerialize(): array
+    {
+        return array_map(function (Variable $variable) {
+            return $variable->jsonSerialize();
+        }, $this->items);
+    }
+
+    public function addVariable(Variable $variable): self
+    {
+        $this->items[] = $variable;
+        return $this;
+    }
+}

tests/Result/JobResultTest.php

@@ -12,6 +12,8 @@
 use Keboola\JobQueueInternalClient\Result\InputOutput\TableCollection;
 use Keboola\JobQueueInternalClient\Result\JobArtifacts;
 use Keboola\JobQueueInternalClient\Result\JobResult;
+use Keboola\JobQueueInternalClient\Result\Variable\Variable;
+use Keboola\JobQueueInternalClient\Result\Variable\VariableCollection;
 use PHPUnit\Framework\TestCase;
 
 class JobResultTest extends TestCase
@@ -36,6 +38,9 @@ public function testAccessors(): void
 
         $output = (new TableCollection())->addTable($outputTable);
 
+        $variable = new Variable('vault.foo', 'bar');
+        $variables = (new VariableCollection())->addVariable($variable);
+
         $jobResult = new JobResult();
         $jobResult
             ->setConfigVersion('123')
@@ -45,6 +50,7 @@ public function testAccessors(): void
             ->setExceptionId('exception-12345')
             ->setInputTables($input)
             ->setOutputTables($output)
+            ->setVariables($variables)
             ->setArtifacts(
                 (new JobArtifacts())
                     ->setUploaded([
@@ -65,6 +71,7 @@ public function testAccessors(): void
         self::assertSame('exception-12345', $jobResult->getExceptionId());
         self::assertSame($input, $jobResult->getInputTables());
         self::assertSame($output, $jobResult->getOutputTables());
+        self::assertSame($variables, $jobResult->getVariables());
         self::assertSame(
             [
                 'message' => 'test',
@@ -119,6 +126,12 @@ public function testAccessors(): void
                         ],
                     ],
                 ],
+                'variables' => [
+                    [
+                        'name' => 'vault.foo',
+                        'value' => 'bar',
+                    ],
+                ],
                 'error' => [
                     'type' => 'application',
                     'exceptionId' => 'exception-12345',
@@ -139,6 +152,7 @@ public function testEmptyResult(): void
         self::assertNull($result->getMessage());
         self::assertNull($result->getInputTables());
         self::assertNull($result->getOutputTables());
+        self::assertNull($result->getVariables());
 
         self::assertSame([
             'message' => null,

tests/Result/Variable/VariableCollectionTest.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\JobQueueInternalClient\Tests\Result\InputOutput;
+
+use Keboola\JobQueueInternalClient\Result\Variable\Variable;
+use Keboola\JobQueueInternalClient\Result\Variable\VariableCollection;
+use PHPUnit\Framework\TestCase;
+
+class VariableCollectionTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $collection = new VariableCollection();
+
+        self::assertSame(0, $collection->count());
+
+        $variable = new Variable('foo', 'bar');
+        $collection->addVariable($variable);
+
+        self::assertSame(1, $collection->count());
+        self::assertSame(
+            [
+                $variable,
+            ],
+            iterator_to_array($collection->getIterator()),
+        );
+        self::assertSame([
+            [
+                'name' => 'foo',
+                'value' => 'bar',
+            ],
+        ], $collection->jsonSerialize());
+    }
+}

tests/Result/Variable/VariableTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\JobQueueInternalClient\Tests\Result\InputOutput;
+
+use Keboola\JobQueueInternalClient\Result\InputOutput\Column;
+use Keboola\JobQueueInternalClient\Result\InputOutput\ColumnCollection;
+use Keboola\JobQueueInternalClient\Result\InputOutput\Table;
+use Keboola\JobQueueInternalClient\Result\Variable\Variable;
+use PHPUnit\Framework\TestCase;
+
+class VariableTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $table = new Variable('vault.foo', 'bar');
+
+        self::assertSame('vault.foo', $table->getName());
+        self::assertSame('bar', $table->getValue());
+
+        self::assertSame([
+            'name' => 'vault.foo',
+            'value' => 'bar',
+        ], $table->jsonSerialize());
+    }
+}