Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
A significant rewrite to ensure that we don't suffer from shutdown race conditions as the prune condition is met and additional resources are being created. Previously this would remove resources that were still in use, now we retry if we detect new resources have been created within a window of the prune condition triggering. This supports the following new environment configuration settings: - RYUK_REMOVE_RETRIES - The number of times to retry removing a resource. - RYUK_REQUEST_TIMEOUT - The timeout for any Docker requests. - RYUK_RETRY_OFFSET - The offset added to the start time of the prune pass that is used as the minimum resource creation time
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,3 +5,9 @@ | |
|
|
||
| vendor/ | ||
| bin/ | ||
|
|
||
| # Binary | ||
| moby-ryuk | ||
|
|
||
| # VS Code | ||
| .vscode | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| run: | ||
| timeout: 2m | ||
|
|
||
| linters-settings: | ||
| gosec: | ||
| excludes: | ||
| - G601 ## Implicit memory aliasing of items from a range statement - not possible in go 1.22. | ||
| cyclop: | ||
| max-complexity: 15 | ||
| nestif: | ||
| min-complexity: 10 | ||
| govet: | ||
| settings: | ||
| shadow: | ||
| strict: true | ||
| enable-all: true | ||
| nolintlint: | ||
| require-explanation: true | ||
| godot: | ||
| scope: all | ||
|
|
||
| linters: | ||
| enable-all: true | ||
| disable: | ||
| # Spammy / low value | ||
| - varnamelen | ||
| - exhaustruct | ||
| - nlreturn | ||
| - wsl | ||
| - lll | ||
| - paralleltest | ||
| # Duplicate functionality. | ||
| - funlen | ||
| - gocognit | ||
| # Deprecated. | ||
| - execinquery | ||
| - gomnd | ||
| # Good but gets in the way too often. | ||
| - testpackage | ||
| # Unknown details about how Artemis works are flagged with TODO's. | ||
| - godox | ||
| # Seems to be broken. | ||
| - depguard | ||
| # Makes it messy for multiple optional tags. | ||
| - tagalign | ||
| # Not needed for go 1.22+. | ||
| - exportloopref | ||
| - errchkjson # Duplicate functionality for errcheck. | ||
|
|
||
| issues: | ||
| include: | ||
| - EXC0012 | ||
| - EXC0014 | ||
| exclude-rules: | ||
| # Exclude linters which aren't an issue in tests. | ||
| - path: _test\.go | ||
| linters: | ||
| - gochecknoglobals | ||
| - wrapcheck | ||
|
|
||
| # File mode permissions are fine for constants. | ||
| - text: "Magic number: 0o\\d+" | ||
| linters: | ||
| - mnd | ||
|
|
||
| # Field alignment in tests isn't a performance issue. | ||
| - text: fieldalignment | ||
| path: _test\.go | ||
|
|
||
| # Dynamic errors can provide useful context. | ||
| - text: "do not define dynamic errors, use wrapped static errors instead:" | ||
| linters: | ||
| - err113 | ||
|
|
||
| # We need to use the `err` named return for error handling. | ||
| - text: 'named return "err" with type "error" found' | ||
| linters: | ||
| - nonamedreturns | ||
|
|
||
| # Interface casting is fine in mock. | ||
| - path: mock_test\.go | ||
| linters: | ||
| - forcetypeassert |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/caarlos0/env/v11" | ||
| ) | ||
|
|
||
| // config represents the configuration for the reaper. | ||
| type config struct { | ||
| // ConnectionTimeout is the duration without receiving any connections which will trigger a shutdown. | ||
| ConnectionTimeout time.Duration `env:"RYUK_CONNECTION_TIMEOUT" envDefault:"60s"` | ||
|
|
||
| // ReconnectionTimeout is the duration after the last connection closes which will trigger | ||
| // resource clean up and shutdown. | ||
| ReconnectionTimeout time.Duration `env:"RYUK_RECONNECTION_TIMEOUT" envDefault:"10s"` | ||
|
|
||
| // RequestTimeout is the timeout for any Docker requests. | ||
| RequestTimeout time.Duration `env:"RYUK_REQUEST_TIMEOUT" envDefault:"10s"` | ||
|
|
||
| // RemoveRetries is the number of times to retry removing a resource. | ||
| RemoveRetries int `env:"RYUK_REMOVE_RETRIES" envDefault:"10"` | ||
|
|
||
| // RetryOffset is the offset added to the start time of the prune pass that is | ||
| // used as the minimum resource creation time. Any resource created after this | ||
| // calculated time will trigger a retry to ensure in use resources are not removed. | ||
| RetryOffset time.Duration `env:"RYUK_RETRY_OFFSET" envDefault:"-1s"` | ||
|
|
||
| // Port is the port to listen on for connections. | ||
| Port uint16 `env:"RYUK_PORT" envDefault:"8080"` | ||
|
|
||
| // Verbose is whether to enable verbose aka debug logging. | ||
| Verbose bool `env:"RYUK_VERBOSE" envDefault:"false"` | ||
| } | ||
|
|
||
| // loadConfig loads the configuration from the environment | ||
| // applying defaults where necessary. | ||
| func loadConfig() (*config, error) { | ||
| var cfg config | ||
| if err := env.Parse(&cfg); err != nil { | ||
| return nil, fmt.Errorf("parse env: %w", err) | ||
| } | ||
|
|
||
| return &cfg, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func Test_loadConfig(t *testing.T) { | ||
| tests := map[string]struct { | ||
| setEnv func() | ||
| expected config | ||
| }{ | ||
| "defaults": { | ||
| expected: config{ | ||
| Port: 8080, | ||
| ConnectionTimeout: time.Minute, | ||
| ReconnectionTimeout: time.Second * 10, | ||
| RequestTimeout: time.Second * 10, | ||
| RemoveRetries: 10, | ||
| RetryOffset: -time.Second, | ||
| }, | ||
| }, | ||
| "custom": { | ||
| setEnv: func() { | ||
| t.Setenv("RYUK_PORT", "1234") | ||
| t.Setenv("RYUK_CONNECTION_TIMEOUT", "2s") | ||
| t.Setenv("RYUK_RECONNECTION_TIMEOUT", "3s") | ||
| t.Setenv("RYUK_REQUEST_TIMEOUT", "4s") | ||
| t.Setenv("RYUK_REMOVE_RETRIES", "5") | ||
| t.Setenv("RYUK_RETRY_OFFSET", "-6s") | ||
| }, | ||
| expected: config{ | ||
| Port: 1234, | ||
| ConnectionTimeout: time.Second * 2, | ||
| ReconnectionTimeout: time.Second * 3, | ||
| RequestTimeout: time.Second * 4, | ||
| RemoveRetries: 5, | ||
| RetryOffset: -time.Second * 6, | ||
| }, | ||
| }, | ||
| } | ||
| for name, tc := range tests { | ||
| t.Run(name, func(t *testing.T) { | ||
| if tc.setEnv != nil { | ||
| tc.setEnv() | ||
| } | ||
|
|
||
| cfg, err := loadConfig() | ||
| require.NoError(t, err) | ||
| require.Equal(t, tc.expected, *cfg) | ||
| }) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| package main | ||
|
|
||
| const ( | ||
| // labelBase is the base label for testcontainers. | ||
| labelBase = "org.testcontainers" | ||
|
|
||
| // ryukLabel is the label used to identify reaper containers. | ||
| ryukLabel = labelBase + ".ryuk" | ||
|
|
||
| // fieldError is the field key for errors. | ||
| fieldError = "error" | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,61 @@ | ||
| module github.com/testcontainers/moby-ryuk | ||
|
|
||
| go 1.22 | ||
|
|
||
| require ( | ||
| github.com/docker/docker v27.1.1+incompatible | ||
| github.com/stretchr/testify v1.9.0 | ||
| ) | ||
|
|
||
| require ( | ||
| github.com/Microsoft/go-winio v0.6.2 // indirect | ||
| github.com/caarlos0/env/v11 v11.1.0 | ||
| golang.org/x/sync v0.7.0 | ||
| ) | ||
|
|
||
| require ( | ||
| github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect | ||
| github.com/cenkalti/backoff/v4 v4.3.0 // indirect | ||
| github.com/containerd/log v0.1.0 // indirect | ||
| github.com/davecgh/go-spew v1.1.1 // indirect | ||
| github.com/distribution/reference v0.6.0 // indirect | ||
| github.com/docker/go-connections v0.5.0 // indirect | ||
| github.com/docker/go-units v0.5.0 // indirect | ||
| github.com/felixge/httpsnoop v1.0.4 // indirect | ||
| github.com/go-logr/logr v1.4.2 // indirect | ||
| github.com/go-logr/stdr v1.2.2 // indirect | ||
| github.com/gogo/protobuf v1.3.2 // indirect | ||
| github.com/google/uuid v1.6.0 // indirect | ||
| github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0 // indirect | ||
| github.com/kr/pretty v0.3.1 // indirect | ||
| github.com/kr/text v0.2.0 // indirect | ||
| github.com/moby/docker-image-spec v1.3.1 // indirect | ||
| github.com/moby/term v0.5.0 // indirect | ||
| github.com/morikuni/aec v1.0.0 // indirect | ||
| github.com/opencontainers/go-digest v1.0.0 // indirect | ||
| github.com/opencontainers/image-spec v1.1.0 // indirect | ||
| github.com/pkg/errors v0.9.1 // indirect | ||
| github.com/pmezard/go-difflib v1.0.0 // indirect | ||
| github.com/rogpeppe/go-internal v1.12.0 // indirect | ||
| github.com/sirupsen/logrus v1.9.3 // indirect | ||
| github.com/stretchr/objx v0.5.2 // indirect | ||
| go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.53.0 // indirect | ||
| go.opentelemetry.io/otel v1.28.0 // indirect | ||
| go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.28.0 // indirect | ||
| go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.28.0 // indirect | ||
| go.opentelemetry.io/otel/metric v1.28.0 // indirect | ||
| go.opentelemetry.io/otel/sdk v1.28.0 // indirect | ||
| go.opentelemetry.io/otel/trace v1.28.0 // indirect | ||
| go.opentelemetry.io/proto/otlp v1.3.1 // indirect | ||
| golang.org/x/net v0.27.0 // indirect | ||
| golang.org/x/sys v0.22.0 // indirect | ||
| golang.org/x/text v0.16.0 // indirect | ||
| golang.org/x/time v0.5.0 // indirect | ||
| google.golang.org/genproto/googleapis/api v0.0.0-20240701130421-f6361c86f094 // indirect | ||
| google.golang.org/genproto/googleapis/rpc v0.0.0-20240725223205-93522f1f2a9f // indirect | ||
| google.golang.org/grpc v1.65.0 // indirect | ||
| google.golang.org/protobuf v1.34.2 // indirect | ||
| gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect | ||
| gopkg.in/yaml.v3 v3.0.1 // indirect | ||
| gotest.tools/v3 v3.5.1 // indirect | ||
| ) |
Oops, something went wrong.