Documentation
¶
Index ¶
- Constants
- func AllocProfileDiff(t testing.TB, beforePath, afterPath string, fn func())
- func FillCerts(cfg *base.Config)
- func IsError(err error, re string) bool
- func IsPError(pErr *roachpb.Error, re string) bool
- func MakeAmbientCtx() log.AmbientContext
- func MakeKey(keys ...[]byte) []byte
- func MatchInOrder(s string, res ...string) error
- func NewNodeTestBaseContext() *base.Config
- func NewTestBaseContext(user string) *base.Config
- func NightlyStress() bool
- func ReadAllFiles(pattern string)
- func RunTrueAndFalse(t *testing.T, name string, fn func(t *testing.T, b bool))
- func SortStructs(s interface{}, fieldNames ...string)
- func SucceedsSoon(t testing.TB, fn func() error)
- func SucceedsSoonError(fn func() error) error
- func TempDir(t testing.TB) (string, func())
- func WriteProfile(t testing.TB, name string, path string)
- type PartitionableConn
- func (c *PartitionableConn) Finish()
- func (c *PartitionableConn) PartitionC2S()
- func (c *PartitionableConn) PartitionS2C()
- func (c *PartitionableConn) Read(b []byte) (n int, err error)
- func (c *PartitionableConn) UnpartitionC2S()
- func (c *PartitionableConn) UnpartitionS2C()
- func (c *PartitionableConn) Write(b []byte) (n int, err error)
Constants ¶
const DefaultSucceedsSoonDuration = 45 * time.Second
DefaultSucceedsSoonDuration is the maximum amount of time unittests will wait for a condition to become true. See SucceedsSoon().
Variables ¶
This section is empty.
Functions ¶
func AllocProfileDiff ¶
AllocProfileDiff writes two alloc profiles, one before running closure and one after. This is similar in spirit to passing the -memprofile flag to a test or benchmark, but make it possible to subtract out setup code, which -memprofile does not.
Example usage:
setupCode()
AllocProfileDiff(t, "mem.before", "mem.after", func() {
interestingCode()
})
The resulting profiles are then diffed via:
go tool pprof -base mem.before mem.after
func IsError ¶
IsError returns true if the error string matches the supplied regex. An empty regex is interpreted to mean that a nil error is expected.
func IsPError ¶
IsPError returns true if pErr's message matches the supplied regex. An empty regex is interpreted to mean that a nil error is expected.
func MakeAmbientCtx ¶
func MakeAmbientCtx() log.AmbientContext
MakeAmbientCtx creates an AmbientContext with a Tracer in it.
func MatchInOrder ¶
MatchInOrder matches interprets the given slice of strings as a slice of regular expressions and checks that they match, in order and without overlap, against the given string. For example, if s=abcdefg and res=ab,cd,fg no error is returned, whereas res=abc,cde would return a descriptive error about failing to match cde.
func NewNodeTestBaseContext ¶
NewNodeTestBaseContext creates a base context for testing. This uses embedded certs and the default node user. The default node user has both server and client certificates.
func NewTestBaseContext ¶
NewTestBaseContext creates a secure base context for user.
func NightlyStress ¶
func NightlyStress() bool
NightlyStress returns true iff the process is running as part of CockroachDB's nightly stress tests.
func ReadAllFiles ¶
func ReadAllFiles(pattern string)
ReadAllFiles reads all of the files matching pattern, thus ensuring they are in the OS buffer cache.
func RunTrueAndFalse ¶
RunTrueAndFalse calls the provided function in a subtest, first with the boolean argument set to false and next with the boolean argument set to true.
func SortStructs ¶
func SortStructs(s interface{}, fieldNames ...string)
SortStructs sorts the given slice of structs using the given fields as the ordered sort keys.
func SucceedsSoon ¶
SucceedsSoon fails the test (with t.Fatal) unless the supplied function runs without error within a preset maximum duration. The function is invoked immediately at first and then successively with an exponential backoff starting at 1ns and ending at around 1s.
func SucceedsSoonError ¶
SucceedsSoonError returns an error unless the supplied function runs without error within a preset maximum duration. The function is invoked immediately at first and then successively with an exponential backoff starting at 1ns and ending at around 1s.
Types ¶
type PartitionableConn ¶
type PartitionableConn struct {
// We embed a net.Conn so that we inherit the interface. Note that we override
// Read() and Write().
//
// This embedded Conn is half of a net.Pipe(). The other half is clientConn.
net.Conn
// contains filtered or unexported fields
}
PartitionableConn is an implementation of net.Conn that allows the client->server and/or the server->client directions to be temporarily partitioned.
A PartitionableConn wraps a provided net.Conn (the serverConn member) and forwards every read and write to it. It interposes an arbiter in front of it that's used to block reads/writes while the PartitionableConn is in the partitioned mode.
While a direction is partitioned, data sent in that direction doesn't flow. A write while partitioned will block after an internal buffer gets filled. Data written to the conn after the partition has been established is not delivered to the remote party until the partition is lifted. At that time, all the buffered data is delivered. Since data is delivered async, data written before the partition is established may or may not be blocked by the partition; use application-level ACKs if that's important.
func NewPartitionableConn ¶
func NewPartitionableConn(serverConn net.Conn) *PartitionableConn
NewPartitionableConn wraps serverConn in a PartitionableConn.
func (*PartitionableConn) Finish ¶
func (c *PartitionableConn) Finish()
Finish removes any partitions that may exist so that blocked goroutines can finish. Finish() must be called if a connection may have been left in a partitioned state.
func (*PartitionableConn) PartitionC2S ¶
func (c *PartitionableConn) PartitionC2S()
PartitionC2S partitions the client-to-server direction. If UnpartitionC2S() is not called, Finish() must be called.
func (*PartitionableConn) PartitionS2C ¶
func (c *PartitionableConn) PartitionS2C()
PartitionS2C partitions the server-to-client direction. If UnpartitionS2C() is not called, Finish() must be called.
func (*PartitionableConn) Read ¶
func (c *PartitionableConn) Read(b []byte) (n int, err error)
Read is part of the net.Conn interface.
func (*PartitionableConn) UnpartitionC2S ¶
func (c *PartitionableConn) UnpartitionC2S()
UnpartitionC2S lifts an existing client-to-server partition.
func (*PartitionableConn) UnpartitionS2C ¶
func (c *PartitionableConn) UnpartitionS2C()
UnpartitionS2C lifts an existing server-to-client partition.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package lint tests Go code for policy and style violations, as well as detecting suspicious constructs that are typically bugs.
|
Package lint tests Go code for policy and style violations, as well as detecting suspicious constructs that are typically bugs. |
|
passes/descriptormarshal
Package descriptormarshal defines an suite of Analyzers that detects correct setting of timestamps when unmarshaling table descriptors.
|
Package descriptormarshal defines an suite of Analyzers that detects correct setting of timestamps when unmarshaling table descriptors. |
|
passes/errcmp
Package errcmp defines an Analyzer which checks for usage of errors.Is instead of direct ==/!= comparisons.
|
Package errcmp defines an Analyzer which checks for usage of errors.Is instead of direct ==/!= comparisons. |
|
passes/hash
Package hash defines an Analyzer that detects correct use of hash.Hash.
|
Package hash defines an Analyzer that detects correct use of hash.Hash. |
|
passes/nocopy
Package nocopy defines an Analyzer that detects invalid uses of util.NoCopy.
|
Package nocopy defines an Analyzer that detects invalid uses of util.NoCopy. |
|
passes/returnerrcheck
Package returnerrcheck defines an suite of Analyzers that detects conditionals which check for a non-nil error and then proceed to return a nil error.
|
Package returnerrcheck defines an suite of Analyzers that detects conditionals which check for a non-nil error and then proceed to return a nil error. |
|
passes/timer
Package timer defines an Analyzer that detects correct use of timeutil.Timer.
|
Package timer defines an Analyzer that detects correct use of timeutil.Timer. |
|
passes/unconvert
Package unconvert defines an Analyzer that detects unnecessary type conversions.
|
Package unconvert defines an Analyzer that detects unnecessary type conversions. |
|
Package reduce implements a reducer core for reducing the size of test failure cases.
|
Package reduce implements a reducer core for reducing the size of test failure cases. |