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

feat: add an option to pass sensitive variable through CLI arg #15

Merged
merged 1 commit into from
Dec 9, 2024
Merged

feat: add an option to pass sensitive variable through CLI arg #15

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 43 additions & 16 deletions pkg/terraform/terraform.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,11 @@ type ModuleOptions struct {
ModulePath string
BackendConfigFileName string
BackendConfig []byte
VariableFileName string
VariablePayload []byte
// A list of sensitive variable assignments. This will be passed to tfexec
// through `-var` arg.
SensitiveVariables map[string]string
VariableFileName string
VariablePayload []byte
}

type TFInitOptions struct {
Expand Down Expand Up @@ -110,6 +113,7 @@ func (t *Terraform) ApplyModule(ctx context.Context, moduleOptions ModuleOptions
ctx,
absModulePath,
backendCfgPath,
moduleOptions.SensitiveVariables,
applyOptions,
)
if err != nil {
Expand All @@ -129,16 +133,16 @@ type DestroyOptions struct {
StdErr io.Writer
}

func (t *Terraform) DestroyModule(ctx context.Context, options ModuleOptions, destroyOptions DestroyOptions) error {
absModulePath := fmt.Sprintf("%s/%s", t.rootPath, options.ModulePath)
backendCfgPath := fmt.Sprintf("%s/%s", absModulePath, options.BackendConfigFileName)
err := os.WriteFile(backendCfgPath, []byte(options.BackendConfig), 0666)
func (t *Terraform) DestroyModule(ctx context.Context, moduleOptions ModuleOptions, destroyOptions DestroyOptions) error {
absModulePath := fmt.Sprintf("%s/%s", t.rootPath, moduleOptions.ModulePath)
backendCfgPath := fmt.Sprintf("%s/%s", absModulePath, moduleOptions.BackendConfigFileName)
err := os.WriteFile(backendCfgPath, []byte(moduleOptions.BackendConfig), 0666)
if err != nil {
return eris.Wrapf(err, "failed to write tf backend config to %v", backendCfgPath)
}

variablePath := fmt.Sprintf("%s/%s", absModulePath, options.VariableFileName)
err = os.WriteFile(variablePath, []byte(options.VariablePayload), 0666)
variablePath := fmt.Sprintf("%s/%s", absModulePath, moduleOptions.VariableFileName)
err = os.WriteFile(variablePath, []byte(moduleOptions.VariablePayload), 0666)
if err != nil {
return eris.Wrapf(err, "failed to write tf variable payloads to %v", variablePath)
}
Expand All @@ -147,6 +151,7 @@ func (t *Terraform) DestroyModule(ctx context.Context, options ModuleOptions, de
ctx,
absModulePath,
backendCfgPath,
moduleOptions.SensitiveVariables,
destroyOptions,
)
if err != nil {
Expand Down Expand Up @@ -348,7 +353,7 @@ func (t *Terraform) getTerraformExec(workingDir string) (*tfexec.Terraform, erro
return tf, nil
}

func (t *Terraform) terraformInitAndApply(ctx context.Context, workingDir, backendPath string, options ApplyOptions) error {
func (t *Terraform) terraformInitAndApply(ctx context.Context, workingDir, backendPath string, sensitiveVariables map[string]string, options ApplyOptions) error {
tf, err := t.getTerraformExec(workingDir)
if err != nil {
return eris.Wrap(err, "failed to create Terraform exec")
Expand All @@ -362,11 +367,18 @@ func (t *Terraform) terraformInitAndApply(ctx context.Context, workingDir, backe
return eris.Wrap(err, "failed to init terraform")
}

apply := func(ctx context.Context) error {
applyErr := tf.Apply(ctx, tfexec.GracefulShutdown(tfexec.GracefulShutdownConfig{
tfexecApplyOptions := []tfexec.ApplyOption{
tfexec.GracefulShutdown(tfexec.GracefulShutdownConfig{
Enable: true,
Period: options.GracefulShutdownPeriod,
}))
}),
}
for _, assignment := range toVariableAssignments(sensitiveVariables) {
tfexecApplyOptions = append(tfexecApplyOptions, tfexec.Var(assignment))
}

apply := func(ctx context.Context) error {
applyErr := tf.Apply(ctx, tfexecApplyOptions...)
lockErrInfo, ok := extractStateLockedError(applyErr)
if options.LockExpirationDuration == 0 || !ok || time.Since(lockErrInfo.Created) < options.LockExpirationDuration {
return applyErr
Expand All @@ -381,7 +393,7 @@ func (t *Terraform) terraformInitAndApply(ctx context.Context, workingDir, backe
return nil
}

func (t *Terraform) terraformInitAndDestroy(ctx context.Context, workingDir, backendPath string, options DestroyOptions) error {
func (t *Terraform) terraformInitAndDestroy(ctx context.Context, workingDir, backendPath string, sensitiveVariables map[string]string, options DestroyOptions) error {
tf, err := t.getTerraformExec(workingDir)
if err != nil {
return eris.Wrap(err, "failed to create Terraform exec")
Expand All @@ -395,11 +407,18 @@ func (t *Terraform) terraformInitAndDestroy(ctx context.Context, workingDir, bac
return eris.Wrap(err, "failed to init terraform")
}

destroy := func(ctx context.Context) error {
destroyErr := tf.Destroy(ctx, tfexec.GracefulShutdown(tfexec.GracefulShutdownConfig{
tfexecDestroyOptions := []tfexec.DestroyOption{
tfexec.GracefulShutdown(tfexec.GracefulShutdownConfig{
Enable: true,
Period: options.GracefulShutdownPeriod,
}))
}),
}
for _, assignment := range toVariableAssignments(sensitiveVariables) {
tfexecDestroyOptions = append(tfexecDestroyOptions, tfexec.Var(assignment))
}

destroy := func(ctx context.Context) error {
destroyErr := tf.Destroy(ctx, tfexecDestroyOptions...)
lockErrInfo, ok := extractStateLockedError(destroyErr)
if options.LockExpirationDuration == 0 || !ok || time.Since(lockErrInfo.Created) < options.LockExpirationDuration {
return destroyErr
Expand Down Expand Up @@ -483,3 +502,11 @@ func extractStateLockedError(err error) (LockErrInfo, bool) {
}
return LockErrInfo{}, false
}

func toVariableAssignments(variables map[string]string) []string {
var assignments []string
for k, v := range variables {
assignments = append(assignments, fmt.Sprintf("%s=%s", k, v))
}
return assignments
}