Merge pull request #50 from KusionStack/dayuan

engine: upgrade manifest to spec

go.mod

@@ -40,8 +40,6 @@ require (
 	github.com/mattn/go-colorable v0.1.11 // indirect
 	github.com/mitchellh/go-wordwrap v1.0.1 // indirect
 	github.com/mitchellh/hashstructure v1.0.0
-	github.com/onsi/ginkgo v1.14.1
-	github.com/onsi/gomega v1.10.2
 	github.com/pkg/errors v0.9.1
 	github.com/pterm/pterm v0.12.41
 	github.com/pulumi/pulumi/sdk/v3 v3.24.0

pkg/compile/compile.go

@@ -16,7 +16,7 @@ import (
 
 	"kusionstack.io/kusion/pkg/compile/rest"
 	"kusionstack.io/kusion/pkg/engine"
-	"kusionstack.io/kusion/pkg/engine/manifest"
+	"kusionstack.io/kusion/pkg/engine/models"
 	"kusionstack.io/kusion/pkg/log"
 	"kusionstack.io/kusion/pkg/projectstack"
 	jsonUtil "kusionstack.io/kusion/pkg/util/json"
@@ -40,7 +40,7 @@ func EnableRPC() bool {
 
 func CompileWithSpinner(workDir string, filenames, settings, arguments, overrides []string,
 	stack *projectstack.Stack,
-) (*manifest.Manifest, *pterm.SpinnerPrinter, error) {
+) (*models.Spec, *pterm.SpinnerPrinter, error) {
 	// Spinner
 	sp := &pretty.SpinnerT
 

pkg/engine/kcl.go

@@ -9,16 +9,15 @@ import (
 	"github.com/pkg/errors"
 	kcl "kusionstack.io/kclvm-go"
 
-	"kusionstack.io/kusion/pkg/engine/manifest"
-	"kusionstack.io/kusion/pkg/engine/states"
+	"kusionstack.io/kusion/pkg/engine/models"
 	"kusionstack.io/kusion/pkg/log"
 	jsonUtil "kusionstack.io/kusion/pkg/util/json"
 )
 
 const MaxLogLength = 3751
 
-func ConvertKCLResult2Resources(resourceYAMLs []kcl.KCLResult) (*manifest.Manifest, error) {
-	resources := []states.ResourceState{}
+func ConvertKCLResult2Resources(resourceYAMLs []kcl.KCLResult) (*models.Spec, error) {
+	resources := []models.Resource{}
 
 	for _, resourcesYamlMap := range resourceYAMLs {
 		// Convert kcl result to yaml string
@@ -37,7 +36,7 @@ func ConvertKCLResult2Resources(resourceYAMLs []kcl.KCLResult) (*manifest.Manife
 		}
 
 		// Parse yaml string as Resource
-		item := &states.ResourceState{}
+		item := &models.Resource{}
 		err = yamlv3.Unmarshal(yamlByte, item)
 		if err != nil {
 			return nil, err
@@ -54,5 +53,5 @@ func ConvertKCLResult2Resources(resourceYAMLs []kcl.KCLResult) (*manifest.Manife
 		resources = append(resources, *item)
 	}
 
-	return &manifest.Manifest{Resources: resources}, nil
+	return &models.Spec{Resources: resources}, nil
 }

pkg/engine/models/resource.go

@@ -0,0 +1,45 @@
+package models
+
+type Type string
+
+type Resources []Resource
+
+type Resource struct {
+	// ID is the unique key of this resource in the whole State. ApiVersion:Kind:Namespace:Name is an idiomatic way of Kubernetes resources.
+	ID string `json:"id"`
+
+	// Type represents all Runtimes we supported
+	Type Type `json:"type"`
+
+	// Attributes represents all specified attributes of this resource
+	Attributes map[string]interface{} `json:"attributes"`
+
+	// DependsOn contains all resources this resource depends on
+	DependsOn []string `json:"dependsOn,omitempty" yaml:"dependsOn,omitempty"`
+
+	// Extensions specifies arbitrary metadata of this resource
+	Extensions map[string]interface{} `json:"extensions"`
+}
+
+func (r *Resource) ResourceKey() string {
+	return r.ID
+}
+
+func (rs Resources) Index() map[string]*Resource {
+	m := make(map[string]*Resource)
+	for i := range rs {
+		m[rs[i].ResourceKey()] = &rs[i]
+	}
+	return m
+}
+
+func (rs Resources) Len() int      { return len(rs) }
+func (rs Resources) Swap(i, j int) { rs[i], rs[j] = rs[j], rs[i] }
+func (rs Resources) Less(i, j int) bool {
+	switch {
+	case rs[i].ID != rs[j].ID:
+		return rs[i].ID < rs[j].ID
+	default:
+		return false
+	}
+}

pkg/engine/models/spec.go

@@ -0,0 +1,6 @@
+package models
+
+// Spec represent the KCL compile result
+type Spec struct {
+	Resources Resources `json:"resources"`
+}

pkg/engine/operation/apply.go

@@ -8,7 +8,7 @@ import (
 	"github.com/hashicorp/terraform/dag"
 	"github.com/hashicorp/terraform/tfdiags"
 
-	"kusionstack.io/kusion/pkg/engine/manifest"
+	"kusionstack.io/kusion/pkg/engine/models"
 	"kusionstack.io/kusion/pkg/engine/states"
 	"kusionstack.io/kusion/pkg/log"
 	"kusionstack.io/kusion/pkg/status"
@@ -26,7 +26,7 @@ type ApplyResponse struct {
 	State *states.State
 }
 
-func NewApplyGraph(m *manifest.Manifest, priorState *states.State) (*dag.AcyclicGraph, status.Status) {
+func NewApplyGraph(m *models.Spec, priorState *states.State) (*dag.AcyclicGraph, status.Status) {
 	manifestParser := NewManifestParser(m)
 	graph := &dag.AcyclicGraph{}
 	graph.Add(&RootNode{})
@@ -83,7 +83,7 @@ func (o *Operation) Apply(request *ApplyRequest) (rsp *ApplyResponse, st status.
 		Operation: Operation{
 			OperationType:           Apply,
 			StateStorage:            o.StateStorage,
-			CtxResourceIndex:        map[string]*states.ResourceState{},
+			CtxResourceIndex:        map[string]*models.Resource{},
 			PriorStateResourceIndex: priorStateResourceIndex,
 			StateResourceIndex:      priorStateResourceIndex,
 			Runtime:                 o.Runtime,
@@ -155,7 +155,7 @@ func validateRequest(request *Request) status.Status {
 	}
 	if request.Manifest == nil {
 		return status.NewErrorStatusWithMsg(status.InvalidArgument,
-			"request.Manifest is empty. If you want to delete all resources, please use command 'destroy'")
+			"request.Spec is empty. If you want to delete all resources, please use command 'destroy'")
 	}
 	resourceKeyMap := make(map[string]bool)
 

pkg/engine/operation/apply_test.go

@@ -13,7 +13,7 @@ import (
 	_ "github.com/go-sql-driver/mysql"
 	"github.com/stretchr/testify/assert"
 
-	"kusionstack.io/kusion/pkg/engine/manifest"
+	"kusionstack.io/kusion/pkg/engine/models"
 	"kusionstack.io/kusion/pkg/engine/runtime"
 	"kusionstack.io/kusion/pkg/engine/states"
 	"kusionstack.io/kusion/pkg/status"
@@ -34,13 +34,13 @@ func Test_validateRequest(t *testing.T) {
 				request: &Request{},
 			},
 			want: status.NewErrorStatusWithMsg(status.InvalidArgument,
-				"request.Manifest is empty. If you want to delete all resources, please use command 'destroy'"),
+				"request.Spec is empty. If you want to delete all resources, please use command 'destroy'"),
 		},
 		{
 			name: "t2",
 			args: args{
 				request: &Request{
-					Manifest: &manifest.Manifest{Resources: []states.ResourceState{}},
+					Manifest: &models.Spec{Resources: []models.Resource{}},
 				},
 			},
 			want: nil,
@@ -59,9 +59,9 @@ func TestOperation_Apply(t *testing.T) {
 	type fields struct {
 		OperationType           Type
 		StateStorage            states.StateStorage
-		CtxResourceIndex        map[string]*states.ResourceState
-		PriorStateResourceIndex map[string]*states.ResourceState
-		StateResourceIndex      map[string]*states.ResourceState
+		CtxResourceIndex        map[string]*models.Resource
+		PriorStateResourceIndex map[string]*models.Resource
+		StateResourceIndex      map[string]*models.Resource
 		Order                   *ChangeOrder
 		Runtime                 runtime.Runtime
 		MsgCh                   chan Message
@@ -73,10 +73,9 @@ func TestOperation_Apply(t *testing.T) {
 	}
 
 	const Jack = "jack"
-	mf := &manifest.Manifest{Resources: []states.ResourceState{
+	mf := &models.Spec{Resources: []models.Resource{
 		{
-			ID:   Jack,
-			Mode: states.Managed,
+			ID: Jack,
 			Attributes: map[string]interface{}{
 				"a": "b",
 			},
@@ -93,10 +92,9 @@ func TestOperation_Apply(t *testing.T) {
 		KusionVersion: "",
 		Serial:        1,
 		Operator:      "faker",
-		Resources: []states.ResourceState{
+		Resources: []models.Resource{
 			{
-				ID:   Jack,
-				Mode: states.Managed,
+				ID: Jack,
 				Attributes: map[string]interface{}{
 					"a": "b",
 				},

pkg/engine/operation/change.go

@@ -5,10 +5,11 @@ import (
 	"fmt"
 	"strings"
 
+	"kusionstack.io/kusion/pkg/engine/models"
+
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/pterm/pterm"
 
-	"kusionstack.io/kusion/pkg/engine/states"
 	"kusionstack.io/kusion/pkg/log"
 	"kusionstack.io/kusion/pkg/projectstack"
 	"kusionstack.io/kusion/pkg/util/diff"
@@ -219,8 +220,8 @@ func (o *ChangeOrder) OutputDiff(target string) {
 	}
 }
 
-func buildResourceStateMap(rs []*states.ResourceState) map[string]*states.ResourceState {
-	rMap := make(map[string]*states.ResourceState)
+func buildResourceStateMap(rs []*models.Resource) map[string]*models.Resource {
+	rMap := make(map[string]*models.Resource)
 	if len(rs) == 0 {
 		return rMap
 	}

pkg/engine/operation/change_test.go

@@ -4,7 +4,8 @@ import (
 	"reflect"
 	"testing"
 
-	"kusionstack.io/kusion/pkg/engine/states"
+	"kusionstack.io/kusion/pkg/engine/models"
+
 	"kusionstack.io/kusion/pkg/projectstack"
 	"kusionstack.io/kusion/pkg/util/pretty"
 )
@@ -492,19 +493,19 @@ func TestChanges_Preview(t *testing.T) {
 
 func Test_buildResourceStateMap(t *testing.T) {
 	type args struct {
-		rs []*states.ResourceState
+		rs []*models.Resource
 	}
 	tests := []struct {
 		name string
 		args args
-		want map[string]*states.ResourceState
+		want map[string]*models.Resource
 	}{
 		{
 			name: "t1",
 			args: args{
-				rs: []*states.ResourceState{},
+				rs: []*models.Resource{},
 			},
-			want: map[string]*states.ResourceState{},
+			want: map[string]*models.Resource{},
 		},
 	}
 	for _, tt := range tests {

pkg/engine/operation/delete_resource_parser.go

@@ -3,7 +3,8 @@ package operation
 import (
 	"fmt"
 
-	"kusionstack.io/kusion/pkg/engine/states"
+	"kusionstack.io/kusion/pkg/engine/models"
+
 	"kusionstack.io/kusion/pkg/log"
 	"kusionstack.io/kusion/pkg/status"
 	"kusionstack.io/kusion/pkg/util"
@@ -13,10 +14,10 @@ import (
 )
 
 type DeleteResourceParser struct {
-	resources states.Resources
+	resources models.Resources
 }
 
-func NewDeleteResourceParser(resources states.Resources) *DeleteResourceParser {
+func NewDeleteResourceParser(resources models.Resources) *DeleteResourceParser {
 	return &DeleteResourceParser{resources: resources}
 }
 
@@ -52,7 +53,7 @@ func (d *DeleteResourceParser) Parse(graph *dag.AcyclicGraph) (s status.Status)
 		rnID := rn.Hashcode().(string)
 
 		if !graph.HasVertex(rn) && manifestGraphMap[rnID] == nil {
-			log.Infof("resource:%v not found in manifest. Mark as delete node", key)
+			log.Infof("resource:%v not found in models. Mark as delete node", key)
 			// we cannot delete this node if any node dependsOn this node
 			for _, v := range priorDependsOn[rnID] {
 				if manifestGraphMap[v] != nil {
@@ -72,7 +73,7 @@ func (d *DeleteResourceParser) Parse(graph *dag.AcyclicGraph) (s status.Status)
 		}
 	}
 	if err = graph.Validate(); err != nil {
-		return status.NewErrorStatusWithMsg(status.IllegalManifest, "Found circle dependency in manifest."+err.Error())
+		return status.NewErrorStatusWithMsg(status.IllegalManifest, "Found circle dependency in models."+err.Error())
 	}
 	graph.TransitiveReduction()
 	return s

pkg/engine/operation/delete_resource_parser_test.go

@@ -4,44 +4,44 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/hashicorp/terraform/dag"
+	"kusionstack.io/kusion/pkg/engine/models"
 
-	"kusionstack.io/kusion/pkg/engine/states"
+	"github.com/hashicorp/terraform/dag"
 )
 
 func TestDeleteResourceParser_Parse(t *testing.T) {
 	const VPC = "vpc"
 	const VSwitch = "vswitch"
 	const VSecutiry = "vsecurity"
 	const Instance = "instance"
-	resources := []states.ResourceState{
+	resources := []models.Resource{
 		{
-			ID:   VPC,
-			Mode: states.Managed,
+			ID: VPC,
+
 			Attributes: map[string]interface{}{
 				"c": "d",
 			},
 			DependsOn: nil,
 		},
 		{
-			ID:   VSwitch,
-			Mode: states.Managed,
+			ID: VSwitch,
+
 			Attributes: map[string]interface{}{
 				"a": "c",
 			},
 			DependsOn: []string{VPC},
 		},
 		{
-			ID:   VSecutiry,
-			Mode: states.Managed,
+			ID: VSecutiry,
+
 			Attributes: map[string]interface{}{
 				"a": "b",
 			},
 			DependsOn: []string{VSwitch},
 		},
 		{
-			ID:   Instance,
-			Mode: states.Managed,
+			ID: Instance,
+
 			Attributes: map[string]interface{}{
 				"a": "b",
 			},