Merge pull request #290 from grafana/import_probe_auth_token

Add support for importing probe auth_token

Author: mem

examples/resources/grafana_synthetic_monitoring_probe/import.sh

@@ -1 +1,2 @@
 terraform import grafana_synthetic_monitoring_probe.probe {{probe-id}}
+terraform import grafana_synthetic_monitoring_probe.probe {{probe-id}}:{{auth_token}}

grafana/resource_synthetic_monitoring_probe.go

@@ -3,7 +3,9 @@ package grafana
 import (
 	"context"
 	"encoding/base64"
+	"fmt"
 	"strconv"
+	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -28,7 +30,7 @@ Grafana Synthetic Monitoring Agent.
 		UpdateContext: resourceSyntheticMonitoringProbeUpdate,
 		DeleteContext: resourceSyntheticMonitoringProbeDelete,
 		Importer: &schema.ResourceImporter{
-			StateContext: schema.ImportStatePassthroughContext,
+			StateContext: importProbeStateWithToken,
 		},
 
 		Schema: map[string]*schema.Schema{
@@ -188,3 +190,29 @@ func makeProbe(d *schema.ResourceData) *sm.Probe {
 		Public:    d.Get("public").(bool),
 	}
 }
+
+// importProbeStateWithToken is an implementation of StateContextFunc
+// that can be used to pass the ID of the probe and the existing
+// auth_token.
+func importProbeStateWithToken(ctx context.Context, d *schema.ResourceData, m interface{}) ([]*schema.ResourceData, error) {
+	parts := strings.SplitN(d.Id(), ":", 2)
+
+	// the auth_token is optional
+	if len(parts) == 2 {
+		if parts[0] == "" || parts[1] == "" {
+			return nil, fmt.Errorf("invalid id %q, expected format 'probe_id:auth_token'", d.Id())
+		}
+
+		if _, err := base64.StdEncoding.DecodeString(parts[1]); err != nil {
+			return nil, fmt.Errorf("invalid auth_token %q, expecting a base64-encoded string", parts[1])
+		}
+
+		if err := d.Set("auth_token", parts[1]); err != nil {
+			return nil, fmt.Errorf("failed to set auth_token: %s", err)
+		}
+	}
+
+	d.SetId(parts[0])
+
+	return []*schema.ResourceData{d}, nil
+}

grafana/resource_synthetic_monitoring_probe_helper_test.go

@@ -0,0 +1,72 @@
+package grafana
+
+import (
+	"context"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func TestImportProbeStateWithToken(t *testing.T) {
+	testcases := map[string]struct {
+		input             string
+		expectError       bool
+		expectedID        string
+		expectedAuthToken string
+	}{
+		"valid id, no auth_token": {
+			input:             "1",
+			expectError:       false,
+			expectedID:        "1",
+			expectedAuthToken: "",
+		},
+		"valid id, valid auth_token": {
+			input:             "1:aGVsbG8=",
+			expectError:       false,
+			expectedID:        "1",
+			expectedAuthToken: "aGVsbG8=",
+		},
+		"valid id, invalid auth_token": {
+			input:       "1:xxx",
+			expectError: true,
+		},
+		"invalid id, valid auth_token": {
+			input:       ":aGVsbG8=",
+			expectError: true,
+		},
+	}
+
+	for name, tc := range testcases {
+		t.Run(name, func(t *testing.T) {
+			d := schema.TestResourceDataRaw(t, syntheticMonitoringProbe.Schema, nil)
+			d.SetId(tc.input)
+
+			res, err := importProbeStateWithToken(context.Background(), d, nil)
+			switch {
+			case tc.expectError && err == nil:
+				t.Fatalf("calling importProbeStateWithToken with id %q, expecting error, got nil", tc.input)
+
+			case !tc.expectError && err != nil:
+				t.Fatalf("calling importProbeStateWithToken with id %q, expecting no error, got %s", tc.input, err)
+
+			case !tc.expectError:
+				if len(res) != 1 {
+					t.Fatalf("expecting 1 ResourceData, got %d", len(res))
+				}
+
+				if tc.expectedID != res[0].Id() {
+					t.Fatalf("expecting id %q, got %q", tc.expectedID, res[0].Id())
+				}
+
+				if tc.expectedAuthToken != "" {
+					output, ok := res[0].GetOk("auth_token")
+					if !ok {
+						t.Fatalf("expecting auth_token to be set")
+					} else if str, ok := output.(string); !ok || str != tc.expectedAuthToken {
+						t.Fatalf("expecting auth_token to match string %q, got %#v", tc.expectedAuthToken, output)
+					}
+				}
+			}
+		})
+	}
+}