Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: use validation from backend config and tidy package config #893

Merged
merged 1 commit into from
Mar 7, 2024
Merged

chore: use validation from backend config and tidy package config #893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 2 additions & 8 deletions pkg/config/operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import (
"gopkg.in/yaml.v3"

v1 "kusionstack.io/kusion/pkg/apis/core/v1"
"kusionstack.io/kusion/pkg/config/validation"
"kusionstack.io/kusion/pkg/util/kfile"
)

Expand Down Expand Up @@ -267,11 +266,6 @@ func setItemInConfig(config *v1.Config, info *itemInfo, key string, value any) (
return convertFromCfgMap(cfg)
}

// validateConfig checks the config is valid or not.
func validateConfig(config *v1.Config) error {
return validation.ValidateConfig(config)
}

// tidyConfig is used to clean dirty empty block.
func tidyConfig(configAddr **v1.Config) {
config := *configAddr
Expand Down Expand Up @@ -328,12 +322,12 @@ func parseStructuredConfigItem(info *itemInfo, strValue string) (any, error) {
case int:
value, err = strconv.Atoi(strValue)
if err != nil {
return nil, validation.ErrNotInt
return nil, ErrNotInt
}
case bool:
value, err = strconv.ParseBool(strValue)
if err != nil {
return nil, validation.ErrNotBool
return nil, ErrNotBool
}
default:
if reflect.TypeOf(value).Kind() == reflect.Pointer {
Expand Down
111 changes: 56 additions & 55 deletions pkg/config/operator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ var (
"pre": {
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
"prod": {
Expand All @@ -52,10 +52,10 @@ var (
"pre": map[string]any{
v1.BackendType: v1.DeprecatedBackendMysql,
v1.BackendConfigItems: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
"prod": map[string]any{
Expand Down Expand Up @@ -154,7 +154,7 @@ func TestOperator_GetConfigItem(t *testing.T) {
success: true,
o: mockOperator(existValidConfigPath, validConfig),
key: "backends.pre.configs.port",
expectedVal: 6443,
expectedVal: 3306,
},
{
name: "get structured config item successfully type pointer of struct",
Expand All @@ -164,10 +164,10 @@ func TestOperator_GetConfigItem(t *testing.T) {
expectedVal: &v1.BackendConfig{
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
},
Expand Down Expand Up @@ -211,14 +211,14 @@ func TestOperator_GetEncodedConfigItem(t *testing.T) {
success: true,
o: mockOperator(existValidConfigPath, validConfig),
key: "backends.pre.configs.port",
expectedVal: "6443",
expectedVal: "3306",
},
{
name: "get encoding config item successfully type map",
success: true,
o: mockOperator(existValidConfigPath, validConfig),
key: "backends.pre",
expectedVal: `{"configs":{"dbName":"kk","host":"127.0.0.1","port":6443,"user":"kusion"},"type":"mysql"}`,
expectedVal: `{"configs":{"dbName":"kusion","host":"127.0.0.1","port":3306,"user":"kk"},"type":"mysql"}`,
},
}

Expand Down Expand Up @@ -265,14 +265,14 @@ func TestOperator_SetConfigItem(t *testing.T) {
},
}),
key: "backends.pre.configs.port",
val: 6443,
val: 3306,
expectedConfig: &v1.Config{
Backends: &v1.BackendConfigs{
Backends: map[string]*v1.BackendConfig{
"pre": {
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
},
Expand All @@ -287,10 +287,10 @@ func TestOperator_SetConfigItem(t *testing.T) {
val: &v1.BackendConfig{
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk-is-tired",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk-tired",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
expectedConfig: &v1.Config{
Expand All @@ -303,10 +303,10 @@ func TestOperator_SetConfigItem(t *testing.T) {
"pre": {
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk-is-tired",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk-tired",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
"prod": {
Expand All @@ -325,7 +325,7 @@ func TestOperator_SetConfigItem(t *testing.T) {
o: mockOperator(existValidConfigPath, validConfig),
key: "backends.prod.configs",
val: map[string]any{
v1.BackendGenericOssBucket: "kk-is-so-tired",
v1.BackendGenericOssBucket: "kk-so-tired",
},
expectedConfig: &v1.Config{
Backends: &v1.BackendConfigs{
Expand All @@ -337,16 +337,16 @@ func TestOperator_SetConfigItem(t *testing.T) {
"pre": {
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
"prod": {
Type: v1.BackendTypeS3,
Configs: map[string]any{
v1.BackendGenericOssBucket: "kk-is-so-tired",
v1.BackendGenericOssBucket: "kk-so-tired",
},
},
},
Expand Down Expand Up @@ -424,14 +424,14 @@ func TestOperator_setEncodedConfigItem(t *testing.T) {
},
}),
key: "backends.pre.configs.port",
val: "6443",
val: "3306",
expectedConfig: &v1.Config{
Backends: &v1.BackendConfigs{
Backends: map[string]*v1.BackendConfig{
"pre": {
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
},
Expand All @@ -443,7 +443,7 @@ func TestOperator_setEncodedConfigItem(t *testing.T) {
success: true,
o: mockOperator(existValidConfigPath, validConfig),
key: "backends.pre",
val: `{"configs":{"dbName":"kk-is-tired","host":"127.0.0.1","port":6443,"user":"kusion"},"type":"mysql"}`,
val: `{"configs":{"dbName":"kusion","host":"127.0.0.1","port":3306,"user":"kk-tired"},"type":"mysql"}`,
expectedConfig: &v1.Config{
Backends: &v1.BackendConfigs{
Current: "dev",
Expand All @@ -454,10 +454,10 @@ func TestOperator_setEncodedConfigItem(t *testing.T) {
"pre": {
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk-is-tired",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk-tired",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
"prod": {
Expand All @@ -475,7 +475,7 @@ func TestOperator_setEncodedConfigItem(t *testing.T) {
success: true,
o: mockOperator(existValidConfigPath, validConfig),
key: "backends.prod.configs",
val: `{"bucket": "kk-is-so-tired"}`,
val: `{"bucket":"kusion","region":"us-east-1"}`,
expectedConfig: &v1.Config{
Backends: &v1.BackendConfigs{
Current: "dev",
Expand All @@ -486,16 +486,17 @@ func TestOperator_setEncodedConfigItem(t *testing.T) {
"pre": {
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
"prod": {
Type: v1.BackendTypeS3,
Configs: map[string]any{
v1.BackendGenericOssBucket: "kk-is-so-tired",
v1.BackendGenericOssBucket: "kusion",
v1.BackendS3Region: "us-east-1",
},
},
},
Expand Down Expand Up @@ -687,8 +688,8 @@ func TestParseStructuredConfigItem(t *testing.T) {
name: "parse structured config item successfully int",
success: true,
info: registeredItems["backends.*.configs.port"],
strVal: "6443",
val: 6443,
strVal: "3306",
val: 3306,
},
{
name: "parse structured config item successfully bool",
Expand All @@ -701,29 +702,29 @@ func TestParseStructuredConfigItem(t *testing.T) {
name: "parse structured config item successfully struct ptr",
success: true,
info: registeredItems["backends.*"],
strVal: `{"configs":{"dbName":"kk","host":"127.0.0.1","port":6443,"user":"kusion"},"type":"mysql"}`,
strVal: `{"configs":{"dbName":"kusion","host":"127.0.0.1","port":3306,"user":"kk"},"type":"mysql"}`,
val: &v1.BackendConfig{
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
},
{
name: "parse structured config item successfully struct",
success: true,
info: &itemInfo{v1.BackendConfig{}, nil, nil},
strVal: `{"configs":{"dbName":"kk","host":"127.0.0.1","port":6443,"user":"kusion"},"type":"mysql"}`,
strVal: `{"configs":{"dbName":"kusion","host":"127.0.0.1","port":3306,"user":"kk"},"type":"mysql"}`,
val: v1.BackendConfig{
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
},
Expand Down Expand Up @@ -856,7 +857,7 @@ func TestGetItemFromCfgMap(t *testing.T) {
success: true,
cfg: validCfg,
key: "backends.pre.configs.port",
expectedVal: 6443,
expectedVal: 3306,
},
{
name: "get item from config map successfully type map",
Expand Down Expand Up @@ -981,13 +982,13 @@ func TestSetItemFromCfgMap(t *testing.T) {
},
},
key: "backends.pre.configs.port",
val: 6443,
val: 3306,
expectedCfg: map[string]any{
"backends": map[string]any{
"pre": map[string]any{
"type": "mysql",
"configs": map[string]any{
"port": 6443,
"port": 3306,
"dbName": "kusion",
},
},
Expand All @@ -1002,21 +1003,21 @@ func TestSetItemFromCfgMap(t *testing.T) {
val: &v1.BackendConfig{
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
expectedCfg: map[string]any{
"backends": map[string]any{
"pre": &v1.BackendConfig{
Type: v1.BackendTypeMysql,
Configs: map[string]any{
v1.BackendMysqlDBName: "kk",
v1.BackendMysqlUser: "kusion",
v1.BackendMysqlDBName: "kusion",
v1.BackendMysqlUser: "kk",
v1.BackendMysqlHost: "127.0.0.1",
v1.BackendMysqlPort: 6443,
v1.BackendMysqlPort: 3306,
},
},
},
Expand Down