Merge pull request #1 from DockerPhpClient/test/tar-archive

add Image Manager

README.md

@@ -10,6 +10,11 @@
 - delete
 - wait
 - logs
+- list
+
+### Images
+- create
+- delete
 
 ## Examples
 See the examples folder for example code

composer.json

@@ -18,7 +18,8 @@
     "php-http/socket-client": "^2.0",
     "php-http/client-common": "^2.3",
     "guzzlehttp/psr7": "^1.7",
-    "docker-client/open-api": "6.1.40.*"
+    "docker-client/open-api": "6.1.40.*",
+    "splitbrain/php-archive": "*"
   },
   "prefer-stable": true,
   "minimum-stability": "dev"

examples/containers-create-and-delete.php

@@ -19,6 +19,11 @@
     // create a named container
     $client->containers()->create($container, ['name' => $containerName]);
 
+
+    // list all images
+    $containers = $client->containers()->list();
+    echo implode("", $client->containers()->toContainerListLog($containers));
+
     // start container
     $client->containers()->start($containerName);
 

examples/images-create-and-delete.php

@@ -1,13 +1,23 @@
 <?php
 
+use Docker\Client\Context\ContextFactory;
+use Docker\Client\Context\ImageContext;
+use Docker\Client\Context\ImageContextFactory;
 use Docker\Client\DockerClientFactory;
+use splitbrain\PHPArchive\Tar;
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
 $client = DockerClientFactory::create();
 
 // build image
-$client->images()->build(__DIR__ . '/app/', ['t' => 'new-test-image']);
+$factory = new ContextFactory(Tar::class);
+$context = $factory->createImageContext(__DIR__ . '/app/');
+$buildInfos = $client->images()->build($context, ['t' => 'new-test-image']);
+
+// print build log and receive id
+echo implode("", $client->images()->toBuildLog($buildInfos));
+echo "\nImage ID: " . $client->images()->toBuildId($buildInfos) . "\n";
 
 // delete image
 $client->images()->delete('new-test-image');

src/Client/Context/ContextFactory.php

@@ -0,0 +1,25 @@
+<?php /** @noinspection PhpMissingFieldTypeInspection */
+
+namespace Docker\Client\Context;
+
+class ContextFactory
+{
+    /**
+     * @var class-string<Archive> $archiveClass
+     */
+    private $archiveClass;
+
+    /**
+     * ImageContextFactory constructor.
+     * @param class-string<Archive> $archiveClass
+     */
+    public function __construct($archiveClass)
+    {
+        $this->archiveClass = $archiveClass;
+    }
+
+    public function createImageContext(string $contextDirectory): ImageContext
+    {
+        return new ImageContext($contextDirectory, new $this->archiveClass());
+    }
+}

src/Client/Context/ImageContext.php

@@ -3,43 +3,48 @@
 namespace Docker\Client\Context;
 
 use Docker\Client\Stream\TarStream;
+use FilesystemIterator;
+use GuzzleHttp\Psr7\Utils;
 use Psr\Http\Message\StreamInterface;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use splitbrain\PHPArchive\Archive;
+use splitbrain\PHPArchive\ArchiveCorruptedException;
+use splitbrain\PHPArchive\ArchiveIllegalCompressionException;
+use splitbrain\PHPArchive\ArchiveIOException;
+use splitbrain\PHPArchive\FileInfoException;
+use splitbrain\PHPArchive\Tar;
 
 class ImageContext
 {
-    private string $directory;
-    /**
-     * @var resource $process
-     */
-    private $process;
+    protected const FLAGS =
+        FilesystemIterator::KEY_AS_PATHNAME |
+        FilesystemIterator::CURRENT_AS_FILEINFO |
+        FilesystemIterator::SKIP_DOTS;
 
-    /**
-     * @var resource $stream
-     */
-    private $stream;
+    private string $contextDirectory;
+    private Archive $archive;
 
-    public function __construct(string $directory)
+    public function __construct($contextDirectory, Archive $archive)
     {
-        $this->directory = $directory;
+        $this->contextDirectory = $contextDirectory;
+        $this->archive = $archive;
     }
 
-    public function getStream(): StreamInterface
+    /**
+     * @return StreamInterface
+     * @throws ArchiveIOException
+     */
+    public function toStream(): StreamInterface
     {
-        $this->process = proc_open("/usr/bin/env tar c .", [["pipe", "r"], ["pipe", "w"], ["pipe", "w"]], $pipes, $this->directory);
-        $this->stream = $pipes[1];
+        $this->archive->create();
 
-        return new TarStream($this->stream);
-    }
-
-    public function __destruct()
-    {
-        if (is_resource($this->process)) {
-            proc_close($this->process);
+        foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($this->contextDirectory, static::FLAGS)) as $file) {
+            if ($file->isFile()) {
+                $this->archive->addFile($file->getPathname(), str_replace($this->contextDirectory, '', $file->getPathname()));
+            }
         }
 
-        if (is_resource($this->stream)) {
-            fclose($this->stream);
-        }
+        return Utils::streamFor($this->archive->getArchive());
     }
-
 }

src/Client/Endpoint/ImageBuild.php

@@ -0,0 +1,40 @@
+<?php
+
+
+namespace Docker\Client\Endpoint;
+
+use Docker\OpenAPI\Endpoint\ImageBuild as BaseEndpoint;
+use Docker\OpenAPI\Model\BuildInfo;
+
+class ImageBuild extends BaseEndpoint
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function transformResponseBody(string $body, int $status, \Symfony\Component\Serializer\SerializerInterface $serializer, ?string $contentType)
+    {
+        if (200 === $status) {
+            $data = $this->logToJson($body);
+            return $serializer->deserialize($data, BuildInfo::class . '[]', 'json');
+        }
+        return parent::transformResponseBody($body, $status, $serializer, $contentType);
+    }
+
+    /**
+     * @param string $body
+     * @return string
+     */
+    protected function logToJson(string $body): string
+    {
+        $data = explode("\n", $body);
+
+        // remove empty line(s)
+        $data = array_filter($data, static function ($line) {
+            return null !== $line && !empty($line);
+        });
+
+        // rebuild as json array
+        $data = "[" . implode(",", $data) . "]";
+        return $data;
+    }
+}

src/Client/Manager/ContainerManager.php

@@ -6,6 +6,7 @@
 
 use Docker\OpenAPI\Client;
 use Docker\OpenAPI\Model\ContainersCreatePostBody;
+use Docker\OpenAPI\Model\ContainerSummaryItem;
 use Psr\Http\Message\ResponseInterface;
 
 class ContainerManager
@@ -44,4 +45,25 @@ public function logs(string $idOrName): string
         $response = $this->apiClient->containerAttach($idOrName, ['logs' => true, 'stdout' => true, 'stderr' => true], Client::FETCH_RESPONSE);
         return ($response instanceof ResponseInterface) ? $response->getBody()->getContents() : "";
     }
+
+    /**
+     * @param array $queryParameters
+     * @return ContainerSummaryItem[]
+     */
+    public function list(array $queryParameters = []): array
+    {
+        return $this->apiClient->containerList($queryParameters, $this->fetchType);
+    }
+
+    /**
+     * TODO: WIP
+     * @param ContainerSummaryItem[] $containers
+     * @return string[]
+     */
+    public function toContainerListLog(array $containers): array
+    {
+        return array_map(static function (ContainerSummaryItem $container) {
+            return substr($container->getId(), 8) . " " . $container->getNames()[0] . " " . $container->getImage() . " (" . substr($container->getImageID(), 8) . ")\n";
+        }, $containers);
+    }
 }