util

package
v1.2.0-alpha.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 15, 2015 License: Apache-2.0 Imports: 49 Imported by: 0

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 ¶

Constants ¶

This section is empty.

Variables ¶

View Source 
var ErrorHandlers = []func(error){logError}

ErrorHandlers is a list of functions which will be invoked when an unreturnable error occurs.

View Source 
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.

View Source 
var NeverStop <-chan struct{} = make(chan struct{})

NeverStop may be passed to Until to make it never stop.

View Source 
var PanicHandlers = []func(interface{}){logPanic}

PanicHandlers is a list of functions which will be invoked when a panic happens.

View Source 
var ReallyCrash bool

For testing, bypass HandleCrash.

Functions ¶

func AllPtrFieldsNil ¶ added in v0.8.0 

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 v1.1.0 

func ApplyRLimitForSelf(maxOpenFiles uint64)

func CertPoolFromFile ¶ added in v0.15.0 

func CertPoolFromFile(filename string) (*x509.CertPool, error)

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 ¶ added in v0.20.0 

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 ¶ added in v0.13.0 

func ChooseHostInterface() (net.IP, error)

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 ¶ 

func CompileRegexps(regexpStrings []string) ([]*regexp.Regexp, error)

Takes a list of strings and compiles them into a list of regular expressions

func DeadlockWatchdog ¶ added in v1.1.1 

func DeadlockWatchdog(lock sync.Locker, name string, maxLockPeriod time.Duration)

func DeadlockWatchdogReadLock ¶ added in v1.1.1 

func DeadlockWatchdogReadLock(lock *sync.RWMutex, name string, maxLockPeriod time.Duration)

DeadlockWatchdogReadLock creates a watchdog on read/write mutex. If the mutex can not be acquired for read access within 'maxLockPeriod', the program exits via glog.Exitf() or os.Exit() if that fails 'name' is a semantic name that is useful for the user and is printed on exit.

func DeepHashObject ¶ added in v0.8.0 

func DeepHashObject(hasher hash.Hash, objectToWrite interface{})

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 ¶ added in v0.19.0 

func EncodePrivateKey(private *rsa.PrivateKey) []byte

func EncodePublicKey ¶ added in v0.19.0 

func EncodePublicKey(public *rsa.PublicKey) ([]byte, error)

func EncodeSSHKey ¶ added in v0.19.0 

func EncodeSSHKey(public *rsa.PublicKey) ([]byte, error)

func EscapeQualifiedNameForDisk ¶ added in v0.14.0 

func EscapeQualifiedNameForDisk(in string) string

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 ¶ added in v0.10.0 

func ExecuteTemplate(w io.Writer, templateText string, data interface{}) error

ExecuteTemplate executes templateText with data and output written to w.

func ExecuteTemplateToString ¶ added in v0.10.0 

func ExecuteTemplateToString(templateText string, data interface{}) (string, error)

func FileExists ¶ added in v0.19.0 

func FileExists(filename string) (bool, error)

func FlushLogs ¶ 

func FlushLogs()

FlushLogs flushes logs immediately.

func Forever ¶ 

func Forever(f func(), period time.Duration)

Forever is syntactic sugar on top of Until

func GenerateKey ¶ added in v0.19.0 

func GenerateKey(bits int) (*rsa.PrivateKey, *rsa.PublicKey, error)

func GenerateSelfSignedCert ¶ added in v0.8.0 

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 GetClient ¶ added in v0.16.0 

func GetClient(req *http.Request) string

func GetIntOrPercentValue ¶ added in v1.1.0 

func GetIntOrPercentValue(intOrStr *intstr.IntOrString) (int, bool, error)

func GetValueFromPercent ¶ added in v1.1.0 

func GetValueFromPercent(percent int, value int) int

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 ¶ added in v0.10.0 

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 InitFlags ¶ added in v0.9.0 

func InitFlags()

InitFlags normalizes and parses the command line flags

func InitLogs ¶ 

func InitLogs()

InitLogs initializes logs the way we want for kubernetes.

func IsProbableEOF ¶ added in v0.16.0 

func IsProbableEOF(err error) bool

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 ¶ added in v0.10.0 

