// 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 ( "testing" "time" "github.com/stretchr/testify/assert" "github.com/milvus-io/milvus/pkg/v3/config" "github.com/milvus-io/milvus/pkg/v3/util" "github.com/milvus-io/milvus/pkg/v3/util/metricsinfo" "github.com/milvus-io/milvus/pkg/v3/util/typeutil" ) func TestServiceParam(t *testing.T) { var SParams ServiceParam bt := NewBaseTable(SkipRemote(true)) SParams.init(bt) t.Run("test MQConfig", func(t *testing.T) { Params := &SParams.MQCfg assert.Equal(t, 100*time.Millisecond, Params.CheckInterval.GetAsDuration(time.Second)) assert.Equal(t, 16, Params.TargetBufSize.GetAsInt()) assert.Equal(t, 3*time.Second, Params.MaxTolerantLag.GetAsDuration(time.Second)) assert.Equal(t, 60*time.Minute, Params.MaxPositionTsGap.GetAsDuration(time.Minute)) }) t.Run("test etcdConfig", func(t *testing.T) { Params := &SParams.EtcdCfg assert.NotZero(t, len(Params.Endpoints.GetAsStrings())) t.Logf("etcd endpoints = %s", Params.Endpoints.GetAsStrings()) assert.NotEqual(t, Params.MetaRootPath, "") t.Logf("meta root path = %s", Params.MetaRootPath.GetValue()) assert.NotEqual(t, Params.KvRootPath, "") t.Logf("kv root path = %s", Params.KvRootPath.GetValue()) assert.NotNil(t, Params.EtcdUseSSL.GetAsBool()) t.Logf("use ssl = %t", Params.EtcdUseSSL.GetAsBool()) assert.NotEmpty(t, Params.EtcdTLSKey.GetValue()) t.Logf("tls key = %s", Params.EtcdTLSKey.GetValue()) assert.NotEmpty(t, Params.EtcdTLSCACert.GetValue()) t.Logf("tls CACert = %s", Params.EtcdTLSCACert.GetValue()) assert.NotEmpty(t, Params.EtcdTLSCert.GetValue()) t.Logf("tls cert = %s", Params.EtcdTLSCert.GetValue()) assert.NotEmpty(t, Params.EtcdTLSMinVersion.GetValue()) t.Logf("tls minVersion = %s", Params.EtcdTLSMinVersion.GetValue()) // test etcd auth default values assert.Equal(t, "etcdadmin", Params.EtcdAuthUserName.GetValue()) assert.Equal(t, "etcdadmin", Params.EtcdAuthPassword.GetValue()) assert.True(t, Params.EtcdEnableAuth.GetAsBool()) // test UseEmbedEtcd with auth enabled — should auto-disable auth, not panic t.Setenv("etcd.use.embed", "true") t.Setenv("etcd.auth.enabled", "true") t.Setenv(metricsinfo.DeployModeEnvKey, metricsinfo.StandaloneDeployMode) assert.NotPanics(t, func() { NewBaseTable() }) // test etcd auth enabled with empty credentials should panic t.Setenv("etcd.use.embed", "false") t.Setenv("etcd.auth.enabled", "true") t.Setenv("etcd.auth.userName", "") t.Setenv("etcd.auth.password", "") assert.Panics(t, func() { NewBaseTable() }) // test etcd auth enabled with valid credentials should not panic t.Setenv("etcd.auth.enabled", "true") t.Setenv("etcd.auth.userName", "milvus") t.Setenv("etcd.auth.password", "milvuspass") assert.NotPanics(t, func() { NewBaseTable() }) t.Setenv("etcd.auth.enabled", "false") t.Setenv(metricsinfo.DeployModeEnvKey, metricsinfo.StandaloneDeployMode) SParams.init(bt) }) t.Run("test tikvConfig", func(t *testing.T) { Params := &SParams.TiKVCfg assert.NotZero(t, len(Params.Endpoints.GetAsStrings())) t.Logf("tikv endpoints = %s", Params.Endpoints.GetAsStrings()) assert.NotEqual(t, Params.MetaRootPath, "") t.Logf("meta root path = %s", Params.MetaRootPath.GetValue()) assert.NotEqual(t, Params.KvRootPath, "") t.Logf("kv root path = %s", Params.KvRootPath.GetValue()) t.Setenv(metricsinfo.DeployModeEnvKey, metricsinfo.StandaloneDeployMode) SParams.init(bt) }) t.Run("test woodpeckerConfig", func(t *testing.T) { wpCfg := &SParams.WoodpeckerCfg assert.Equal(t, wpCfg.MetaType.GetValue(), "etcd") assert.Equal(t, wpCfg.MetaPrefix.GetValue(), "woodpecker") assert.Equal(t, wpCfg.AppendQueueSize.GetAsInt(), 10000) assert.Equal(t, wpCfg.AppendMaxRetries.GetAsInt(), 3) assert.Equal(t, wpCfg.SegmentRollingMaxSize.GetAsSize(), int64(256*1024*1024)) assert.Equal(t, wpCfg.SegmentRollingMaxTime.GetAsDurationByParse().Seconds(), float64(600)) assert.Equal(t, wpCfg.SegmentRollingMaxBlocks.GetAsInt64(), int64(1000)) assert.Equal(t, wpCfg.AuditorMaxInterval.GetAsDurationByParse().Seconds(), float64(10)) // Test default quorum configuration values // Buffer pools (should be empty by default) assert.Equal(t, wpCfg.QuorumBufferPools.GetValue(), "") // Selection strategy assert.Equal(t, wpCfg.QuorumAffinityMode.GetValue(), "soft") assert.Equal(t, wpCfg.QuorumReplicas.GetAsInt(), 3) assert.Equal(t, wpCfg.QuorumStrategy.GetValue(), "random") // Custom placement (should be empty by default) assert.Equal(t, wpCfg.QuorumCustomPlacement.GetValue(), "") assert.Equal(t, wpCfg.SyncMaxInterval.GetAsDurationByParse().Milliseconds(), int64(200)) assert.Equal(t, wpCfg.SyncMaxIntervalForLocalStorage.GetAsDurationByParse().Milliseconds(), int64(10)) assert.Equal(t, wpCfg.SyncMaxEntries.GetAsInt(), 10000) assert.Equal(t, wpCfg.SyncMaxBytes.GetAsSize(), int64(256*1024*1024)) assert.Equal(t, wpCfg.FlushMaxRetries.GetAsInt(), 5) assert.Equal(t, wpCfg.FlushMaxSize.GetAsSize(), int64(2*1024*1024)) assert.Equal(t, wpCfg.FlushMaxThreads.GetAsInt(), 32) assert.Equal(t, wpCfg.RetryInterval.GetAsDurationByParse().Milliseconds(), int64(1000)) assert.Equal(t, wpCfg.CompactionSize.GetAsSize(), int64(2*1024*1024)) assert.Equal(t, wpCfg.CompactionMaxParallelUploads.GetAsInt(), 4) assert.Equal(t, wpCfg.CompactionMaxParallelReads.GetAsInt(), 8) assert.Equal(t, wpCfg.ReaderMaxBatchSize.GetAsSize(), int64(16*1024*1024)) assert.Equal(t, wpCfg.ReaderMaxFetchThreads.GetAsInt(), 32) assert.Equal(t, wpCfg.RetentionTTL.GetAsDurationByParse().Milliseconds()/1000, int64(72*60*60)) assert.Equal(t, wpCfg.FencePolicyConditionWrite.GetValue(), "auto") assert.Equal(t, wpCfg.StorageType.GetValue(), "minio") assert.Equal(t, wpCfg.ForceLocalStorage.GetAsBool(), false) assert.Equal(t, wpCfg.RootPath.GetValue(), "default") }) t.Run("test woodpeckerConfig RetentionTTL fallback", func(t *testing.T) { // Test fallback key behavior: when main key doesn't exist, use fallback key { testBt := NewBaseTable(SkipRemote(true)) testBt.Save("streaming.walTruncate.retentionInterval", "48h") testBt.Remove("woodpecker.logstore.retentionPolicy.ttl") var testSParams ServiceParam testSParams.init(testBt) wpCfg := &testSParams.WoodpeckerCfg // Should use fallback key value assert.Equal(t, wpCfg.RetentionTTL.GetAsDurationByParse().Milliseconds()/1000, int64(48*60*60)) } // Test main key priority: when main key exists, use main key instead of fallback { testBt := NewBaseTable(SkipRemote(true)) testBt.Save("woodpecker.logstore.retentionPolicy.ttl", "24h") testBt.Save("streaming.walTruncate.retentionInterval", "48h") var testSParams ServiceParam testSParams.init(testBt) wpCfg := &testSParams.WoodpeckerCfg // Should use main key value, not fallback assert.Equal(t, wpCfg.RetentionTTL.GetAsDurationByParse().Milliseconds()/1000, int64(24*60*60)) } }) t.Run("test woodpeckerQuorumConfig", func(t *testing.T) { wpCfg := &SParams.WoodpeckerCfg // Test setting custom quorum configuration values using JSON format // Buffer pools as JSON array bufferPoolsJSON := `[{"name":"region1","seeds":["node1:8080","node2:8080","node3:8080"]},{"name":"region2","seeds":["node4:8080","node5:8080","node6:8080"]}]` bt.Save("woodpecker.client.quorum.quorumBufferPools", bufferPoolsJSON) // Selection strategy bt.Save("woodpecker.client.quorum.quorumSelectStrategy.affinityMode", "hard") bt.Save("woodpecker.client.quorum.quorumSelectStrategy.replicas", "5") bt.Save("woodpecker.client.quorum.quorumSelectStrategy.strategy", "custom") // Custom placement as JSON array customPlacementJSON := `[{"name":"replica-1","region":"region1","az":"az-1","resourceGroup":"rg-1"},{"name":"replica-2","region":"region2","az":"az-2","resourceGroup":"rg-2"},{"name":"replica-3","region":"region3","az":"az-3","resourceGroup":"rg-3"},{"name":"replica-4","region":"region1","az":"az-4","resourceGroup":"rg-4"},{"name":"replica-5","region":"region2","az":"az-5","resourceGroup":"rg-5"}]` bt.Save("woodpecker.client.quorum.quorumSelectStrategy.customPlacement", customPlacementJSON) // Reinitialize configuration to pick up the new values SParams.WoodpeckerCfg.QuorumBufferPools.Init(bt.mgr) SParams.WoodpeckerCfg.QuorumAffinityMode.Init(bt.mgr) SParams.WoodpeckerCfg.QuorumReplicas.Init(bt.mgr) SParams.WoodpeckerCfg.QuorumStrategy.Init(bt.mgr) SParams.WoodpeckerCfg.QuorumCustomPlacement.Init(bt.mgr) // Verify the updated configuration values // Buffer pools (should contain JSON string) bufferPools := wpCfg.QuorumBufferPools.GetValue() assert.NotEmpty(t, bufferPools) assert.Contains(t, bufferPools, "region1") assert.Contains(t, bufferPools, "region2") assert.Contains(t, bufferPools, "node1:8080") assert.Contains(t, bufferPools, "node4:8080") assert.Contains(t, bufferPools, "[") assert.Contains(t, bufferPools, "]") // Selection strategy assert.Equal(t, "hard", wpCfg.QuorumAffinityMode.GetValue()) assert.Equal(t, 5, wpCfg.QuorumReplicas.GetAsInt()) assert.Equal(t, "custom", wpCfg.QuorumStrategy.GetValue()) // Custom placement (should contain JSON string) customPlacement := wpCfg.QuorumCustomPlacement.GetValue() assert.NotEmpty(t, customPlacement) assert.Contains(t, customPlacement, "replica-1") assert.Contains(t, customPlacement, "replica-5") assert.Contains(t, customPlacement, "region1") assert.Contains(t, customPlacement, "az-1") assert.Contains(t, customPlacement, "rg-1") assert.Contains(t, customPlacement, "[") assert.Contains(t, customPlacement, "]") // Log the configuration values for verification t.Logf("Buffer pools (JSON): %s", bufferPools) t.Logf("Selection strategy - Affinity: %s, Replicas: %d, Strategy: %s", wpCfg.QuorumAffinityMode.GetValue(), wpCfg.QuorumReplicas.GetAsInt(), wpCfg.QuorumStrategy.GetValue()) t.Logf("Custom placement (JSON): %s", customPlacement) }) t.Run("test pulsarConfig", func(t *testing.T) { // test default value { pc := &PulsarConfig{} base := &BaseTable{mgr: config.NewManager()} pc.Init(base) assert.Empty(t, pc.Address.GetValue()) } { assert.NotEqual(t, SParams.PulsarCfg.Address.GetValue(), "") t.Logf("pulsar address = %s", SParams.PulsarCfg.Address.GetValue()) assert.Equal(t, SParams.PulsarCfg.MaxMessageSize.GetAsInt(), 2097152) } address := "pulsar://localhost:6650" { bt.Save("pulsar.address", address) assert.Equal(t, SParams.PulsarCfg.Address.GetValue(), address) } { bt.Save("pulsar.address", "localhost") bt.Save("pulsar.port", "6650") assert.Equal(t, SParams.PulsarCfg.Address.GetValue(), address) } }) t.Run("test pulsar web config", func(t *testing.T) { assert.NotEqual(t, SParams.PulsarCfg.Address.GetValue(), "") { assert.NotEqual(t, SParams.PulsarCfg.WebAddress.GetValue(), "") } { bt.Save(SParams.PulsarCfg.Address.Key, "u\\invalid") assert.Equal(t, SParams.PulsarCfg.WebAddress.GetValue(), "") } { bt.Save(SParams.PulsarCfg.Address.Key, "") assert.Equal(t, SParams.PulsarCfg.WebAddress.GetValue(), "") } }) t.Run("test pulsar auth config", func(t *testing.T) { Params := &SParams.PulsarCfg assert.Equal(t, "", Params.AuthPlugin.GetValue()) assert.Equal(t, "{}", Params.AuthParams.GetValue()) }) t.Run("test pulsar auth config formatter", func(t *testing.T) { Params := &SParams.PulsarCfg assert.Equal(t, "{}", Params.AuthParams.Formatter("")) assert.Equal(t, "{\"a\":\"b\"}", Params.AuthParams.Formatter("a:b")) }) t.Run("test pulsar tenant/namespace config", func(t *testing.T) { Params := &SParams.PulsarCfg assert.Equal(t, "public", Params.Tenant.GetValue()) assert.Equal(t, "default", Params.Namespace.GetValue()) }) t.Run("pulsar_operation_timeout", func(t *testing.T) { Params := &SParams.PulsarCfg assert.Equal(t, "60", Params.RequestTimeout.GetValue()) }) t.Run("pulsar_backlog_auto_clear_bytes", func(t *testing.T) { Params := &SParams.PulsarCfg assert.Equal(t, int64(100*1024*1024), Params.BacklogAutoClearBytes.GetAsSize()) }) t.Run("test rocksmqConfig", func(t *testing.T) { Params := &SParams.RocksmqCfg assert.NotEqual(t, Params.Path.GetValue(), "") t.Logf("rocksmq path = %s", Params.Path.GetValue()) }) t.Run("test kafkaConfig", func(t *testing.T) { // test default value { kc := &KafkaConfig{} base := &BaseTable{mgr: config.NewManager()} kc.Init(base) assert.Equal(t, "localhost:9092", kc.Address.GetValue()) assert.Empty(t, kc.SaslMechanisms.GetValue()) assert.Empty(t, kc.SecurityProtocol.GetValue()) assert.Equal(t, kc.ReadTimeout.GetAsDuration(time.Second), 10*time.Second) assert.Equal(t, kc.KafkaUseSSL.GetAsBool(), false) assert.Empty(t, kc.KafkaTLSCACert.GetValue()) assert.Empty(t, kc.KafkaTLSCert.GetValue()) assert.Empty(t, kc.KafkaTLSKey.GetValue()) assert.Empty(t, kc.KafkaTLSKeyPassword.GetValue()) } }) t.Run("test minioConfig", func(t *testing.T) { Params := &SParams.MinioCfg addr := Params.Address.GetValue() equal := addr == "localhost:9000" || addr == "minio:9000" assert.Equal(t, equal, true) t.Logf("minio address = %s", Params.Address.GetValue()) assert.Equal(t, Params.AccessKeyID.GetValue(), "minioadmin") assert.Equal(t, Params.SecretAccessKey.GetValue(), "minioadmin") assert.Equal(t, Params.UseSSL.GetAsBool(), false) assert.Empty(t, Params.SslCACert.GetValue()) assert.Equal(t, Params.UseIAM.GetAsBool(), false) assert.Equal(t, Params.CloudProvider.GetValue(), "aws") assert.Equal(t, Params.IAMEndpoint.GetValue(), "") assert.Equal(t, Params.GcpCredentialJSON.GetValue(), "") t.Logf("Minio BucketName = %s", Params.BucketName.GetValue()) t.Logf("Minio rootpath = %s", Params.RootPath.GetValue()) }) t.Run("test metastore config", func(t *testing.T) { Params := &SParams.MetaStoreCfg assert.Equal(t, util.MetaStoreTypeEtcd, Params.MetaStoreType.GetValue()) assert.Equal(t, 100000, Params.PaginationSize.GetAsInt()) assert.Equal(t, 32, Params.ReadConcurrency.GetAsInt()) }) t.Run("test profile config", func(t *testing.T) { params := &SParams.ProfileCfg assert.Equal(t, "/var/lib/milvus/data/pprof", params.PprofPath.GetValue()) bt.Save(params.PprofPath.Key, "/tmp/pprof") assert.Equal(t, "/tmp/pprof", params.PprofPath.GetValue()) }) } func TestRuntimConfig(t *testing.T) { SetRole(typeutil.StandaloneRole) assert.Equal(t, GetRole(), typeutil.StandaloneRole) SetLocalComponentEnabled(typeutil.QueryNodeRole) assert.True(t, IsLocalComponentEnabled(typeutil.QueryNodeRole)) SetLocalComponentEnabled(typeutil.QueryCoordRole) assert.True(t, IsLocalComponentEnabled(typeutil.QueryCoordRole)) }