Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions .github/workflows/linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,30 +35,27 @@ jobs:
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: ${{ runner.os }}-go-

- name: Create folders
run: |
mkdir ./tests/coverage-ci

- name: Install Go dependencies
run: go mod download

- name: Run KV unit tests with coverage
run: |
go test -timeout 20m -v -race -cover -tags=debug -coverpkg=./... -coverprofile=./tests/coverage-ci/kvu.out -covermode=atomic ./...

- name: Run golang tests with coverage
run: |
cd tests
mkdir ./coverage-ci

docker compose -f env/docker-compose-memcached.yaml up -d
sleep 30
if [ "$(docker ps -q -f status=running -f name=memcached_1)" ]; then
echo "KV Docker container started successfully."
else
echo "Failed to start KV Docker container."
exit 1
fi
go test -timeout 20m -v -race -cover -tags=debug -failfast -coverprofile=./coverage-ci/kv.out -covermode=atomic -coverpkg=github.com/roadrunner-server/kv/v6/... ./...
docker compose -f env/docker-compose-memcached.yaml down
go test -timeout 20m -v -race -cover -tags=debug -coverprofile=./coverage-ci/kv.out -covermode=atomic -coverpkg=github.com/roadrunner-server/kv/v6/... ./...

- name: Archive code coverage results
uses: actions/upload-artifact@v7
with:
name: coverage-kv
path: ./tests/coverage-ci/kv.out
path: ./tests/coverage-ci

codecov:
name: Upload codecov
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# boltdb files the tests create in the tests/ working directory
*.db

# Dependency directories (remove the comment below to include it)
# vendor/
.idea
Expand Down
237 changes: 237 additions & 0 deletions fakes_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,237 @@
package kv

import (
"context"
"log/slog"
"slices"
"strings"
"sync"

"github.com/roadrunner-server/api-plugins/v6/kv"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
)

// mockCfg satisfies Configurer.
type mockCfg struct {
data map[string]any // returned through UnmarshalKey
has map[string]bool // drives Serve's local/global/default switch
unmarshalErr error // when set, UnmarshalKey fails (Init error path)
}

func (c *mockCfg) UnmarshalKey(_ string, out any) error {
if c.unmarshalErr != nil {
return c.unmarshalErr
}

if p, ok := out.(*map[string]any); ok {
*p = c.data
}

return nil
}

func (c *mockCfg) Has(name string) bool { return c.has[name] }

// capHandler is a slog.Handler that records emitted records so tests can assert
// which warnings the plugin logged.
type capHandler struct {
mu sync.Mutex
records []slog.Record
}

func (h *capHandler) Enabled(context.Context, slog.Level) bool { return true }

func (h *capHandler) Handle(_ context.Context, r slog.Record) error {
h.mu.Lock()
defer h.mu.Unlock()
h.records = append(h.records, r.Clone())

return nil
}

func (h *capHandler) WithAttrs([]slog.Attr) slog.Handler { return h }
func (h *capHandler) WithGroup(string) slog.Handler { return h }

// hasWarn reports whether a warn-level record whose message contains sub was emitted.
func (h *capHandler) hasWarn(sub string) bool {
h.mu.Lock()
defer h.mu.Unlock()

return slices.ContainsFunc(h.records, func(r slog.Record) bool {
return r.Level == slog.LevelWarn && strings.Contains(r.Message, sub)
})
}

// mockLogger satisfies Logger.
type mockLogger struct{ h slog.Handler }

func (l *mockLogger) NamedLogger(string) *slog.Logger { return slog.New(l.h) }

// fakeTracer satisfies Tracer, the dependency the OTEL plugin fills in.
type fakeTracer struct{ tp *sdktrace.TracerProvider }

func (f *fakeTracer) Tracer() *sdktrace.TracerProvider { return f.tp }

// itemSnapshot holds what a kv.Item carried when the storage received it.
type itemSnapshot struct {
key string
value []byte
timeout string
}

func snapshot(items []kv.Item) []itemSnapshot {
out := make([]itemSnapshot, 0, len(items))
for _, it := range items {
out = append(out, itemSnapshot{key: it.Key(), value: it.Value(), timeout: it.Timeout()})
}

return out
}

// recordedCalls is what a fakeStorage was asked to do.
type recordedCalls struct {
hasKeys []string
mgetKeys []string
ttlKeys []string
deleteKeys []string
setItems []itemSnapshot
expireItems []itemSnapshot
clearCalls int
stopCalls int
}

// fakeStorage implements kv.Storage. It records every call and answers from the
// canned maps; err, when set, is returned by every method that can fail.
// stopBlock, when set, holds Stop until the channel is closed.
type fakeStorage struct {
hasRet map[string]bool
mgetRet map[string][]byte
ttlRet map[string]string
err error
stopBlock chan struct{}

mu sync.Mutex
calls recordedCalls
}

// recorded returns a copy of the recorded calls, safe to read while the plugin
// still holds a reference to the storage.
func (f *fakeStorage) recorded() recordedCalls {
f.mu.Lock()
defer f.mu.Unlock()

return f.calls
}

func (f *fakeStorage) Has(_ context.Context, keys ...string) (map[string]bool, error) {
f.mu.Lock()
f.calls.hasKeys = keys
f.mu.Unlock()

if f.err != nil {
return nil, f.err
}

return f.hasRet, nil
}

func (f *fakeStorage) Get(context.Context, string) ([]byte, error) {
return nil, f.err
}

