Skip to content

Commit 1830148

Browse files
jesslourencoyurishkuro
jesslourenco
and
yurishkuro
authored
Create config file for Mockery instead of using explicit CLI flags in the Makefile (jaegertracing#5623)
## Which problem is this PR solving? - Part of jaegertracing#5569 ## Description of the changes - Created the configuration file (.mockery.yaml) to match what was being done by `make generate-mocks` - Removed a few mock files from es/mocks that were defined within the subpackage `client`. These files are still (auto) generated but within es/client/mocks only ## How was this change tested? - manually by running `mockery` - by running `make test` ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [ ] I have added unit tests for the new functionality - [ ] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `yarn lint` and `yarn test` --------- Signed-off-by: jessica lourenco <[email protected]> Signed-off-by: jesslourenco <[email protected]> Co-authored-by: Yuri Shkuro <[email protected]>
1 parent d1a5107 commit 1830148

11 files changed

+48
-138
lines changed

‎.mockery.yaml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
with-expecter: false
2+
disable-version-string: true
3+
outpkg: "mocks"
4+
dir: "{{.InterfaceDir}}/mocks/"
5+
mockname: "{{.InterfaceName}}"
6+
filename: "{{.InterfaceName}}.go"
7+
packages:
8+
github.com/jaegertracing/jaeger/pkg/es:
9+
config:
10+
all: true
11+
github.com/jaegertracing/jaeger/storage/spanstore:
12+
config:
13+
all: true
14+
github.com/jaegertracing/jaeger/proto-gen/storage_v1:
15+
config:
16+
all: true
17+
github.com/jaegertracing/jaeger/pkg/es/client:
18+
config:
19+
all: true
20+

‎Makefile

+1-3
Original file line numberDiff line numberDiff line change
@@ -468,9 +468,7 @@ init-submodules:
468468
MOCKERY_FLAGS := --all --disable-version-string
469469
.PHONY: generate-mocks
470470
generate-mocks: $(MOCKERY)
471-
$(MOCKERY) $(MOCKERY_FLAGS) --dir ./pkg/es/ --output ./pkg/es/mocks
472-
$(MOCKERY) $(MOCKERY_FLAGS) --dir ./storage/spanstore/ --output ./storage/spanstore/mocks
473-
$(MOCKERY) $(MOCKERY_FLAGS) --dir ./proto-gen/storage_v1/ --output ./proto-gen/storage_v1/mocks
471+
$(MOCKERY)
474472

475473
.PHONY: certs
476474
certs:

‎cmd/es-rollover/app/init/action_test.go

+14-14
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ func TestIndexCreateIfNotExist(t *testing.T) {
7676

7777
for _, test := range tests {
7878
t.Run(test.name, func(t *testing.T) {
79-
indexClient := &mocks.MockIndexAPI{}
79+
indexClient := &mocks.IndexAPI{}
8080
indexClient.On("CreateIndex", "jaeger-span").Return(test.returnErr)
8181
err := createIndexIfNotExist(indexClient, "jaeger-span")
8282
if test.containsError != "" {
@@ -91,13 +91,13 @@ func TestIndexCreateIfNotExist(t *testing.T) {
9191
func TestRolloverAction(t *testing.T) {
9292
tests := []struct {
9393
name string
94-
setupCallExpectations func(indexClient *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, ilmClient *mocks.MockILMAPI)
94+
setupCallExpectations func(indexClient *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, ilmClient *mocks.IndexManagementLifecycleAPI)
9595
config Config
9696
expectedErr error
9797
}{
9898
{
9999
name: "Unsupported version",
100-
setupCallExpectations: func(_ *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, _ *mocks.MockILMAPI) {
100+
setupCallExpectations: func(_ *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, _ *mocks.IndexManagementLifecycleAPI) {
101101
clusterClient.On("Version").Return(uint(5), nil)
102102
},
103103
config: Config{
@@ -110,7 +110,7 @@ func TestRolloverAction(t *testing.T) {
110110
},
111111
{
112112
name: "error getting version",
113-
setupCallExpectations: func(_ *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, _ *mocks.MockILMAPI) {
113+
setupCallExpectations: func(_ *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, _ *mocks.IndexManagementLifecycleAPI) {
114114
clusterClient.On("Version").Return(uint(0), errors.New("version error"))
115115
},
116116
expectedErr: errors.New("version error"),
@@ -123,7 +123,7 @@ func TestRolloverAction(t *testing.T) {
123123
},
124124
{
125125
name: "ilm doesnt exist",
126-
setupCallExpectations: func(_ *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, ilmClient *mocks.MockILMAPI) {
126+
setupCallExpectations: func(_ *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, ilmClient *mocks.IndexManagementLifecycleAPI) {
127127
clusterClient.On("Version").Return(uint(7), nil)
128128
ilmClient.On("Exists", "myilmpolicy").Return(false, nil)
129129
},
@@ -138,7 +138,7 @@ func TestRolloverAction(t *testing.T) {
138138
},
139139
{
140140
name: "fail get ilm policy",
141-
setupCallExpectations: func(_ *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, ilmClient *mocks.MockILMAPI) {
141+
setupCallExpectations: func(_ *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, ilmClient *mocks.IndexManagementLifecycleAPI) {
142142
clusterClient.On("Version").Return(uint(7), nil)
143143
ilmClient.On("Exists", "myilmpolicy").Return(false, errors.New("error getting ilm policy"))
144144
},
@@ -153,7 +153,7 @@ func TestRolloverAction(t *testing.T) {
153153
},
154154
{
155155
name: "fail to create template",
156-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, _ *mocks.MockILMAPI) {
156+
setupCallExpectations: func(indexClient *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, _ *mocks.IndexManagementLifecycleAPI) {
157157
clusterClient.On("Version").Return(uint(7), nil)
158158
indexClient.On("CreateTemplate", mock.Anything, "jaeger-span").Return(errors.New("error creating template"))
159159
},
@@ -167,7 +167,7 @@ func TestRolloverAction(t *testing.T) {
167167
},
168168
{
169169
name: "fail to get jaeger indices",
170-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, _ *mocks.MockILMAPI) {
170+
setupCallExpectations: func(indexClient *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, _ *mocks.IndexManagementLifecycleAPI) {
171171
clusterClient.On("Version").Return(uint(7), nil)
172172
indexClient.On("CreateTemplate", mock.Anything, "jaeger-span").Return(nil)
173173
indexClient.On("CreateIndex", "jaeger-span-archive-000001").Return(nil)
@@ -183,7 +183,7 @@ func TestRolloverAction(t *testing.T) {
183183
},
184184
{
185185
name: "fail to create alias",
186-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, _ *mocks.MockILMAPI) {
186+
setupCallExpectations: func(indexClient *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, _ *mocks.IndexManagementLifecycleAPI) {
187187
clusterClient.On("Version").Return(uint(7), nil)
188188
indexClient.On("CreateTemplate", mock.Anything, "jaeger-span").Return(nil)
189189
indexClient.On("CreateIndex", "jaeger-span-archive-000001").Return(nil)
@@ -203,7 +203,7 @@ func TestRolloverAction(t *testing.T) {
203203
},
204204
{
205205
name: "create rollover index",
206-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, _ *mocks.MockILMAPI) {
206+
setupCallExpectations: func(indexClient *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, _ *mocks.IndexManagementLifecycleAPI) {
207207
clusterClient.On("Version").Return(uint(7), nil)
208208
indexClient.On("CreateTemplate", mock.Anything, "jaeger-span").Return(nil)
209209
indexClient.On("CreateIndex", "jaeger-span-archive-000001").Return(nil)
@@ -223,7 +223,7 @@ func TestRolloverAction(t *testing.T) {
223223
},
224224
{
225225
name: "create rollover index with ilm",
226-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, clusterClient *mocks.MockClusterAPI, ilmClient *mocks.MockILMAPI) {
226+
setupCallExpectations: func(indexClient *mocks.IndexAPI, clusterClient *mocks.ClusterAPI, ilmClient *mocks.IndexManagementLifecycleAPI) {
227227
clusterClient.On("Version").Return(uint(7), nil)
228228
indexClient.On("CreateTemplate", mock.Anything, "jaeger-span").Return(nil)
229229
indexClient.On("CreateIndex", "jaeger-span-archive-000001").Return(nil)
@@ -247,9 +247,9 @@ func TestRolloverAction(t *testing.T) {
247247

248248
for _, test := range tests {
249249
t.Run(test.name, func(t *testing.T) {
250-
indexClient := &mocks.MockIndexAPI{}
251-
clusterClient := &mocks.MockClusterAPI{}
252-
ilmClient := &mocks.MockILMAPI{}
250+
indexClient := &mocks.IndexAPI{}
251+
clusterClient := &mocks.ClusterAPI{}
252+
ilmClient := &mocks.IndexManagementLifecycleAPI{}
253253
initAction := Action{
254254
Config: test.config,
255255
IndicesClient: indexClient,

‎cmd/es-rollover/app/lookback/action_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,13 @@ func TestLookBackAction(t *testing.T) {
7676

7777
tests := []struct {
7878
name string
79-
setupCallExpectations func(indexClient *mocks.MockIndexAPI)
79+
setupCallExpectations func(indexClient *mocks.IndexAPI)
8080
config Config
8181
expectedErr error
8282
}{
8383
{
8484
name: "success",
85-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI) {
85+
setupCallExpectations: func(indexClient *mocks.IndexAPI) {
8686
indexClient.On("GetJaegerIndices", "").Return(indices, nil)
8787
indexClient.On("DeleteAlias", []client.Alias{
8888
{
@@ -103,7 +103,7 @@ func TestLookBackAction(t *testing.T) {
103103
},
104104
{
105105
name: "get indices error",
106-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI) {
106+
setupCallExpectations: func(indexClient *mocks.IndexAPI) {
107107
indexClient.On("GetJaegerIndices", "").Return(indices, errors.New("get indices error"))
108108
},
109109
config: Config{
@@ -118,7 +118,7 @@ func TestLookBackAction(t *testing.T) {
118118
},
119119
{
120120
name: "empty indices",
121-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI) {
121+
setupCallExpectations: func(indexClient *mocks.IndexAPI) {
122122
indexClient.On("GetJaegerIndices", "").Return([]client.Index{}, nil)
123123
},
124124
config: Config{
@@ -137,7 +137,7 @@ func TestLookBackAction(t *testing.T) {
137137

138138
for _, test := range tests {
139139
t.Run(test.name, func(t *testing.T) {
140-
indexClient := &mocks.MockIndexAPI{}
140+
indexClient := &mocks.IndexAPI{}
141141
lookbackAction := Action{
142142
Config: test.config,
143143
IndicesClient: indexClient,

‎cmd/es-rollover/app/rollover/action_test.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func TestRolloverAction(t *testing.T) {
4545
createAliasErr error
4646
expectedError bool
4747
indices []client.Index
48-
setupCallExpectations func(indexClient *mocks.MockIndexAPI, t *testCase)
48+
setupCallExpectations func(indexClient *mocks.IndexAPI, t *testCase)
4949
}
5050

5151
tests := []testCase{
@@ -54,7 +54,7 @@ func TestRolloverAction(t *testing.T) {
5454
conditions: "{\"max_age\": \"2d\"}",
5555
expectedError: false,
5656
indices: readIndices,
57-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, test *testCase) {
57+
setupCallExpectations: func(indexClient *mocks.IndexAPI, test *testCase) {
5858
indexClient.On("GetJaegerIndices", "").Return(test.indices, test.getJaegerIndicesErr)
5959
indexClient.On("CreateAlias", aliasToCreate).Return(test.createAliasErr)
6060
indexClient.On("Rollover", "jaeger-span-archive-write", map[string]any{"max_age": "2d"}).Return(test.rolloverErr)
@@ -72,7 +72,7 @@ func TestRolloverAction(t *testing.T) {
7272
},
7373
},
7474
},
75-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, test *testCase) {
75+
setupCallExpectations: func(indexClient *mocks.IndexAPI, test *testCase) {
7676
indexClient.On("GetJaegerIndices", "").Return(test.indices, test.getJaegerIndicesErr)
7777
indexClient.On("Rollover", "jaeger-span-archive-write", map[string]any{"max_age": "2d"}).Return(test.rolloverErr)
7878
},
@@ -83,7 +83,7 @@ func TestRolloverAction(t *testing.T) {
8383
expectedError: true,
8484
getJaegerIndicesErr: errors.New("unable to get indices"),
8585
indices: readIndices,
86-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, test *testCase) {
86+
setupCallExpectations: func(indexClient *mocks.IndexAPI, test *testCase) {
8787
indexClient.On("Rollover", "jaeger-span-archive-write", map[string]any{"max_age": "2d"}).Return(test.rolloverErr)
8888
indexClient.On("GetJaegerIndices", "").Return(test.indices, test.getJaegerIndicesErr)
8989
},
@@ -94,7 +94,7 @@ func TestRolloverAction(t *testing.T) {
9494
expectedError: true,
9595
rolloverErr: errors.New("unable to rollover"),
9696
indices: readIndices,
97-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, test *testCase) {
97+
setupCallExpectations: func(indexClient *mocks.IndexAPI, test *testCase) {
9898
indexClient.On("Rollover", "jaeger-span-archive-write", map[string]any{"max_age": "2d"}).Return(test.rolloverErr)
9999
},
100100
},
@@ -104,7 +104,7 @@ func TestRolloverAction(t *testing.T) {
104104
expectedError: true,
105105
createAliasErr: errors.New("unable to create alias"),
106106
indices: readIndices,
107-
setupCallExpectations: func(indexClient *mocks.MockIndexAPI, test *testCase) {
107+
setupCallExpectations: func(indexClient *mocks.IndexAPI, test *testCase) {
108108
indexClient.On("GetJaegerIndices", "").Return(test.indices, test.getJaegerIndicesErr)
109109
indexClient.On("CreateAlias", aliasToCreate).Return(test.createAliasErr)
110110
indexClient.On("Rollover", "jaeger-span-archive-write", map[string]any{"max_age": "2d"}).Return(test.rolloverErr)
@@ -116,13 +116,13 @@ func TestRolloverAction(t *testing.T) {
116116
unmarshalErrExpected: true,
117117
createAliasErr: errors.New("unable to create alias"),
118118
indices: readIndices,
119-
setupCallExpectations: func(_ *mocks.MockIndexAPI, _ *testCase) {},
119+
setupCallExpectations: func(_ *mocks.IndexAPI, _ *testCase) {},
120120
},
121121
}
122122

123123
for _, test := range tests {
124124
t.Run(test.name, func(t *testing.T) {
125-
indexClient := &mocks.MockIndexAPI{}
125+
indexClient := &mocks.IndexAPI{}
126126

127127
rolloverAction := Action{
128128
Config: Config{

‎pkg/es/mocks/ClusterAPI.go ‎pkg/es/client/mocks/ClusterAPI.go

File renamed without changes.

‎pkg/es/mocks/IndexAPI.go ‎pkg/es/client/mocks/IndexAPI.go

File renamed without changes.

‎pkg/es/mocks/IndexManagementLifecycleAPI.go ‎pkg/es/client/mocks/IndexManagementLifecycleAPI.go

File renamed without changes.

‎pkg/es/client/mocks/cluster_client.go

-28
This file was deleted.

‎pkg/es/client/mocks/ilm_client.go

-26
This file was deleted.

‎pkg/es/client/mocks/index_client.go

-54
This file was deleted.

0 commit comments

Comments
 (0)