Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated containerCopy() and containerCopyStream() methods and remove deprecated HostConfig parameter from containerStart() #55

Merged
merged 2 commits into from
Sep 19, 2019
Merged

Remove deprecated containerCopy() and containerCopyStream() methods and remove deprecated HostConfig parameter from containerStart() #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
746b9cb
Remove deprecated HostConfig parameter from `containerStart()`
clue Sep 18, 2019
376715e
Remove deprecated `containerCopy()` and `containerCopyStream()` methods
clue Sep 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ The following API endpoints resolve with a string in the [TAR file format](https

```php
$client->containerExport($container);
$client->containerCopy($container, $config);
$client->containerArchive($container, $path);
```

Keep in mind that this means the whole string has to be kept in memory.
Expand All @@ -257,14 +257,14 @@ a [`Stream`](https://github.com/reactphp/stream) instance instead:

```php
$stream = $client->containerExportStream($image);
$stream = $client->containerCopyStream($image, $config);
$stream = $client->containerArchiveStream($container, $path);
```

Accessing individual files in the TAR file format string or stream is out of scope
for this library.
Several libraries are available, one that is known to work is [clue/reactphp-tar](https://github.com/clue/reactphp-tar).

See also the [copy example](examples/copy.php) and the [export example](examples/export.php).
See also the [archive example](examples/archive.php) and the [export example](examples/export.php).

#### JSON streaming

Expand Down
95 changes: 5 additions & 90 deletions src/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,20 +531,18 @@ public function containerResize($container, $w, $h)
* Start the container id
*
* @param string $container container ID
* @param array $config (optional) start config (see link)
* @return PromiseInterface Promise<null>
* @link https://docs.docker.com/engine/api/v1.40/#operation/ContainerStart
*/
public function containerStart($container, $config = array())
public function containerStart($container)
{
return $this->postJson(
return $this->browser->post(
$this->uri->expand(
'/containers/{container}/start',
array(
'container' => $container
)
),
$config
)
)->then(array($this->parser, 'expectEmpty'));
}

Expand Down Expand Up @@ -714,89 +712,6 @@ public function containerRemove($container, $v = false, $force = false)
)->then(array($this->parser, 'expectEmpty'));
}

/**
* [deprecated] Copy files or folders of container id
*
* This resolves with a string in the TAR file format containing all files
* specified in the given $path.
*
* Keep in mind that this means the whole string has to be kept in memory.
* For bigger containers it's usually a better idea to use a streaming approach,
* see containerCopyStream() for more details.
*
* Accessing individual files in the TAR file format string is out of scope
* for this library. Several libraries are available, one that is known to
* work is clue/reactphp-tar (see links).
*
* @param string $container container ID
* @param string $resource path to file or directory to copy
* @return PromiseInterface Promise<string> tar stream
* @link https://docs.docker.com/engine/api/v1.22/#copy-files-or-folders-from-a-container
* @link https://github.com/clue/reactphp-tar
* @deprecated 0.3.0 Deprecated in Docker Engine API v1.20 (Docker v1.8) and removed in Docker Engine API v1.24 (Docker v1.12), use `containerArchive()` instead
* @see self::containerArchive()
* @see self::containerCopyStream()
*/
public function containerCopy($container, $path)
{
return $this->postJson(
$this->uri->expand(
'/containers/{container}/copy',
array(
'container' => $container
)
),
array(
'Resource' => $path
)
)->then(array($this->parser, 'expectPlain'));
}

/**
* [Deprecated] Copy files or folders of container id
*
* This returns a stream in the TAR file format containing all files
* specified in the given $path.
*
* This works for (any number of) files of arbitrary sizes as only small chunks have to
* be kept in memory.
*
* Accessing individual files in the TAR file format stream is out of scope
* for this library. Several libraries are available, one that is known to
* work is clue/reactphp-tar (see links).
*
* The resulting stream is a well-behaving readable stream that will emit
* the normal stream events.
*
* @param string $container container ID
* @param string $path path to file or directory to copy
* @return ReadableStreamInterface tar stream
* @link https://docs.docker.com/engine/api/v1.22/#copy-files-or-folders-from-a-container
* @link https://github.com/clue/reactphp-tar
* @deprecated 0.3.0 Deprecated in Docker Engine API v1.20 (Docker v1.8) and removed in Docker Engine API v1.24 (Docker v1.12), use `containerArchiveStream()` instead
* @see self::containerArchiveStream()
* @see self::containerCopy()
*/
public function containerCopyStream($container, $path)
{
return $this->streamingParser->parsePlainStream(
$this->browser->withOptions(array('streaming' => true))->post(
$this->uri->expand(
'/containers/{container}/copy',
array(
'container' => $container
)
),
array(
'Content-Type' => 'application/json'
),
$this->json(array(
'Resource' => $path
))
)
);
}

/**
* Get a tar archive of a resource in the filesystem of container id.
*
Expand All @@ -816,7 +731,7 @@ public function containerCopyStream($container, $path)
* @return PromiseInterface Promise<string> tar stream
* @link https://docs.docker.com/engine/api/v1.40/#operation/ContainerArchive
* @link https://github.com/clue/reactphp-tar
* @since 0.3.0 Available as of Docker Engine API v1.20 (Docker v1.8), use deprecated `containerCopy()` on legacy versions
* @since 0.3.0 Available as of Docker Engine API v1.20 (Docker v1.8)
* @see self::containerArchiveStream()
*/
public function containerArchive($container, $path)
Expand Down Expand Up @@ -853,7 +768,7 @@ public function containerArchive($container, $path)
* @return ReadableStreamInterface tar stream
* @link https://docs.docker.com/engine/api/v1.40/#operation/ContainerArchive
* @link https://github.com/clue/reactphp-tar
* @since 0.3.0 Available as of Docker Engine API v1.20 (Docker v1.8), use deprecated `containerCopyStream()` on legacy versions
* @since 0.3.0 Available as of Docker Engine API v1.20 (Docker v1.8)
* @see self::containerArchive()
*/
public function containerArchiveStream($container, $path)
Expand Down
18 changes: 0 additions & 18 deletions tests/ClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,24 +417,6 @@ public function testContainerResize()
$this->expectPromiseResolveWith('', $this->client->containerResize(123, 800, 600));
}

public function testContainerCopy()
{
$data = 'tar stream';
$this->expectRequestFlow('post', '/containers/123/copy', $this->createResponse($data), 'expectPlain');

$this->expectPromiseResolveWith($data, $this->client->containerCopy('123', 'file.txt'));
}

public function testContainerCopyStream()
{
$stream = $this->getMockBuilder('React\Stream\ReadableStreamInterface')->getMock();

$this->expectRequest('post', '/containers/123/copy', $this->createResponse(''));
$this->streamingParser->expects($this->once())->method('parsePlainStream')->will($this->returnValue($stream));

$this->assertSame($stream, $this->client->containerCopyStream('123', 'file.txt'));
}

public function testContainerArchive()
{
$data = 'tar stream';
Expand Down