feat: add configs in the workspace mod definition

KusionStack · Apr 24, 2024 · 28c395d · 28c395d
1 parent e77a5fd
commit 28c395d
Show file tree

Hide file tree

Showing 12 changed files with 314 additions and 240 deletions.
diff --git a/pkg/apis/api.kusion.io/v1/types.go b/pkg/apis/api.kusion.io/v1/types.go
@@ -96,7 +96,6 @@ type Workspace struct {
 }
 
 // ModuleConfigs is a set of multiple ModuleConfig, whose key is the module name.
-// The module name format is "source@version".
 type ModuleConfigs map[string]*ModuleConfig
 
 // GenericConfig is a generic model to describe config which shields the difference among multiple concrete
@@ -113,9 +112,11 @@ type GenericConfig map[string]any
 // in multiple patchers is not allowed. For a project, if not specified in the patcher block's
 // "projectSelector" field, the default config will be used.
 //
-// Take the ModuleConfig of "database" for an example, which is shown as below:
+// Take the ModuleConfig of "mysql" for an example, which is shown as below:
 //
-//	 config := ModuleConfig {
+//	config := ModuleConfig {
+//		"path": "ghcr.io/kusionstack/mysql"
+//		"version": "0.1.0"
 //		"default": {
 //			"type":         "aws",
 //			"version":      "5.7",
@@ -127,9 +128,17 @@ type GenericConfig map[string]any
 //		},
 //	}
 type ModuleConfig struct {
+	// Path is the path of the module. It can be a local path or a remote URL
+	Path string `yaml:"path" json:"path"`
+	// Version is the version of the module.
+	Version string `yaml:"version" json:"version"`
+	// Configs contains all levels of module configs
+	Configs Configs `yaml:"configs" json:"configs"`
+}
+
+type Configs struct {
 	// Default is default block of the module config.
 	Default GenericConfig `yaml:"default" json:"default"`
-
 	// ModulePatcherConfigs are the patcher blocks of the module config.
 	ModulePatcherConfigs `yaml:",inline,omitempty" json:",inline,omitempty"`
 }

diff --git a/pkg/cmd/workspace/util/testdata/valid_ws.yaml b/pkg/cmd/workspace/util/testdata/valid_ws.yaml
@@ -1,17 +1,21 @@
 modules:
-  database:
-    default:
-      instanceType: db.t3.micro
-      type: aws
-      version: "5.7"
-    smallClass:
-      projectSelector:
-        - foo
-        - bar
-      instanceType: db.t3.small
-  port:
-    default:
-      type: aws
+  mysql:
+    path: ghcr.io/kusionstack/mysql
+    version: 0.1.0
+    configs:
+      default:
+        instanceType: db.t3.micro
+        type: aws
+        version: '5.7'
+      smallClass:
+        projectSelector:
+          - foo
+          - bar
+        instanceType: db.t3.small
+  network:
+    configs:
+      default:
+        type: aws
 runtimes:
   kubernetes:
     kubeConfig: /etc/kubeconfig.yaml