func (f *fakeStorage) MGet(_ context.Context, keys ...string) (map[string][]byte, error) {
f.mu.Lock()
f.calls.mgetKeys = keys
f.mu.Unlock()

if f.err != nil {
return nil, f.err
}

return f.mgetRet, nil
}

func (f *fakeStorage) Set(_ context.Context, items ...kv.Item) error {
f.mu.Lock()
f.calls.setItems = snapshot(items)
f.mu.Unlock()

return f.err
}

func (f *fakeStorage) MExpire(_ context.Context, items ...kv.Item) error {
f.mu.Lock()
f.calls.expireItems = snapshot(items)
f.mu.Unlock()

return f.err
}

func (f *fakeStorage) TTL(_ context.Context, keys ...string) (map[string]string, error) {
f.mu.Lock()
f.calls.ttlKeys = keys
f.mu.Unlock()

if f.err != nil {
return nil, f.err
}

return f.ttlRet, nil
}

func (f *fakeStorage) Clear(context.Context) error {
f.mu.Lock()
f.calls.clearCalls++
f.mu.Unlock()

return f.err
}

func (f *fakeStorage) Delete(_ context.Context, keys ...string) error {
f.mu.Lock()
f.calls.deleteKeys = keys
f.mu.Unlock()

return f.err
}

func (f *fakeStorage) Stop(context.Context) {
f.mu.Lock()
f.calls.stopCalls++
f.mu.Unlock()

if f.stopBlock != nil {
<-f.stopBlock
}
}

// fakeConstructor implements kv.Constructor. It hands out storage when that
// field is set and otherwise builds a fresh fakeStorage per call, recording the
// config keys the plugin passed in.
type fakeConstructor struct {
name string
storage kv.Storage
err error

cfgKeys []string
created []*fakeStorage
}

func (c *fakeConstructor) Name() string { return c.name }

func (c *fakeConstructor) KvFromConfig(_ context.Context, key string) (kv.Storage, error) {
c.cfgKeys = append(c.cfgKeys, key)

if c.err != nil {
return nil, c.err
}

if c.storage != nil {
return c.storage, nil
}

st := &fakeStorage{}
c.created = append(c.created, st)

return st, nil
}
6 changes: 4 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ go 1.26
toolchain go1.26.5

require (
github.com/roadrunner-server/api-go/v6 v6.0.0-beta.13
github.com/roadrunner-server/api-go/v6 v6.0.0-beta.14
github.com/roadrunner-server/api-plugins/v6 v6.0.0-beta.2
github.com/roadrunner-server/endure/v2 v2.6.2
github.com/roadrunner-server/errors v1.5.0
github.com/stretchr/testify v1.11.1
go.opentelemetry.io/otel/sdk v1.45.0
go.opentelemetry.io/otel/trace v1.45.0
google.golang.org/protobuf v1.36.12
)

require (
Expand All @@ -25,4 +25,6 @@ require (
go.opentelemetry.io/otel v1.45.0 // indirect
go.opentelemetry.io/otel/metric v1.45.0 // indirect
golang.org/x/sys v0.47.0 // indirect
google.golang.org/protobuf v1.36.12 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
13 changes: 11 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,22 @@ github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/roadrunner-server/api-go/v6 v6.0.0-beta.13 h1:BAV1aKkRp51C1OXDfEYZXgfrXqn4O7bpr6Z/m5otwd8=
github.com/roadrunner-server/api-go/v6 v6.0.0-beta.13/go.mod h1:Y4rsabWjr4Y10Jg6H8J5NDitQqlnXmGhCdgR+zyLYkI=
github.com/roadrunner-server/api-go/v6 v6.0.0-beta.14 h1:sTskv/3ImOZlUdtHuj9uT24gm1gQl/qU8rFNvn3MzhU=
github.com/roadrunner-server/api-go/v6 v6.0.0-beta.14/go.mod h1:Y4rsabWjr4Y10Jg6H8J5NDitQqlnXmGhCdgR+zyLYkI=
github.com/roadrunner-server/api-plugins/v6 v6.0.0-beta.2 h1:GqsZzWQ5jMXRF1O/b8IqFz9PLpS7Ui0K4OyACLql2MI=
github.com/roadrunner-server/api-plugins/v6 v6.0.0-beta.2/go.mod h1:2v4yUK5Kvbvq8C3IkDoBkuamq9h+7i/JLjyf7k1j5JM=
github.com/roadrunner-server/endure/v2 v2.6.2 h1:sIB4kTyE7gtT3fDhuYWUYn6Vt/dcPtiA6FoNS1eS+84=
github.com/roadrunner-server/endure/v2 v2.6.2/go.mod h1:t/2+xpNYgGBwhzn83y2MDhvhZ19UVq1REcvqn7j7RB8=
github.com/roadrunner-server/errors v1.5.0 h1:unG7LKIZrSzkCCF3YLRLA5VyqE0KKomofXVJUXJe00g=
github.com/roadrunner-server/errors v1.5.0/go.mod h1:g9fo/T2C13cWRDR9PW1r0ZAOSQfNhWAZawyfkGiaHuI=
github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=
Expand All @@ -41,5 +47,8 @@ golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
google.golang.org/protobuf v1.36.12 h1:pJOKDDOyeXErUroCihFAd5LQuwXBSpVnKGrj5o/fwxc=
google.golang.org/protobuf v1.36.12/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
Loading
Loading