mirror of
https://github.com/optim-enterprises-bv/kubernetes.git
synced 2025-11-02 11:18:16 +00:00
b497d28d43
If an unknown command or a phase is called consistently return the same error. If a command that has subcommands is called return an error. To achieve the above add a new util function RequireSubcommand() that sets NoArgs and RunE for regular commands or a "phase" command. Remove MacroCommandLongDescription and just return an error that a subcommand is required from the phase runner. Fix minor comments capitalization. Perform other minor fixes in util/error.go.
118 lines
3.2 KiB
Go
118 lines
3.2 KiB
Go
/*
|
|
Copyright 2016 The Kubernetes 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 util
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
errorsutil "k8s.io/apimachinery/pkg/util/errors"
|
|
)
|
|
|
|
const (
|
|
// DefaultErrorExitCode defines exit the code for failed action generally
|
|
DefaultErrorExitCode = 1
|
|
// PreFlightExitCode defines exit the code for preflight checks
|
|
PreFlightExitCode = 2
|
|
// ValidationExitCode defines the exit code validation checks
|
|
ValidationExitCode = 3
|
|
)
|
|
|
|
var (
|
|
// ErrExit is an error returned when kubeadm is about to exit
|
|
ErrExit = errors.New("exit")
|
|
)
|
|
|
|
// fatal prints the message if set and then exits.
|
|
func fatal(msg string, code int) {
|
|
if len(msg) > 0 {
|
|
// add newline if needed
|
|
if !strings.HasSuffix(msg, "\n") {
|
|
msg += "\n"
|
|
}
|
|
|
|
fmt.Fprint(os.Stderr, msg)
|
|
}
|
|
os.Exit(code)
|
|
}
|
|
|
|
// CheckErr prints a user friendly error to STDERR and exits with a non-zero
|
|
// exit code. Unrecognized errors will be printed with an "error: " prefix.
|
|
//
|
|
// This method is generic to the command in use and may be used by non-Kubectl
|
|
// commands.
|
|
func CheckErr(err error) {
|
|
checkErr(err, fatal)
|
|
}
|
|
|
|
// preflightError allows us to know if the error is a preflight error or not
|
|
// defining the interface here avoids an import cycle of pulling in preflight into the util package
|
|
type preflightError interface {
|
|
Preflight() bool
|
|
}
|
|
|
|
// checkErr formats a given error as a string and calls the passed handleErr
|
|
// func with that string and an exit code.
|
|
func checkErr(err error, handleErr func(string, int)) {
|
|
if err == nil {
|
|
return
|
|
}
|
|
|
|
msg := fmt.Sprintf("%s\nTo see the stack trace of this error execute with --v=5 or higher", err.Error())
|
|
// Check if the verbosity level in klog is high enough and print a stack trace.
|
|
f := flag.CommandLine.Lookup("v")
|
|
if f != nil {
|
|
// Assume that the "v" flag contains a parsable Int32 as per klog's "Level" type alias,
|
|
// thus no error from ParseInt is handled here.
|
|
if v, e := strconv.ParseInt(f.Value.String(), 10, 32); e == nil {
|
|
// https://git.k8s.io/community/contributors/devel/sig-instrumentation/logging.md
|
|
// klog.V(5) - Trace level verbosity
|
|
if v > 4 {
|
|
msg = fmt.Sprintf("%+v", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
switch {
|
|
case err == ErrExit:
|
|
handleErr("", DefaultErrorExitCode)
|
|
default:
|
|
switch err.(type) {
|
|
case preflightError:
|
|
handleErr(msg, PreFlightExitCode)
|
|
case errorsutil.Aggregate:
|
|
handleErr(msg, ValidationExitCode)
|
|
default:
|
|
handleErr(msg, DefaultErrorExitCode)
|
|
}
|
|
}
|
|
}
|
|
|
|
// FormatErrMsg returns a human-readable string describing the slice of errors passed to the function
|
|
func FormatErrMsg(errs []error) string {
|
|
var errMsg string
|
|
for _, err := range errs {
|
|
errMsg = fmt.Sprintf("%s\t- %s\n", errMsg, err.Error())
|
|
}
|
|
return errMsg
|
|
}
|