API-599: fix composer install by deleting composer.lock and add documentation to test with docker

Author: ahocquard

.travis.yml

@@ -13,6 +13,7 @@ cache:
 
 before_install:
     - phpenv config-rm xdebug.ini
+    - phpenv config-add travis.php.ini
     - echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
     - composer self-update --no-interaction
 

phpunit.xml.dist

@@ -7,7 +7,7 @@
      convertErrorsToExceptions="true"
      convertNoticesToExceptions="true"
      convertWarningsToExceptions="true"
-     processIsolation="true"
+     processIsolation="false"
      stopOnFailure="false"
      syntaxCheck="false">
 

spec/Api/ProductMediaFileApiSpec.php

@@ -133,7 +133,7 @@ function it_creates_a_media_file($resourceClient, ResponseInterface $response)
             ->willReturn($response);
 
         $this->create($fileResource, $product)
-            ->shouldReturn('1/e/e/d/1eed10f108bde68b279d6f903f17b4b053e9d89d_akeneo.png');
+            ->shouldReturn($response);
     }
 
     function it_throws_an_exception_if_the_file_is_unreadable_when_creating_a_media_file()

src/Api/MediaFileApiInterface.php

@@ -7,6 +7,7 @@
 use Akeneo\Pim\ApiClient\Api\Operation\ListableResourceInterface;
 use Akeneo\Pim\ApiClient\Exception\HttpException;
 use Akeneo\Pim\ApiClient\Exception\RuntimeException;
+use GuzzleHttp\Psr7\Response;
 
 /**
  * API to manage the media files.
@@ -29,7 +30,7 @@ interface MediaFileApiInterface extends
      * @throws HttpException    If the request failed.
      * @throws RuntimeException If the file could not be opened.
      *
-     * @return string returns the code of created media file
+     * @return Response returns the code of created media file
      */
     public function create($mediaFile, array $data);
 }

src/Api/ProductMediaFileApi.php

@@ -99,8 +99,18 @@ public function create($mediaFile, array $productData)
         ];
 
         $response = $this->resourceClient->createMultipartResource(static::MEDIA_FILES_URI, [], $requestParts);
+        $headers = $response->getHeaders();
+
+        if (!isset($headers['Location'][0])) {
+            throw new RuntimeException('The response does not contain the URI of the created media-file.');
+        }
 
-        return $this->extractCodeFromCreationResponse($response);
+        $matches = [];
+        if (1 !== preg_match(ProductMediaFileApi::MEDIA_FILE_URI_CODE_REGEX, $headers['Location'][0], $matches)) {
+            throw new RuntimeException('Unable to find the code in the URI of the created media-file.');
+        }
+        
+        return $response;
     }
 
     /**

tests/Api/ApiTestCase.php

@@ -5,11 +5,11 @@
 use Akeneo\Pim\ApiClient\AkeneoPimClientBuilder;
 use Akeneo\Pim\ApiClient\AkeneoPimClientInterface;
 use Akeneo\Pim\ApiClient\Api\AuthenticationApi;
+use Akeneo\Pim\ApiClient\Api\ProductMediaFileApi;
+use Akeneo\Pim\ApiClient\Exception\RuntimeException;
 use donatj\MockWebServer\MockWebServer;
 use donatj\MockWebServer\Response;
 use donatj\MockWebServer\ResponseStack;
-use Http\Message\StreamFactory;
-use Http\Discovery\StreamFactoryDiscovery;
 
 /**
  * @author    Laurent Petard <[email protected]>
@@ -37,6 +37,14 @@ protected function setUp()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    protected function tearDown()
+    {
+        $this->server->stop();
+    }
+
     /**
      * @return AkeneoPimClientInterface
      */
@@ -63,10 +71,41 @@ private function getAuthenticatedJson()
     }
 
     /**
-     * @return StreamFactory
+     * Extracts the code of a media-file from a creation response.
+     *
+     * @param $response
+     *
+     * @throws RuntimeException if unable to extract the code
+     *
+     * @return mixed
      */
-    protected function getStreamFactory()
+    protected function extractCodeFromCreationResponse($response)
     {
-        return StreamFactoryDiscovery::find();
+        $headers = $response->getHeaders();
+
+        if (!isset($headers['Location'][0])) {
+            throw new RuntimeException('The response does not contain the URI of the created media-file.');
+        }
+
+        $matches = [];
+        if (1 !== preg_match(ProductMediaFileApi::MEDIA_FILE_URI_CODE_REGEX, $headers['Location'][0], $matches)) {
+            throw new RuntimeException('Unable to find the code in the URI of the created media-file.');
+        }
+
+        return $matches['code'];
+    }
+
+    /**
+     * @param CursorInterface $result
+     * @param array $expected
+     */
+    protected function assertSameResults()
+    {
+        $products = [];
+        foreach ($result as $product) {
+            $products[] = $product->getIdentifier();
+        }
+
+        $this->assertSame($products, $expected);
     }
 }

tests/Api/CreateProductMediaFileTest.php

@@ -3,6 +3,7 @@
 namespace Akeneo\Pim\ApiClient\tests\Api;
 
 use Akeneo\Pim\ApiClient\Api\ProductMediaFileApi;
+use donatj\MockWebServer\RequestInfo;
 use donatj\MockWebServer\Response;
 use donatj\MockWebServer\ResponseStack;
 use PHPUnit\Framework\Assert;
@@ -22,13 +23,20 @@ public function test_create_media_file()
         $api = $this->createClient()->getProductMediaFileApi();
         $mediaFile = realpath(__DIR__ . '/../fixtures/akeneo.png');
 
-        $response = $api->create($mediaFile, [
+        $productInfos = [
             'identifier' => 'medium_boot',
             'attribute'  => 'side_view',
             'scope'      => null,
             'locale'     => null,
-        ]);
+        ];
 
-        Assert::assertSame('f/b/0/6/fb068ccc9e3c5609d73c28d852812ba5faeeab28_akeneo.png', $response);
+        $response = $api->create($mediaFile, $productInfos);
+
+        Assert::assertSame($this->server->getLastRequest()->jsonSerialize()[RequestInfo::JSON_KEY_POST]['product'], json_encode($productInfos));
+        Assert::assertSame($this->server->getLastRequest()->jsonSerialize()[RequestInfo::JSON_KEY_REQUEST_URI], '/'. ProductMediaFileApi::MEDIA_FILES_URI);
+
+        Assert::assertSame(201, $response->getStatusCode());
+        Assert::assertSame('', $response->getBody()->getContents());
+        Assert::assertSame('f/b/0/6/fb068ccc9e3c5609d73c28d852812ba5faeeab28_akeneo.png', $this->extractCodeFromCreationResponse($response));
     }
 }

tests/Api/UpsertListProductTest.php

@@ -5,6 +5,7 @@
 use Akeneo\Pim\ApiClient\Api\ProductApi;
 use donatj\MockWebServer\Response;
 use donatj\MockWebServer\ResponseStack;
+use Http\Discovery\StreamFactoryDiscovery;
 use PHPUnit\Framework\Assert;
 
 class UpsertListProductTest extends ApiTestCase
@@ -87,7 +88,7 @@ public function test_upsert_list_from_stream()
         fwrite($resources, $resourcesContent);
         rewind($resources);
 
-        $streamedResources = $this->getStreamFactory()->createStream($resources);
+        $streamedResources = StreamFactoryDiscovery::find()->createStream($resources);
         $api = $this->createClient()->getProductAPi();
         $response = $api->upsertList($streamedResources);
 

travis.php.ini

@@ -0,0 +1 @@
+always_populate_raw_post_data = -1