github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/configuration/core/config_test.go

/*
Copyright (C) 2022-2023 ApeCloud Co., Ltd

This file is part of KubeBlocks project

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package core

import (
	"context"
	"encoding/json"
	"sort"
	"strings"
	"testing"

	"github.com/StudioSol/set"
	"github.com/bhmj/jsonslice"
	"github.com/stretchr/testify/require"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/log"

	appsv1alpha1 "github.com/1aal/kubeblocks/apis/apps/v1alpha1"
	"github.com/1aal/kubeblocks/pkg/configuration/util"
)

var iniConfig = `
[mysqld]
innodb-buffer-pool-size=512M
log-bin=master-bin
gtid_mode=OFF
consensus_auto_leader_transfer=ON

log_error=/data/mysql/log/mysqld.err
character-sets-dir=/usr/share/mysql-8.0/charsets
datadir=/data/mysql/data
port=3306
general_log=1
general_log_file=/data/mysql/mysqld.log
pid-file=/data/mysql/run/mysqld.pid
server-id=1
slow_query_log=1
#slow_query_log_file=/data/mysql/mysqld-slow.log2
slow_query_log_file=/data/mysql/mysqld-slow.log
socket=/data/mysql/tmp/mysqld.sock
ssl-ca=/data/mysql/std_data/cacert.pem
ssl-cert=/data/mysql/std_data/server-cert.pem
ssl-key=/data/mysql/std_data/server-key.pem
tmpdir=/data/mysql/tmp/
loose-sha256_password_auto_generate_rsa_keys=0
loose-caching_sha2_password_auto_generate_rsa_keys=0
secure-file-priv=/data/mysql

[client]
socket=/data/mysql/tmp/mysqld.sock
host=localhost
`

func TestConfigMapConfig(t *testing.T) {
	cfg, err := NewConfigLoader(CfgOption{
		Type:    CfgCmType,
		Log:     log.FromContext(context.Background()),
		CfgType: appsv1alpha1.Ini,
		ConfigResource: &ConfigResource{
			CfgKey: client.ObjectKey{
				Name:      "xxxx",    // set cm name
				Namespace: "default", // set cm namespace
			},
			ResourceReader: func(key client.ObjectKey) (map[string]string, error) {
				return map[string]string{
					"my.cnf":      iniConfig,
					"my_test.cnf": iniConfig,
				}, nil
			},
		},
	})

	require.Nil(t, err)
	log.Log.Info("cfg option: %v", cfg.Option)

	require.Equal(t, cfg.fileCount, 2)
	require.NotNil(t, cfg.getConfigObject(NewCfgOptions("my.cnf")))
	require.Nil(t, cfg.getConfigObject(NewCfgOptions("my2.cnf")))

	res, err := cfg.Query("$..slow_query_log_file", NewCfgOptions(""))
	require.Nil(t, err)
	require.NotNil(t, res)

	require.Equal(t, "[\"/data/mysql/mysqld-slow.log\"]", string(res))

	// patch
	{

		ctx := NewCfgOptions("my.cnf",
			func(ctx *CfgOpOption) {
				ctx.IniContext = &IniContext{
					SectionName: "mysqld",
				}
			})

		require.Nil(t,
			cfg.MergeFrom(map[string]interface{}{
				"slow_query_log": 0,
				"general_log":    0,
			}, ctx))

		content, _ := cfg.ToCfgContent()
		patch, err := CreateMergePatch(&ConfigResource{
			ConfigData: map[string]string{
				"my.cnf":  iniConfig,
				"my2.cnf": iniConfig,
			},
		}, FromConfigData(content, nil), cfg.Option)

		require.Nil(t, err)
		require.NotNil(t, patch)

		// add config: my_test.cnf
		// delete config: my2.cnf

		_, ok := patch.AddConfig["my_test.cnf"]
		require.True(t, ok)

		_, ok = patch.DeleteConfig["my2.cnf"]
		require.True(t, ok)

		updated, ok := patch.UpdateConfig["my.cnf"]
		require.True(t, ok)

		// update my.cnf
		// update slow_query_log 0
		res, _ := jsonslice.Get(updated, "$.mysqld.slow_query_log")
		require.Equal(t, []byte(`"0"`), res)

		// update general_log 0
		res, _ = jsonslice.Get(updated, "$.mysqld.general_log")
		require.Equal(t, []byte(`"0"`), res)
	}
}

func TestGenerateVisualizedParamsList(t *testing.T) {
	type args struct {
		configPatch  *ConfigPatchInfo
		formatConfig *appsv1alpha1.FormatterConfig
		sets         *set.LinkedHashSetString
	}

	var (
		testJSON          any
		fileUpdatedParams = []byte(`{"mysqld": { "max_connections": "666", "read_buffer_size": "55288" }}`)
		testUpdatedParams = []byte(`{"mysqld": { "max_connections": "666", "read_buffer_size": "55288", "delete_params": null }}`)
	)

	require.Nil(t, json.Unmarshal(fileUpdatedParams, &testJSON))
	tests := []struct {
		name string
		args args
		want []VisualizedParam
	}{{
		name: "visualizedParamsTest",
		args: args{
			configPatch: &ConfigPatchInfo{
				IsModify: false,
			},
		},
		want: nil,
	}, {
		name: "visualizedParamsTest",
		args: args{
			configPatch: &ConfigPatchInfo{
				IsModify:     true,
				UpdateConfig: map[string][]byte{"key": testUpdatedParams}},
		},
		want: []VisualizedParam{{
			Key:        "key",
			UpdateType: UpdatedType,
			Parameters: []ParameterPair{
				{
					Key:   "mysqld.max_connections",
					Value: util.ToPointer("666"),
				}, {
					Key:   "mysqld.read_buffer_size",
					Value: util.ToPointer("55288"),
				}, {
					Key:   "mysqld.delete_params",
					Value: nil,
				}},
		}},
	}, {
		name: "visualizedParamsTest",
		args: args{
			configPatch: &ConfigPatchInfo{
				IsModify:     true,
				UpdateConfig: map[string][]byte{"key": testUpdatedParams}},
			formatConfig: &appsv1alpha1.FormatterConfig{
				Format: appsv1alpha1.Ini,
				FormatterOptions: appsv1alpha1.FormatterOptions{IniConfig: &appsv1alpha1.IniConfig{
					SectionName: "mysqld",
				}},
			},
		},
		want: []VisualizedParam{{
			Key:        "key",
			UpdateType: UpdatedType,
			Parameters: []ParameterPair{
				{
					Key:   "max_connections",
					Value: util.ToPointer("666"),
				}, {
					Key:   "read_buffer_size",
					Value: util.ToPointer("55288"),
				}, {
					Key:   "delete_params",
					Value: nil,
				}},
		}},
	}, {
		name: "addFileTest",
		args: args{
			configPatch: &ConfigPatchInfo{
				IsModify:  true,
				AddConfig: map[string]interface{}{"key": testJSON},
			},
			formatConfig: &appsv1alpha1.FormatterConfig{
				Format: appsv1alpha1.Ini,
				FormatterOptions: appsv1alpha1.FormatterOptions{IniConfig: &appsv1alpha1.IniConfig{
					SectionName: "mysqld",
				}},
			},
		},
		want: []VisualizedParam{{
			Key:        "key",
			UpdateType: AddedType,
			Parameters: []ParameterPair{
				{
					Key:   "max_connections",
					Value: util.ToPointer("666"),
				}, {
					Key:   "read_buffer_size",
					Value: util.ToPointer("55288"),
				}},
		}},
	}, {
		name: "deleteFileTest",
		args: args{
			configPatch: &ConfigPatchInfo{
				IsModify:     true,
				DeleteConfig: map[string]interface{}{"key": testJSON},
			},
			formatConfig: &appsv1alpha1.FormatterConfig{
				Format: appsv1alpha1.Ini,
				FormatterOptions: appsv1alpha1.FormatterOptions{IniConfig: &appsv1alpha1.IniConfig{
					SectionName: "mysqld",
				}},
			},
		},
		want: []VisualizedParam{{
			Key:        "key",
			UpdateType: DeletedType,
			Parameters: []ParameterPair{
				{
					Key:   "max_connections",
					Value: util.ToPointer("666"),
				}, {
					Key:   "read_buffer_size",
					Value: util.ToPointer("55288"),
				}},
		}},
	}}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got := GenerateVisualizedParamsList(tt.args.configPatch, tt.args.formatConfig, tt.args.sets)
			sortParams(got)
			sortParams(tt.want)
			require.Equal(t, got, tt.want)
		})
	}
}

func sortParams(param []VisualizedParam) {
	for _, v := range param {
		sort.SliceStable(v.Parameters, func(i, j int) bool {
			return strings.Compare(v.Parameters[i].Key, v.Parameters[j].Key) <= 0
		})
	}
	if len(param) > 0 {
		sort.SliceStable(param, func(i, j int) bool {
			return strings.Compare(param[i].Key, param[j].Key) <= 0
		})
	}
}