Added support for copy file to container #226

franklinlindemberg · 2020-07-02T18:40:30Z

Missing tests and update in documentation.

Just a draft to validate if it looks good so far

joe-getcouragenow · 2020-07-10T08:35:53Z

container.go

@@ -49,6 +49,8 @@ type Container interface {
 	NetworkAliases(context.Context) (map[string][]string, error) // get container network aliases for a network
 	Exec(ctx context.Context, cmd []string) (int, error)
 	ContainerIP(context.Context) (string, error) // get container ip
+	CopyToContainer(ctx context.Context, containerPath string, content io.Reader) error


Shouldn't it be called "CopyFromContainer" ?

@joe-getcouragenow My use case is a little different than yours. I need to copy a single file to the container. CopyToContainer copies a compacted file to the container (using io.Reader), I then implemented CopyFileToContainer as well to wrap and allow to copy only one file to the container, using CopyToContainer.

Does that make more sense to you?

Yep it does :)

Thanks.

I will try to do the copy from Container --> Host

franklinlindemberg · 2020-07-10T14:17:15Z

@gianarb Do you know why the build is failing? I checked in Travis and it says The command "scripts/checks.sh" exited with 1.

But when I run this script locally it works

franklinlindemberg · 2020-07-10T14:30:06Z

@gianarb Do you know why the build is failing? I checked in Travis and it says The command "scripts/checks.sh" exited with 1.

But when I run this script locally it works

Found the problem

franklinlindemberg · 2020-07-10T15:50:45Z

docker_test.go

@@ -1267,3 +1268,31 @@ func TestContainerNonExistentImage(t *testing.T) {
 	})

 }
