Adding ResultMockFactory (#286)

* Adding ResultMockFactory

* Bugfixes

* Adding support for not adding all properties

* cs

* Revert debug code

Author: Nyholm

src/Test/ResultMockFactory.php

@@ -0,0 +1,101 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AsyncAws\Core\Test;
+
+use AsyncAws\Core\Result;
+
+/**
+ * An easy way to create Result objects for your tests.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class ResultMockFactory
+{
+    /**
+     * Instantiate a Result class with some data.
+     *
+     * <code>
+     * ResultMockFactory::create(SendEmailResponse::class, ['MessageId'=>'foo123']);
+     * </code>
+     *
+     * @template T
+     * @psalm-param class-string<T> $class
+     *
+     * @return T
+     */
+    public static function create(string $class, array $data = [])
+    {
+        $parent = get_parent_class($class);
+        if (false === $parent || Result::class !== $parent) {
+            throw new \LogicException(sprintf('The "%s::%s" can only be used for classes that extend "%s"', __CLASS__, __METHOD__, Result::class));
+        }
+
+        $rereflectionClass = new \ReflectionClass($class);
+        $object = $rereflectionClass->newInstanceWithoutConstructor();
+
+        foreach ($data as $propertyName => $propertyValue) {
+            $property = $rereflectionClass->getProperty($propertyName);
+            $property->setAccessible(true);
+            $property->setValue($object, $propertyValue);
+        }
+
+        self::addUndefinedProperties($rereflectionClass, $object, $data);
+
+        return $object;
+    }
+
+    /**
+     * Try to add some values to the properties not defined in $data.
+     *
+     * @throws \ReflectionException
+     */
+    private static function addUndefinedProperties(\ReflectionClass $rereflectionClass, $object, array $data): void
+    {
+        foreach ($rereflectionClass->getProperties(\ReflectionProperty::IS_PRIVATE) as $property) {
+            if (\array_key_exists($property->getName(), $data)) {
+                continue;
+            }
+
+            $getter = $rereflectionClass->getMethod('get' . $property->getName());
+            /** @psalm-suppress PossiblyNullReference */
+            if (!$getter->hasReturnType() || $getter->getReturnType()->allowsNull()) {
+                continue;
+            }
+
+            /** @psalm-suppress PossiblyNullReference */
+            switch ($getter->getReturnType()->getName()) {
+                case 'int':
+                    $propertyValue = 0;
+
+                    break;
+                case 'string':
+                    $propertyValue = '';
+
+                    break;
+                case 'bool':
+                    $propertyValue = false;
+
+                    break;
+                case 'float':
+                    $propertyValue = 0.0;
+
+                    break;
+                case 'array':
+                    $propertyValue = [];
+
+                    break;
+                default:
+                    $propertyValue = null;
+
+                    break;
+            }
+
+            if (null !== $propertyValue) {
+                $property->setAccessible(true);
+                $property->setValue($object, $propertyValue);
+            }
+        }
+    }
+}

tests/Resources/ExampleResponse.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AsyncAws\Core\Tests\Resources;
+
+use AsyncAws\Core\Result;
+
+class ExampleResponse extends Result
+{
+    private $int;
+
+    private $float;
+
+    private $bool;
+
+    private $array;
+
+    private $string;
+
+    public function getInt(): int
+    {
+        return $this->int;
+    }
+
+    public function getFloat(): float
+    {
+        return $this->float;
+    }
+
+    public function getBool(): bool
+    {
+        return $this->bool;
+    }
+
+    public function getArray(): array
+    {
+        return $this->array;
+    }
+
+    public function getString(): string
+    {
+        return $this->string;
+    }
+}

tests/Unit/Test/ResultMockFactoryTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AsyncAws\Core\Tests\Unit\Test;
+
+use AsyncAws\Core\Sts\Result\AssumedRoleUser;
+use AsyncAws\Core\Sts\Result\AssumeRoleResponse;
+use AsyncAws\Core\Test\ResultMockFactory;
+use AsyncAws\Core\Tests\Resources\ExampleResponse;
+use PHPUnit\Framework\TestCase;
+
+class ResultMockFactoryTest extends TestCase
+{
+    public function testCreate()
+    {
+        /** @var AssumeRoleResponse $result */
+        $result = ResultMockFactory::create(AssumeRoleResponse::class, [
+            'PackedPolicySize' => 342,
+        ]);
+
+        self::assertInstanceOf(AssumeRoleResponse::class, $result);
+        self::assertNull($result->getAssumedRoleUser());
+        self::assertEquals(342, $result->getPackedPolicySize());
+    }
+
+    public function testCreateAndFillEmptyParams()
+    {
+        /** @var ExampleResponse $result */
+        $result = ResultMockFactory::create(ExampleResponse::class);
+
+        self::assertEquals(0, $result->getInt());
+        self::assertEquals([], $result->getArray());
+        self::assertEquals(false, $result->getBool());
+        self::assertEquals(0.0, $result->getFloat());
+        self::assertEquals('', $result->getString());
+    }
+
+    public function testCreateWithInvalidParameters()
+    {
+        $this->expectException(\ReflectionException::class);
+        ResultMockFactory::create(AssumeRoleResponse::class, [
+            'Foobar' => 'arn123',
+        ]);
+    }
+
+    public function testCreateWithInvalidClass()
+    {
+        $this->expectException(\LogicException::class);
+        ResultMockFactory::create(AssumedRoleUser::class, [
+            'Arn' => 'arn123',
+            'AssumedRoleId' => 'foo123',
+        ]);
+    }
+}