Enforce valid chars in repo name (#1806)

* Enforce valid chars in repo name Signed-off-by: Benoit Donneaux <ben@tergology.com> * Add dash to validate repo name Signed-off-by: Benoit Donneaux <ben@tergology.com> * Better name validation message Signed-off-by: Benoit Donneaux <ben@tergology.com> * Test repo name max length Signed-off-by: Benoit Donneaux <ben@tergology.com> * Test space in repo name Signed-off-by: Benoit Donneaux <ben@tergology.com> --------- Signed-off-by: Benoit Donneaux <ben@tergology.com> Co-authored-by: Keegan Campbell <me@kfcampbell.com>
integrations · Jul 24, 2023 · b490535 · b490535
1 parent 64f123a
commit b490535
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 1 deletion.
diff --git a/github/resource_github_repository.go b/github/resource_github_repository.go
@@ -34,7 +34,7 @@ func resourceGithubRepository() *schema.Resource {
 			"name": {
 				Type:         schema.TypeString,
 				Required:     true,
-				ValidateFunc: validation.StringLenBetween(1, 100),
+				ValidateFunc: validation.StringMatch(regexp.MustCompile(`^[-a-zA-Z0-9_.]{1,100}$`), "must include only alphanumeric characters, underscores or hyphens and consist of 100 characters or less"),
 				Description:  "The name of the repository.",
 			},
 			"description": {

diff --git a/github/resource_github_repository_test.go b/github/resource_github_repository_test.go
@@ -1455,3 +1455,33 @@ func testCheckResourceAttrContains(resourceName, attributeName, substring string
 		return nil
 	}
 }
+
+func TestGithubRepositoryNameFailsValidationWhenOverMaxCharacters(t *testing.T) {
+	resource := resourceGithubRepository()
+	schema := resource.Schema["name"]
+
+	_, err := schema.ValidateFunc(strings.Repeat("a", 101), "name")
+	if len(err) != 1 {
+		t.Error(fmt.Errorf("unexpected number of name validation failures; expected=1; actual=%d", len(err)))
+	}
+	expectedFailure := "invalid value for name (must include only alphanumeric characters, underscores or hyphens and consist of 100 characters or less)"
+	actualFailure := err[0].Error()
+	if expectedFailure != actualFailure {
+		t.Error(fmt.Errorf("unexpected name validation failure; expected=%s; action=%s", expectedFailure, actualFailure))
+	}
+}
+
+func TestGithubRepositoryNameFailsValidationWithSpace(t *testing.T) {
+	resource := resourceGithubRepository()
+	schema := resource.Schema["name"]
+
+	_, err := schema.ValidateFunc("test space", "name")
+	if len(err) != 1 {
+		t.Error(fmt.Errorf("unexpected number of name validation failures; expected=1; actual=%d", len(err)))
+	}
+	expectedFailure := "invalid value for name (must include only alphanumeric characters, underscores or hyphens and consist of 100 characters or less)"
+	actualFailure := err[0].Error()
+	if expectedFailure != actualFailure {
+		t.Error(fmt.Errorf("unexpected name validation failure; expected=%s; action=%s", expectedFailure, actualFailure))
+	}
+}