func JoinQualifiedName(namespace, name string) string

Joins 'namespace' and 'name' and returns a fully qualified name Assumes that the input is valid.

func JoinSchemeNamePort ¶ added in v1.1.2 

func JoinSchemeNamePort(scheme, name, port string) string

JoinSchemeNamePort returns a string that specifies the scheme, name, and port:

  • "<name>"
  • "<name>:<port>"
  • "<scheme>:<name>:<port>"

None of the parameters may contain a ':' character Name is required Scheme must be "", "http", or "https"

func MakePrivateKeySignerFromBytes ¶ added in v0.19.0 

func MakePrivateKeySignerFromBytes(buffer []byte) (ssh.Signer, error)

func MakePrivateKeySignerFromFile ¶ added in v0.19.0 

func MakePrivateKeySignerFromFile(key string) (ssh.Signer, error)

func NewCRLFWriter ¶ added in v1.2.0 

func NewCRLFWriter(w io.Writer) io.Writer

NewCRLFWriter implements a CR/LF line ending writer used for normalizing text for Windows platforms.

func NewLogger ¶ 

func NewLogger(prefix string) *log.Logger

NewLogger creates a new log.Logger which sends logs to glog.Info.

func NewUUID ¶ added in v0.5.1 

func NewUUID() types.UID

*

  • 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 ¶ added in v0.7.0 

func ObjectGoPrintSideBySide(a, b interface{}) string

ObjectGoPrintSideBySide prints a and b as textual dumps side by side, enabling easy visual scanning for mismatches.

func ParsePublicKeyFromFile ¶ added in v0.20.0 

func ParsePublicKeyFromFile(keyFile string) (*rsa.PublicKey, error)

func ReadDirNoExit ¶ added in v1.1.0 

func ReadDirNoExit(dirname string) ([]os.FileInfo, []error, error)

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 ¶ added in v0.16.0 

func RunInResourceContainer(containerName string) error

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 ¶ added in v0.19.0 

func RunSSHCommand(cmd, user, host string, signer ssh.Signer) (string, string, int, error)

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 SetTransportDefaults ¶ added in v1.1.2 

func SetTransportDefaults(t *http.Transport) *http.Transport

SetTransportDefaults applies the defaults from http.DefaultTransport for the Proxy, Dial, and TLSHandshakeTimeout fields if unset

func ShortenString ¶ added in v0.19.0 

func ShortenString(str string, n int) string

func SplitQualifiedName ¶ added in v0.10.0 

func SplitQualifiedName(str string) (string, string)

Splits a fully qualified name and returns its namespace and name. Assumes that the input 'str' has been validated.

func SplitSchemeNamePort ¶ added in v1.1.2 

func SplitSchemeNamePort(id string) (scheme, name, port string, valid bool)

SplitSchemeNamePort takes a string of the following forms:

  • "<name>", returns "", "<name>","", true
  • "<name>:<port>", returns "", "<name>","<port>",true
  • "<scheme>:<name>:<port>", returns "<scheme>","<name>","<port>",true

Name must be non-empty or valid will be returned false. Scheme must be "http" or "https" if specified Port is returned as a string, and it is not required to be numeric (could be used for a named port, for example).

func StringDiff ¶ 

func StringDiff(a, b string) string

StringDiff diffs a and b and returns a human readable diff.

func TLSClientConfig ¶ added in v1.1.2 

func TLSClientConfig(transport http.RoundTripper) (*tls.Config, error)

func Umask ¶ added in v1.1.0 

func Umask(mask int) (old int, err error)

func UnescapeQualifiedNameForDisk ¶ added in v0.14.0 

func UnescapeQualifiedNameForDisk(in string) string

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 ¶ added in v0.7.0 

func Until(f func(), period time.Duration, stopCh <-chan struct{})

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 ¶ added in v0.20.0 

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 ValidPublicAddrForMaster ¶ 

func ValidPublicAddrForMaster(bindAddress net.IP) (net.IP, error)

If bind-address is usable, return it directly If bind-address is not usable (unset, 0.0.0.0, or loopback), we will use the host's default interface.

func WarnWordSepNormalizeFunc ¶ added in v0.18.0 

