search

testcontainers / testcontainers-go

Testcontainers for Go is a Go package that makes it simple to create and clean up container-based dependencies for automated integration/smoke tests. The clean, easy-to-use API enables developers to programmatically define containers that should be run as part of a test and clean up those resources when the test is done.
https://golang.testcontainers.org
MIT License
3.57k stars 492 forks source link

[Documentation]: document volumes and mounts #2163

Open mdelapenya opened 8 months ago

mdelapenya commented 8 months ago

Proposal

They are not properly documented in our docs

srabraham commented 8 months ago

This seemed like a good place to remark on my experience in the last couple of days with mounts, as a testcontainers-go user.

My bind mounts quietly stopped working when I upgraded from 0.26.0 to 0.27.0, for some reason I couldn't figure out (the deprecation of bind mounts in testcontainers wasn't supposed to break them). So, I switched over to volumes instead. That created a lot more pain, since our CI system got overrun with volumes. As it turned out, named volumes don't get cleaned up by ryuk, so they stuck around indefinitely. The testcontainers-go API makes it really tempting to set a non-empty name for volumes, but the consequences of that are quite bad.

Anyway, yeah, more documentation on this stuff would be great :).

Also, there was some quite misleading logging in place as of when bind mounts were deprecated, and I made a PR to improve that. https://github.com/testcontainers/testcontainers-go/pull/2178/files

mdelapenya commented 8 months ago

@srabraham thanks for raising your voice on this issue. I do appreciate your feedback.

My bind mounts quietly stopped working when I upgraded from 0.26.0 to 0.27.0, for some reason I couldn't figure out (the deprecation of bind mounts in testcontainers wasn't supposed to break them)

I'm interested in this. Could you share a repo where it happened? As you pointed out, they should not break any client code as per the deprecation, although I could have committed a mistake during the deprecation path.

named volumes don't get cleaned up by ryuk

Did you manually created the volumes? If not I'd expect testcontainers-go to label the volumes accordingly, so that Ryuk prunes them. Could you run Ryuk in verbose mode, so you're be able to check what volumes are pruned?: https://github.com/testcontainers/moby-ryuk/blob/430d3338e3af80816a0a7445a90b4a1e58b1c710/main.go#L330-L337.

In order to do so: https://golang.testcontainers.org/features/configuration/#customizing-ryuk-the-resource-reaper. Since v0.27.0 it's possible to run Ryuk in verbose mode.

The testcontainers-go API makes it really tempting to set a non-empty name

Mmmm could you share how did you create the volumes? I think this answers my previous question so you probably used the API. I'm interested in how so I can double check and identify where the experience is broken.

srabraham commented 8 months ago

Regarding bind mount breakage at 0.27.0, I made a separate bug report here with a very simple reproduction: https://github.com/testcontainers/testcontainers-go/issues/2179

srabraham commented 8 months ago

and here's a demo of named volumes not getting deleted by ryuk: https://github.com/srabraham/demovolume/blob/main/main.go

srabraham commented 8 months ago

@mdelapenya in case you missed it, please have a look at my additional demo above (https://github.com/testcontainers/testcontainers-go/issues/2163#issuecomment-1919561727), which shows how named volumes don't get cleaned up by Ryuk.

mdelapenya commented 8 months ago

@mdelapenya in case you missed it, please have a look at my additional demo above (#2163 (comment)), which shows how named volumes don't get cleaned up by Ryuk.

I think we should open a bug in https://github.com/testcontainers/moby-ryuk

mdelapenya commented 8 months ago

@srabraham here it's the fix https://github.com/testcontainers/testcontainers-go/pull/2191

srabraham commented 8 months ago

Awesome, thanks!