// 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 paramtable import ( "encoding/json" "strconv" "testing" "github.com/milvus-io/milvus/pkg/util/indexparamcheck" "github.com/milvus-io/milvus/pkg/config" "github.com/stretchr/testify/assert" "github.com/milvus-io/milvus/pkg/common" ) const ( MetricTypeKey = common.MetricTypeKey IndexTypeKey = common.IndexTypeKey ) func TestAutoIndexParams_build(t *testing.T) { var CParams ComponentParam CParams.Init() t.Run("test parseBuildParams success", func(t *testing.T) { //Params := CParams.AutoIndexConfig //buildParams := make([string]interface) var err error map1 := map[string]any{ IndexTypeKey: "HNSW", "M": 48, "efConstruction": 500, } var jsonStrBytes []byte jsonStrBytes, err = json.Marshal(map1) assert.NoError(t, err) CParams.Save(CParams.AutoIndexConfig.IndexParams.Key, string(jsonStrBytes)) assert.Equal(t, "HNSW", CParams.AutoIndexConfig.IndexType.GetValue()) assert.Equal(t, strconv.Itoa(map1["M"].(int)), CParams.AutoIndexConfig.IndexParams.GetAsJSONMap()["M"]) assert.Equal(t, strconv.Itoa(map1["efConstruction"].(int)), CParams.AutoIndexConfig.IndexParams.GetAsJSONMap()["efConstruction"]) map2 := map[string]interface{}{ IndexTypeKey: "IVF_FLAT", "nlist": 1024, } jsonStrBytes, err = json.Marshal(map2) assert.NoError(t, err) CParams.Save(CParams.AutoIndexConfig.IndexParams.Key, string(jsonStrBytes)) assert.Equal(t, "IVF_FLAT", CParams.AutoIndexConfig.IndexType.GetValue()) assert.Equal(t, strconv.Itoa(map2["nlist"].(int)), CParams.AutoIndexConfig.IndexParams.GetAsJSONMap()["nlist"]) }) // t.Run("test parseBuildParams miss total", func(t *testing.T) { // defer func() { // if r := recover(); r == nil { // t.Errorf("The code did not panic") // } // }() // CParams.Save(CParams.AutoIndexConfig.IndexParams.Key, "") // // }) // // t.Run("test parseBuildParams miss index_type", func(t *testing.T) { // defer func() { // if r := recover(); r == nil { // t.Errorf("The code did not panic") // } // }() // var err error // map1 := map[string]any{ // "M": 48, // "efConstruction": 500, // } // var jsonStrBytes []byte // jsonStrBytes, err = json.Marshal(map1) // assert.NoError(t, err) // CParams.Save(CParams.AutoIndexConfig.IndexParams.Key, string(jsonStrBytes)) // }) } func Test_autoIndexConfig_panicIfNotValid(t *testing.T) { t.Run("not in json format", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", "not in json format") p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.Panics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) }) t.Run("index type not found", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", `{"M": 30}`) p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.Panics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) }) t.Run("unsupported index type", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", `{"index_type": "not supported"}`) p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.Panics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) }) t.Run("normal case, hnsw", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", `{"M": 30,"efConstruction": 360,"index_type": "HNSW"}`) p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.NotPanics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) metricType, exist := p.IndexParams.GetAsJSONMap()[common.MetricTypeKey] assert.True(t, exist) assert.Equal(t, indexparamcheck.FloatVectorDefaultMetricType, metricType) }) t.Run("normal case, ivf flat", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", `{"nlist": 30, "index_type": "IVF_FLAT"}`) p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.NotPanics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) metricType, exist := p.IndexParams.GetAsJSONMap()[common.MetricTypeKey] assert.True(t, exist) assert.Equal(t, indexparamcheck.FloatVectorDefaultMetricType, metricType) }) t.Run("normal case, ivf flat", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", `{"nlist": 30, "index_type": "IVF_FLAT"}`) p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.NotPanics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) metricType, exist := p.IndexParams.GetAsJSONMap()[common.MetricTypeKey] assert.True(t, exist) assert.Equal(t, indexparamcheck.FloatVectorDefaultMetricType, metricType) }) t.Run("normal case, diskann", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", `{"index_type": "DISKANN"}`) p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.NotPanics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) metricType, exist := p.IndexParams.GetAsJSONMap()[common.MetricTypeKey] assert.True(t, exist) assert.Equal(t, indexparamcheck.FloatVectorDefaultMetricType, metricType) }) t.Run("normal case, bin flat", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", `{"index_type": "BIN_FLAT"}`) p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.NotPanics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) metricType, exist := p.IndexParams.GetAsJSONMap()[common.MetricTypeKey] assert.True(t, exist) assert.Equal(t, indexparamcheck.BinaryVectorDefaultMetricType, metricType) }) t.Run("normal case, bin ivf flat", func(t *testing.T) { mgr := config.NewManager() mgr.SetConfig("autoIndex.params.build", `{"nlist": 30, "index_type": "BIN_IVF_FLAT"}`) p := &autoIndexConfig{ IndexParams: ParamItem{ Key: "autoIndex.params.build", }, } p.IndexParams.Init(mgr) assert.NotPanics(t, func() { p.panicIfNotValidAndSetDefaultMetricType(mgr) }) metricType, exist := p.IndexParams.GetAsJSONMap()[common.MetricTypeKey] assert.True(t, exist) assert.Equal(t, indexparamcheck.BinaryVectorDefaultMetricType, metricType) }) }