func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName

WarnWordSepNormalizeFunc changes and warns for flags that contain "_" separators

func WordSepNormalizeFunc ¶ added in v0.17.0 

func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName

WordSepNormalizeFunc changes all flags that contain "_" separators

Types ¶

type Backoff ¶ added in v1.1.0 

type Backoff struct {
	sync.Mutex
	Clock Clock
	// contains filtered or unexported fields
}

func NewBackOff ¶ added in v1.1.0 

func NewBackOff(initial, max time.Duration) *Backoff

func (*Backoff) GC ¶ added in v1.1.0 

func (p *Backoff) GC()

Garbage collect records that have aged past maxDuration. Backoff users are expected to invoke this periodically.

func (*Backoff) Get ¶ added in v1.1.0 

func (p *Backoff) Get(id string) time.Duration

Get the current backoff Duration

func (*Backoff) IsInBackOffSince ¶ added in v1.1.0 

func (p *Backoff) IsInBackOffSince(id string, eventTime time.Time) bool

Returns True if the elapsed time since eventTime is smaller than the current backoff window

func (*Backoff) IsInBackOffSinceUpdate ¶ added in v1.2.0 

func (p *Backoff) IsInBackOffSinceUpdate(id string, eventTime time.Time) bool

Returns True if time since lastupdate is less than the current backoff window.

func (*Backoff) Next ¶ added in v1.1.0 

func (p *Backoff) Next(id string, eventTime time.Time)

move backoff to the next mark, capping at maxDuration

func (*Backoff) Reset ¶ added in v1.2.0 

func (p *Backoff) Reset(id string)

Reset forces clearing of all backoff data for a given key.

type BoolFlag ¶ added in v0.10.0 

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

func (*BoolFlag) Default ¶ added in v0.10.0 

func (f *BoolFlag) Default(value bool)

func (BoolFlag) Provided ¶ added in v0.10.0 

func (f BoolFlag) Provided() bool

func (*BoolFlag) Set ¶ added in v0.10.0 

func (f *BoolFlag) Set(value string) error

func (BoolFlag) String ¶ added in v0.10.0 

func (f BoolFlag) String() string

func (*BoolFlag) Type ¶ added in v0.10.0 

func (f *BoolFlag) Type() string

func (BoolFlag) Value ¶ added in v0.10.0 

func (f BoolFlag) Value() bool

type Cache ¶ added in v0.17.0 

type Cache []*cacheShard

func NewCache ¶ added in v0.17.0 

func NewCache(maxSize int) Cache

func (*Cache) Add ¶ added in v0.17.0 

func (c *Cache) Add(index uint64, obj interface{}) bool

Returns true if object already existed, false otherwise.

func (*Cache) Get ¶ added in v0.17.0 

func (c *Cache) Get(index uint64) (obj interface{}, found bool)

type Clock ¶ added in v0.8.0 

type Clock interface {
	Now() time.Time
	Since(time.Time) time.Duration
}

Clock allows for injecting fake or real clocks into code that needs to do arbitrary things based on time.

type ConfigurationMap ¶ added in v0.9.0 

type ConfigurationMap map[string]string

func (*ConfigurationMap) Set ¶ added in v0.9.0 

func (m *ConfigurationMap) Set(value string) error

func (*ConfigurationMap) String ¶ added in v0.9.0 

func (m *ConfigurationMap) String() string

func (*ConfigurationMap) Type ¶ added in v0.9.0 

func (*ConfigurationMap) Type() string

type DialFunc ¶ added in v1.1.2 

type DialFunc func(net, addr string) (net.Conn, error)

func Dialer ¶ added in v1.1.2 

func Dialer(transport http.RoundTripper) (DialFunc, error)

type FakeClock ¶ added in v0.8.0 

type FakeClock struct {
	Time time.Time
}

FakeClock implements Clock, but returns an arbitrary time.

func (*FakeClock) Now ¶ added in v0.8.0 

func (f *FakeClock) Now() time.Time

Now returns f's time.

func (*FakeClock) Since ¶ added in v0.15.0 

func (f *FakeClock) Since(ts time.Time) time.Duration

Since returns time since the time in f.

func (*FakeClock) Step ¶ added in v1.1.0 

func (f *FakeClock) Step(d time.Duration)

Move clock by Duration

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 ¶ added in v0.7.0 

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.

func (GlogWriter) Write ¶ 

func (writer GlogWriter) Write(data []byte) (n int, err error)

Write implements the io.Writer interface.

type IntervalClock ¶ added in v1.2.0 

type IntervalClock struct {
	Time     time.Time
	Duration time.Duration
}

IntervalClock implements Clock, but each invocation of Now steps the clock forward the specified duration

func (*IntervalClock) Now ¶ added in v1.2.0 

func (i *IntervalClock) Now() time.Time

Now returns i's time.

func (*IntervalClock) Since ¶ added in v1.2.0 

func (i *IntervalClock) Since(ts time.Time) time.Duration

Since returns time since the time in i.

type LineDelimiter ¶ added in v1.0.0 

type LineDelimiter struct {
	// contains filtered or unexported fields
}

A Line Delimiter is a filter that will

func NewLineDelimiter ¶ added in v1.0.0 

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 ¶ added in v1.0.0 

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.

func (*LineDelimiter) Write ¶ added in v1.0.0 

func (ld *LineDelimiter) Write(buf []byte) (n int, err error)

Write writes buf to the LineDelimiter ld. The only errors returned are ones encountered while writing to the underlying output 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 ¶ added in v0.18.0 

type PortRange struct {
	Base int
	Size int
}

PortRange represents a range of TCP/UDP ports. To represent a single port, set Size to 1.

func ParsePortRange ¶ added in v0.18.0 

func ParsePortRange(value string) (*PortRange, error)

ParsePortRange parses a string of the form "min-max", inclusive at both ends, and initializs a new PortRange from it.

func (*PortRange) Contains ¶ added in v0.18.0 

func (pr *PortRange) Contains(p int) bool

Contains tests whether a given port falls within the PortRange.

func (*PortRange) Set ¶ added in v0.18.0 

func (pr *PortRange) Set(value string) error

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.

func (PortRange) String ¶ added in v0.18.0 

func (pr PortRange) String() string

String converts the PortRange to a string representation, which can be parsed by PortRange.Set or ParsePortRange.

func (*PortRange) Type ¶ added in v0.18.0 

func (*PortRange) Type() string

Type returns a descriptive string about this type. This is part of the pflag.Value interface.

type RateLimiter ¶ 

type RateLimiter interface {
	// TryAccept returns true if a token is taken immediately. Otherwise,
	// it returns false.
	TryAccept() bool
	// Accept returns once a token becomes available.
	Accept()
	// Stop stops the rate limiter, subsequent calls to CanAccept will return false
	Stop()
	// Saturation returns a percentage number which describes how saturated
	// this rate limiter is.
	// Usually we use token bucket rate limiter. In that case,
	// 1.0 means no tokens are available; 0.0 means we have a full bucket of tokens to use.
	Saturation() float64
}

func NewFakeRateLimiter ¶ added in v0.15.0 

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 RealClock ¶ added in v0.8.0 

type RealClock struct{}

RealClock really calls time.Now()

func (RealClock) Now ¶ added in v0.8.0 

func (r RealClock) Now() time.Time

Now returns the current time.

func (RealClock) Since ¶ added in v0.15.0 

func (r RealClock) Since(ts time.Time) time.Duration

Since returns time since the specified timestamp.

type RoundTripperWrapper ¶ added in v1.1.2 

type RoundTripperWrapper interface {
	http.RoundTripper
	WrappedRoundTripper() http.RoundTripper
}

type Route ¶ added in v0.13.0 

type Route struct {
	Interface   string
	Destination net.IP
	Gateway     net.IP
}

type Runner ¶ added in v0.5.1 

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.

func NewRunner ¶ added in v0.5.1 

func NewRunner(f ...func(stop chan struct{})) *Runner

NewRunner makes a runner for the given function(s). The function(s) should loop until the channel is closed.

func (*Runner) Start ¶ added in v0.5.1 

func (r *Runner) Start()

Start begins running.

func (*Runner) Stop ¶ added in v0.5.1 

func (r *Runner) Stop()

Stop stops running.

type SSHTunnel ¶ added in v0.19.0 

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 ¶ added in v0.19.0 

func NewSSHTunnel(user, keyfile, host string) (*SSHTunnel, error)

func NewSSHTunnelFromBytes ¶ added in v0.19.0 

func NewSSHTunnelFromBytes(user string, privateKey []byte, host string) (*SSHTunnel, error)

func (*SSHTunnel) Close ¶ added in v0.19.0 

func (s *SSHTunnel) Close() error

func (*SSHTunnel) Dial ¶ added in v0.19.0 

func (s *SSHTunnel) Dial(network, address string) (net.Conn, error)

func (*SSHTunnel) Open ¶ added in v0.19.0 

func (s *SSHTunnel) Open() error

type SSHTunnelEntry ¶ added in v0.19.0 

type SSHTunnelEntry struct {
	Address string
	Tunnel  *SSHTunnel
}

Should be thread safe.

type SSHTunnelList ¶ added in v0.19.0 

type SSHTunnelList struct {
	// contains filtered or unexported fields
}

Not thread safe!

func MakeSSHTunnels ¶ added in v0.19.0 

func MakeSSHTunnels(user, keyfile string, addresses []string) *SSHTunnelList

func (*SSHTunnelList) Close ¶ added in v0.19.0 

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 ¶ added in v0.19.0 

func (l *SSHTunnelList) Has(addr string) bool

func (*SSHTunnelList) Len ¶ added in v0.19.1 

func (l *SSHTunnelList) Len() int

func (*SSHTunnelList) Open ¶ added in v0.19.0 

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 ¶ added in v0.20.0 

func (l *SSHTunnelList) PickRandomTunnel() (SSHTunnelEntry, error)

Returns a random tunnel, xor an error if there are none.

type StringFlag ¶ added in v0.10.0 

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 ¶ added in v0.18.0 

func NewStringFlag(defaultVal string) StringFlag

func (*StringFlag) Default ¶ added in v0.10.0 

func (f *StringFlag) Default(value string)

func (StringFlag) Provided ¶ added in v0.10.0 

func (f StringFlag) Provided() bool

func (*StringFlag) Set ¶ added in v0.10.0 

func (f *StringFlag) Set(value string) error

func (StringFlag) String ¶ added in v0.10.0 

func (f StringFlag) String() string

func (*StringFlag) Type ¶ added in v0.10.0 

func (f *StringFlag) Type() string

func (StringFlag) Value ¶ added in v0.10.0 

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).

type Trace ¶ added in v0.18.0 

type Trace struct {
	// contains filtered or unexported fields
}

func NewTrace ¶ added in v0.18.0 

func NewTrace(name string) *Trace

func (*Trace) Log ¶ added in v0.18.0 

func (t *Trace) Log()

func (*Trace) LogIfLong ¶ added in v0.18.0 

func (t *Trace) LogIfLong(threshold time.Duration)

func (*Trace) Step ¶ added in v0.18.0 

func (t *Trace) Step(msg string)

func (*Trace) TotalTime ¶ added in v0.18.0 

func (t *Trace) TotalTime() time.Duration

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
Package bandwidth provides utilities for bandwidth shaping
 Package bandwidth provides utilities for bandwidth shaping
Package chown provides an interface and implementations for things that run run the chmod system call.
 Package chown provides an interface and implementations for things that run run the chmod system call.
Package chown provides utilities to chown a path
 Package chown provides utilities to chown a path
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.
spdy
Package iptables provides an interface and implementations for running iptables commands.
 Package iptables provides an interface and implementations for running iptables commands.
testing
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 selinux contains selinux utility functions.
 Package selinux contains selinux utility functions.
Package sets has auto-generated set types.
 Package sets has auto-generated set types.
types
Package types just provides input types to the set generator.
 Package types just provides input types to the set generator.
Package slice provides utility methods for common operations on slices.
 Package slice provides utility methods for common operations on slices.
field
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.
Package wsstream contains utilities for streaming content over WebSockets.
 Package wsstream contains utilities for streaming content over WebSockets.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.