diff --git a/pkg/modules/generators/app_configurations_generator_test.go b/pkg/modules/generators/app_configurations_generator_test.go
@@ -184,29 +184,37 @@ func buildMockWorkspace(namespace string) *v1.Workspace {
 	return &v1.Workspace{
 		Name: "test",
 		Modules: v1.ModuleConfigs{
-			"kusionstack/database@v0.1": {
-				Default: v1.GenericConfig{
-					"type":         "aws",
-					"version":      "5.7",
-					"instanceType": "db.t3.micro",
-				},
-				ModulePatcherConfigs: v1.ModulePatcherConfigs{
-					"smallClass": {
-						GenericConfig: v1.GenericConfig{
-							"instanceType": "db.t3.small",
+			"mysql": &v1.ModuleConfig{
+				Path:    "kusionstack.io/mysql",
+				Version: "v1.0.0",
+				Configs: v1.Configs{
+					Default: v1.GenericConfig{
+						"type":         "aws",
+						"version":      "5.7",
+						"instanceType": "db.t3.micro",
+					},
+					ModulePatcherConfigs: v1.ModulePatcherConfigs{
+						"smallClass": {
+							GenericConfig: v1.GenericConfig{
+								"instanceType": "db.t3.small",
+							},
+							ProjectSelector: []string{"foo", "bar"},
 						},
-						ProjectSelector: []string{"foo", "bar"},
 					},
 				},
 			},
-			"port": {
-				Default: v1.GenericConfig{
-					"type": "aws",
+			"port": &v1.ModuleConfig{
+				Configs: v1.Configs{
+					Default: v1.GenericConfig{
+						"type": "aws",
+					},
 				},
 			},
-			"namespace": {
-				Default: v1.GenericConfig{
-					"name": namespace,
+			"namespace": &v1.ModuleConfig{
+				Configs: v1.Configs{
+					Default: v1.GenericConfig{
+						"name": namespace,
+					},
 				},
 			},
 		},

diff --git a/pkg/workspace/storages/local_test.go b/pkg/workspace/storages/local_test.go
@@ -19,24 +19,30 @@ func mockWorkspace(name string) *v1.Workspace {
 	return &v1.Workspace{
 		Name: name,
 		Modules: map[string]*v1.ModuleConfig{
-			"database": {
-				Default: v1.GenericConfig{
-					"type":         "aws",
-					"version":      "5.7",
-					"instanceType": "db.t3.micro",
-				},
-				ModulePatcherConfigs: v1.ModulePatcherConfigs{
-					"smallClass": {
-						GenericConfig: v1.GenericConfig{
-							"instanceType": "db.t3.small",
+			"mysql": {
+				Path:    "ghcr.io/kusionstack/mysql",
+				Version: "0.1.0",
+				Configs: v1.Configs{
+					Default: v1.GenericConfig{
+						"type":         "aws",
+						"version":      "5.7",
+						"instanceType": "db.t3.micro",
+					},
+					ModulePatcherConfigs: v1.ModulePatcherConfigs{
+						"smallClass": {
+							GenericConfig: v1.GenericConfig{
+								"instanceType": "db.t3.small",
+							},
+							ProjectSelector: []string{"foo", "bar"},
 						},
-						ProjectSelector: []string{"foo", "bar"},
 					},
 				},
 			},
-			"port": {
-				Default: v1.GenericConfig{
-					"type": "aws",
+			"network": {
+				Configs: v1.Configs{
+					Default: v1.GenericConfig{
+						"type": "aws",
+					},
 				},
 			},
 		},
@@ -60,27 +66,31 @@ func mockWorkspace(name string) *v1.Workspace {
 func mockWorkspaceContent() string {
 	return `
 modules:
-    database:
-        default:
-            instanceType: db.t3.micro
-            type: aws
-            version: "5.7"
-        smallClass:
-            projectSelector:
-                - foo
-                - bar
-            instanceType: db.t3.small
-    port:
-        default:
-            type: aws
+  mysql:
+    path: ghcr.io/kusionstack/mysql
+    version: 0.1.0
+    configs:
+      default:
+        instanceType: db.t3.micro
+        type: aws
+        version: '5.7'
+      smallClass:
+        projectSelector:
+          - foo
+          - bar
+        instanceType: db.t3.small
+  network:
+    configs:
+      default:
+        type: aws
 runtimes:
-    kubernetes:
-        kubeConfig: /etc/kubeconfig.yaml
-    terraform:
-        aws:
-            source: hashicorp/aws
-            version: 1.0.4
-            region: us-east-1
+  kubernetes:
+    kubeConfig: /etc/kubeconfig.yaml
+  terraform:
+    aws:
+      source: hashicorp/aws
+      version: 1.0.4
+      region: us-east-1
 `
 }
 

diff --git a/pkg/workspace/storages/testdata/for_delete_workspaces/dev.yaml b/pkg/workspace/storages/testdata/for_delete_workspaces/dev.yaml
@@ -1,17 +1,23 @@
 modules:
-    database:
-        default:
-            instanceType: db.t3.micro
-            type: aws
-            version: "5.7"
-        smallClass:
-            projectSelector:
-                - foo
-                - bar
-            instanceType: db.t3.small
-    port:
-        default:
-            type: aws
+    mysql:
+        path: ghcr.io/kusionstack/mysql
+        version: 0.1.0
+        configs:
+            default:
+                instanceType: db.t3.micro
+                type: aws
+                version: "5.7"
+            smallClass:
+                projectSelector:
+                    - foo
+                    - bar
+                instanceType: db.t3.small
+    network:
+        path: ""
+        version: ""
+        configs:
+            default:
+                type: aws
 runtimes:
     kubernetes:
         kubeConfig: /etc/kubeconfig.yaml

diff --git a/pkg/workspace/storages/testdata/for_set_current_workspaces/dev.yaml b/pkg/workspace/storages/testdata/for_set_current_workspaces/dev.yaml
@@ -1,22 +1,26 @@
 modules:
-    database:
-        default:
-            instanceType: db.t3.micro
-            type: aws
-            version: "5.7"
-        smallClass:
-            projectSelector:
-                - foo
-                - bar
-            instanceType: db.t3.small
-    port:
-        default:
-            type: aws
+  mysql:
+    path: ghcr.io/kusionstack/mysql
+    version: 0.1.0
+    configs:
+      default:
+        instanceType: db.t3.micro
+        type: aws
+        version: '5.7'
+      smallClass:
+        projectSelector:
+          - foo
+          - bar
+        instanceType: db.t3.small
+  network:
+    configs:
+      default:
+        type: aws
 runtimes:
-    kubernetes:
-        kubeConfig: /etc/kubeconfig.yaml
-    terraform:
-        aws:
-            source: hashicorp/aws
-            version: 1.0.4
-            region: us-east-1
+  kubernetes:
+    kubeConfig: /etc/kubeconfig.yaml
+  terraform:
+    aws:
+      source: hashicorp/aws
+      version: 1.0.4
+      region: us-east-1
diff --git a/pkg/workspace/storages/testdata/workspaces/dev.yaml b/pkg/workspace/storages/testdata/workspaces/dev.yaml
@@ -1,22 +1,26 @@
 modules:
-    database:
-        default:
-            instanceType: db.t3.micro
-            type: aws
-            version: "5.7"
-        smallClass:
-            projectSelector:
-                - foo
-                - bar
-            instanceType: db.t3.small
-    port:
-        default:
-            type: aws
+  mysql:
+    path: ghcr.io/kusionstack/mysql
+    version: 0.1.0
+    configs:
+      default:
+        instanceType: db.t3.micro
+        type: aws
+        version: '5.7'
+      smallClass:
+        projectSelector:
+          - foo
+          - bar
+        instanceType: db.t3.small
+  network:
+    configs:
+      default:
+        type: aws
 runtimes:
-    kubernetes:
-        kubeConfig: /etc/kubeconfig.yaml
-    terraform:
-        aws:
-            source: hashicorp/aws
-            version: 1.0.4
-            region: us-east-1
+  kubernetes:
+    kubeConfig: /etc/kubeconfig.yaml
+  terraform:
+    aws:
+      source: hashicorp/aws
+      version: 1.0.4
+      region: us-east-1