mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-02-02 10:35:08 -05:00
cli: cleanup terraform files when create fails (#2282)
This commit is contained in:
parent
b278b76df5
commit
9e79e2e0a1
@ -13,11 +13,12 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
|
|
||||||
"github.com/edgelesssys/constellation/v2/cli/internal/terraform"
|
"github.com/edgelesssys/constellation/v2/cli/internal/terraform"
|
||||||
|
"github.com/edgelesssys/constellation/v2/internal/constants"
|
||||||
)
|
)
|
||||||
|
|
||||||
// rollbacker does a rollback.
|
// rollbacker does a rollback.
|
||||||
type rollbacker interface {
|
type rollbacker interface {
|
||||||
rollback(ctx context.Context, logLevel terraform.LogLevel) error
|
rollback(ctx context.Context, w io.Writer, logLevel terraform.LogLevel) error
|
||||||
}
|
}
|
||||||
|
|
||||||
// rollbackOnError calls rollback on the rollbacker if the handed error is not nil,
|
// rollbackOnError calls rollback on the rollbacker if the handed error is not nil,
|
||||||
@ -28,7 +29,7 @@ func rollbackOnError(w io.Writer, onErr *error, roll rollbacker, logLevel terraf
|
|||||||
}
|
}
|
||||||
fmt.Fprintf(w, "An error occurred: %s\n", *onErr)
|
fmt.Fprintf(w, "An error occurred: %s\n", *onErr)
|
||||||
fmt.Fprintln(w, "Attempting to roll back.")
|
fmt.Fprintln(w, "Attempting to roll back.")
|
||||||
if err := roll.rollback(context.Background(), logLevel); err != nil {
|
if err := roll.rollback(context.Background(), w, logLevel); err != nil {
|
||||||
*onErr = errors.Join(*onErr, fmt.Errorf("on rollback: %w", err)) // TODO(katexochen): print the error, or return it?
|
*onErr = errors.Join(*onErr, fmt.Errorf("on rollback: %w", err)) // TODO(katexochen): print the error, or return it?
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@ -39,8 +40,10 @@ type rollbackerTerraform struct {
|
|||||||
client tfCommonClient
|
client tfCommonClient
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *rollbackerTerraform) rollback(ctx context.Context, logLevel terraform.LogLevel) error {
|
func (r *rollbackerTerraform) rollback(ctx context.Context, w io.Writer, logLevel terraform.LogLevel) error {
|
||||||
if err := r.client.Destroy(ctx, logLevel); err != nil {
|
if err := r.client.Destroy(ctx, logLevel); err != nil {
|
||||||
|
fmt.Fprintf(w, "Could not destroy the resources. Please delete the %q directory manually if no resources were created\n",
|
||||||
|
constants.TerraformWorkingDir)
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return r.client.CleanUpWorkspace()
|
return r.client.CleanUpWorkspace()
|
||||||
@ -52,11 +55,13 @@ type rollbackerQEMU struct {
|
|||||||
createdWorkspace bool
|
createdWorkspace bool
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *rollbackerQEMU) rollback(ctx context.Context, logLevel terraform.LogLevel) (retErr error) {
|
func (r *rollbackerQEMU) rollback(ctx context.Context, w io.Writer, logLevel terraform.LogLevel) (retErr error) {
|
||||||
if r.createdWorkspace {
|
if r.createdWorkspace {
|
||||||
retErr = r.client.Destroy(ctx, logLevel)
|
retErr = r.client.Destroy(ctx, logLevel)
|
||||||
}
|
}
|
||||||
if retErr := errors.Join(retErr, r.libvirt.Stop(ctx)); retErr != nil {
|
if retErr := errors.Join(retErr, r.libvirt.Stop(ctx)); retErr != nil {
|
||||||
|
fmt.Fprintf(w, "Could not destroy the resources. Please delete the %q directory manually if no resources were created\n",
|
||||||
|
constants.TerraformWorkingDir)
|
||||||
return retErr
|
return retErr
|
||||||
}
|
}
|
||||||
return r.client.CleanUpWorkspace()
|
return r.client.CleanUpWorkspace()
|
||||||
|
@ -7,6 +7,7 @@ SPDX-License-Identifier: AGPL-3.0-only
|
|||||||
package cloudcmd
|
package cloudcmd
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"testing"
|
"testing"
|
||||||
@ -20,18 +21,19 @@ func TestRollbackTerraform(t *testing.T) {
|
|||||||
|
|
||||||
testCases := map[string]struct {
|
testCases := map[string]struct {
|
||||||
tfClient *stubTerraformClient
|
tfClient *stubTerraformClient
|
||||||
wantErr bool
|
wantCleanupErr bool
|
||||||
|
wantDestroyErr bool
|
||||||
}{
|
}{
|
||||||
"success": {
|
"success": {
|
||||||
tfClient: &stubTerraformClient{},
|
tfClient: &stubTerraformClient{},
|
||||||
},
|
},
|
||||||
"destroy cluster error": {
|
"destroy cluster error": {
|
||||||
tfClient: &stubTerraformClient{destroyErr: someErr},
|
tfClient: &stubTerraformClient{destroyErr: someErr},
|
||||||
wantErr: true,
|
wantDestroyErr: true,
|
||||||
},
|
},
|
||||||
"clean up workspace error": {
|
"clean up workspace error": {
|
||||||
tfClient: &stubTerraformClient{cleanUpWorkspaceErr: someErr},
|
tfClient: &stubTerraformClient{cleanUpWorkspaceErr: someErr},
|
||||||
wantErr: true,
|
wantCleanupErr: true,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -43,14 +45,20 @@ func TestRollbackTerraform(t *testing.T) {
|
|||||||
client: tc.tfClient,
|
client: tc.tfClient,
|
||||||
}
|
}
|
||||||
|
|
||||||
err := rollbacker.rollback(context.Background(), terraform.LogLevelNone)
|
destroyClusterErrOutput := &bytes.Buffer{}
|
||||||
if tc.wantErr {
|
err := rollbacker.rollback(context.Background(), destroyClusterErrOutput, terraform.LogLevelNone)
|
||||||
|
if tc.wantCleanupErr {
|
||||||
assert.Error(err)
|
assert.Error(err)
|
||||||
if tc.tfClient.cleanUpWorkspaceErr == nil {
|
if tc.tfClient.cleanUpWorkspaceErr == nil {
|
||||||
assert.False(tc.tfClient.cleanUpWorkspaceCalled)
|
assert.False(tc.tfClient.cleanUpWorkspaceCalled)
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
if tc.wantDestroyErr {
|
||||||
|
assert.Error(err)
|
||||||
|
assert.Equal("Could not destroy the resources. Please delete the \"constellation-terraform\" directory manually if no resources were created\n", destroyClusterErrOutput.String())
|
||||||
|
return
|
||||||
|
}
|
||||||
assert.NoError(err)
|
assert.NoError(err)
|
||||||
assert.True(tc.tfClient.destroyCalled)
|
assert.True(tc.tfClient.destroyCalled)
|
||||||
assert.True(tc.tfClient.cleanUpWorkspaceCalled)
|
assert.True(tc.tfClient.cleanUpWorkspaceCalled)
|
||||||
@ -65,6 +73,7 @@ func TestRollbackQEMU(t *testing.T) {
|
|||||||
libvirt *stubLibvirtRunner
|
libvirt *stubLibvirtRunner
|
||||||
tfClient *stubTerraformClient
|
tfClient *stubTerraformClient
|
||||||
createdWorkspace bool
|
createdWorkspace bool
|
||||||
|
wantDestroyErr bool
|
||||||
wantErr bool
|
wantErr bool
|
||||||
}{
|
}{
|
||||||
"success": {
|
"success": {
|
||||||
@ -80,7 +89,7 @@ func TestRollbackQEMU(t *testing.T) {
|
|||||||
"destroy cluster error": {
|
"destroy cluster error": {
|
||||||
libvirt: &stubLibvirtRunner{stopErr: someErr},
|
libvirt: &stubLibvirtRunner{stopErr: someErr},
|
||||||
tfClient: &stubTerraformClient{destroyErr: someErr},
|
tfClient: &stubTerraformClient{destroyErr: someErr},
|
||||||
wantErr: true,
|
wantDestroyErr: true,
|
||||||
},
|
},
|
||||||
"clean up workspace error": {
|
"clean up workspace error": {
|
||||||
libvirt: &stubLibvirtRunner{},
|
libvirt: &stubLibvirtRunner{},
|
||||||
@ -99,7 +108,9 @@ func TestRollbackQEMU(t *testing.T) {
|
|||||||
createdWorkspace: tc.createdWorkspace,
|
createdWorkspace: tc.createdWorkspace,
|
||||||
}
|
}
|
||||||
|
|
||||||
err := rollbacker.rollback(context.Background(), terraform.LogLevelNone)
|
destroyClusterErrOutput := &bytes.Buffer{}
|
||||||
|
|
||||||
|
err := rollbacker.rollback(context.Background(), destroyClusterErrOutput, terraform.LogLevelNone)
|
||||||
if tc.wantErr {
|
if tc.wantErr {
|
||||||
assert.Error(err)
|
assert.Error(err)
|
||||||
if tc.tfClient.cleanUpWorkspaceErr == nil {
|
if tc.tfClient.cleanUpWorkspaceErr == nil {
|
||||||
@ -107,6 +118,11 @@ func TestRollbackQEMU(t *testing.T) {
|
|||||||
}
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
if tc.wantDestroyErr {
|
||||||
|
assert.Error(err)
|
||||||
|
assert.Equal("Could not destroy the resources. Please delete the \"constellation-terraform\" directory manually if no resources were created\n", destroyClusterErrOutput.String())
|
||||||
|
return
|
||||||
|
}
|
||||||
assert.NoError(err)
|
assert.NoError(err)
|
||||||
assert.True(tc.libvirt.stopCalled)
|
assert.True(tc.libvirt.stopCalled)
|
||||||
if tc.createdWorkspace {
|
if tc.createdWorkspace {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user