kubernetes
/
git-sync
mirror of https://github.com/kubernetes/git-sync.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Logging and error handling cleanup

This commit is contained in:
Tim Hockin 2022-06-25 16:12:52 -07:00
parent 467cbf3c76
commit 94e8d00093
1 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
cmd/git-sync/main.go
View File

@ -316,27 +316,27 @@ func main() {
} }
if *flRepo == "" { if *flRepo == "" {
handleError(log, true, "ERROR: --repo must be specified") handleConfigError(log, true, "ERROR: --repo must be specified")
} }
if *flDepth < 0 { // 0 means "no limit" if *flDepth < 0 { // 0 means "no limit"
handleError(log, true, "ERROR: --depth must be greater than or equal to 0") handleConfigError(log, true, "ERROR: --depth must be greater than or equal to 0")
} }
switch submodulesMode(*flSubmodules) { switch submodulesMode(*flSubmodules) {
case submodulesRecursive, submodulesShallow, submodulesOff: case submodulesRecursive, submodulesShallow, submodulesOff:
default: default:
handleError(log, true, "ERROR: --submodules must be one of %q, %q, or %q", submodulesRecursive, submodulesShallow, submodulesOff) handleConfigError(log, true, "ERROR: --submodules must be one of %q, %q, or %q", submodulesRecursive, submodulesShallow, submodulesOff)
} }
switch *flGitGC { switch *flGitGC {
case gcAuto, gcAlways, gcAggressive, gcOff: case gcAuto, gcAlways, gcAggressive, gcOff:
default: default:
handleError(log, true, "ERROR: --git-gc must be one of %q, %q, %q, or %q", gcAuto, gcAlways, gcAggressive, gcOff) handleConfigError(log, true, "ERROR: --git-gc must be one of %q, %q, %q, or %q", gcAuto, gcAlways, gcAggressive, gcOff)
} }
if *flRoot == "" { if *flRoot == "" {
handleError(log, true, "ERROR: --root must be specified") handleConfigError(log, true, "ERROR: --root must be specified")
} }
if *flDest != "" { if *flDest != "" {
@ -347,21 +347,21 @@ func main() {
*flLink = parts[len(parts)-1] *flLink = parts[len(parts)-1]
} }
if strings.HasPrefix(filepath.Base(*flLink), ".") { if strings.HasPrefix(filepath.Base(*flLink), ".") {
handleError(log, true, "ERROR: --link must not start with '.'") handleConfigError(log, true, "ERROR: --link must not start with '.'")
} }
if *flWait != 0 { if *flWait != 0 {
*flPeriod = time.Duration(int(*flWait*1000)) * time.Millisecond *flPeriod = time.Duration(int(*flWait*1000)) * time.Millisecond
} }
if *flPeriod < 10*time.Millisecond { if *flPeriod < 10*time.Millisecond {
handleError(log, true, "ERROR: --period must be at least 10ms") handleConfigError(log, true, "ERROR: --period must be at least 10ms")
} }
if *flTimeout != 0 { if *flTimeout != 0 {
*flSyncTimeout = time.Duration(*flTimeout) * time.Second *flSyncTimeout = time.Duration(*flTimeout) * time.Second
} }
if *flSyncTimeout < 10*time.Millisecond { if *flSyncTimeout < 10*time.Millisecond {
handleError(log, true, "ERROR: --sync-timeout must be at least 10ms") handleConfigError(log, true, "ERROR: --sync-timeout must be at least 10ms")
} }
if *flSyncHookCommand != "" { if *flSyncHookCommand != "" {
@ -369,56 +369,56 @@ func main() {
} }
if *flExechookCommand != "" { if *flExechookCommand != "" {
if *flExechookTimeout < time.Second { if *flExechookTimeout < time.Second {
handleError(log, true, "ERROR: --exechook-timeout must be at least 1s") handleConfigError(log, true, "ERROR: --exechook-timeout must be at least 1s")
} }
if *flExechookBackoff < time.Second { if *flExechookBackoff < time.Second {
handleError(log, true, "ERROR: --exechook-backoff must be at least 1s") handleConfigError(log, true, "ERROR: --exechook-backoff must be at least 1s")
} }
} }
if *flWebhookURL != "" { if *flWebhookURL != "" {
if *flWebhookStatusSuccess < -1 { if *flWebhookStatusSuccess < -1 {
handleError(log, true, "ERROR: --webhook-success-status must be a valid HTTP code or -1") handleConfigError(log, true, "ERROR: --webhook-success-status must be a valid HTTP code or -1")
} }
if *flWebhookTimeout < time.Second { if *flWebhookTimeout < time.Second {
handleError(log, true, "ERROR: --webhook-timeout must be at least 1s") handleConfigError(log, true, "ERROR: --webhook-timeout must be at least 1s")
} }
if *flWebhookBackoff < time.Second { if *flWebhookBackoff < time.Second {
handleError(log, true, "ERROR: --webhook-backoff must be at least 1s") handleConfigError(log, true, "ERROR: --webhook-backoff must be at least 1s")
} }
} }
if *flPassword != "" && *flPasswordFile != "" { if *flPassword != "" && *flPasswordFile != "" {
handleError(log, false, "ERROR: only one of --password and --password-file may be specified") handleConfigError(log, true, "ERROR: only one of --password and --password-file may be specified")
} }
if *flUsername != "" { if *flUsername != "" {
if *flPassword == "" && *flPasswordFile == "" { if *flPassword == "" && *flPasswordFile == "" {
handleError(log, true, "ERROR: --password or --password-file must be set when --username is specified") handleConfigError(log, true, "ERROR: --password or --password-file must be set when --username is specified")
} }
} }
if *flSSH { if *flSSH {
if *flUsername != "" { if *flUsername != "" {
handleError(log, false, "ERROR: only one of --ssh and --username may be specified") handleConfigError(log, true, "ERROR: only one of --ssh and --username may be specified")
} }
if *flPassword != "" { if *flPassword != "" {
handleError(log, false, "ERROR: only one of --ssh and --password may be specified") handleConfigError(log, true, "ERROR: only one of --ssh and --password may be specified")
} }
if *flPasswordFile != "" { if *flPasswordFile != "" {
handleError(log, false, "ERROR: only one of --ssh and --password-file may be specified") handleConfigError(log, true, "ERROR: only one of --ssh and --password-file may be specified")
} }
if *flAskPassURL != "" { if *flAskPassURL != "" {
handleError(log, false, "ERROR: only one of --ssh and --askpass-url may be specified") handleConfigError(log, true, "ERROR: only one of --ssh and --askpass-url may be specified")
} }
if *flCookieFile { if *flCookieFile {
handleError(log, false, "ERROR: only one of --ssh and --cookie-file may be specified") handleConfigError(log, true, "ERROR: only one of --ssh and --cookie-file may be specified")
} }
if *flSSHKeyFile == "" { if *flSSHKeyFile == "" {
handleError(log, true, "ERROR: --ssh-key-file must be specified when --ssh is specified") handleConfigError(log, true, "ERROR: --ssh-key-file must be specified when --ssh is specified")
} }
if *flSSHKnownHosts { if *flSSHKnownHosts {
if *flSSHKnownHostsFile == "" { if *flSSHKnownHostsFile == "" {
handleError(log, true, "ERROR: --ssh-known-hosts-file must be specified when --ssh-known-hosts is specified") handleConfigError(log, true, "ERROR: --ssh-known-hosts-file must be specified when --ssh-known-hosts is specified")
} }
} }
} }
@ -490,9 +490,9 @@ func main() {
// no long-running operations like `git clone`, so hopefully 30 seconds will be enough. // no long-running operations like `git clone`, so hopefully 30 seconds will be enough.
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
// Set additional configs we want, but users might override. // Set various configs we want, but users might override.
if err := git.setupDefaultGitConfigs(ctx); err != nil { if err := git.setupDefaultGitConfigs(ctx); err != nil {
log.Error(err, "ERROR: can't set default git configs") log.Error(err, "can't set default git configs")
os.Exit(1) os.Exit(1)
} }
@ -500,27 +500,27 @@ func main() {
if *flPasswordFile != "" { if *flPasswordFile != "" {
passwordFileBytes, err := ioutil.ReadFile(*flPasswordFile) passwordFileBytes, err := ioutil.ReadFile(*flPasswordFile)
if err != nil { if err != nil {
log.Error(err, "ERROR: can't read password file") log.Error(err, "can't read password file", "file", *flPasswordFile)
os.Exit(1) os.Exit(1)
} }
*flPassword = string(passwordFileBytes) *flPassword = string(passwordFileBytes)
} }
if err := git.StoreCredentials(ctx, *flUsername, *flPassword); err != nil { if err := git.StoreCredentials(ctx, *flUsername, *flPassword); err != nil {
log.Error(err, "ERROR: can't store git credentials") log.Error(err, "can't store git credentials")
os.Exit(1) os.Exit(1)
} }
} }
if *flSSH { if *flSSH {
if err := git.SetupGitSSH(*flSSHKnownHosts, *flSSHKeyFile, *flSSHKnownHostsFile); err != nil { if err := git.SetupGitSSH(*flSSHKnownHosts, *flSSHKeyFile, *flSSHKnownHostsFile); err != nil {
log.Error(err, "ERROR: can't set up git SSH") log.Error(err, "can't set up git SSH", "keyFile", *flSSHKeyFile, "knownHosts", *flSSHKnownHosts, "knownHostsFile", *flSSHKnownHostsFile)
os.Exit(1) os.Exit(1)
} }
} }
if *flCookieFile { if *flCookieFile {
if err := git.SetupCookieFile(ctx); err != nil { if err := git.SetupCookieFile(ctx); err != nil {
log.Error(err, "ERROR: can't set up git cookie file") log.Error(err, "can't set up git cookie file")
os.Exit(1) os.Exit(1)
} }
} }
@ -528,7 +528,7 @@ func main() {
// This needs to be after all other git-related config flags. // This needs to be after all other git-related config flags.
if *flGitConfig != "" { if *flGitConfig != "" {
if err := git.setupExtraGitConfigs(ctx, *flGitConfig); err != nil { if err := git.setupExtraGitConfigs(ctx, *flGitConfig); err != nil {
log.Error(err, "ERROR: can't set additional git configs") log.Error(err, "can't set additional git configs", "configs", *flGitConfig)
os.Exit(1) os.Exit(1)
} }
} }
@ -539,7 +539,7 @@ func main() {
if *flHTTPBind != "" { if *flHTTPBind != "" {
ln, err := net.Listen("tcp", *flHTTPBind) ln, err := net.Listen("tcp", *flHTTPBind)
if err != nil { if err != nil {
log.Error(err, "ERROR: failed to bind HTTP endpoint", "endpoint", *flHTTPBind) log.Error(err, "can't bind HTTP endpoint", "endpoint", *flHTTPBind)
os.Exit(1) os.Exit(1)
} }
mux := http.NewServeMux() mux := http.NewServeMux()
@ -814,9 +814,10 @@ func sleepForever() {
os.Exit(0) os.Exit(0)
} }
// handleError prints the error to the standard error, prints the usage if the `printUsage` flag is true, // handleConfigError prints the error to the standard error, prints the usage
// exports the error to the error file and exits the process with the exit code. // if the `printUsage` flag is true, exports the error to the error file and
func handleError(log *logging.Logger, printUsage bool, format string, a ...interface{}) { // exits the process with the exit code.
func handleConfigError(log *logging.Logger, printUsage bool, format string, a ...interface{}) {
s := fmt.Sprintf(format, a...) s := fmt.Sprintf(format, a...)
fmt.Fprintln(os.Stderr, s) fmt.Fprintln(os.Stderr, s)
if printUsage { if printUsage {