milvus/internal/util/function/highlight/zilliz_highlight_provider_test.go

/*
 * # Licensed to the LF AI & Data foundation under one
 * # or more contributor license agreements. See the NOTICE file
 * # distributed with this work for additional information
 * # regarding copyright ownership. The ASF licenses this file
 * # to you under the Apache License, Version 2.0 (the
 * # "License"); you may not use this file except in compliance
 * # with the License. You may obtain a copy of the License at
 * #
 * #     http://www.apache.org/licenses/LICENSE-2.0
 * #
 * # Unless required by applicable law or agreed to in writing, software
 * # distributed under the License is distributed on an "AS IS" BASIS,
 * # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * # See the License for the specific language governing permissions and
 * # limitations under the License.
 */

package highlight

import (
	"context"
	"testing"

	"github.com/bytedance/mockey"
	"github.com/cockroachdb/errors"
	"github.com/stretchr/testify/suite"

	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
	"github.com/milvus-io/milvus/internal/util/function/models"
	"github.com/milvus-io/milvus/internal/util/function/models/zilliz"
)

func TestZillizHighlightProvider(t *testing.T) {
	suite.Run(t, new(ZillizHighlightProviderSuite))
}

type ZillizHighlightProviderSuite struct {
	suite.Suite
}

func (s *ZillizHighlightProviderSuite) TestNewZillizHighlightProvider_Success() {
	tests := []struct {
		name           string
		params         []*commonpb.KeyValuePair
		conf           map[string]string
		extraInfo      *models.ModelExtraInfo
		expectedBatch  int
		expectedParams map[string]string
	}{
		{
			name: "basic configuration",
			params: []*commonpb.KeyValuePair{
				{Key: models.ModelDeploymentIDKey, Value: "test-deployment"},
			},
			conf: map[string]string{
				"endpoint": "localhost:8080",
			},
			extraInfo: &models.ModelExtraInfo{
				ClusterID: "test-cluster",
				DBName:    "test-db",
			},
			expectedBatch:  64, // default batch size
			expectedParams: map[string]string{},
		},
		{
			name: "with custom batch size",
			params: []*commonpb.KeyValuePair{
				{Key: models.ModelDeploymentIDKey, Value: "test-deployment"},
				{Key: models.MaxClientBatchSizeParamKey, Value: "32"},
			},
			conf: map[string]string{
				"endpoint": "localhost:8080",
			},
			extraInfo: &models.ModelExtraInfo{
				ClusterID: "test-cluster",
				DBName:    "test-db",
			},
			expectedBatch:  32,
			expectedParams: map[string]string{},
		},
		{
			name: "with additional model parameters",
			params: []*commonpb.KeyValuePair{
				{Key: models.ModelDeploymentIDKey, Value: "test-deployment"},
				{Key: models.MaxClientBatchSizeParamKey, Value: "16"},
				{Key: "threshold", Value: "0.7"},
			},
			conf: map[string]string{
				"endpoint": "localhost:8080",
			},
			extraInfo: &models.ModelExtraInfo{
				ClusterID: "test-cluster",
				DBName:    "test-db",
			},
			expectedBatch: 16,
			expectedParams: map[string]string{
				"threshold": "0.7",
			},
		},
	}

	for _, tt := range tests {
		s.Run(tt.name, func() {
			// Note: This test will fail with actual connection since we can't easily mock the global client manager
			// But we can test the parameter parsing logic by checking the error message
			provider, err := newZillizHighlightProvider(tt.params, tt.conf, tt.extraInfo)

			// Since we can't easily mock the zilliz client creation, we expect a connection error
			// but we can verify that the parameters were parsed correctly by checking the error doesn't relate to parameter parsing
			if err != nil {
				// Connection errors are expected in unit tests
				s.Contains(err.Error(), "Connect model serving failed", "Expected connection error, got: %v", err)
			} else {
				// If somehow the connection succeeds, verify the provider was created correctly
				s.NotNil(provider)
				zillizProvider, ok := provider.(*zillizHighlightProvider)
				s.True(ok)
				s.Equal(tt.expectedBatch, zillizProvider.maxBatch())
				s.Equal(tt.expectedParams, zillizProvider.modelParams)
			}
		})
	}
}

