mirror of
https://github.com/zrepl/zrepl.git
synced 2024-11-24 17:35:01 +01:00
1df0f8912a
It may be desirable to check that a config is valid without checking for the existence of certificate files (e.g. when validating a config inside a sandbox without access to the cert files). This will be very useful for NixOS so that we can check the config file at nix-build time (e.g. potentially without proper permissions to read cert files for a TLS connection). fixes https://github.com/zrepl/zrepl/issues/467 closes https://github.com/zrepl/zrepl/pull/587
132 lines
3.0 KiB
Go
132 lines
3.0 KiB
Go
package client
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/kr/pretty"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/pflag"
|
|
"github.com/zrepl/yaml-config"
|
|
|
|
"github.com/zrepl/zrepl/cli"
|
|
"github.com/zrepl/zrepl/config"
|
|
"github.com/zrepl/zrepl/daemon/job"
|
|
"github.com/zrepl/zrepl/daemon/logging"
|
|
"github.com/zrepl/zrepl/logger"
|
|
)
|
|
|
|
var configcheckArgs struct {
|
|
format string
|
|
what string
|
|
skipCertCheck bool
|
|
}
|
|
|
|
var ConfigcheckCmd = &cli.Subcommand{
|
|
Use: "configcheck",
|
|
Short: "check if config can be parsed without errors",
|
|
SetupFlags: func(f *pflag.FlagSet) {
|
|
f.StringVar(&configcheckArgs.format, "format", "", "dump parsed config object [pretty|yaml|json]")
|
|
f.StringVar(&configcheckArgs.what, "what", "all", "what to print [all|config|jobs|logging]")
|
|
f.BoolVar(&configcheckArgs.skipCertCheck, "skip-cert-check", false, "skip checking cert files")
|
|
},
|
|
Run: func(ctx context.Context, subcommand *cli.Subcommand, args []string) error {
|
|
formatMap := map[string]func(interface{}){
|
|
"": func(i interface{}) {},
|
|
"pretty": func(i interface{}) {
|
|
if _, err := pretty.Println(i); err != nil {
|
|
panic(err)
|
|
}
|
|
},
|
|
"json": func(i interface{}) {
|
|
if err := json.NewEncoder(os.Stdout).Encode(subcommand.Config()); err != nil {
|
|
panic(err)
|
|
}
|
|
},
|
|
"yaml": func(i interface{}) {
|
|
if err := yaml.NewEncoder(os.Stdout).Encode(subcommand.Config()); err != nil {
|
|
panic(err)
|
|
}
|
|
},
|
|
}
|
|
|
|
formatter, ok := formatMap[configcheckArgs.format]
|
|
if !ok {
|
|
return fmt.Errorf("unsupported --format %q", configcheckArgs.format)
|
|
}
|
|
|
|
var hadErr bool
|
|
|
|
parseFlags := config.ParseFlagsNone
|
|
|
|
if configcheckArgs.skipCertCheck {
|
|
parseFlags |= config.ParseFlagsNoCertCheck
|
|
}
|
|
|
|
// further: try to build jobs
|
|
confJobs, err := job.JobsFromConfig(subcommand.Config(), parseFlags)
|
|
|
|
if err != nil {
|
|
err := errors.Wrap(err, "cannot build jobs from config")
|
|
if configcheckArgs.what == "jobs" {
|
|
return err
|
|
} else {
|
|
fmt.Fprintf(os.Stderr, "%s\n", err)
|
|
confJobs = nil
|
|
hadErr = true
|
|
}
|
|
}
|
|
|
|
// further: try to build logging outlets
|
|
outlets, err := logging.OutletsFromConfig(*subcommand.Config().Global.Logging)
|
|
if err != nil {
|
|
err := errors.Wrap(err, "cannot build logging from config")
|
|
if configcheckArgs.what == "logging" {
|
|
return err
|
|
} else {
|
|
fmt.Fprintf(os.Stderr, "%s\n", err)
|
|
outlets = nil
|
|
hadErr = true
|
|
}
|
|
}
|
|
|
|
whatMap := map[string]func(){
|
|
"all": func() {
|
|
o := struct {
|
|
config *config.Config
|
|
jobs []job.Job
|
|
logging *logger.Outlets
|
|
}{
|
|
subcommand.Config(),
|
|
confJobs,
|
|
outlets,
|
|
}
|
|
formatter(o)
|
|
},
|
|
"config": func() {
|
|
formatter(subcommand.Config())
|
|
},
|
|
"jobs": func() {
|
|
formatter(confJobs)
|
|
},
|
|
"logging": func() {
|
|
formatter(outlets)
|
|
},
|
|
}
|
|
|
|
wf, ok := whatMap[configcheckArgs.what]
|
|
if !ok {
|
|
return fmt.Errorf("unsupported --format %q", configcheckArgs.what)
|
|
}
|
|
wf()
|
|
|
|
if hadErr {
|
|
return fmt.Errorf("config parsing failed")
|
|
} else {
|
|
return nil
|
|
}
|
|
},
|
|
}
|