Skip to content

load: clarify project name validation rules in errors #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2023
Merged

load: clarify project name validation rules in errors #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions cli/options_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,53 +91,53 @@ 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.ErrorContains(t, err, `"-my_project" is not a valid project name`)
assert.ErrorContains(t, err, `invalid project name "-my_project"`)

opts, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithEnv([]string{
fmt.Sprintf("%s=%s", consts.ComposeProjectName, "-my_project"),
}))
assert.NilError(t, err)
p, err := ProjectFromOptions(opts)
assert.ErrorContains(t, err, `"-my_project" is not a valid project name`)
assert.ErrorContains(t, err, `invalid project name "-my_project"`)
assert.Assert(t, p == nil)
})

t.Run("by name start with invalid char '_'", func(t *testing.T) {
_, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithName("_my_project"))
assert.ErrorContains(t, err, `"_my_project" is not a valid project name`)
assert.ErrorContains(t, err, `invalid project name "_my_project"`)

opts, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithEnv([]string{
fmt.Sprintf("%s=%s", consts.ComposeProjectName, "_my_project"),
}))
assert.NilError(t, err)
p, err := ProjectFromOptions(opts)
assert.ErrorContains(t, err, `"_my_project" is not a valid project name`)
assert.ErrorContains(t, err, `invalid project name "_my_project"`)
assert.Assert(t, p == nil)
})

t.Run("by name contains dots", func(t *testing.T) {
_, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithName("www.my.project"))
assert.ErrorContains(t, err, `"www.my.project" is not a valid project name`)
assert.ErrorContains(t, err, `invalid project name "www.my.project"`)

opts, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithEnv([]string{
fmt.Sprintf("%s=%s", consts.ComposeProjectName, "www.my.project"),
}))
assert.NilError(t, err)
p, err := ProjectFromOptions(opts)
assert.ErrorContains(t, err, `"www.my.project" is not a valid project name`)
assert.ErrorContains(t, err, `invalid project name "www.my.project"`)
assert.Assert(t, p == nil)
})

t.Run("by name uppercase", func(t *testing.T) {
_, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithName("MY_PROJECT"))
assert.ErrorContains(t, err, `"MY_PROJECT" is not a valid project name`)
assert.ErrorContains(t, err, `invalid project name "MY_PROJECT"`)

opts, err := NewProjectOptions([]string{"testdata/simple/compose.yaml"}, WithEnv([]string{
fmt.Sprintf("%s=%s", consts.ComposeProjectName, "MY_PROJECT"),
}))
assert.NilError(t, err)
p, err := ProjectFromOptions(opts)
assert.ErrorContains(t, err, `"MY_PROJECT" is not a valid project name`)
assert.ErrorContains(t, err, `invalid project name "MY_PROJECT"`)
assert.Assert(t, p == nil)
})

Expand Down
4 changes: 2 additions & 2 deletions loader/loader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,8 @@ func Load(configDetails types.ConfigDetails, options ...func(*Options)) (*types.

func InvalidProjectNameErr(v string) error {
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]", v,
"invalid project name %q: must consist only of lowercase alphanumeric characters, hyphens, and underscores as well as start with a letter or number",
v,
)
}

Expand Down