feat: state backend using workspace, and upgrade of state (#669)

KusionStack · Dec 14, 2023 · 1dd8aa2 · 1dd8aa2
1 parent efa145e
commit 1dd8aa2
Show file tree

Hide file tree

Showing 40 changed files with 1,258 additions and 430 deletions.
diff --git a/pkg/apis/project/types.go b/pkg/apis/project/types.go
@@ -7,7 +7,6 @@ import (
 	"github.com/pterm/pterm"
 
 	"kusionstack.io/kusion/pkg/apis/stack"
-	"kusionstack.io/kusion/pkg/engine/backend"
 	"kusionstack.io/kusion/pkg/log"
 )
 
@@ -50,9 +49,6 @@ type Configuration struct {
 	// Tenant name
 	Tenant string `json:"tenant,omitempty" yaml:"tenant,omitempty"`
 
-	// Backend storage config
-	Backend *backend.Storage `json:"backend,omitempty" yaml:"backend,omitempty"`
-
 	// SpecGenerator configs
 	Generator *GeneratorConfig `json:"generator,omitempty" yaml:"generator,omitempty"`
 

diff --git a/pkg/cmd/apply/options.go b/pkg/cmd/apply/options.go
@@ -91,8 +91,8 @@ func (o *Options) Run() error {
 		return nil
 	}
 
-	// Get state storage from backend config to manage state
-	stateStorage, err := backend.BackendFromConfig(project.Backend, o.BackendOps, o.WorkDir)
+	// Get state storage from cli backend options, environment variables, workspace backend configs
+	stateStorage, err := backend.NewStateStorage(stack, &o.BackendOptions)
 	if err != nil {
 		return err
 	}

diff --git a/pkg/cmd/apply/options_test.go b/pkg/cmd/apply/options_test.go
@@ -188,7 +188,7 @@ func newSA(name string) intent.Resource {
 }
 
 func Test_apply(t *testing.T) {
-	stateStorage := &local.FileSystemState{Path: filepath.Join("", local.KusionState)}
+	stateStorage := &local.FileSystemState{Path: filepath.Join("", local.KusionStateFileFile)}
 	mockey.PatchConvey("dry run", t, func() {
 		planResources := &intent.Intent{Resources: []intent.Resource{sa1}}
 		order := &opsmodels.ChangeOrder{

diff --git a/pkg/cmd/destroy/options.go b/pkg/cmd/destroy/options.go
@@ -28,7 +28,7 @@ type Options struct {
 	Operator string
 	Yes      bool
 	Detail   bool
-	backend.BackendOps
+	backend.BackendOptions
 }
 
 func NewDestroyOptions() *Options {
@@ -42,7 +42,15 @@ func (o *Options) Complete(args []string) {
 }
 
 func (o *Options) Validate() error {
-	return o.Options.Validate()
+	if err := o.Options.Validate(); err != nil {
+		return err
+	}
+	if !o.BackendOptions.IsEmpty() {
+		if err := o.BackendOptions.Validate(); err != nil {
+			return err
+		}
+	}
+	return nil
 }
 
 func (o *Options) Run() error {
@@ -54,8 +62,8 @@ func (o *Options) Run() error {
 		return err
 	}
 
-	// Get stateStorage from backend config to manage state
-	stateStorage, err := backend.BackendFromConfig(project.Backend, o.BackendOps, o.WorkDir)
+	// Get state storage from cli backend options, environment variables, workspace backend configs
+	stateStorage, err := backend.NewStateStorage(stack, &o.BackendOptions)
 	if err != nil {
 		return err
 	}

diff --git a/pkg/cmd/destroy/options_test.go b/pkg/cmd/destroy/options_test.go
@@ -100,7 +100,7 @@ func Test_preview(t *testing.T) {
 		mockOperationPreview()
 
 		o := NewDestroyOptions()
-		stateStorage := &local.FileSystemState{Path: filepath.Join(o.WorkDir, local.KusionState)}
+		stateStorage := &local.FileSystemState{Path: filepath.Join(o.WorkDir, local.KusionStateFileFile)}
 		_, err := o.preview(&intent.Intent{Resources: []intent.Resource{sa1}}, p, s, stateStorage)
 		assert.Nil(t, err)
 	})
@@ -217,7 +217,7 @@ func Test_destroy(t *testing.T) {
 		}
 		changes := opsmodels.NewChanges(p, s, order)
 
-		stateStorage := &local.FileSystemState{Path: filepath.Join(o.WorkDir, local.KusionState)}
+		stateStorage := &local.FileSystemState{Path: filepath.Join(o.WorkDir, local.KusionStateFileFile)}
 
 		err := o.destroy(planResources, changes, stateStorage)
 		assert.Nil(t, err)
@@ -239,7 +239,7 @@ func Test_destroy(t *testing.T) {
 			},
 		}
 		changes := opsmodels.NewChanges(p, s, order)
-		stateStorage := &local.FileSystemState{Path: filepath.Join(o.WorkDir, local.KusionState)}
+		stateStorage := &local.FileSystemState{Path: filepath.Join(o.WorkDir, local.KusionStateFileFile)}
 
 		err := o.destroy(planResources, changes, stateStorage)
 		assert.NotNil(t, err)

diff --git a/pkg/cmd/preview/options.go b/pkg/cmd/preview/options.go
@@ -29,7 +29,7 @@ const jsonOutput = "json"
 type Options struct {
 	build.Options
 	Flags
-	backend.BackendOps
+	backend.BackendOptions
 }
 
 type Flags struct {
@@ -62,6 +62,11 @@ func (o *Options) Validate() error {
 	if err := o.ValidateIntentFile(); err != nil {
 		return err
 	}
+	if !o.BackendOptions.IsEmpty() {
+		if err := o.BackendOptions.Validate(); err != nil {
+			return err
+		}
+	}
 	return nil
 }
 
@@ -152,8 +157,8 @@ func (o *Options) Run() error {
 		return nil
 	}
 
-	// Get state storage from backend config to manage state
-	stateStorage, err := backend.BackendFromConfig(project.Backend, o.BackendOps, o.WorkDir)
+	// Get state storage from cli backend options, environment variables, workspace backend configs
+	stateStorage, err := backend.NewStateStorage(stack, &o.BackendOptions)
 	if err != nil {
 		return err
 	}

diff --git a/pkg/cmd/preview/options_test.go b/pkg/cmd/preview/options_test.go
@@ -47,7 +47,7 @@ var (
 )
 
 func Test_preview(t *testing.T) {
-	stateStorage := &local.FileSystemState{Path: filepath.Join("", local.KusionState)}
+	stateStorage := &local.FileSystemState{Path: filepath.Join("", local.KusionStateFileFile)}
 	t.Run("preview success", func(t *testing.T) {
 		m := mockOperationPreview()
 		defer m.UnPatch()

diff --git a/pkg/engine/backend/backend.go b/pkg/engine/backend/backend.go