cmd: add verify command to verify if config file syntax is valid (#2389)

This commit is contained in:
fatedier 2021-05-12 12:15:22 +08:00 committed by GitHub
parent 630dad50ed
commit 9cebfccb39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 111 additions and 4 deletions

54
cmd/frpc/sub/verify.go Normal file
View File

@ -0,0 +1,54 @@
// Copyright 2021 The frp Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package sub
import (
"fmt"
"os"
"github.com/fatedier/frp/pkg/config"
"github.com/spf13/cobra"
)
func init() {
rootCmd.AddCommand(verifyCmd)
}
var verifyCmd = &cobra.Command{
Use: "verify",
Short: "Verify that the configures is valid",
RunE: func(cmd *cobra.Command, args []string) error {
iniContent, err := config.GetRenderedConfFromFile(cfgFile)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
cfg, err := parseClientCommonCfg(CfgFileTypeIni, iniContent)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
_, _, err = config.LoadAllProxyConfsFromIni(cfg.User, iniContent, cfg.Start)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
fmt.Printf("frpc: the configuration file %s syntax is ok\n", cfgFile)
return nil
},
}

53
cmd/frps/verify.go Normal file
View File

@ -0,0 +1,53 @@
// Copyright 2021 The frp Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package main
import (
"fmt"
"os"
"github.com/fatedier/frp/pkg/config"
"github.com/spf13/cobra"
)
func init() {
rootCmd.AddCommand(verifyCmd)
}
var verifyCmd = &cobra.Command{
Use: "verify",
Short: "Verify that the configures is valid",
RunE: func(cmd *cobra.Command, args []string) error {
if cfgFile == "" {
fmt.Println("no config file is specified")
return nil
}
iniContent, err := config.GetRenderedConfFromFile(cfgFile)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
_, err = parseServerCommonCfg(CfgFileTypeIni, iniContent)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
fmt.Printf("frps: the configuration file %s syntax is ok\n", cfgFile)
return nil
},
}

View File

@ -290,7 +290,7 @@ func LoadAllProxyConfsFromIni(
for _, section := range rangeSections { for _, section := range rangeSections {
err = renderRangeProxyTemplates(f, section) err = renderRangeProxyTemplates(f, section)
if err != nil { if err != nil {
return nil, nil, fmt.Errorf("fail to render range-section[%s] with error: %v", section.Name(), err) return nil, nil, fmt.Errorf("failed to render template for proxy %s: %v", section.Name(), err)
} }
} }
@ -315,7 +315,7 @@ func LoadAllProxyConfsFromIni(
case "server": case "server":
newConf, newErr := NewProxyConfFromIni(prefix, name, section) newConf, newErr := NewProxyConfFromIni(prefix, name, section)
if newErr != nil { if newErr != nil {
return nil, nil, fmt.Errorf("fail to parse section[%s], err: %v", name, newErr) return nil, nil, fmt.Errorf("failed to parse proxy %s, err: %v", name, newErr)
} }
proxyConfs[prefix+name] = newConf proxyConfs[prefix+name] = newConf
case "visitor": case "visitor":
@ -325,7 +325,7 @@ func LoadAllProxyConfsFromIni(
} }
visitorConfs[prefix+name] = newConf visitorConfs[prefix+name] = newConf
default: default:
return nil, nil, fmt.Errorf("section[%s] role should be 'server' or 'visitor'", name) return nil, nil, fmt.Errorf("proxy %s role should be 'server' or 'visitor'", name)
} }
} }
return proxyConfs, visitorConfs, nil return proxyConfs, visitorConfs, nil

View File

@ -274,7 +274,7 @@ func NewProxyConfFromIni(prefix, name string, section *ini.Section) (ProxyConf,
conf := DefaultProxyConf(proxyType) conf := DefaultProxyConf(proxyType)
if conf == nil { if conf == nil {
return nil, fmt.Errorf("proxy [%s] type [%s] error", name, proxyType) return nil, fmt.Errorf("proxy %s has invalid type [%s]", name, proxyType)
} }
if err := conf.UnmarshalFromIni(prefix, name, section); err != nil { if err := conf.UnmarshalFromIni(prefix, name, section); err != nil {