ContainerManager::copy(): Copy files or folders from a container to a tar stream by Boran · Pull Request #89 · docker-php/docker-php

Boran · 2015-01-28T12:36:09Z

Api for http://docs.docker.com/reference/api/docker_remote_api_v1.16/#copy-files-or-folders-from-a-container

Example usage

$lookfor = 'vanilla2';
$container = $manager->find($lookfor);
$resource = '/etc/default';      # copy this whole folder
$exportStream = $manager->copy($container, $resource);
$tarFileName  = "/tmp/resource.tar";
$tarFile      = fopen($tarFileName, 'w+');
stream_copy_to_stream($exportStream->detach(), $tarFile);
fclose($tarFile);
echo "$tarFileName written\n";

hacfi · 2015-01-28T20:00:13Z

Sweet feature..will try this soon!

ubermuda · 2015-01-29T02:56:21Z

You can skip the double quotes around $resource here

ubermuda · 2015-01-29T03:01:07Z

Sweet indeed! I have a couple questions/remarks before merging though:

What's in the return stream exactly?
Please write some tests for this method
Can you add a small documentation for this too? Preferably something that's easy to integrate with Docs: Improve installation, add image pull, small changes #87

ubermuda · 2015-01-29T03:02:12Z

Missing variable type here, I assume it would be string? Maybe you could rename the argument too, because $resource is misleading if it can't be an actual resource. What about $source?

hacfi · 2015-01-29T03:25:56Z

@ubermuda about 1.: It’s a Guzzle\Stream\Stream instance of a tcp_socket/ssl stream containing the tar file contents.

hacfi · 2015-01-29T03:27:15Z

@return \Guzzle\Stream\Stream Tarfile stream would be more accurate and allows for autocompletion.

ubermuda · 2015-01-29T03:30:05Z

Ok I misread the title, I was thinking it was meant to copy files to the container, not from. It's all clear now thanks :)

hacfi · 2015-01-29T03:33:25Z

@Boran I think it makes sense to add an additional helper method containing the example code..something like

    public function copyToDisk(Container $container, $source, $destination)
    {
        $stream = $this->copy($container, $source);

        $output = fopen($destination, 'w+');
        stream_copy_to_stream($stream->detach(), $output);
        fclose($output);

        return $this;
    }

ubermuda · 2015-01-29T03:35:38Z

@Boran I think it makes sense to add an additional helper method containing the example code..something like

+1

Boran · 2015-01-29T05:41:59Z

Made the comments and code changes.
One can now do
$manager->copyToDisk($container, '/etc/default', '/tmp/resource.tar')

Docs: my master /stage1/docker-php/doc does not have all the stuff from #87, I must check.
Tests: yes ....

ubermuda · 2015-01-29T11:17:07Z

Great thanks! #87 has been merged btw :)

Boran · 2015-01-30T07:12:10Z

Is there doc explaining how to run tests?

ubermuda · 2015-01-30T09:26:25Z

Running bin/phpunit should be enough? Do you have a specific problem?

Boran · 2015-01-30T11:12:01Z

Well I'm not used to phpunit. I installed it and then tried:

cd /var/www/html/sites/all/libraries/composer/stage1/docker-php
phpunit src/Docker/Tests/ContainerTest.php
PHPUnit 3.7.28 by Sebastian Bergmann.
Cannot open file "/var/www/html/sites/all/libraries/composer/stage1/docker-php/vendor/autoload.php".

Then tried in the directory where the autoload.php is...
cd /var/www/html/sites/all/libraries/composer

phpunit stage1/docker-php/src/Docker/Tests/ContainerTest.php
PHP Fatal error: Class 'Docker\Container' not found in /var/www/html/sites/all/libraries/composer/stage1/docker-php/src/Docker/Tests/ContainerTest.php on line 12
PHP Stack trace:
PHP 1. {main}() /usr/bin/phpunit:0
PHP 2. PHPUnit_TextUI_Command::main() /usr/bin/phpunit:46
PHP 3. PHPUnit_TextUI_Command->run() /usr/share/php/PHPUnit/TextUI/Command.php:129
PHP 4. PHPUnit_TextUI_TestRunner->doRun() /usr/share/php/PHPUnit/TextUI/Command.php:176
PHP 5. PHPUnit_Framework_TestSuite->run() /usr/share/php/PHPUnit/TextUI/TestRunner.php:349
PHP 6. PHPUnit_Framework_TestSuite->runTest() /usr/share/php/PHPUnit/Framework/TestSuite.php:745
PHP 7. PHPUnit_Framework_TestCase->run() /usr/share/php/PHPUnit/Framework/TestSuite.php:775
PHP 8. PHPUnit_Framework_TestResult->run() /usr/share/php/PHPUnit/Framework/TestCase.php:783
PHP 9. PHPUnit_Framework_TestCase->runBare() /usr/share/php/PHPUnit/Framework/TestResult.php:648
PHP 10. PHPUnit_Framework_TestCase->runTest() /usr/share/php/PHPUnit/Framework/TestCase.php:838
PHP 11. ReflectionMethod->invokeArgs() /usr/share/php/PHPUnit/Framework/TestCase.php:983
PHP 12. Docker\Tests\ContainerTest->testAddEnvWithNoExistingEnv() /usr/share/php/PHPUnit/Framework/TestCase.php:983

Any tips?

hacfi · 2015-01-31T01:44:14Z

