chore: add new properties formatter for nebula addon (#9528)

(cherry picked from commit ae7016a)

Author: sophon-zt

apis/parameters/v1alpha1/types.go

@@ -29,20 +29,21 @@ const (
 
 // CfgFileFormat defines formatter of configuration files.
 // +enum
-// +kubebuilder:validation:Enum={xml,ini,yaml,json,hcl,dotenv,toml,properties,redis,props-plus}
+// +kubebuilder:validation:Enum={xml,ini,yaml,json,hcl,dotenv,toml,properties,redis,props-plus,props-ultra}
 type CfgFileFormat string
 
 const (
-	Ini            CfgFileFormat = "ini"
-	YAML           CfgFileFormat = "yaml"
-	JSON           CfgFileFormat = "json"
-	XML            CfgFileFormat = "xml"
-	HCL            CfgFileFormat = "hcl"
-	Dotenv         CfgFileFormat = "dotenv"
-	TOML           CfgFileFormat = "toml"
-	Properties     CfgFileFormat = "properties"
-	RedisCfg       CfgFileFormat = "redis"
-	PropertiesPlus CfgFileFormat = "props-plus"
+	Ini             CfgFileFormat = "ini"
+	YAML            CfgFileFormat = "yaml"
+	JSON            CfgFileFormat = "json"
+	XML             CfgFileFormat = "xml"
+	HCL             CfgFileFormat = "hcl"
+	Dotenv          CfgFileFormat = "dotenv"
+	TOML            CfgFileFormat = "toml"
+	Properties      CfgFileFormat = "properties"
+	RedisCfg        CfgFileFormat = "redis"
+	PropertiesPlus  CfgFileFormat = "props-plus"
+	PropertiesUltra CfgFileFormat = "props-ultra"
 )
 
 // DynamicReloadType defines reload method.

config/crd/bases/parameters.kubeblocks.io_paramconfigrenderers.yaml

@@ -109,6 +109,7 @@ spec:
                           - properties
                           - redis
                           - props-plus
+                          - props-ultra
                           type: string
                         iniConfig:
                           description: Holds options specific to the 'ini' file format.

deploy/helm/crds/parameters.kubeblocks.io_paramconfigrenderers.yaml

@@ -109,6 +109,7 @@ spec:
                           - properties
                           - redis
                           - props-plus
+                          - props-ultra
                           type: string
                         iniConfig:
                           description: Holds options specific to the 'ini' file format.

docs/developer_docs/api-reference/parameters.md

@@ -670,6 +670,8 @@ string
 <td></td>
 </tr><tr><td><p>&#34;props-plus&#34;</p></td>
 <td></td>
+</tr><tr><td><p>&#34;props-ultra&#34;</p></td>
+<td></td>
 </tr><tr><td><p>&#34;redis&#34;</p></td>
 <td></td>
 </tr><tr><td><p>&#34;toml&#34;</p></td>

pkg/unstructured/properties.go

@@ -31,6 +31,9 @@ import (
 type propertiesConfig struct {
 	name       string
 	Properties *properties.Properties
+
+	// Specifies the separator of key and value while writing the properties, default " = "
+	writeSeparator string
 }
 
 const commentPrefix = "# "
@@ -39,6 +42,9 @@ func init() {
 	CfgObjectRegistry().RegisterConfigCreator(parametersv1alpha1.PropertiesPlus, func(name string) ConfigObject {
 		return &propertiesConfig{name: name}
 	})
+	CfgObjectRegistry().RegisterConfigCreator(parametersv1alpha1.PropertiesUltra, func(name string) ConfigObject {
+		return &propertiesConfig{name: name, writeSeparator: "="}
+	})
 }
 
 func (p *propertiesConfig) Update(key string, value any) error {
@@ -83,6 +89,10 @@ func (p *propertiesConfig) Marshal() (string, error) {
 		return "", nil
 	}
 
+	if p.writeSeparator != "" {
+		p.Properties.WriteSeparator = p.writeSeparator
+	}
+
 	var buf bytes.Buffer
 	_, err := p.Properties.WriteComment(&buf, commentPrefix, properties.UTF8)
 	if err != nil {

pkg/unstructured/properties_test.go

@@ -28,7 +28,10 @@ import (
 )
 
 func TestPropertiesFormat(t *testing.T) {
-	const propsContext = `
+
+	testProperties := func(formatter parametersv1alpha1.CfgFileFormat) {
+
+		const propsContext = `
 # Time of inactivity after which the broker will discard the deduplication information
 # relative to a disconnected producer. Default is 6 hours.
 brokerDeduplicationProducerInactivityTimeoutMinutes=360
@@ -53,34 +56,38 @@ brokerMaxConnections=0
 # The maximum number of connections per IP. If it exceeds, new connections are rejected.
 brokerMaxConnectionsPerIp=0
 `
-	propsConfigObj, err := LoadConfig("props_test", propsContext, parametersv1alpha1.PropertiesPlus)
-	assert.Nil(t, err)
+		propsConfigObj, err := LoadConfig("props_test", propsContext, formatter)
+		assert.Nil(t, err)
 
-	assert.EqualValues(t, propsConfigObj.Get("brokerDeduplicationProducerInactivityTimeoutMinutes"), "360")
-	assert.EqualValues(t, propsConfigObj.Get("maxNamespacesPerTenant.brokerMaxConnections.threadMethod"), "660")
+		assert.EqualValues(t, propsConfigObj.Get("brokerDeduplicationProducerInactivityTimeoutMinutes"), "360")
+		assert.EqualValues(t, propsConfigObj.Get("maxNamespacesPerTenant.brokerMaxConnections.threadMethod"), "660")
 
-	v, _ := propsConfigObj.GetString("defaultNumberOfNamespaceBundles")
-	assert.EqualValues(t, v, "4")
-	v, _ = propsConfigObj.GetString("brokerMaxConnectionsPerIp")
-	assert.EqualValues(t, v, "0")
+		v, _ := propsConfigObj.GetString("defaultNumberOfNamespaceBundles")
+		assert.EqualValues(t, v, "4")
+		v, _ = propsConfigObj.GetString("brokerMaxConnectionsPerIp")
+		assert.EqualValues(t, v, "0")
 
-	v, err = propsConfigObj.GetString("profiles.web.xxxx")
-	assert.Nil(t, err)
-	assert.EqualValues(t, v, "")
+		v, err = propsConfigObj.GetString("profiles.web.xxxx")
+		assert.Nil(t, err)
+		assert.EqualValues(t, v, "")
 
-	dumpContext, err := propsConfigObj.Marshal()
-	assert.Nil(t, err)
-	newObj, err := LoadConfig("props_test", dumpContext, parametersv1alpha1.PropertiesPlus)
-	assert.Nil(t, err)
-	assert.EqualValues(t, newObj.GetAllParameters(), propsConfigObj.GetAllParameters())
+		dumpContext, err := propsConfigObj.Marshal()
+		assert.Nil(t, err)
+		newObj, err := LoadConfig("props_test", dumpContext, parametersv1alpha1.PropertiesPlus)
+		assert.Nil(t, err)
+		assert.EqualValues(t, newObj.GetAllParameters(), propsConfigObj.GetAllParameters())
+
+		assert.EqualValues(t, newObj.SubConfig("test"), nil)
 
-	assert.EqualValues(t, newObj.SubConfig("test"), nil)
+		assert.Nil(t, propsConfigObj.Update("profiles.web.timeout_before_checking_execution_speed", 200))
+		assert.EqualValues(t, propsConfigObj.Get("profiles.web.timeout_before_checking_execution_speed"), "200")
 
-	assert.Nil(t, propsConfigObj.Update("profiles.web.timeout_before_checking_execution_speed", 200))
-	assert.EqualValues(t, propsConfigObj.Get("profiles.web.timeout_before_checking_execution_speed"), "200")
+		assert.Nil(t, propsConfigObj.Update("defaultNumberOfNamespaceBundles", "600"))
+		assert.EqualValues(t, propsConfigObj.Get("defaultNumberOfNamespaceBundles"), "600")
+	}
 
-	assert.Nil(t, propsConfigObj.Update("defaultNumberOfNamespaceBundles", "600"))
-	assert.EqualValues(t, propsConfigObj.Get("defaultNumberOfNamespaceBundles"), "600")
+	testProperties(parametersv1alpha1.PropertiesPlus)
+	testProperties(parametersv1alpha1.PropertiesUltra)
 }
 
 func TestPropertiesEmpty(t *testing.T) {