Merge pull request #362 from mbland/project-name-error-message

compose-spec · Mar 3, 2023 · 37ba724 · 37ba724
2 parents 5837d67 + b94d8f4
commit 37ba724
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 6 deletions.
diff --git a/cli/options.go b/cli/options.go
@@ -65,7 +65,8 @@ func NewProjectOptions(configs []string, opts ...ProjectOptionsFn) (*ProjectOpti
 func WithName(name string) ProjectOptionsFn {
 	return func(o *ProjectOptions) error {
 		if name != loader.NormalizeProjectName(name) {
-			return fmt.Errorf("%q is not a valid project name", name)
+			return fmt.Errorf("%q is not a valid project name: it must contain "+
+				"only characters from [a-z0-9_-] and start with [a-z0-9]", name)
 		}
 		o.Name = name
 		return nil

diff --git a/cli/options_test.go b/cli/options_test.go
@@ -54,7 +54,7 @@ func TestProjectName(t *testing.T) {
 
 	t.Run("by name start with invalid char '-'", func(t *testing.T) {
 		_, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithName("-my_project"))
-		assert.Error(t, err, `"-my_project" is not a valid project name`)
+		assert.ErrorContains(t, err, `"-my_project" is not a valid project name`)
 
 		opts, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithEnv([]string{
 			fmt.Sprintf("%s=%s", consts.ComposeProjectName, "-my_project"),
@@ -67,7 +67,7 @@ func TestProjectName(t *testing.T) {
 
 	t.Run("by name start with invalid char '_'", func(t *testing.T) {
 		_, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithName("_my_project"))
-		assert.Error(t, err, `"_my_project" is not a valid project name`)
+		assert.ErrorContains(t, err, `"_my_project" is not a valid project name`)
 
 		opts, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithEnv([]string{
 			fmt.Sprintf("%s=%s", consts.ComposeProjectName, "_my_project"),
@@ -80,7 +80,7 @@ func TestProjectName(t *testing.T) {
 
 	t.Run("by name contains dots", func(t *testing.T) {
 		_, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithName("www.my.project"))
-		assert.Error(t, err, `"www.my.project" is not a valid project name`)
+		assert.ErrorContains(t, err, `"www.my.project" is not a valid project name`)
 
 		opts, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithEnv([]string{
 			fmt.Sprintf("%s=%s", consts.ComposeProjectName, "www.my.project"),
@@ -93,7 +93,7 @@ func TestProjectName(t *testing.T) {
 
 	t.Run("by name uppercase", func(t *testing.T) {
 		_, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithName("MY_PROJECT"))
-		assert.Error(t, err, `"MY_PROJECT" is not a valid project name`)
+		assert.ErrorContains(t, err, `"MY_PROJECT" is not a valid project name`)
 
 		opts, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithEnv([]string{
 			fmt.Sprintf("%s=%s", consts.ComposeProjectName, "_my_project"),

diff --git a/loader/full-example.yml b/loader/full-example.yml
@@ -1,4 +1,4 @@
-name: Full_Example_project_name
+name: full_example_project_name
 services:
   foo:
 

diff --git a/schema/compose-spec.json b/schema/compose-spec.json
@@ -13,6 +13,7 @@
 
     "name": {
       "type": "string",
+      "pattern": "^[a-z0-9][a-z0-9_-]*$",
       "description": "define the Compose project name, until user defines one explicitly."
     },