Throw error when encountering untracked action secrets (#248)

* Throw error when encountering untracked action secrets * Rename warnings to diagnostics * Consolidate config secrets into just 1 slice * Fix error message in action secret tests
auth0 · Jul 27, 2022 · c099b3b · c099b3b
1 parent 7355119
commit c099b3b
Show file tree

Hide file tree

Showing 3 changed files with 268 additions and 107 deletions.
diff --git a/auth0/resource_auth0_action.go b/auth0/resource_auth0_action.go
@@ -6,6 +6,7 @@ import (
 	"net/http"
 
 	"github.com/auth0/go-auth0/management"
+	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/go-multierror"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
@@ -160,6 +161,7 @@ func readAction(ctx context.Context, d *schema.ResourceData, m interface{}) diag
 		d.Set("dependencies", flattenActionDependencies(action.Dependencies)),
 		d.Set("runtime", action.Runtime),
 	)
+
 	if action.DeployedVersion != nil {
 		result = multierror.Append(result, d.Set("version_id", action.DeployedVersion.GetID()))
 	}
@@ -171,6 +173,12 @@ func updateAction(ctx context.Context, d *schema.ResourceData, m interface{}) di
 	action := expandAction(d)
 
 	api := m.(*management.Management)
+
+	diagnostics := preventErasingUnmanagedSecrets(d, api)
+	if diagnostics.HasError() {
+		return diagnostics
+	}
+
 	if err := api.Action.Update(d.Id(), action); err != nil {
 		return diag.FromErr(err)
 	}
@@ -251,6 +259,53 @@ func deployAction(ctx context.Context, d *schema.ResourceData, m interface{}) di
 	return diag.FromErr(d.Set("version_id", actionVersion.GetID()))
 }
 
