NEW FEATURE: Moving provider TYPE from dnsconfig.js to creds.json (#1500)

Fixes https://github.com/StackExchange/dnscontrol/issues/1457 * New-style creds.json implememented backwards compatible * Update tests * Update docs * Assume new-style TYPE
2024-05-11 05:55:12 +00:00 · 2022-05-08 14:23:45 -04:00
parent bbecce74bd
commit 9e6d642e35
23 changed files with 949 additions and 108 deletions
--- a/commands/previewPush_test.go
+++ b/commands/previewPush_test.go
@ -0,0 +1,58 @@
+package commands
+
+import (
+	"strings"
+	"testing"
+)
+
+func Test_refineProviderType(t *testing.T) {
+
+	var mapEmpty map[string]string
+	mapTypeMissing := map[string]string{"otherfield": "othervalue"}
+	mapTypeFoo := map[string]string{"TYPE": "FOO"}
+	mapTypeBar := map[string]string{"TYPE": "BAR"}
+	mapTypeHyphen := map[string]string{"TYPE": "-"}
+
+	type args struct {
+		t          string
+		credFields map[string]string
+	}
+	tests := []struct {
+		name                string
+		args                args
+		wantReplacementType string
+		wantWarnMsgPrefix   string
+		wantErr             bool
+	}{
+		{"fooEmp", args{"FOO", mapEmpty}, "FOO", "WARN", false},       // 3.x: Provide compatibility suggestion. 4.0: hard error
+		{"fooMis", args{"FOO", mapTypeMissing}, "FOO", "WARN", false}, // 3.x: Provide compatibility suggestion. 4.0: hard error
+		{"fooHyp", args{"FOO", mapTypeHyphen}, "-", "", true},         // Error: Invalid creds.json data.
+		{"fooFoo", args{"FOO", mapTypeFoo}, "FOO", "INFO", false},     // Suggest cleanup.
+		{"fooBar", args{"FOO", mapTypeBar}, "FOO", "", true},          // Error: Mismatched!
+
+		{"hypEmp", args{"-", mapEmpty}, "", "", true},       // Hard error. creds.json entry is missing type.
+		{"hypMis", args{"-", mapTypeMissing}, "", "", true}, // Hard error. creds.json entry is missing type.
+		{"hypHyp", args{"-", mapTypeHyphen}, "-", "", true}, // Hard error: Invalid creds.json data.
+		{"hypFoo", args{"-", mapTypeFoo}, "FOO", "", false}, // normal
+		{"hypBar", args{"-", mapTypeBar}, "BAR", "", false}, // normal
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if tt.wantErr && (tt.wantWarnMsgPrefix != "") {
+				t.Error("refineProviderType() bad test data. Prefix should be \"\" if wantErr is set")
+			}
+			gotReplacementType, gotWarnMsg, err := refineProviderType("foo", tt.args.t, tt.args.credFields, "FOO")
+			if !strings.HasPrefix(gotWarnMsg, tt.wantWarnMsgPrefix) {
+				t.Errorf("refineProviderType() gotWarnMsg = %q, wanted prefix %q", gotWarnMsg, tt.wantWarnMsgPrefix)
+			}
+			if (err != nil) != tt.wantErr {
+				t.Errorf("refineProviderType() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if gotReplacementType != tt.wantReplacementType {
+				t.Errorf("refineProviderType() gotReplacementType = %q, want %q (warn,msg)=(%q,%s)", gotReplacementType, tt.wantReplacementType, gotWarnMsg, err)
+			}
+		})
+	}
+}