Skip to content

Commit 901e98a

Browse files
authored
Update CONTRIBUTING.md for mockery generation (#26842)
Signed-off-by: Congqi Xia <[email protected]>
1 parent fb0705d commit 901e98a

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,26 @@ $ go test ./internal/datanode -run SegmentReplica/segmentFlushed
192192
ok github.com/milvus-io/milvus/internal/datanode 0.019s
193193
```
194194

195+
### Using mockery
196+
197+
It is recommended to use [Mockery](https://github.com/vektra/mockery) to generate mock implementations for unit test dependencies.
198+
199+
If your PR changes any interface definition, you shall run following commands to update all mockery implemented type before submitting it:
200+
201+
```shell
202+
make generate-mockery
203+
```
204+
205+
If your PR adds any new interface and related mockery types, please add a new entry under proper [Makefile](Makefile) `generate-mockery-xxx` command.
206+
207+
```Makefile
208+
generate-mockery-xxx: getdeps
209+
# ...
210+
# other mockery generation commands
211+
# use mockery under $(INSTALL_PATH) to unify mockery binary version
212+
$(INSTALL_PATH)/mockery --name=NewInterface ...
213+
```
214+
195215
### Run C++ unit tests
196216

197217
Install lcov

0 commit comments

Comments
 (0)