+func preventErasingUnmanagedSecrets(d *schema.ResourceData, api *management.Management) diag.Diagnostics {
+	if !d.HasChange("secrets") {
+		return nil
+	}
+
+	preUpdateAction, err := api.Action.Read(d.Id())
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	// We need to also include the secrets that we're about to remove
+	// against the checks, not just the ones with which we are left.
+	oldSecrets, newSecrets := d.GetChange("secrets")
+	allSecrets := append(oldSecrets.([]interface{}), newSecrets.([]interface{})...)
+
+	return checkForUnmanagedActionSecrets(allSecrets, preUpdateAction.Secrets)
+}
+
+func checkForUnmanagedActionSecrets(
+	secretsFromConfig []interface{},
+	secretsFromAPI []*management.ActionSecret,
+) diag.Diagnostics {
+	secretKeysInConfigMap := make(map[string]bool, len(secretsFromConfig))
+	for _, secret := range secretsFromConfig {
+		secretKeyName := secret.(map[string]interface{})["name"].(string)
+		secretKeysInConfigMap[secretKeyName] = true
+	}
+
+	var diagnostics diag.Diagnostics
+	for _, secret := range secretsFromAPI {
+		if _, ok := secretKeysInConfigMap[secret.GetName()]; !ok {
+			diagnostics = append(diagnostics, diag.Diagnostic{
+				Severity: diag.Error,
+				Summary:  "Unmanaged Action Secret",
+				Detail: fmt.Sprintf("Detected an action secret not managed though Terraform: %s. If you proceed, "+
+					"this secret will get deleted. It is required to add this secret to your action configuration "+
+					"to prevent unintentionally destructive results.",
+					secret.GetName(),
+				),
+				AttributePath: cty.Path{cty.GetAttrStep{Name: "secrets"}},
+			})
+		}
+	}
+
+	return diagnostics
+}
+
 func expandAction(d *schema.ResourceData) *management.Action {
 	action := &management.Action{
 		Name:    String(d, "name"),

diff --git a/auth0/resource_auth0_action_test.go b/auth0/resource_auth0_action_test.go
@@ -5,7 +5,12 @@ import (
 	"regexp"
 	"testing"
 
+	"github.com/auth0/go-auth0"
+	"github.com/auth0/go-auth0/management"
+	"github.com/hashicorp/go-cty/cty"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/stretchr/testify/assert"
 
 	"github.com/auth0/terraform-provider-auth0/auth0/internal/template"
 )
@@ -19,6 +24,11 @@ resource auth0_action my_action {
 		id = "post-login"
 		version = "v3"
 	}
+
+	secrets {
+		name = "foo"
+		value = "111111"
+	}
 }
 `
 
@@ -43,6 +53,11 @@ resource auth0_action my_action {
 		name = "foo"
 		value = "123456"
 	}
+
+	secrets {
+		name = "bar"
+		value = "654321"
+	}
 }
 `
 
@@ -79,7 +94,9 @@ func TestAccAction(t *testing.T) {
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("auth0_action.my_action", "name", fmt.Sprintf("Test Action %s", t.Name())),
 					resource.TestCheckResourceAttr("auth0_action.my_action", "code", "exports.onExecutePostLogin = async (event, api) => {};"),
-					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.#", "0"),
+					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.#", "1"),
+					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.0.name", "foo"),
+					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.0.value", "111111"),
 					resource.TestCheckResourceAttr("auth0_action.my_action", "dependencies.#", "0"),
 					resource.TestCheckResourceAttr("auth0_action.my_action", "runtime", "node16"),
 					resource.TestCheckResourceAttr("auth0_action.my_action", "deploy", "false"),
@@ -103,9 +120,11 @@ func TestAccAction(t *testing.T) {
 					resource.TestCheckResourceAttr("auth0_action.my_action", "dependencies.#", "1"),
 					resource.TestCheckResourceAttr("auth0_action.my_action", "dependencies.0.name", "auth0"),
 					resource.TestCheckResourceAttr("auth0_action.my_action", "dependencies.0.version", "2.41.0"),
-					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.#", "1"),
+					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.#", "2"),
 					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.0.name", "foo"),
 					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.0.value", "123456"),
+					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.1.name", "bar"),
+					resource.TestCheckResourceAttr("auth0_action.my_action", "secrets.1.value", "654321"),
 				),
 			},
 			{
@@ -179,3 +198,70 @@ resource auth0_action my_action {
 	}
 }
 `
+
+func TestCheckForUntrackedActionSecrets(t *testing.T) {
+	var testCases = []struct {
+		name                 string
+		givenSecretsInConfig []interface{}
+		givenActionSecrets   []*management.ActionSecret
+		expectedDiagnostics  diag.Diagnostics
+	}{
+		{
+			name:                 "action has no secrets",
+			givenSecretsInConfig: []interface{}{},
+			givenActionSecrets:   []*management.ActionSecret{},
+			expectedDiagnostics:  diag.Diagnostics(nil),
+		},
+		{
+			name: "action has no untracked secrets",
+			givenSecretsInConfig: []interface{}{
+				map[string]interface{}{
+					"name": "secretName",
+				},
+			},
+			givenActionSecrets: []*management.ActionSecret{
+				{
+					Name: auth0.String("secretName"),
+				},
+			},
+			expectedDiagnostics: diag.Diagnostics(nil),
+		},
+		{
+			name: "action has untracked secrets",
+			givenSecretsInConfig: []interface{}{
+				map[string]interface{}{
+					"name": "secretName",
+				},
+			},
+			givenActionSecrets: []*management.ActionSecret{
+				{
+					Name: auth0.String("secretName"),
+				},
+				{
+					Name: auth0.String("anotherSecretName"),
+				},
+			},
+			expectedDiagnostics: diag.Diagnostics{
+				{
+					Severity: diag.Error,
+					Summary:  "Unmanaged Action Secret",
+					Detail: "Detected an action secret not managed though Terraform: anotherSecretName. " +
+						"If you proceed, this secret will get deleted. It is required to add this secret to " +
+						"your action configuration to prevent unintentionally destructive results.",
+					AttributePath: cty.Path{cty.GetAttrStep{Name: "secrets"}},
+				},
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			actualDiagnostics := checkForUnmanagedActionSecrets(
+				testCase.givenSecretsInConfig,
+				testCase.givenActionSecrets,
+			)
+
+			assert.Equal(t, testCase.expectedDiagnostics, actualDiagnostics)
+		})
+	}
+}