cmd: remove zealous check of Caddyfile auto-detection (#6370)

* cmd: remove zealous check of Caddyfile auto-detection

* add test case

* remove redundant check, add comment

* one more case
This commit is contained in:
Mohammed Al Sahaf 2024-06-05 17:57:15 +03:00 committed by GitHub
parent 198f4385d2
commit 243351b2b1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 31 additions and 14 deletions

View file

@ -119,7 +119,6 @@ func isCaddyfile(configFile, adapterName string) (bool, error) {
baseConfig := strings.ToLower(filepath.Base(configFile)) baseConfig := strings.ToLower(filepath.Base(configFile))
baseConfigExt := filepath.Ext(baseConfig) baseConfigExt := filepath.Ext(baseConfig)
startsOrEndsInCaddyfile := strings.HasPrefix(baseConfig, "caddyfile") || strings.HasSuffix(baseConfig, ".caddyfile") startsOrEndsInCaddyfile := strings.HasPrefix(baseConfig, "caddyfile") || strings.HasSuffix(baseConfig, ".caddyfile")
extNotCaddyfileOrJSON := (baseConfigExt != "" && baseConfigExt != ".caddyfile" && baseConfigExt != ".json")
if baseConfigExt == ".json" { if baseConfigExt == ".json" {
return false, nil return false, nil
@ -130,18 +129,15 @@ func isCaddyfile(configFile, adapterName string) (bool, error) {
// the config file has an extension, // the config file has an extension,
// and isn't a JSON file (e.g. Caddyfile.yaml), // and isn't a JSON file (e.g. Caddyfile.yaml),
// then we don't know what the config format is. // then we don't know what the config format is.
if adapterName == "" && startsOrEndsInCaddyfile && extNotCaddyfileOrJSON { if adapterName == "" && startsOrEndsInCaddyfile {
return false, fmt.Errorf("ambiguous config file format; please specify adapter (use --adapter)")
}
// If the config file starts or ends with "caddyfile",
// the extension of the config file is not ".json", AND
// the user did not specify an adapter, then we assume it's Caddyfile.
if startsOrEndsInCaddyfile &&
baseConfigExt != ".json" &&
adapterName == "" {
return true, nil return true, nil
} }
// adapter is not empty,
// adapter is not "caddyfile",
// extension is not ".json",
// extension is not ".caddyfile"
// file does not start with "Caddyfile"
return false, nil return false, nil
} }

View file

@ -226,15 +226,16 @@ func Test_isCaddyfile(t *testing.T) {
wantErr: false, wantErr: false,
}, },
{ {
name: "config is Caddyfile.yaml without adapter", name: "config is Caddyfile.yaml with adapter",
args: args{ args: args{
configFile: "./Caddyfile.yaml", configFile: "./Caddyfile.yaml",
adapterName: "", adapterName: "yaml",
}, },
want: false, want: false,
wantErr: true, wantErr: false,
}, },
{ {
name: "json is not caddyfile but not error", name: "json is not caddyfile but not error",
args: args{ args: args{
configFile: "./Caddyfile.json", configFile: "./Caddyfile.json",
@ -243,6 +244,26 @@ func Test_isCaddyfile(t *testing.T) {
want: false, want: false,
wantErr: false, wantErr: false,
}, },
{
name: "prefix of Caddyfile and ./ with any extension is Caddyfile",
args: args{
configFile: "./Caddyfile.prd",
adapterName: "",
},
want: true,
wantErr: false,
},
{
name: "prefix of Caddyfile without ./ with any extension is Caddyfile",
args: args{
configFile: "Caddyfile.prd",
adapterName: "",
},
want: true,
wantErr: false,
},
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {