rework addon name validation

Author: davidji99

heroku/resource_heroku_addon.go

@@ -3,6 +3,7 @@ package heroku
 import (
 	"context"
 	"fmt"
+	"github.com/hashicorp/terraform/helper/validation"
 	"log"
 	"net/url"
 	"regexp"
@@ -15,10 +16,6 @@ import (
 	heroku "github.com/heroku/heroku-go/v5"
 )
 
-const (
-	AddonNameMaxLength = 256
-)
-
 // Global lock to prevent parallelism for heroku_addon since
 // the Heroku API cannot handle a single application requesting
 // multiple addons simultaneously.
@@ -52,9 +49,10 @@ func resourceHerokuAddon() *schema.Resource {
 			},
 
 			"name": {
-				Type:     schema.TypeString,
-				Optional: true,
-				Computed: true,
+				Type:         schema.TypeString,
+				Optional:     true,
+				Computed:     true,
+				ValidateFunc: validateCustomAddonName,
 			},
 
 			"config": {
@@ -79,6 +77,25 @@ func resourceHerokuAddon() *schema.Resource {
 	}
 }
 
+func validateCustomAddonName(v interface{}, k string) (ws []string, errors []error) {
+	// Check length
+	v1 := validation.StringLenBetween(1, 256)
+	_, errs1 := v1(v, k)
+	for _, err := range errs1 {
+		errors = append(errors, err)
+	}
+
+	// Check validity
+	valRegex := regexp.MustCompile(`^[a-zA-Z][A-Za-z0-9_-]+$`)
+	v2 := validation.StringMatch(valRegex, "Invalid custom addon name: must start with a letter and can only contain lowercase letters, numbers, and dashes")
+	_, errs2 := v2(v, k)
+	for _, err := range errs2 {
+		errors = append(errors, err)
+	}
+
+	return ws, errors
+}
+
 func resourceHerokuAddonCreate(d *schema.ResourceData, meta interface{}) error {
 	addonLock.Lock()
 	defer addonLock.Unlock()
@@ -99,12 +116,6 @@ func resourceHerokuAddonCreate(d *schema.ResourceData, meta interface{}) error {
 	}
 
 	if v := d.Get("name").(string); v != "" {
-		// Validate name with regex
-		valErr := validateAddonName(v)
-		if valErr != nil {
-			return valErr
-		}
-
 		opts.Name = &v
 	}
 
@@ -256,32 +267,3 @@ func AddOnStateRefreshFunc(client *heroku.Service, appID, addOnID string) resour
 		return (*heroku.AddOn)(addon), addon.State, nil
 	}
 }
-
-// validateAddonName uses the documented regex expression to make sure the user provided addon name is valid.
-//
-// Reference: https://devcenter.heroku.com/articles/platform-api-reference#add-on-create-optional-parameters
-func validateAddonName(name string) error {
-	errors := make([]string, 0)
-
-	// First validate length. There is no documented length
-	// but I've tried up to 256 characters so this will be max for now.
-	if len(name) > AddonNameMaxLength {
-		errors = append(errors, fmt.Sprintf("Length cannot exceed %v characters", AddonNameMaxLength))
-	}
-
-	// Then validate the content of the string against documented regex.
-	regex := regexp.MustCompile(`^[a-zA-Z][A-Za-z0-9_-]+$`)
-	matches := regex.FindStringSubmatch(name)
-	if len(matches) == 0 {
-		errors = append(errors, "Needs to match this regex: ^[a-zA-Z][A-Za-z0-9_-]+$")
-	}
-
-	if len(errors) > 0 {
-		errFormatted := ""
-		for _, err := range errors {
-			errFormatted += fmt.Sprintf("-%s\n", err)
-		}
-		return fmt.Errorf("Invalid custom addon name:\n" + errFormatted)
-	}
-	return nil
-}

heroku/resource_heroku_addon_test.go

@@ -111,7 +111,41 @@ func TestAccHerokuAddon_CustomName_Invalid(t *testing.T) {
 		Steps: []resource.TestStep{
 			{
 				Config:      testAccCheckHerokuAddonConfig_CustomName(appName, customName),
-				ExpectError: regexp.MustCompile(`Invalid custom addon name:.*`),
+				ExpectError: regexp.MustCompile(`config is invalid: invalid value for name`),
+			},
+		},
+	})
+}
+
+func TestAccHerokuAddon_CustomName_EmptyString(t *testing.T) {
+	appName := fmt.Sprintf("tftest-%s", acctest.RandString(10))
+	customName := ""
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckHerokuAddonDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config:      testAccCheckHerokuAddonConfig_CustomName(appName, customName),
+				ExpectError: regexp.MustCompile(`config is invalid: 2 problems:.*`),
+			},
+		},
+	})
+}
+
+func TestAccHerokuAddon_CustomName_FirstCharNum(t *testing.T) {
+	appName := fmt.Sprintf("tftest-%s", acctest.RandString(10))
+	customName := "1dasdad"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckHerokuAddonDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config:      testAccCheckHerokuAddonConfig_CustomName(appName, customName),
+				ExpectError: regexp.MustCompile(`config is invalid: invalid value for name`),
 			},
 		},
 	})