@Boran Go to your docker-php dir (cd /var/www/html/sites/all/libraries/composer/stage1/docker-php) and run composer install. This should solve the issue. (Explanation: the tests are run on the repository outside of the context that docker-php is part of a project which already installed the required libs.)

hacfi · 2015-01-31T02:11:04Z

Tested it one more time..works like a charm! Thanks @Boran ...that’s a very important feature!

Boran · 2015-01-31T20:59:24Z

So test written and working:

Starting test 'Docker\Tests\Manager\ContainerManagerTest::testcopyToDisk'.
.

A quick note on how to run tests:
@hacfi your method works, but also found the "--bootstrap" which is more elegant (composer won't install a second set of files). i.e.:

cd /var/www/html/sites/all/libraries/composer/stage1/docker-php
phpunit --debug --bootstrap /var/www/html/sites/all/libraries/composer/autoload.php src/Docker/Tests/Manager/ContainerManagerTest

Also: didn't find a way of running just one test function, e.g. testcopyToDisk(), which makes developing the test a bit more time consuming, is there a way? (Tried --filter 'Docker\Tests\Manager\ContainerManagerTest::testCreate', but that is ignored)

hacfi · 2015-02-01T00:34:04Z

@Boran Had the same problem last week :)

Try:
phpunit --filter testCreate ContainerManagerTest src/Docker/Tests/Manager/ContainerManagerTest.php

Boran · 2015-02-01T17:15:37Z

Thanks, '--filter' works nicely:

phpunit --debug --bootstrap /var/www/html/sites/all/libraries/composer/autoload.php --filter testCopyToDisk ContainerManagerTest src/Docker/Tests/Manager/ContainerManagerTest.php
......
Starting test 'Docker\Tests\Manager\ContainerManagerTest::testCopyToDisk'.
Time: 1.26 seconds, Memory: 4.50Mb
OK (1 test, 1 assertion)

ubermuda · 2015-02-05T14:13:13Z

Function, file and directory names should be enclosed with backticks (`)

Add an s to the first File (first word in paragraph)

Boran · 2015-02-05T14:28:47Z

I think I got all your suggestions in?

joelwurtz · 2015-02-20T15:01:23Z

joelwurtz · 2015-02-20T15:02:30Z

@Boran Looks good, can you rebase the PR into a single commit before merging ? Thanks !

Boran · 2015-03-03T10:17:25Z

After trying to rebase and solve merge conflicts with master, am giving up on this branch. Created a new file-copy2 branch and PR #109.

copy(): Copy files or folders from a container to a tar stream

2d4bdf8

ubermuda reviewed Jan 29, 2015
View reviewed changes

hacfi reviewed Jan 29, 2015
View reviewed changes

copyToDisk(), rename $resource>$source, header comments

0f694e7

Sean Boran added 4 commits January 31, 2015 06:45

Merge branch 'master' into file-copy

42e217e

copyToDisk() doc

e741281

revert spacing changes

2678581

testcopyToDisk()

fa595fa

rename testcopyToDisk to testCopyToDisk

46b1049

ubermuda reviewed Feb 5, 2015
View reviewed changes

Sean Boran added 2 commits February 5, 2015 14:21

$resource -> $source

61728fa

reformulate copyToDisk() doc

5a36534

joelwurtz reviewed Feb 20, 2015
View reviewed changes

Comment thread src/Docker/Manager/ContainerManager.php

joelwurtz Feb 20, 2015

Copy link
Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo :)

joelwurtz mentioned this pull request Feb 23, 2015

Updated docker-php (the last 0.3 is buggy) jolicode/JoliCi#45

Closed

Boran mentioned this pull request Mar 3, 2015

copy(): Copy files or folders from a container to a tar stream. copyToDi... #109

Closed

Boran closed this Mar 3, 2015

Uh oh!

Conversation

Boran commented Jan 28, 2015

Uh oh!

hacfi commented Jan 28, 2015

Uh oh!

ubermuda Jan 29, 2015

Choose a reason for hiding this comment

Uh oh!

ubermuda commented Jan 29, 2015

Uh oh!

ubermuda Jan 29, 2015

Choose a reason for hiding this comment

Uh oh!

hacfi commented Jan 29, 2015

Uh oh!

hacfi Jan 29, 2015

Choose a reason for hiding this comment

Uh oh!

ubermuda commented Jan 29, 2015

Uh oh!

hacfi commented Jan 29, 2015

Uh oh!

ubermuda commented Jan 29, 2015

Uh oh!

Boran commented Jan 29, 2015

Uh oh!

ubermuda commented Jan 29, 2015

Uh oh!

Boran commented Jan 30, 2015

Uh oh!

ubermuda commented Jan 30, 2015

Uh oh!

Boran commented Jan 30, 2015

Uh oh!

hacfi commented Jan 31, 2015

Uh oh!

hacfi commented Jan 31, 2015

Uh oh!

Boran commented Jan 31, 2015

Uh oh!

hacfi commented Feb 1, 2015

Uh oh!

Boran commented Feb 1, 2015

Uh oh!

ubermuda Feb 5, 2015

Choose a reason for hiding this comment

Uh oh!

Boran commented Feb 5, 2015

Uh oh!

joelwurtz Feb 20, 2015

Choose a reason for hiding this comment

Uh oh!

joelwurtz commented Feb 20, 2015

Uh oh!

Boran commented Mar 3, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants