Documentation ¶
Overview ¶
Package util implements various utility functions used in both testing and implementation of Kubernetes. Package util may not depend on any other package in the Kubernetes package tree.
Index ¶
- Variables
- func AllPtrFieldsNil(obj interface{}) bool
- func ApplyRLimitForSelf(maxOpenFiles uint64)
- func CertPoolFromFile(filename string) (*x509.CertPool, error)
- func CertsFromPEM(pemCerts []byte) ([]*x509.Certificate, error)
- func ChooseHostInterface() (net.IP, error)
- func CompileRegexps(regexpStrings []string) ([]*regexp.Regexp, error)
- func DeepHashObject(hasher hash.Hash, objectToWrite interface{})
- func EncodePrivateKey(private *rsa.PrivateKey) []byte
- func EncodePublicKey(public *rsa.PublicKey) ([]byte, error)
- func EncodeSSHKey(public *rsa.PublicKey) ([]byte, error)
- func EscapeQualifiedNameForDisk(in string) string
- func ExecuteTemplate(w io.Writer, templateText string, data interface{}) error
- func ExecuteTemplateToString(templateText string, data interface{}) (string, error)
- func FileExists(filename string) (bool, error)
- func FlushLogs()
- func Forever(f func(), period time.Duration)
- func GenerateKey(bits int) (*rsa.PrivateKey, *rsa.PublicKey, error)
- func GenerateSelfSignedCert(host, certPath, keyPath string, alternateIPs []net.IP, alternateDNS []string) error
- func GetClient(req *http.Request) string
- func GetIntOrPercentValue(intStr *IntOrString) (int, bool, error)
- func GetValueFromPercent(percent int, value int) int
- func HandleCrash(additionalHandlers ...func(interface{}))
- func HandleError(err error)
- func InitFlags()
- func InitLogs()
- func IsProbableEOF(err error) bool
- func JoinQualifiedName(namespace, name string) string
- func MakePrivateKeySignerFromBytes(buffer []byte) (ssh.Signer, error)
- func MakePrivateKeySignerFromFile(key string) (ssh.Signer, error)
- func NewLogger(prefix string) *log.Logger
- func NewUUID() types.UID
- func ObjectDiff(a, b interface{}) string
- func ObjectGoPrintDiff(a, b interface{}) string
- func ObjectGoPrintSideBySide(a, b interface{}) string
- func ParsePublicKeyFromFile(keyFile string) (*rsa.PublicKey, error)
- func ReadDirNoExit(dirname string) ([]os.FileInfo, []error, error)
- func RunInResourceContainer(containerName string) error
- func RunSSHCommand(cmd, user, host string, signer ssh.Signer) (string, string, int, error)
- func ShortenString(str string, n int) string
- func SplitPort(id string) (name, port string, valid bool)
- func SplitQualifiedName(str string) (string, string)
- func StringDiff(a, b string) string
- func Umask(mask int) (old int, err error)
- func UnescapeQualifiedNameForDisk(in string) string
- func Until(f func(), period time.Duration, stopCh <-chan struct{})
- func UsingSystemdInitSystem() bool
- func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
- func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
- type AtomicValue
- type Backoff
- type BoolFlag
- type Cache
- type Clock
- type ConfigurationMap
- type FakeClock
- type FakeHandler
- type GlogWriter
- type HighWaterMark
- type IntOrString
- type IntstrKind
- type LineDelimiter
- type LogInterface
- type PortRange
- type RateLimiter
- type RealClock
- type Route
- type Runner
- type SSHTunnel
- type SSHTunnelEntry
- type SSHTunnelList
- type StringFlag
- type TestInterface
- type Trace
Constants ¶
This section is empty.
Variables ¶
var ErrorHandlers = []func(error){logError}
ErrorHandlers is a list of functions which will be invoked when an unreturnable error occurs.
var ForeverTestTimeout = time.Second * 30
For any test of the style:
... <- time.After(timeout): t.Errorf("Timed out")
The value for timeout should effectively be "forever." Obviously we don't want our tests to truly lock up forever, but 30s is long enough that it is effectively forever for the things that can slow down a run on a heavily contended machine (GC, seeks, etc), but not so long as to make a developer ctrl-c a test run if they do happen to break that test.
var NeverStop <-chan struct{} = make(chan struct{})
NeverStop may be passed to Until to make it never stop.
var PanicHandlers = []func(interface{}){logPanic}
PanicHandlers is a list of functions which will be invoked when a panic happens.
var ReallyCrash bool
For testing, bypass HandleCrash.
Functions ¶
func AllPtrFieldsNil ¶
func AllPtrFieldsNil(obj interface{}) bool
Tests whether all pointer fields in a struct are nil. This is useful when, for example, an API struct is handled by plugins which need to distinguish "no plugin accepted this spec" from "this spec is empty".
This function is only valid for structs and pointers to structs. Any other type will cause a panic. Passing a typed nil pointer will return true.
func ApplyRLimitForSelf ¶ added in v0.19.0
func ApplyRLimitForSelf(maxOpenFiles uint64)
func CertPoolFromFile ¶
CertPoolFromFile returns an x509.CertPool containing the certificates in the given PEM-encoded file. Returns an error if the file could not be read, a certificate could not be parsed, or if the file does not contain any certificates
func CertsFromPEM ¶
func CertsFromPEM(pemCerts []byte) ([]*x509.Certificate, error)
CertsFromPEM returns the x509.Certificates contained in the given PEM-encoded byte array Returns an error if a certificate could not be parsed, or if the data does not contain any certificates
func ChooseHostInterface ¶
ChooseHostInterface is a method used fetch an IP for a daemon. It uses data from /proc/net/route file. For a node with no internet connection ,it returns error For a multi n/w interface node it returns the IP of the interface with gateway on it.
func CompileRegexps ¶
Takes a list of strings and compiles them into a list of regular expressions
func DeepHashObject ¶
DeepHashObject writes specified object to hash using the spew library which follows pointers and prints actual values of the nested objects ensuring the hash does not change when a pointer changes.
func EncodePrivateKey ¶
func EncodePrivateKey(private *rsa.PrivateKey) []byte
func EscapeQualifiedNameForDisk ¶
EscapeQualifiedNameForDisk converts a plugin name, which might contain a / into a string that is safe to use on-disk. This assumes that the input has already been validates as a qualified name. we use "~" rather than ":" here in case we ever use a filesystem that doesn't allow ":".
func ExecuteTemplate ¶
ExecuteTemplate executes templateText with data and output written to w.
func ExecuteTemplateToString ¶
func FileExists ¶
func GenerateKey ¶
func GenerateSelfSignedCert ¶
func GenerateSelfSignedCert(host, certPath, keyPath string, alternateIPs []net.IP, alternateDNS []string) error
GenerateSelfSignedCert creates a self-signed certificate and key for the given host. Host may be an IP or a DNS name You may also specify additional subject alt names (either ip or dns names) for the certificate The certificate will be created with file mode 0644. The key will be created with file mode 0600. If the certificate or key files already exist, they will be overwritten. Any parent directories of the certPath or keyPath will be created as needed with file mode 0755.
func GetIntOrPercentValue ¶ added in v0.19.0
func GetIntOrPercentValue(intStr *IntOrString) (int, bool, error)
func GetValueFromPercent ¶ added in v0.19.0
func HandleCrash ¶
func HandleCrash(additionalHandlers ...func(interface{}))
HandleCrash simply catches a crash and logs an error. Meant to be called via defer. Additional context-specific handlers can be provided, and will be called in case of panic
func HandleError ¶
func HandleError(err error)
HandlerError is a method to invoke when a non-user facing piece of code cannot return an error and needs to indicate it has been ignored. Invoking this method is preferable to logging the error - the default behavior is to log but the errors may be sent to a remote server for analysis.
func IsProbableEOF ¶
IsProbableEOF returns true if the given error resembles a connection termination scenario that would justify assuming that the watch is empty. These errors are what the Go http stack returns back to us which are general connection closure errors (strongly correlated) and callers that need to differentiate probable errors in connection behavior between normal "this is disconnected" should use the method.
func JoinQualifiedName ¶
Joins 'namespace' and 'name' and returns a fully qualified name Assumes that the input is valid.
func NewUUID ¶
*
- The UUID package is naive and can generate identical UUIDs if the time interval is quick enough.
- Block subsequent UUIDs for 200 Nanoseconds, the UUID uses 100 ns increments, we block for 200 to be safe
- Blocks in a go routine, so that the caller doesn't have to wait.
- TODO: save old unused UUIDs so that no one has to block.
func ObjectDiff ¶
func ObjectDiff(a, b interface{}) string
ObjectDiff writes the two objects out as JSON and prints out the identical part of the objects followed by the remaining part of 'a' and finally the remaining part of 'b'. For debugging tests.
func ObjectGoPrintDiff ¶
func ObjectGoPrintDiff(a, b interface{}) string
ObjectGoPrintDiff is like ObjectDiff, but uses go-spew to print the objects, which shows absolutely everything by recursing into every single pointer (go's %#v formatters OTOH stop at a certain point). This is needed when you can't figure out why reflect.DeepEqual is returning false and nothing is showing you differences. This will.
func ObjectGoPrintSideBySide ¶
func ObjectGoPrintSideBySide(a, b interface{}) string
ObjectGoPrintSideBySide prints a and b as textual dumps side by side, enabling easy visual scanning for mismatches.
func ReadDirNoExit ¶ added in v0.19.0
borrowed from ioutil.ReadDir ReadDir reads the directory named by dirname and returns a list of directory entries, minus those with lstat errors
func RunInResourceContainer ¶
Creates resource-only containerName if it does not already exist and moves the current process to it.
containerName must be an absolute container name.
func RunSSHCommand ¶
RunSSHCommand returns the stdout, stderr, and exit code from running cmd on host as specific user, along with any SSH-level error. If user=="", it will default (like SSH) to os.Getenv("USER")
func ShortenString ¶
func SplitPort ¶
Takes a string of the form "name:port" or "name".
- If id is of the form "name" or "name:", then return (name, "", true)
- If id is of the form "name:port", then return (name, port, true)
- Otherwise, return ("", "", false)
Additionally, name must be non-empty or valid will be returned false.
Port is returned as a string, and it is not required to be numeric (could be used for a named port, for example).
func SplitQualifiedName ¶
Splits a fully qualified name and returns its namespace and name. Assumes that the input 'str' has been validated.
func StringDiff ¶
StringDiff diffs a and b and returns a human readable diff.
func UnescapeQualifiedNameForDisk ¶
UnescapeQualifiedNameForDisk converts an escaped plugin name (as per EscapeQualifiedNameForDisk) back to its normal form. This assumes that the input has already been validates as a qualified name.
func Until ¶
Until loops until stop channel is closed, running f every period. Catches any panics, and keeps going. f may not be invoked if stop channel is already closed. Pass NeverStop to Until if you don't want it stop.
func UsingSystemdInitSystem ¶
func UsingSystemdInitSystem() bool
Detects if using systemd as the init system Please note that simply reading /proc/1/cmdline can be misleading because some installation of various init programs can automatically make /sbin/init a symlink or even a renamed version of their main program. TODO(dchen1107): realiably detects the init system using on the system: systemd, upstart, initd, etc.
func WarnWordSepNormalizeFunc ¶
func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
WarnWordSepNormalizeFunc changes and warns for flags that contain "_" separators
func WordSepNormalizeFunc ¶
func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
WordSepNormalizeFunc changes all flags that contain "_" separators
Types ¶
type AtomicValue ¶
type AtomicValue struct {
// contains filtered or unexported fields
}
TODO(ArtfulCoder) sync/atomic/Value was added in golang 1.4 Once support is dropped for go 1.3, this type must be deprecated in favor of sync/atomic/Value. The functions are named Load/Store to match sync/atomic/Value function names.
func (*AtomicValue) Load ¶
func (at *AtomicValue) Load() interface{}
func (*AtomicValue) Store ¶
func (at *AtomicValue) Store(val interface{})
type Backoff ¶ added in v0.19.0
func NewBackOff ¶ added in v0.19.0
func (*Backoff) GC ¶ added in v0.19.0
func (p *Backoff) GC()
Garbage collect records that have aged past maxDuration. Backoff users are expected to invoke this periodically.
func (*Backoff) IsInBackOffSince ¶ added in v0.19.0
Returns True if the elapsed time since eventTime is smaller than the current backoff window
type BoolFlag ¶
type BoolFlag struct {
// contains filtered or unexported fields
}
BoolFlag is a boolean flag compatible with flags and pflags that keeps track of whether it had a value supplied or not. Beware! If you use this type, you must actually specify --flag-name=true, you cannot leave it as --flag-name and still have the value set
type Cache ¶
type Cache []*cacheShard
type Clock ¶
Clock allows for injecting fake or real clocks into code that needs to do arbitrary things based on time.
type ConfigurationMap ¶
func (*ConfigurationMap) Set ¶
func (m *ConfigurationMap) Set(value string) error
func (*ConfigurationMap) String ¶
func (m *ConfigurationMap) String() string
func (*ConfigurationMap) Type ¶
func (*ConfigurationMap) Type() string
type FakeClock ¶
FakeClock implements Clock, but returns an arbitrary time.
type FakeHandler ¶
type FakeHandler struct { RequestReceived *http.Request RequestBody string StatusCode int ResponseBody string // For logging - you can use a *testing.T // This will keep log messages associated with the test. T LogInterface // contains filtered or unexported fields }
FakeHandler is to assist in testing HTTP requests. Notice that FakeHandler is not thread safe and you must not direct traffic to except for the request you want to test. You can do this by hiding it in an http.ServeMux.
func (*FakeHandler) ServeHTTP ¶
func (f *FakeHandler) ServeHTTP(response http.ResponseWriter, request *http.Request)
func (*FakeHandler) ValidateRequest ¶
func (f *FakeHandler) ValidateRequest(t TestInterface, expectedPath, expectedMethod string, body *string)
ValidateRequest verifies that FakeHandler received a request with expected path, method, and body.
func (*FakeHandler) ValidateRequestCount ¶
func (f *FakeHandler) ValidateRequestCount(t TestInterface, count int) bool
type GlogWriter ¶
type GlogWriter struct{}
GlogWriter serves as a bridge between the standard log package and the glog package.
type HighWaterMark ¶
type HighWaterMark int64
HighWaterMark is a thread-safe object for tracking the maximum value seen for some quantity.
func (*HighWaterMark) Check ¶
func (hwm *HighWaterMark) Check(current int64) bool
Check returns true if and only if 'current' is the highest value ever seen.
type IntOrString ¶
type IntOrString struct { Kind IntstrKind IntVal int StrVal string }
IntOrString is a type that can hold an int or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.
func NewIntOrStringFromInt ¶
func NewIntOrStringFromInt(val int) IntOrString
NewIntOrStringFromInt creates an IntOrString object with an int value.
func NewIntOrStringFromString ¶
func NewIntOrStringFromString(val string) IntOrString
NewIntOrStringFromString creates an IntOrString object with a string value.
func (*IntOrString) Fuzz ¶
func (intstr *IntOrString) Fuzz(c fuzz.Continue)
func (IntOrString) MarshalJSON ¶
func (intstr IntOrString) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface.
func (*IntOrString) String ¶
func (intstr *IntOrString) String() string
String returns the string value, or Itoa's the int value.
func (*IntOrString) UnmarshalJSON ¶
func (intstr *IntOrString) UnmarshalJSON(value []byte) error
UnmarshalJSON implements the json.Unmarshaller interface.
type IntstrKind ¶
type IntstrKind int
IntstrKind represents the stored type of IntOrString.
const ( IntstrInt IntstrKind = iota // The IntOrString holds an int. IntstrString // The IntOrString holds a string. )
type LineDelimiter ¶
type LineDelimiter struct {
// contains filtered or unexported fields
}
A Line Delimiter is a filter that will
func NewLineDelimiter ¶
func NewLineDelimiter(output io.Writer, delimiter string) *LineDelimiter
NewLineDelimiter allocates a new io.Writer that will split input on lines and bracket each line with the delimiter string. This can be useful in output tests where it is difficult to see and test trailing whitespace.
func (*LineDelimiter) Flush ¶
func (ld *LineDelimiter) Flush() (err error)
Flush all lines up until now. This will assume insert a linebreak at the current point of the stream.
type LogInterface ¶
type LogInterface interface {
Logf(format string, args ...interface{})
}
LogInterface is a simple interface to allow injection of Logf to report serving errors.
type PortRange ¶
PortRange represents a range of TCP/UDP ports. To represent a single port, set Size to 1.
func ParsePortRange ¶
ParsePortRange parses a string of the form "min-max", inclusive at both ends, and initializs a new PortRange from it.
func (*PortRange) Set ¶
Set parses a string of the form "min-max", inclusive at both ends, and sets the PortRange from it. This is part of the flag.Value and pflag.Value interfaces.
type RateLimiter ¶
type RateLimiter interface { // CanAccept returns true if the rate is below the limit, false otherwise CanAccept() bool // Accept returns once a token becomes available. Accept() // Stop stops the rate limiter, subsequent calls to CanAccept will return false Stop() }
func NewFakeRateLimiter ¶
func NewFakeRateLimiter() RateLimiter
func NewTokenBucketRateLimiter ¶
func NewTokenBucketRateLimiter(qps float32, burst int) RateLimiter
NewTokenBucketRateLimiter creates a rate limiter which implements a token bucket approach. The rate limiter allows bursts of up to 'burst' to exceed the QPS, while still maintaining a smoothed qps rate of 'qps'. The bucket is initially filled with 'burst' tokens, and refills at a rate of 'qps'. The maximum number of tokens in the bucket is capped at 'burst'.
type Runner ¶
type Runner struct {
// contains filtered or unexported fields
}
Runner is an abstraction to make it easy to start and stop groups of things that can be described by a single function which waits on a channel close to exit.
type SSHTunnel ¶
type SSHTunnel struct { Config *ssh.ClientConfig Host string SSHPort string // contains filtered or unexported fields }
TODO: Unit tests for this code, we can spin up a test SSH server with instructions here: https://godoc.org/golang.org/x/crypto/ssh#ServerConn
func NewSSHTunnel ¶
func NewSSHTunnelFromBytes ¶
type SSHTunnelEntry ¶
Should be thread safe.
type SSHTunnelList ¶
type SSHTunnelList struct {
// contains filtered or unexported fields
}
Not thread safe!
func MakeSSHTunnels ¶
func MakeSSHTunnels(user, keyfile string, addresses []string) *SSHTunnelList
func (*SSHTunnelList) Close ¶
func (l *SSHTunnelList) Close()
Close asynchronously closes all tunnels in the list after waiting for 1 minute. Tunnels will still be open upon this function's return, but should no longer be used.
func (*SSHTunnelList) Has ¶
func (l *SSHTunnelList) Has(addr string) bool
func (*SSHTunnelList) Len ¶
func (l *SSHTunnelList) Len() int
func (*SSHTunnelList) Open ¶
func (l *SSHTunnelList) Open() error
Open attempts to open all tunnels in the list, and removes any tunnels that failed to open.
func (*SSHTunnelList) PickRandomTunnel ¶
func (l *SSHTunnelList) PickRandomTunnel() (SSHTunnelEntry, error)
Returns a random tunnel, xor an error if there are none.
type StringFlag ¶
type StringFlag struct {
// contains filtered or unexported fields
}
StringFlag is a string flag compatible with flags and pflags that keeps track of whether it had a value supplied or not.
func NewStringFlag ¶
func NewStringFlag(defaultVal string) StringFlag
func (*StringFlag) Default ¶
func (f *StringFlag) Default(value string)
func (StringFlag) Provided ¶
func (f StringFlag) Provided() bool
func (*StringFlag) Set ¶
func (f *StringFlag) Set(value string) error
func (StringFlag) String ¶
func (f StringFlag) String() string
func (*StringFlag) Type ¶
func (f *StringFlag) Type() string
func (StringFlag) Value ¶
func (f StringFlag) Value() string
type TestInterface ¶
type TestInterface interface { Errorf(format string, args ...interface{}) Logf(format string, args ...interface{}) }
TestInterface is a simple interface providing Errorf, to make injection for testing easier (insert 'yo dawg' meme here).
Source Files ¶
- atomic_value.go
- backoff.go
- bool_flag.go
- cache.go
- clock.go
- configuration_map.go
- crypto.go
- diff.go
- doc.go
- escape.go
- fake_handler.go
- flags.go
- hash.go
- http.go
- line_delimiter.go
- logs.go
- port_range.go
- port_split.go
- resource_container_linux.go
- runner.go
- ssh.go
- string_flag.go
- template.go
- throttle.go
- trace.go
- umask.go
- util.go
- uuid.go
Directories ¶
Path | Synopsis |
---|---|
Package bandwidth provides utilities for bandwidth shaping
|
Package bandwidth provides utilities for bandwidth shaping |
Package config provides utility objects for decoupling sources of configuration and the actual configuration state.
|
Package config provides utility objects for decoupling sources of configuration and the actual configuration state. |
Package dbus provides an injectable interface and implementations for D-Bus communication
|
Package dbus provides an injectable interface and implementations for D-Bus communication |
Package errors implements various utility functions and types around errors.
|
Package errors implements various utility functions and types around errors. |
Package exec provides an injectable interface and implementations for running commands.
|
Package exec provides an injectable interface and implementations for running commands. |
Package flushwriter implements a wrapper for a writer that flushes on every write if that writer implements the io.Flusher interface
|
Package flushwriter implements a wrapper for a writer that flushes on every write if that writer implements the io.Flusher interface |
Package httpstream adds multiplexed streaming support to HTTP requests and responses via connection upgrades.
|
Package httpstream adds multiplexed streaming support to HTTP requests and responses via connection upgrades. |
Package iptables provides an interface and implementations for running iptables commands.
|
Package iptables provides an interface and implementations for running iptables commands. |
package jsonpath is a template engine using jsonpath syntax, which can be seen at http://goessner.net/articles/JsonPath/.
|
package jsonpath is a template engine using jsonpath syntax, which can be seen at http://goessner.net/articles/JsonPath/. |
Package limitwriter provides a writer that only allows a certain number of bytes to be written.
|
Package limitwriter provides a writer that only allows a certain number of bytes to be written. |
Package mount defines an interface to mounting filesystems.
|
Package mount defines an interface to mounting filesystems. |
Package oom implements utility functions relating to out of memory management.
|
Package oom implements utility functions relating to out of memory management. |
Package procfs implements utility functions relating to the /proc mount.
|
Package procfs implements utility functions relating to the /proc mount. |
Package proxy provides transport and upgrade support for proxies
|
Package proxy provides transport and upgrade support for proxies |
Package rand provides utilities related to randomization.
|
Package rand provides utilities related to randomization. |
Package slice provides utility methods for common operations on slices.
|
Package slice provides utility methods for common operations on slices. |
Package wait provides tools for polling or listening for changes to a condition.
|
Package wait provides tools for polling or listening for changes to a condition. |
Package workqueue provides a simple queue that supports the following features: * Fair: items processed in the order in which they are added.
|
Package workqueue provides a simple queue that supports the following features: * Fair: items processed in the order in which they are added. |