Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: replace handwriten mocks with mockery #3520

Merged
merged 1 commit into from
Aug 27, 2024
Merged

chore: replace handwriten mocks with mockery #3520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions .mockery.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
with-expecter: true
disable-version-string: True
outpkg: "mock{{.PackageName}}"
mockname: "Mock{{.InterfaceName}}"
filename: "mock_{{.InterfaceName | snakecase}}.go"
dir: "pkg/test/mocks/mock{{.PackageName}}"
packages:
github.com/grafana/pyroscope/pkg/objstore:
interfaces:
Bucket:
github.com/grafana/pyroscope/api/gen/proto/go/metastore/v1:
interfaces:
MetastoreServiceClient:

8 changes: 8 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,10 @@ $(BIN)/mage: Makefile go.mod
@mkdir -p $(@D)
GOBIN=$(abspath $(@D)) $(GO) install github.com/magefile/mage@v1.13.0

$(BIN)/mockery: Makefile go.mod
@mkdir -p $(@D)
GOBIN=$(abspath $(@D)) $(GO) install github.com/vektra/mockery/v2@v2.45.0

$(BIN)/updater: Makefile
@mkdir -p $(@D)
GOBIN=$(abspath $(@D)) GOPRIVATE=github.com/grafana/deployment_tools $(GO) install github.com/grafana/deployment_tools/drone/plugins/cmd/updater@d64d509
Expand Down Expand Up @@ -456,3 +460,7 @@ docs/%:
.PHONY: run
run: ## Run the pyroscope binary (pass parameters with 'make run PARAMS=-myparam')
./pyroscope $(PARAMS)

.PHONY: mockery
mockery: $(BIN)/mockery
$(BIN)/mockery
72 changes: 0 additions & 72 deletions pkg/experiment/ingester/bucket_mock_test.go
View file
Open in desktop

This file was deleted.

98 changes: 45 additions & 53 deletions pkg/experiment/ingester/segment_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"bytes"
"context"
"fmt"
"github.com/stretchr/testify/assert"
"io"
"math/rand"
"path/filepath"
Expand All @@ -29,9 +28,14 @@ import (
"github.com/grafana/pyroscope/pkg/phlaredb"
testutil3 "github.com/grafana/pyroscope/pkg/phlaredb/block/testutil"
pprofth "github.com/grafana/pyroscope/pkg/pprof/testhelper"
"github.com/grafana/pyroscope/pkg/test/mocks/mockmetastorev1"
"github.com/grafana/pyroscope/pkg/test/mocks/mockobjstore"
model2 "github.com/prometheus/common/model"
"github.com/prometheus/prometheus/util/testutil"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
"go.uber.org/atomic"
"google.golang.org/grpc"
)