+
+func TestDockerContainerCopyFileToContainer(t *testing.T) {


I added a single test using CopyFileToContainer since it uses already CopyToContainer underneath

franklinlindemberg · 2020-07-10T15:51:51Z

docker.go

@@ -306,6 +307,31 @@ func (c *DockerContainer) Exec(ctx context.Context, cmd []string) (int, error) {
 	return exitCode, nil
 }

+func (c *DockerContainer) CopyToContainer(ctx context.Context, containerPath string, content io.Reader) error {
+	return c.provider.client.CopyToContainer(ctx, c.ID, containerPath, content, types.CopyToContainerOptions{})


since I didn't need any special configuration, Im using the default types.CopyToContainerOptions, let me know if you think its better to already expose this

Hi 👋 ! Is there a special need to expose this method, instead of directly calling the client provider method from the CopyFileToContainer? I feel a bit confused for having two methods in the API.

What do you think about this signature?

func (c *DockerContainer) CopyFileToContainer(ctx context.Context, hostPath string, containerPath string, fileMode int64) error

With this method, the client code must simply provide the source (localPath) and the target (containerPath), and the internals of the method will obtain all the information from those two params: will read the bytes and generate the Reader needed by the provider client. I think the API would be cleaner, but I'd like to hear your voice here.

BTW, I already implemented something like this in the past here: https://github.com/mdelapenya/lpn/blob/master/docker/docker.go#L141-L195

@mdelapenya tks for your comment! The only reason I exposed this method is because it will allow clients to copy multiple files at once, since it exposes the io.Reader to an archive file. Im not really interested in this method to be honest, I'm using the one below that copies a single file.

What do you think? Should I set this first one to internal?

Let's delegate to @gianarb for a decision. From my point of view, I'd go with the simplest use case, which is copying a file. We could build on top of this to copy multiples files later on, if/when needed. Sounds good?

Sounds good to me! I removed the copyToContainer method. Leg me know what you guys think

franklinlindemberg · 2020-07-10T15:52:52Z

@gianarb Added tests and a documentation example, let me know if it sounds good to you

mdelapenya

I added a few suggestions. Please share your thoughts with us :)

mdelapenya · 2020-08-14T11:46:39Z

docker.go

@@ -306,6 +307,31 @@ func (c *DockerContainer) Exec(ctx context.Context, cmd []string) (int, error) {
 	return exitCode, nil
 }

+func (c *DockerContainer) CopyToContainer(ctx context.Context, containerPath string, content io.Reader) error {
+	return c.provider.client.CopyToContainer(ctx, c.ID, containerPath, content, types.CopyToContainerOptions{})


Hi 👋 ! Is there a special need to expose this method, instead of directly calling the client provider method from the CopyFileToContainer? I feel a bit confused for having two methods in the API.

What do you think about this signature?

func (c *DockerContainer) CopyFileToContainer(ctx context.Context, hostPath string, containerPath string, fileMode int64) error

With this method, the client code must simply provide the source (localPath) and the target (containerPath), and the internals of the method will obtain all the information from those two params: will read the bytes and generate the Reader needed by the provider client. I think the API would be cleaner, but I'd like to hear your voice here.

BTW, I already implemented something like this in the past here: https://github.com/mdelapenya/lpn/blob/master/docker/docker.go#L141-L195

mdelapenya · 2020-08-14T11:48:34Z

docker_test.go

+	fileContent, err := ioutil.ReadFile("./testresources/hello.sh")
+	if err != nil {
+		t.Fatal(err)
+	}


With above explanation, this would be a matter of the internals of the copy method, simplifying client code's life

mdelapenya · 2020-08-18T15:13:15Z

container.go

@@ -49,6 +49,7 @@ type Container interface {
 	NetworkAliases(context.Context) (map[string][]string, error) // get container network aliases for a network
 	Exec(ctx context.Context, cmd []string) (int, error)
 	ContainerIP(context.Context) (string, error) // get container ip
+	CopyFileToContainer(ctx context.Context, containerPath string, fileName string, fileContent []byte, fileMode int64) error


What do you think about not exposing the fileContent in method header, and obtain it internally? That would simplify clients code.

that sounds great, do you think a single parameter like filePath, meaning the filePath on the client side, and from it we can extract the filename to save in the container?

or maybe have a containerFilePath (instead of containerPath) and from it extract the name to save in the container?

What do you think?

I like the first one more: containerFilePath and hostFilePath. I'd get the file name from the host file, using it in the container too. Wdyt?

Besides that, what are the Java folks doing? (I'm currently on the phone)

In java the method receives a Transferable (I imagine that this is the content in bytes) and the filepath that we want in the container (path + filename). https://github.com/testcontainers/testcontainers-java/blob/6bdbc8ffe257fc879791eb7fddcf3b5ecccdd52d/core/src/main/java/org/testcontainers/containers/ContainerState.java#L262

Regarding the suggested solution, I think it would be better to use the filename from the container one, this way users will be able to copy the file to the container and at the same time rename it, its more flexible. What do you think?

I updated the interface, let me know if it sounds good to you

mdelapenya

Shaun approves 😎

gianarb · 2020-08-21T07:14:39Z

Thanks @franklinlindemberg for this new cool feature!
And thanks @mdelapenya for your review!
Let's ship it!

franklinlindemberg · 2020-09-05T15:42:15Z

@gianarb @mdelapenya my pleasure guys! Do you have an idea will a new release will be created? Currently Im importing my merge commit version (btw the latest commit in master gives me an error about logrus import), but it would be nice to import a specific release

Added support for copy file to container

08c0b48

franklinlindemberg mentioned this pull request Jul 2, 2020

Feature: Copy files into created container #225

Closed

joe-getcouragenow reviewed Jul 10, 2020

View reviewed changes

Fix fmt

d5ae599

franklinlindemberg added 2 commits July 10, 2020 11:04

Updated copy to container signature and added test

1ca2158

Added documentation

88c7fb9

franklinlindemberg commented Jul 10, 2020

View reviewed changes

franklinlindemberg marked this pull request as ready for review July 10, 2020 15:52

Fix fmt

09b0430

mdelapenya reviewed Aug 14, 2020

View reviewed changes

Remove copyToContainer method

635892e

mdelapenya reviewed Aug 18, 2020

View reviewed changes

franklinlindemberg added 3 commits August 20, 2020 20:43

Simplied copyToContainer interface

e46cbf4

Update documentation

51c8e42

Fix checks

e3a7202

mdelapenya approved these changes Aug 21, 2020

View reviewed changes

gianarb merged commit 8d2b4d5 into testcontainers:master Aug 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for copy file to container #226

Added support for copy file to container #226

franklinlindemberg commented Jul 2, 2020 •

edited

Loading

joe-getcouragenow Jul 10, 2020 •

edited

Loading

franklinlindemberg Jul 10, 2020

joe-getcouragenow Jul 10, 2020 •

edited

Loading

franklinlindemberg commented Jul 10, 2020

franklinlindemberg commented Jul 10, 2020

franklinlindemberg Jul 10, 2020

franklinlindemberg Jul 10, 2020

mdelapenya Aug 14, 2020

franklinlindemberg Aug 14, 2020

mdelapenya Aug 14, 2020

franklinlindemberg Aug 16, 2020

franklinlindemberg commented Jul 10, 2020

mdelapenya left a comment

mdelapenya Aug 14, 2020

mdelapenya Aug 14, 2020

mdelapenya Aug 18, 2020

franklinlindemberg Aug 19, 2020

mdelapenya Aug 19, 2020

franklinlindemberg Aug 21, 2020

franklinlindemberg Aug 21, 2020

mdelapenya left a comment

gianarb commented Aug 21, 2020 •

edited

Loading

franklinlindemberg commented Sep 5, 2020

Added support for copy file to container #226

Added support for copy file to container #226

Conversation

franklinlindemberg commented Jul 2, 2020 • edited Loading

joe-getcouragenow Jul 10, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joe-getcouragenow Jul 10, 2020 • edited Loading

Choose a reason for hiding this comment

franklinlindemberg commented Jul 10, 2020

franklinlindemberg commented Jul 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franklinlindemberg commented Jul 10, 2020

mdelapenya left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mdelapenya left a comment

Choose a reason for hiding this comment

gianarb commented Aug 21, 2020 • edited Loading

franklinlindemberg commented Sep 5, 2020

franklinlindemberg commented Jul 2, 2020 •

edited

Loading

joe-getcouragenow Jul 10, 2020 •

edited

Loading

joe-getcouragenow Jul 10, 2020 •

edited

Loading

gianarb commented Aug 21, 2020 •

edited

Loading