Replace ContainerRequest.BindMounts and ContainerRequest.VolumeMounts with ContainerRequest.Mounts as dedicated type #386

prskr · 2021-11-24T20:13:37Z

What does this PR do?

introduce dedicated type for mounts
introduce generic and Docker specific types for different mount sources (bind, volume, tmpfs)
introduce convenience methods to support common mount scenarios
add validation to avoid duplicate mount targets

Why is it important?

The current map based data structure is somehow confusing. This change avoids confusion by introducing dedicated types for all components to get help by IDEs and the compiler.

How to migrate

Simple bind mount

req := ContainerRequest {
    		//...
    		BindMounts: map[string]string{
		    "/var/run/docker.sock": "/var/run/docker.sock",
    		}
    		//...
}

becomes:

req := ContainerRequest {
    		//...
    		Mounts: Mounts(BindMount("/var/run/docker.sock", "/var/run/docker.sock")),
    		//...
}

Multiple mounts including a volume mount

req := ContainerRequest {
    		//...
    		BindMounts: map[string]string {
		    // container path : host path
		    "/hello.sh", absPath
    		},
    		VolumeMounts: map[string]string {
		    // container path : volume name
		    "/data": volumeName
    		//...
}

becomes

req := ContainerRequest {
    		//...
    		Mounts: Mounts(BindMount(absPath, "/hello.sh"), VolumeMount(volumeName, "/data")),
    		//...
}

silh · 2021-12-08T17:31:57Z

mounts.go

+package testcontainers
+
+import (
+	"github.com/docker/docker/api/types/mount"


As I understood the already existing code the things related to particular container backend (in this case - docker) are kept in the docker.go so that the testcontainers implementation is decoupled from it (although there is right now only one container backend provider).

I see. To be honest after this comment I assumed it would be okay to rely on Docker API types but I refactored my draft to be Docker API independent, moved all the Docker related code to mounts_docker.go and split the mount sources into generic, container provider agnostic variants and added Docker specific ones in case one would like to be able to provide e.g. volume options.

I hope this matches better the current code structure?

prskr · 2021-12-13T13:13:35Z

@mdelapenya probably any feedback on this? 😊

mdelapenya

Hey @baez90, thanks for this great PR, I added a few comments, although I'm OK with the changes. Let'd discuss them before moving forward

Thanks in advance and sorry for the late response, I was on PTO past week

mdelapenya · 2021-12-13T16:21:45Z

mounts_docker.go

@@ -0,0 +1,116 @@
+package testcontainers


NIT: I'd rename this file to docker_mounts.go as it's used as ..DockerMounts... everywhere.

fair enough!

mdelapenya · 2021-12-13T16:23:02Z

mounts_docker.go

+
+// MapToDockerMounts maps the given []ContainerMount to the corresponding
+// []mount.Mount for further processing
+func MapToDockerMounts(containerMounts ContainerMounts) []mount.Mount {


Do we want to expose this method externally? Not against it, but I'm simply double-checking it's on purpose

I tend to expose rather more than less because personally I prefer a breaking API instead of an API I cannot easily extend or 'hack' but for the sake of stability I made it private.
I was actually already wondering about the same and I think if there is a use case it can still be done later on?

mdelapenya · 2021-12-13T16:29:22Z

mounts_docker.go

+		MountTypeBind:   mount.TypeBind,
+		MountTypeVolume: mount.TypeVolume,
+		MountTypeTmpfs:  mount.TypeTmpfs,
+		MountTypePipe:   mount.TypeNamedPipe,


I cannot see an implementation for MountTypePipe but there are for Bind, Volume and Tmpfs. Is this on purpose?

😄 yes and no, I don't have any Windows running around here and I could not think of good test for MountTypePipe without it but it is supported for Docker (although I don't expect it to be implemented e.g. in Podman) hence I thought if someone has the need for it, it can be done without having to change testcontainers-go because it's already supported in the mapping.

There's no such thing like mount.NamedPipeOptions in Docker so no need to support it with an optional interface. I can remove it, it's another 'keep it open'-thing I thought could be nice

prskr · 2021-12-13T20:53:13Z

Thanks @mdelapenya for your kind words and the feedback!
Don't you worry, I just wasn't sure if there's something missing or if i forgot something or the like 😅

I tried to 'resolve' everything you mentioned.
Anything else that pops into mind?

codecov · 2021-12-20T14:59:18Z

Codecov Report

Merging #386 (acb1983) into master (cdd4aba) will increase coverage by 0.89%.
The diff coverage is 77.77%.

@@            Coverage Diff             @@
##           master     #386      +/-   ##
==========================================
+ Coverage   63.27%   64.16%   +0.89%     
==========================================
  Files          16       18       +2     
  Lines        1070     1108      +38     
==========================================
+ Hits          677      711      +34     
- Misses        291      293       +2     
- Partials      102      104       +2

Impacted Files	Coverage Δ
docker.go	`64.60% <23.07%> (-1.09%)`	⬇️
reaper.go	`79.31% <50.00%> (-0.69%)`	⬇️
wait/host_port.go	`56.14% <50.00%> (ø)`
generic.go	`64.70% <66.66%> (ø)`
container.go	`88.37% <90.00%> (+3.07%)`	⬆️
docker_mounts.go	`92.59% <92.59%> (ø)`
compose.go	`75.18% <100.00%> (ø)`
mounts.go	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6b77020...acb1983. Read the comment docs.

- introduce specific types for different mount sources - support read-only mount - introduce convenience methods to support common mount scenarios - add validation to avoid duplicate mount targets

- introduce Docker specific mount sources and generic counterparts - move Docker specific code to mounts_docker.go

gianarb · 2021-12-20T16:53:33Z

Can we get a note about a migration for this breaking change? I would like to place it at the top of this PR and in the changelog! Let's get this bc break ready to get merged!

prskr · 2021-12-20T17:13:29Z

Sure thing! I tried to improve the title and added some examples how to migrate in the PR description.
Something like that or did you already have some specific ideas? 😊

gianarb · 2021-12-21T14:17:53Z

Thanks a lot for your help with this!

silh reviewed Dec 8, 2021

View reviewed changes

silh approved these changes Dec 9, 2021

View reviewed changes

mdelapenya approved these changes Dec 13, 2021

View reviewed changes

prskr force-pushed the 384-container-mounts branch from 1432c73 to 91dc436 Compare December 13, 2021 20:46

mdelapenya added breaking change Causing compatibility issues. feature New functionality or new behaviors on the existing one labels Dec 20, 2021

mdelapenya mentioned this pull request Dec 20, 2021

Read only bind and volume mounts #382

Closed

prskr added 3 commits December 20, 2021 17:07

Replace BindMounts and VolumeMounts with Mounts

287b9e3

- introduce specific types for different mount sources - support read-only mount - introduce convenience methods to support common mount scenarios - add validation to avoid duplicate mount targets

Add some doc comments

f95b5b2

Generify mount sources

57d25b2

- introduce Docker specific mount sources and generic counterparts - move Docker specific code to mounts_docker.go

prskr force-pushed the 384-container-mounts branch from 91dc436 to 57d25b2 Compare December 20, 2021 16:07

Fix container_test.go with matching error string

acb1983

prskr force-pushed the 384-container-mounts branch from c9b9cb2 to acb1983 Compare December 20, 2021 16:45

prskr changed the title ~~Replace BindMounts and VolumeMounts with Mounts~~ Replace ContainerRequest.BindMounts and ContainerRequest.VolumeMounts with ContainerRequest.Mounts as dedicated type Dec 20, 2021

gianarb merged commit 9c3076f into testcontainers:master Dec 21, 2021

mdelapenya mentioned this pull request May 19, 2022

Env map not getting passed to postgres 11.7 container #325

Closed

DmitriyLewen mentioned this pull request May 30, 2022

chore(deps): bump github.com/testcontainers/testcontainers-go from 0.12.0 to 0.13.0 aquasecurity/fanal#538

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace ContainerRequest.BindMounts and ContainerRequest.VolumeMounts with ContainerRequest.Mounts as dedicated type #386

Replace ContainerRequest.BindMounts and ContainerRequest.VolumeMounts with ContainerRequest.Mounts as dedicated type #386

prskr commented Nov 24, 2021 •

edited

silh Dec 8, 2021

prskr Dec 9, 2021

prskr commented Dec 13, 2021

mdelapenya left a comment

mdelapenya Dec 13, 2021

prskr Dec 13, 2021

mdelapenya Dec 13, 2021

prskr Dec 13, 2021

mdelapenya Dec 13, 2021

prskr Dec 13, 2021

prskr commented Dec 13, 2021

codecov bot commented Dec 20, 2021 •

edited

gianarb commented Dec 20, 2021

prskr commented Dec 20, 2021

gianarb commented Dec 21, 2021

Replace ContainerRequest.BindMounts and ContainerRequest.VolumeMounts with ContainerRequest.Mounts as dedicated type #386

Replace ContainerRequest.BindMounts and ContainerRequest.VolumeMounts with ContainerRequest.Mounts as dedicated type #386

Conversation

prskr commented Nov 24, 2021 • edited

What does this PR do?

Why is it important?

How to migrate

Simple bind mount

Multiple mounts including a volume mount

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prskr commented Dec 13, 2021

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

prskr commented Dec 13, 2021

codecov bot commented Dec 20, 2021 • edited

Codecov Report

gianarb commented Dec 20, 2021

prskr commented Dec 20, 2021

gianarb commented Dec 21, 2021

prskr commented Nov 24, 2021 •

edited

codecov bot commented Dec 20, 2021 •

edited