Expand Down Expand Up @@ -71,14 +75,11 @@ func ingestWithMetastoreAvailable(t *testing.T, chunks []inputChunk) {
sw := newTestSegmentWriter(t, defaultTestSegmentWriterConfig())
defer sw.Stop()
blocks := make(chan *metastorev1.BlockMeta, 128)
sw.client.addBlock = func(ctx context.Context, in *metastorev1.AddBlockRequest, opts ...grpc.CallOption) (*metastorev1.AddBlockResponse, error) {
select {
case blocks <- in.Block:
return &metastorev1.AddBlockResponse{}, nil
default:
return nil, fmt.Errorf("mock meta channel full")
}
}

sw.client.On("AddBlock", mock.Anything, mock.Anything, mock.Anything).
Run(func(args mock.Arguments) {
blocks <- args.Get(1).(*metastorev1.AddBlockRequest).Block
}).Return(new(metastorev1.AddBlockResponse), nil)
allBlocks := make([]*metastorev1.BlockMeta, 0, len(chunks))
for _, chunk := range chunks {
chunkBlocks := make([]*metastorev1.BlockMeta, 0, len(chunk))
Expand All @@ -97,10 +98,8 @@ func ingestWithMetastoreAvailable(t *testing.T, chunks []inputChunk) {
func ingestWithDLQ(t *testing.T, chunks []inputChunk) {
sw := newTestSegmentWriter(t, defaultTestSegmentWriterConfig())
defer sw.Stop()
sw.client.addBlock = func(ctx context.Context, in *metastorev1.AddBlockRequest, opts ...grpc.CallOption) (*metastorev1.AddBlockResponse, error) {
t.Log("addBlock: metastore unavailable")
return nil, fmt.Errorf("metastore unavailable")
}
sw.client.On("AddBlock", mock.Anything, mock.Anything, mock.Anything).
Return(nil, fmt.Errorf("metastore unavailable"))
ingestedChunks := make([]inputChunk, 0, len(chunks))
for chunkIndex, chunk := range chunks {
t.Logf("ingesting chunk %d", chunkIndex)
Expand All @@ -120,10 +119,9 @@ func TestIngestWait(t *testing.T) {
})

defer sw.Stop()
sw.client.addBlock = func(ctx context.Context, in *metastorev1.AddBlockRequest, opts ...grpc.CallOption) (*metastorev1.AddBlockResponse, error) {
sw.client.On("AddBlock", mock.Anything, mock.Anything, mock.Anything).Run(func(args mock.Arguments) {
time.Sleep(1 * time.Second)
return new(metastorev1.AddBlockResponse), nil
}
}).Return(new(metastorev1.AddBlockResponse), nil)

t1 := time.Now()
awaiter := sw.ingest(0, func(head segmentIngest) {
Expand All @@ -147,18 +145,14 @@ func TestBusyIngestLoop(t *testing.T) {
readCtx, readCancel := context.WithCancel(context.Background())
metaChan := make(chan *metastorev1.BlockMeta)
defer sw.Stop()
cnt := 0
sw.client.addBlock = func(ctx context.Context, in *metastorev1.AddBlockRequest, opts ...grpc.CallOption) (*metastorev1.AddBlockResponse, error) {
t.Logf("addBlock %v", in.Block)
metaChan <- in.Block
t.Logf("addedBlock %v", in.Block)

cnt++
if cnt == 3 { // wait for at least 3 segment
writeCancel()
}
return new(metastorev1.AddBlockResponse), nil
}
cnt := atomic.NewInt32(0)
sw.client.On("AddBlock", mock.Anything, mock.Anything, mock.Anything).
Run(func(args mock.Arguments) {
metaChan <- args.Get(1).(*metastorev1.AddBlockRequest).Block
if cnt.Inc() == 3 {
writeCancel()
}
}).Return(new(metastorev1.AddBlockResponse), nil)
metas := make([]*metastorev1.BlockMeta, 0)
readG := sync.WaitGroup{}
readG.Add(1)
Expand Down Expand Up @@ -227,20 +221,18 @@ func TestBusyIngestLoop(t *testing.T) {
}

func TestDLQFail(t *testing.T) {

l := testutil.NewLogger(t)
bucket := mockBucket{upload: func(ctx context.Context, name string, r io.Reader) error {
if strings.HasSuffix(name, pathBlock) {
return nil
}
assert.Contains(t, name, pathDLQ)
return fmt.Errorf("mock upload DLQ error")
}}
client := &metastoreClientMock{
addBlock: func(ctx context.Context, in *metastorev1.AddBlockRequest, opts ...grpc.CallOption) (*metastorev1.AddBlockResponse, error) {
return nil, fmt.Errorf("metastore unavailable")
},
}
bucket := mockobjstore.NewMockBucket(t)
bucket.On("Upload", mock.Anything, mock.MatchedBy(func(name string) bool {
return strings.HasSuffix(name, pathBlock)
}), mock.Anything).Return(nil)
bucket.On("Upload", mock.Anything, mock.MatchedBy(func(name string) bool {
return strings.Contains(name, pathDLQ)
}), mock.Anything).Return(fmt.Errorf("mock upload DLQ error"))
client := mockmetastorev1.NewMockMetastoreServiceClient(t)
client.On("AddBlock", mock.Anything, mock.Anything, mock.Anything).
Return(nil, fmt.Errorf("mock add block error"))

Comment on lines +225 to +235
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may also want to specify whether each method (and how many times) was called and AssertExpectations in the end. Otherwise, if a method has not been called, the test will pass (unless you assert side-effects, which you do)

res := newSegmentWriter(
l,
newSegmentMetrics(nil),
Expand Down Expand Up @@ -279,12 +271,12 @@ func TestDatasetMinMaxTime(t *testing.T) {
l := testutil.NewLogger(t)
bucket := memory.NewInMemBucket()
metas := make(chan *metastorev1.BlockMeta)
client := &metastoreClientMock{
addBlock: func(ctx context.Context, in *metastorev1.AddBlockRequest, opts ...grpc.CallOption) (*metastorev1.AddBlockResponse, error) {
metas <- in.Block
return new(metastorev1.AddBlockResponse), nil
},
}
client := mockmetastorev1.NewMockMetastoreServiceClient(t)
client.On("AddBlock", mock.Anything, mock.Anything, mock.Anything).
Run(func(args mock.Arguments) {
meta := args.Get(1).(*metastorev1.AddBlockRequest).Block
metas <- meta
}).Return(new(metastorev1.AddBlockResponse), nil)
res := newSegmentWriter(
l,
newSegmentMetrics(nil),
Expand Down Expand Up @@ -333,10 +325,10 @@ func TestQueryMultipleSeriesSingleTenant(t *testing.T) {
segmentDuration: 100 * time.Millisecond,
})
defer sw.Stop()
sw.client.addBlock = func(ctx context.Context, in *metastorev1.AddBlockRequest, opts ...grpc.CallOption) (*metastorev1.AddBlockResponse, error) {
metas <- in.Block
return new(metastorev1.AddBlockResponse), nil
}
sw.client.On("AddBlock", mock.Anything, mock.Anything, mock.Anything).
Run(func(args mock.Arguments) {
metas <- args.Get(1).(*metastorev1.AddBlockRequest).Block
}).Return(new(metastorev1.AddBlockResponse), nil)

data := inputChunk([]input{
{shard: 1, tenant: "tb", profile: cpuProfile(42, 239, "svc1", "kek", "foo", "bar")},
Expand Down Expand Up @@ -376,15 +368,15 @@ func TestQueryMultipleSeriesSingleTenant(t *testing.T) {
type sw struct {
*segmentsWriter
bucket *memory.InMemBucket
client *metastoreClientMock
client *mockmetastorev1.MockMetastoreServiceClient
t *testing.T
queryNo int
}

func newTestSegmentWriter(t *testing.T, cfg segmentWriterConfig) sw {
l := testutil.NewLogger(t)
bucket := memory.NewInMemBucket()
client := new(metastoreClientMock)
client := mockmetastorev1.NewMockMetastoreServiceClient(t)
res := newSegmentWriter(
l,
newSegmentMetrics(nil),
Expand Down
Loading
Loading