feat: Add new StoredObjectManager service.

To read and write onto `StoredObject` document using a common interface.
2025-08-22 15:43:51 +00:00 · 2022-03-08 15:45:39 +01:00
parent 8abed67e1c
commit 62af980ea5
4 changed files with 390 additions and 0 deletions
--- a/src/Bundle/ChillDocStoreBundle/Tests/StoredObjectManagerTest.php
+++ b/src/Bundle/ChillDocStoreBundle/Tests/StoredObjectManagerTest.php
@@ -0,0 +1,183 @@
+<?php
+
+/**
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Chill\DocStoreBundle\Tests;
+
+use ChampsLibres\AsyncUploaderBundle\TempUrl\TempUrlGeneratorInterface;
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Exception\StoredObjectManagerException;
+use Chill\DocStoreBundle\Service\StoredObjectManager;
+use Chill\DocStoreBundle\Service\StoredObjectManagerInterface;
+use Generator;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+use Symfony\Component\HttpClient\Exception\TransportException;
+use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\MockResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * @internal
+ *
+ * @covers \Chill\DocStoreBundle\Service\StoredObjectManager
+ */
+final class StoredObjectManagerTest extends TestCase
+{
+    public function getDataProvider(): Generator
+    {
+        /* HAPPY SCENARIO */
+
+        // Encrypted object
+        yield [
+            (new StoredObject())
+                ->setFilename('encrypted.txt')
+                ->setKeyInfos(['k' => base64_encode('S9NIHMaFHOWzLPez3jZOIHBaNfBrMQUR5zvqBz6kme8')])
+                ->setIv(unpack('C*', 'abcdefghijklmnop')),
+            hex2bin('741237d255fd4f7eddaaa9058912a84caae28a41b10b34d4e3e3abe41d3b9b47cb0dd8f22c3c883d4f0e9defa75ff662'), // Binary encoded string
+            'The quick brown fox jumps over the lazy dog', // clear
+        ];
+
+        // Non-encrypted object
+        yield [
+            (new StoredObject())->setFilename('non-encrypted.txt'), // The StoredObject
+            'The quick brown fox jumps over the lazy dog', // Encrypted
+            'The quick brown fox jumps over the lazy dog', // Clear
+        ];
+
+        /* UNHAPPY SCENARIO */
+
+        // Encrypted object with issue during HTTP communication
+        yield [
+            (new StoredObject())
+                ->setFilename('error_during_http_request.txt')
+                ->setKeyInfos(['k' => base64_encode('S9NIHMaFHOWzLPez3jZOIHBaNfBrMQUR5zvqBz6kme8')])
+                ->setIv(unpack('C*', 'abcdefghijklmnop')),
+            hex2bin('741237d255fd4f7eddaaa9058912a84caae28a41b10b34d4e3e3abe41d3b9b47cb0dd8f22c3c883d4f0e9defa75ff662'), // Binary encoded string
+            'The quick brown fox jumps over the lazy dog', // clear
+            StoredObjectManagerException::class,
+        ];
+
+        // Encrypted object with issue during HTTP communication: Invalid status code
+        yield [
+            (new StoredObject())
+                ->setFilename('invalid_statuscode.txt')
+                ->setKeyInfos(['k' => base64_encode('S9NIHMaFHOWzLPez3jZOIHBaNfBrMQUR5zvqBz6kme8')])
+                ->setIv(unpack('C*', 'abcdefghijklmnop')),
+            hex2bin('741237d255fd4f7eddaaa9058912a84caae28a41b10b34d4e3e3abe41d3b9b47cb0dd8f22c3c883d4f0e9defa75ff662'), // Binary encoded string
+            'The quick brown fox jumps over the lazy dog', // clear
+            StoredObjectManagerException::class,
+        ];
+
+        // Erroneous encrypted: Unable to decrypt exception.
+        yield [
+            (new StoredObject())
+                ->setFilename('unable_to_decrypt.txt')
+                ->setKeyInfos(['k' => base64_encode('WRONG_PASS_PHRASE')])
+                ->setIv(unpack('C*', 'abcdefghijklmnop')),
+            'WRONG_ENCODED_VALUE', // Binary encoded string
+            'The quick brown fox jumps over the lazy dog', // clear
+            StoredObjectManagerException::class,
+        ];
+    }
+
+    /**
+     * @dataProvider getDataProvider
+     */
+    public function testRead(StoredObject $storedObject, string $encodedContent, string $clearContent, ?string $exceptionClass = null)
+    {
+        if (null !== $exceptionClass) {
+            $this->expectException($exceptionClass);
+        }
+
+        $storedObjectManager = $this->getSubject($storedObject, $encodedContent);
+
+        self::assertEquals($clearContent, $storedObjectManager->read($storedObject));
+    }
+
+    /**
+     * @dataProvider getDataProvider
+     */
+    public function testWrite(StoredObject $storedObject, string $encodedContent, string $clearContent, ?string $exceptionClass = null)
+    {
+        if (null !== $exceptionClass) {
+            $this->expectException($exceptionClass);
+        }
+
+        $storedObjectManager = $this->getSubject($storedObject, $encodedContent);
+
+        $storedObjectManager->write($storedObject, $clearContent);
+
+        self::assertEquals($clearContent, $storedObjectManager->read($storedObject));
+    }
+
+    private function getHttpClient(string $encodedContent): HttpClientInterface
+    {
+        $callback = static function ($method, $url, $options) use ($encodedContent) {
+            if (Request::METHOD_GET === $method) {
+                switch ($url) {
+                    case 'https://example.com/non-encrypted.txt':
+                    case 'https://example.com/encrypted.txt':
+                        return new MockResponse($encodedContent, ['http_code' => 200]);
+
+                    case 'https://example.com/error_during_http_request.txt':
+                        return new TransportException('error_during_http_request.txt');
+
+                    case 'https://example.com/invalid_statuscode.txt':
+                        return new MockResponse($encodedContent, ['http_code' => 404]);
+                }
+            }
+
+            if (Request::METHOD_PUT === $method) {
+                switch ($url) {
+                    case 'https://example.com/non-encrypted.txt':
+                    case 'https://example.com/encrypted.txt':
+                        return new MockResponse($encodedContent, ['http_code' => 201]);
+
+                    case 'https://example.com/error_during_http_request.txt':
+                        throw new TransportException('error_during_http_request.txt');
+
+                    case 'https://example.com/invalid_statuscode.txt':
+                        return new MockResponse($encodedContent, ['http_code' => 404]);
+                }
+            }
+
+            return new MockResponse('Not found');
+        };
+
+        return new MockHttpClient($callback);
+    }
+
+    private function getSubject(StoredObject $storedObject, string $encodedContent): StoredObjectManagerInterface
+    {
+        return new StoredObjectManager(
+            $this->getHttpClient($encodedContent),
+            $this->getTempUrlGenerator($storedObject)
+        );
+    }
+
+    private function getTempUrlGenerator(StoredObject $storedObject): TempUrlGeneratorInterface
+    {
+        $response = new stdClass();
+        $response->url = $storedObject->getFilename();
+
+        $tempUrlGenerator = $this
+            ->getMockBuilder(TempUrlGeneratorInterface::class)
+            ->getMock();
+
+        $tempUrlGenerator
+            ->method('generate')
+            ->withAnyParameters()
+            ->willReturn($response);
+
+        return $tempUrlGenerator;
+    }
+}