client_suite_test.go 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. package client
  2. import (
  3. "context"
  4. "math/rand"
  5. "net"
  6. "strings"
  7. mock "github.com/stretchr/testify/mock"
  8. "github.com/stretchr/testify/suite"
  9. "google.golang.org/grpc"
  10. "google.golang.org/grpc/credentials/insecure"
  11. "google.golang.org/grpc/test/bufconn"
  12. "github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
  13. "github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
  14. "github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
  15. "github.com/milvus-io/milvus/client/v2/entity"
  16. )
  17. const (
  18. bufSize = 1024 * 1024
  19. )
  20. type MockSuiteBase struct {
  21. suite.Suite
  22. lis *bufconn.Listener
  23. svr *grpc.Server
  24. mock *MilvusServiceServer
  25. client *Client
  26. }
  27. func (s *MockSuiteBase) SetupSuite() {
  28. s.lis = bufconn.Listen(bufSize)
  29. s.svr = grpc.NewServer()
  30. s.mock = &MilvusServiceServer{}
  31. milvuspb.RegisterMilvusServiceServer(s.svr, s.mock)
  32. go func() {
  33. s.T().Log("start mock server")
  34. if err := s.svr.Serve(s.lis); err != nil {
  35. s.Fail("failed to start mock server", err.Error())
  36. }
  37. }()
  38. s.setupConnect()
  39. }
  40. func (s *MockSuiteBase) TearDownSuite() {
  41. s.svr.Stop()
  42. s.lis.Close()
  43. }
  44. func (s *MockSuiteBase) mockDialer(context.Context, string) (net.Conn, error) {
  45. return s.lis.Dial()
  46. }
  47. func (s *MockSuiteBase) SetupTest() {
  48. c, err := New(context.Background(), &ClientConfig{
  49. Address: "bufnet",
  50. DialOptions: []grpc.DialOption{
  51. grpc.WithBlock(),
  52. grpc.WithTransportCredentials(insecure.NewCredentials()),
  53. grpc.WithContextDialer(s.mockDialer),
  54. },
  55. })
  56. s.Require().NoError(err)
  57. s.setupConnect()
  58. s.client = c
  59. }
  60. func (s *MockSuiteBase) TearDownTest() {
  61. s.client.Close(context.Background())
  62. s.client = nil
  63. }
  64. func (s *MockSuiteBase) resetMock() {
  65. // MetaCache.reset()
  66. if s.mock != nil {
  67. s.mock.Calls = nil
  68. s.mock.ExpectedCalls = nil
  69. s.setupConnect()
  70. }
  71. }
  72. func (s *MockSuiteBase) setupConnect() {
  73. s.mock.EXPECT().Connect(mock.Anything, mock.AnythingOfType("*milvuspb.ConnectRequest")).
  74. Return(&milvuspb.ConnectResponse{
  75. Status: &commonpb.Status{},
  76. Identifier: 1,
  77. }, nil).Maybe()
  78. }
  79. func (s *MockSuiteBase) setupCache(collName string, schema *entity.Schema) {
  80. s.client.collCache.collections.Insert(collName, &entity.Collection{
  81. Name: collName,
  82. Schema: schema,
  83. })
  84. }
  85. func (s *MockSuiteBase) setupHasCollection(collNames ...string) {
  86. s.mock.EXPECT().HasCollection(mock.Anything, mock.AnythingOfType("*milvuspb.HasCollectionRequest")).
  87. Call.Return(func(ctx context.Context, req *milvuspb.HasCollectionRequest) *milvuspb.BoolResponse {
  88. resp := &milvuspb.BoolResponse{Status: &commonpb.Status{}}
  89. for _, collName := range collNames {
  90. if req.GetCollectionName() == collName {
  91. resp.Value = true
  92. break
  93. }
  94. }
  95. return resp
  96. }, nil)
  97. }
  98. func (s *MockSuiteBase) setupHasCollectionError(errorCode commonpb.ErrorCode, err error) {
  99. s.mock.EXPECT().HasCollection(mock.Anything, mock.AnythingOfType("*milvuspb.HasCollectionRequest")).
  100. Return(&milvuspb.BoolResponse{
  101. Status: &commonpb.Status{ErrorCode: errorCode},
  102. }, err)
  103. }
  104. func (s *MockSuiteBase) setupHasPartition(collName string, partNames ...string) {
  105. s.mock.EXPECT().HasPartition(mock.Anything, mock.AnythingOfType("*milvuspb.HasPartitionRequest")).
  106. Call.Return(func(ctx context.Context, req *milvuspb.HasPartitionRequest) *milvuspb.BoolResponse {
  107. resp := &milvuspb.BoolResponse{Status: &commonpb.Status{}}
  108. if req.GetCollectionName() == collName {
  109. for _, partName := range partNames {
  110. if req.GetPartitionName() == partName {
  111. resp.Value = true
  112. break
  113. }
  114. }
  115. }
  116. return resp
  117. }, nil)
  118. }
  119. func (s *MockSuiteBase) setupHasPartitionError(errorCode commonpb.ErrorCode, err error) {
  120. s.mock.EXPECT().HasPartition(mock.Anything, mock.AnythingOfType("*milvuspb.HasPartitionRequest")).
  121. Return(&milvuspb.BoolResponse{
  122. Status: &commonpb.Status{ErrorCode: errorCode},
  123. }, err)
  124. }
  125. func (s *MockSuiteBase) setupDescribeCollection(_ string, schema *entity.Schema) {
  126. s.mock.EXPECT().DescribeCollection(mock.Anything, mock.AnythingOfType("*milvuspb.DescribeCollectionRequest")).
  127. Call.Return(func(ctx context.Context, req *milvuspb.DescribeCollectionRequest) *milvuspb.DescribeCollectionResponse {
  128. return &milvuspb.DescribeCollectionResponse{
  129. Status: &commonpb.Status{ErrorCode: commonpb.ErrorCode_Success},
  130. Schema: schema.ProtoMessage(),
  131. }
  132. }, nil)
  133. }
  134. func (s *MockSuiteBase) setupDescribeCollectionError(errorCode commonpb.ErrorCode, err error) {
  135. s.mock.EXPECT().DescribeCollection(mock.Anything, mock.AnythingOfType("*milvuspb.DescribeCollectionRequest")).
  136. Return(&milvuspb.DescribeCollectionResponse{
  137. Status: &commonpb.Status{ErrorCode: errorCode},
  138. }, err)
  139. }
  140. func (s *MockSuiteBase) getInt64FieldData(name string, data []int64) *schemapb.FieldData {
  141. return &schemapb.FieldData{
  142. Type: schemapb.DataType_Int64,
  143. FieldName: name,
  144. Field: &schemapb.FieldData_Scalars{
  145. Scalars: &schemapb.ScalarField{
  146. Data: &schemapb.ScalarField_LongData{
  147. LongData: &schemapb.LongArray{
  148. Data: data,
  149. },
  150. },
  151. },
  152. },
  153. }
  154. }
  155. func (s *MockSuiteBase) getVarcharFieldData(name string, data []string) *schemapb.FieldData {
  156. return &schemapb.FieldData{
  157. Type: schemapb.DataType_VarChar,
  158. FieldName: name,
  159. Field: &schemapb.FieldData_Scalars{
  160. Scalars: &schemapb.ScalarField{
  161. Data: &schemapb.ScalarField_StringData{
  162. StringData: &schemapb.StringArray{
  163. Data: data,
  164. },
  165. },
  166. },
  167. },
  168. }
  169. }
  170. func (s *MockSuiteBase) getJSONBytesFieldData(name string, data [][]byte, isDynamic bool) *schemapb.FieldData {
  171. return &schemapb.FieldData{
  172. Type: schemapb.DataType_JSON,
  173. FieldName: name,
  174. Field: &schemapb.FieldData_Scalars{
  175. Scalars: &schemapb.ScalarField{
  176. Data: &schemapb.ScalarField_JsonData{
  177. JsonData: &schemapb.JSONArray{
  178. Data: data,
  179. },
  180. },
  181. },
  182. },
  183. IsDynamic: isDynamic,
  184. }
  185. }
  186. func (s *MockSuiteBase) getFloatVectorFieldData(name string, dim int64, data []float32) *schemapb.FieldData {
  187. return &schemapb.FieldData{
  188. Type: schemapb.DataType_FloatVector,
  189. FieldName: name,
  190. Field: &schemapb.FieldData_Vectors{
  191. Vectors: &schemapb.VectorField{
  192. Dim: dim,
  193. Data: &schemapb.VectorField_FloatVector{
  194. FloatVector: &schemapb.FloatArray{
  195. Data: data,
  196. },
  197. },
  198. },
  199. },
  200. }
  201. }
  202. func (s *MockSuiteBase) getSuccessStatus() *commonpb.Status {
  203. return s.getStatus(commonpb.ErrorCode_Success, "")
  204. }
  205. func (s *MockSuiteBase) getStatus(code commonpb.ErrorCode, reason string) *commonpb.Status {
  206. return &commonpb.Status{
  207. ErrorCode: code,
  208. Reason: reason,
  209. }
  210. }
  211. var letters = []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
  212. func (s *MockSuiteBase) randString(l int) string {
  213. builder := strings.Builder{}
  214. for i := 0; i < l; i++ {
  215. builder.WriteRune(letters[rand.Intn(len(letters))])
  216. }
  217. return builder.String()
  218. }