Add imagePushStream()

Also serves as a basis for imagePush()

Author: clue

src/Client.php

@@ -414,6 +414,9 @@ public function imageHistory($image)
     /**
      * Push the image name on the registry
      *
+     * Will resolve with an array of all progress events. These can also be
+     * accessed via the Promise progress handler.
+     *
      * @param string      $image        image ID
      * @param string|null $tag          (optional) the tag to associate with the image on the registry
      * @param string|null $registry     (optional) the registry to push to (e.g. `registry.acme.com:5000`)
@@ -422,9 +425,37 @@ public function imageHistory($image)
      * @link https://docs.docker.com/reference/api/docker_remote_api_v1.15/#push-an-image-on-the-registry
      */
     public function imagePush($image, $tag = null, $registry = null, $registryAuth = null)
+    {
+        $stream = $this->imagePushStream($image, $tag, $registry, $registryAuth);
+
+        return $this->streamingParser->deferredStream($stream, 'progress');
+    }
+
+    /**
+     * Push the image name on the registry
+     *
+     * The resulting stream will emit the following events:
+     * - progress: for *each* element in the update stream
+     * - error:    once if an error occurs, will close() stream then
+     * - close:    once the stream ends (either finished or after "error")
+     *
+     * Please note that the resulting stream does not emit any "data" events, so
+     * you will not be able to pipe() its events into another `WritableStream`.
+     *
+     * @param string      $image        image ID
+     * @param string|null $tag          (optional) the tag to associate with the image on the registry
+     * @param string|null $registry     (optional) the registry to push to (e.g. `registry.acme.com:5000`)
+     * @param array|null  $registryAuth (optional) AuthConfig object (to send as X-Registry-Auth header)
+     * @return ReadableStreamInterface stream of image push messages
+     * @link https://docs.docker.com/reference/api/docker_remote_api_v1.15/#push-an-image-on-the-registry
+     */
+    public function imagePushStream($image, $tag = null, $registry = null, $registryAuth = null)
     {
         $path = '/images' . ($registry === null ? '' : ('/' . $registry)) . '/%s/push?tag=%s';
-        return $this->browser->post($this->url($path, $image, $tag), $this->authHeaders($registryAuth))->then(array($this->parser, 'expectJson'));
+
+        return $this->streamingParser->parseJsonStream(
+            $this->browser->post($this->url($path, $image, $tag), $this->authHeaders($registryAuth))
+        );
     }
 
     /**

tests/ClientTest.php

@@ -244,17 +244,35 @@ public function testImageHistory()
     public function testImagePush()
     {
         $json = array();
-        $this->expectRequestFlow('post', '/images/123/push?tag=', $this->createResponseJson($json), 'expectJson');
+        $stream = $this->getMock('React\Stream\ReadableStreamInterface');
+
+        $this->expectRequest('post', '/images/123/push?tag=', $this->createResponseJsonStream($json));
+        $this->streamingParser->expects($this->once())->method('parseJsonStream')->will($this->returnValue($stream));
+        $this->streamingParser->expects($this->once())->method('deferredStream')->with($this->equalTo($stream), $this->equalTo('progress'))->will($this->returnPromise($json));
 
         $this->expectPromiseResolveWith($json, $this->client->imagePush('123'));
     }
 
+    public function testImagePushStream()
+    {
+        $stream = $this->getMock('React\Stream\ReadableStreamInterface');
+
+        $this->expectRequest('post', '/images/123/push?tag=', $this->createResponseJsonStream(array()));
+        $this->streamingParser->expects($this->once())->method('parseJsonStream')->will($this->returnValue($stream));
+
+        $this->assertSame($stream, $this->client->imagePushStream('123'));
+    }
+
     public function testImagePushCustomRegistry()
     {
         // TODO: verify headers
         $auth = array();
         $json = array();
-        $this->expectRequestFlow('post', '/images/demo.acme.com:5000/123/push?tag=test', $this->createResponseJson($json), 'expectJson');
+        $stream = $this->getMock('React\Stream\ReadableStreamInterface');
+
+        $this->expectRequest('post', '/images/demo.acme.com:5000/123/push?tag=test', $this->createResponseJsonStream($json));
+        $this->streamingParser->expects($this->once())->method('parseJsonStream')->will($this->returnValue($stream));
+        $this->streamingParser->expects($this->once())->method('deferredStream')->with($this->equalTo($stream), $this->equalTo('progress'))->will($this->returnPromise($json));
 
         $this->expectPromiseResolveWith($json, $this->client->imagePush('123', 'test', 'demo.acme.com:5000', $auth));
     }