milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md for mockery generation (#26842) 

Signed-off-by: Congqi Xia <congqi.xia@zilliz.com>
pull/26847/head
congqixia 2023-09-05 14:11:54 +08:00 committed by GitHub
parent fb0705df1b
commit 901e98a868
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -192,6 +192,26 @@ $ go test ./internal/datanode -run SegmentReplica/segmentFlushed
ok github.com/milvus-io/milvus/internal/datanode 0.019s ok github.com/milvus-io/milvus/internal/datanode 0.019s
``` ```
### Using mockery
It is recommended to use [Mockery](https://github.com/vektra/mockery) to generate mock implementations for unit test dependencies.
If your PR changes any interface definition, you shall run following commands to update all mockery implemented type before submitting it:
```shell
make generate-mockery
```
If your PR adds any new interface and related mockery types, please add a new entry under proper [Makefile](Makefile) `generate-mockery-xxx` command.
```Makefile
generate-mockery-xxx: getdeps
# ...
# other mockery generation commands
# use mockery under $(INSTALL_PATH) to unify mockery binary version
$(INSTALL_PATH)/mockery --name=NewInterface ...
```
### Run C++ unit tests ### Run C++ unit tests
Install lcov Install lcov