Merge pull request #29 from ks6088ts/enhancement/issue-28_handle-auth

explicitly handles authentication method other than authKey

.goreleaser.yml

@@ -14,7 +14,7 @@ builds:
   flags:
     - -trimpath
   ldflags:
-    - '-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}'
+    - '-s -w -X github.com/ks6088ts/terraform-provider-soracom/internal.Version={{.Version}} -X github.com/ks6088ts/terraform-provider-soracom/internal.Revision={{.Commit}}'
   goos:
     - freebsd
     - windows

internal/conns/conns.go

@@ -63,6 +63,10 @@ func getProfile(profileName string) (*profile, error) {
 		return nil, err
 	}
 
+	if err := validateProfile(&p); err != nil {
+		return nil, err
+	}
+
 	// supply default values for older versions (which support 'jp' coverage type only)
 	if p.CoverageType == "" {
 		p.CoverageType = "jp"
@@ -71,6 +75,14 @@ func getProfile(profileName string) (*profile, error) {
 	return &p, nil
 }
 
+func validateProfile(p *profile) error {
+	// validation logic: handles authentication methods other than auth key
+	if p.AuthKey == nil || p.AuthKeyId == nil {
+		return fmt.Errorf("authentication by auth key is only supported. please specify AuthKey and AuthKeyId in profile")
+	}
+	return nil
+}
+
 type SoracomClient struct {
 	Client       *soracom.APIClient
 	AuthResponse *soracom.AuthResponse

internal/conns/conns_test.go

@@ -113,3 +113,37 @@ func TestGetProfile(t *testing.T) {
 		t.Errorf("failed to get registerPaymentMethod")
 	}
 }
+
+func TestValidateProfile(t *testing.T) {
+	tempAuthKeyId := "authKeyId"
+	tempAuthKey := "authKey"
+
+	testCases := []struct {
+		name     string
+		profile  profile
+		hasError bool
+	}{
+		{
+			name: "nominal scenarios with authKey specified in profile",
+			profile: profile{
+				AuthKeyId: &tempAuthKeyId,
+				AuthKey:   &tempAuthKey,
+			},
+			hasError: false,
+		},
+		{
+			name:     "non-nominal scenarios without authKey in profile",
+			profile:  profile{},
+			hasError: true,
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			err := validateProfile(&testCase.profile)
+			if hasError := (err != nil); hasError != testCase.hasError {
+				t.Errorf("got %v, expected %v, err %v", hasError, testCase.hasError, err)
+			}
+		})
+	}
+}