func (s *ZillizHighlightProviderSuite) TestNewZillizHighlightProvider_InvalidBatchSize() {
	tests := []struct {
		name        string
		batchValue  string
		expectedErr string
	}{
		{
			name:        "invalid number format",
			batchValue:  "not_a_number",
			expectedErr: "invalid syntax",
		},
		{
			name:        "empty batch size",
			batchValue:  "",
			expectedErr: "invalid syntax",
		},
	}

	for _, tt := range tests {
		s.Run(tt.name, func() {
			params := []*commonpb.KeyValuePair{
				{Key: models.ModelDeploymentIDKey, Value: "test-deployment"},
				{Key: models.MaxClientBatchSizeParamKey, Value: tt.batchValue},
			}
			conf := map[string]string{
				"endpoint": "localhost:8080",
			}
			extraInfo := &models.ModelExtraInfo{
				ClusterID: "test-cluster",
				DBName:    "test-db",
			}

			provider, err := newZillizHighlightProvider(params, conf, extraInfo)
			s.Error(err)
			s.Nil(provider)
			s.Contains(err.Error(), tt.expectedErr)
		})
	}
}

func (s *ZillizHighlightProviderSuite) TestZillizHighlightProvider_Highlight_Success() {
	// Set up expected behavior
	ctx := context.Background()
	query := "machine learning"
	texts := []string{
		"Machine learning is a subset of artificial intelligence.",
		"Deep learning is a type of machine learning.",
		"Natural language processing uses machine learning techniques.",
	}
	params := map[string]string{"param1": "value1"}
	expectedHighlights := [][]string{
		{"Machine learning", "artificial intelligence"},
		{"Deep learning", "machine learning"},
		{"Natural language processing", "machine learning"},
	}

	mock1 := mockey.Mock(zilliz.NewZilliClient).To(func(_ string, _ string, _ string, _ map[string]string) (*zilliz.ZillizClient, error) {
		return &zilliz.ZillizClient{}, nil
	}).Build()
	defer mock1.UnPatch()

	mock2 := mockey.Mock((*zilliz.ZillizClient).Highlight).To(func(_ *zilliz.ZillizClient, _ context.Context, _ string, _ []string, _ map[string]string) ([][]string, error) {
		return expectedHighlights, nil
	}).Build()
	defer mock2.UnPatch()

	provider, err := newZillizHighlightProvider([]*commonpb.KeyValuePair{
		{Key: models.ModelDeploymentIDKey, Value: "test-deployment"},
	}, map[string]string{"endpoint": "localhost:8080"}, &models.ModelExtraInfo{
		ClusterID: "test-cluster",
		DBName:    "test-db",
	})
	s.NoError(err)
	s.NotNil(provider)

	highlights, err := provider.highlight(ctx, query, texts, params)

	s.NoError(err)
	s.Equal(expectedHighlights, highlights)
}

func (s *ZillizHighlightProviderSuite) TestZillizHighlightProvider_Highlight_Error() {
	// Set up expected behavior with error
	ctx := context.Background()
	query := "test query"
	texts := []string{"doc1", "doc2", "doc3"}
	params := map[string]string{"param1": "value1"}
	expectedError := errors.New("highlight service error")

	mock1 := mockey.Mock(zilliz.NewZilliClient).To(func(_ string, _ string, _ string, _ map[string]string) (*zilliz.ZillizClient, error) {
		return &zilliz.ZillizClient{}, nil
	}).Build()
	defer mock1.UnPatch()

	mock2 := mockey.Mock((*zilliz.ZillizClient).Highlight).To(func(_ *zilliz.ZillizClient, _ context.Context, _ string, _ []string, _ map[string]string) ([][]string, error) {
		return nil, expectedError
	}).Build()
	defer mock2.UnPatch()

	provider, err := newZillizHighlightProvider([]*commonpb.KeyValuePair{
		{Key: models.ModelDeploymentIDKey, Value: "test-deployment"},
	}, map[string]string{"endpoint": "localhost:8080"}, &models.ModelExtraInfo{
		ClusterID: "test-cluster",
		DBName:    "test-db",
	})
	s.NoError(err)
	s.NotNil(provider)

	// Test the highlight method
	highlights, err := provider.highlight(ctx, query, texts, params)

	s.Error(err)
	s.Nil(highlights)
	s.Equal(expectedError, err)
}