testing

package
v0.0.0-...-be26699 Latest Latest
Warning

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

 Go to latest Published: Jul 3, 2015 License: AGPL-3.0 Imports: 34 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SampleEnvName = "erewhemos"
	EnvDefault    = "default:\n  " + SampleEnvName + "\n"
)
View Source 
const DefaultMongoPassword = "conn-from-name-secret"
View Source 
const FakeAuthKeys = `` /* 180-byte string literal not displayed */

FakeAuthKeys holds the authorized key used for testing purposes in FakeConfig. It is valid for parsing with the utils/ssh authorized-key utilities.

View Source 
const FakeDefaultSeries = "trusty"
View Source 
const LongWait = 10 * time.Second

LongWait is used when something should have already happened, or happens quickly, but we want to make sure we just haven't missed it. As in, the test suite should proceed without sleeping at all, but just in case. It is long so that we don't have spurious failures without actually slowing down the test suite

View Source 
const MultipleEnvConfig = EnvDefault + MultipleEnvConfigNoDefault
View Source 
const MultipleEnvConfigNoDefault = `
environments:
    erewhemos:
        type: dummy
        state-server: true
        authorized-keys: i-am-a-key
        admin-secret: ` + DefaultMongoPassword + `
    erewhemos-2:
        type: dummy
        state-server: true
        authorized-keys: i-am-a-key
        admin-secret: ` + DefaultMongoPassword + `
`
View Source 
const SampleCertName = "erewhemos"
View Source 
const ShortWait = 50 * time.Millisecond

ShortWait is a reasonable amount of time to block waiting for something that shouldn't actually happen. (as in, the test suite will *actually* wait this long before continuing)

View Source 
const SingleEnvConfig = EnvDefault + SingleEnvConfigNoDefault
View Source 
const SingleEnvConfigNoDefault = `
environments:
    erewhemos:
        type: dummy
        state-server: true
        authorized-keys: i-am-a-key
        admin-secret: ` + DefaultMongoPassword + `
`

Environment names below are explicit as it makes them more readable.

Variables

View Source 
var (
	CACert, CAKey = mustNewCA()

	CACertX509, CAKeyRSA = mustParseCertAndKey(CACert, CAKey)

	ServerCert, ServerKey = mustNewServer()

	Certs = serverCerts()

	// Other valid test certs different from the default.
	OtherCACert, OtherCAKey = mustNewCA()
)

CACert and CAKey make up a CA key pair. CACertX509 and CAKeyRSA hold their parsed equivalents. ServerCert and ServerKey hold a CA-signed server cert/key. Certs holds the certificates and keys required to make a secure connection to a Mongo database.

View Source 
var EnvironmentTag = names.NewEnvironTag("deadbeef-0bad-400d-8000-4b1d0d06f00d")

EnvironmentTag is a defined known valid UUID that can be used in testing.

View Source 
var LongAttempt = &utils.AttemptStrategy{
	Total: LongWait,
	Delay: ShortWait,
}

Functions

func CheckString 

func CheckString(c *gc.C, value, expected string)

CheckString compares two strings. If they do not match then the spot where they do not match is logged.

func CheckWriteFileCommand 

func CheckWriteFileCommand(c *gc.C, cmd, filename, expected string, parse func(lines []string) interface{})

CheckWriteFileCommand verifies that the given shell command correctly writes the expected content to the given filename. The provided parse function decomposes file content into structured data that may be correctly compared regardless of ordering within the content. If parse is nil then the content lines are used un-parsed.

func Context 

func Context(c *gc.C) *cmd.Context

Context creates a simple command execution context with the current dir set to a newly created directory within the test directory.

func ContextForDir 

func ContextForDir(c *gc.C, dir string) *cmd.Context

ContextForDir creates a simple command execution context with the current dir set to the specified directory.

func CustomEnvironConfig 

func CustomEnvironConfig(c *gc.C, extra Attrs) *config.Config

CustomEnvironConfig returns an environment configuration with additional specified keys added.

func DumpTestLogsAfter 

func DumpTestLogsAfter(timeout time.Duration, c *gc.C, cleaner TestCleanup)

DumpTestLogsAfter will write the test logs to stdout if the timeout is reached.

func EnvironConfig 

func EnvironConfig(c *gc.C) *config.Config

EnvironConfig returns a default environment configuration suitable for setting in the state.

func ExtractCommandsFromHelpOutput 

func ExtractCommandsFromHelpOutput(ctx *cmd.Context) []string

ExtractCommandsFromHelpOutput takes the standard output from the command context and looks for the "commands:" string and returns the commands output after that.

func FindJujuCoreImports 

func FindJujuCoreImports(c *gc.C, packageName string) []string

FindJujuCoreImports returns a sorted list of juju-core packages that are imported by the packageName parameter. The resulting list removes the common prefix "github.com/juju/juju/" leaving just the short names.

func InitCommand 

func InitCommand(c cmd.Command, args []string) error

InitCommand will create a new flag set, and call the Command's SetFlags and Init methods with the appropriate args.

func MakeSampleJujuHome 

func MakeSampleJujuHome(c *gc.C)

MakeSampleJujuHome sets up a sample Juju environment.

func MgoTestPackage 

func MgoTestPackage(t *testing.T)

MgoTestPackage should be called to register the tests for any package that requires a secure connection to a MongoDB server.

func NewFlagSet 

func NewFlagSet() *gnuflag.FlagSet

NewFlagSet creates a new flag set using the standard options, particularly the option to stop the gnuflag methods from writing to StdErr or StdOut.

func RunCommand 

func RunCommand(c *gc.C, com cmd.Command, args ...string) (*cmd.Context, error)

RunCommand runs a command with the specified args. The returned error may come from either the parsing of the args, the command initialisation, or the actual running of the command. Access to the resulting output streams is provided through the returned context instance.

func RunCommandInDir 

func RunCommandInDir(c *gc.C, com cmd.Command, args []string, dir string) (*cmd.Context, error)

RunCommandInDir works like RunCommand, but runs with a context that uses dir.

func SkipIfGitNotAvailable 

func SkipIfGitNotAvailable(c *gc.C)

func SkipIfI386 

func SkipIfI386(c *gc.C, bugID string)

SkipIfI386 skips the test if the arch is I386.

func SkipIfPPC64EL 

func SkipIfPPC64EL(c *gc.C, bugID string)

SkipIfPPC64EL skips the test if the arch is PPC64EL and the compiler is gccgo.

func SkipIfWindowsBug 

func SkipIfWindowsBug(c *gc.C, bugID string)

SkipIfWindowsBug skips the test if the OS is Windows.

func Stderr 

func Stderr(ctx *cmd.Context) string

Stderr takes a command Context that we assume has been created in this package, and gets the content of the Stderr buffer as a string.

func Stdout 

func Stdout(ctx *cmd.Context) string

Stdout takes a command Context that we assume has been created in this package, and gets the content of the Stdout buffer as a string.

func TarGz 

func TarGz(files ...*TarFile) ([]byte, string)

TarGz returns the given files in gzipped tar-archive format, along with the sha256 checksum.

func TestInit 

func TestInit(c *gc.C, com cmd.Command, args []string, errPat string)

TestInit checks that a command initialises correctly with the given set of arguments.

func TestLockingFunction 

func TestLockingFunction(lock *sync.Mutex, function func())

TestLockingFunction verifies that a function obeys a given lock.

Use this as a building block in your own tests for proper locking. Parameters are a lock that you expect your function to block on, and the function that you want to test for proper locking on that lock.

This helper attempts to verify that the function both obtains and releases the lock. It will panic if the function fails to do either. TODO: Support generic sync.Locker instead of just Mutex. TODO: This could be a gocheck checker. TODO(rog): make this work reliably even for functions that take longer than a few µs to execute.

func WriteEnvironments 

func WriteEnvironments(c *gc.C, envConfig string, certNames ...string)

WriteEnvironments creates an environments file with envConfig and certs from certNames.

Types

type Attrs 

type Attrs map[string]interface{}

Attrs is a convenience type for messing around with configuration attributes.

func FakeConfig 

func FakeConfig() Attrs

FakeConfig() returns an environment configuration for a fake provider with all required attributes set.

func (Attrs) Delete 

func (a Attrs) Delete(attrNames ...string) Attrs

func (Attrs) Merge 

func (a Attrs) Merge(with Attrs) Attrs

type BaseSuite 

type BaseSuite struct {
	testing.CleanupSuite
	testing.LoggingSuite
	JujuOSEnvSuite
}

BaseSuite provides required functionality for all test suites when embedded in a gocheck suite type: - logger redirect - no outgoing network access - protection of user's home directory - scrubbing of env vars TODO (frankban) 2014-06-09: switch to using IsolationSuite. NOTE: there will be many tests that fail when you try to change to the IsolationSuite that rely on external things in PATH.

func (*BaseSuite) SetUpSuite 

func (s *BaseSuite) SetUpSuite(c *gc.C)

func (*BaseSuite) SetUpTest 

func (s *BaseSuite) SetUpTest(c *gc.C)

func (*BaseSuite) TearDownSuite 

func (s *BaseSuite) TearDownSuite(c *gc.C)

func (*BaseSuite) TearDownTest 

func (s *BaseSuite) TearDownTest(c *gc.C)

type ContentAsserterC 

type ContentAsserterC struct {
	// C is a gocheck C structure for doing assertions
	C *gc.C
	// Chan is the channel we want to receive on
	Chan interface{}
	// Precond will be called before waiting on the channel, can be nil
	Precond func()
}

ContentAsserterC is like NotifyAsserterC in that it checks the behavior of a channel. The difference is that we expect actual content on the channel, so callers need to put that into and out of an 'interface{}'

func (*ContentAsserterC) AssertClosed 

func (a *ContentAsserterC) AssertClosed()

AssertClosed ensures that we get a closed event on the channel

func (*ContentAsserterC) AssertNoReceive 

func (a *ContentAsserterC) AssertNoReceive()

Assert that we fail to receive on the channel after a short wait.

func (*ContentAsserterC) AssertOneReceive 

func (a *ContentAsserterC) AssertOneReceive() interface{}

AssertOneReceive checks that we have exactly one message, and no more

func (*ContentAsserterC) AssertOneValue 

func (a *ContentAsserterC) AssertOneValue(val interface{}) interface{}

AssertOneValue checks that exactly 1 message was sent, and that the content DeepEquals the value. It also returns the value in case further inspection is desired.

func (*ContentAsserterC) AssertReceive 

func (a *ContentAsserterC) AssertReceive() interface{}

AssertReceive will ensure that we get an event on the channel and the channel is not closed. It will return the content received

type FakeJujuHomeSuite 

type FakeJujuHomeSuite struct {
	JujuOSEnvSuite
	gitjujutesting.FakeHomeSuite
	// contains filtered or unexported fields
}

FakeJujuHomeSuite isolates the user's home directory and sets up a Juju home with a sample environment and certificate.

func (*FakeJujuHomeSuite) AssertConfigParameterUpdated 

func (s *FakeJujuHomeSuite) AssertConfigParameterUpdated(c *gc.C, key, value string)

AssertConfigParameterUpdated updates environment parameter and asserts that no errors were encountered.

func (*FakeJujuHomeSuite) SetUpSuite 

func (s *FakeJujuHomeSuite) SetUpSuite(c *gc.C)

func (*FakeJujuHomeSuite) SetUpTest 

func (s *FakeJujuHomeSuite) SetUpTest(c *gc.C)

func (*FakeJujuHomeSuite) TearDownSuite 

func (s *FakeJujuHomeSuite) TearDownSuite(c *gc.C)

func (*FakeJujuHomeSuite) TearDownTest 

func (s *FakeJujuHomeSuite) TearDownTest(c *gc.C)

type GitSuite 

type GitSuite struct {
	BaseSuite
}

func (*GitSuite) SetUpTest 

func (t *GitSuite) SetUpTest(c *gc.C)

type JujuOSEnvSuite 

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

JujuOSEnvSuite isolates the tests from Juju environment variables. This is intended to be only used by existing suites, usually embedded in BaseSuite and in FakeJujuHomeSuite. Eventually the tests relying on JujuOSEnvSuite will be converted to use the IsolationSuite in github.com/juju/testing, and this suite will be removed. Do not use JujuOSEnvSuite when writing new tests.

func (*JujuOSEnvSuite) SetFeatureFlags 

func (s *JujuOSEnvSuite) SetFeatureFlags(flag ...string)

func (*JujuOSEnvSuite) SetInitialFeatureFlags 

func (s *JujuOSEnvSuite) SetInitialFeatureFlags(flags ...string)

SetInitialFeatureFlags sets the feature flags to be in effect for the next call to SetUpTest.

func (*JujuOSEnvSuite) SetUpSuite 

func (s *JujuOSEnvSuite) SetUpSuite(c *gc.C)

func (*JujuOSEnvSuite) SetUpTest 

func (s *JujuOSEnvSuite) SetUpTest(c *gc.C)

func (*JujuOSEnvSuite) TearDownSuite 

func (s *JujuOSEnvSuite) TearDownSuite(c *gc.C)

func (*JujuOSEnvSuite) TearDownTest 

func (s *JujuOSEnvSuite) TearDownTest(c *gc.C)

type NotifyAsserterC 

type NotifyAsserterC struct {
	// C is a gocheck C structure for doing assertions
	C *gc.C
	// Chan is the channel we want to receive on
	Chan <-chan struct{}
	// Precond will be called before waiting on the channel, can be nil
	Precond func()
}

NotifyAsserterC gives helper functions for making assertions about how a channel operates (whether we get a receive event or not, whether it is closed, etc.)

func (*NotifyAsserterC) AssertClosed 

func (a *NotifyAsserterC) AssertClosed()

AssertClosed ensures that we get a closed event on the channel

func (*NotifyAsserterC) AssertNoReceive 

func (a *NotifyAsserterC) AssertNoReceive()

Assert that we fail to receive on the channel after a short wait.

func (*NotifyAsserterC) AssertOneReceive 

func (a *NotifyAsserterC) AssertOneReceive()

AssertOneReceive checks that we have exactly one message, and no more

func (*NotifyAsserterC) AssertReceive 

func (a *NotifyAsserterC) AssertReceive()

AssertReceive will ensure that we get an event on the channel and the channel is not closed.

type TarFile 

type TarFile struct {
	Header   tar.Header
	Contents string
}

TarFile represents a file to be archived.

func NewTarFile 

func NewTarFile(name string, mode os.FileMode, contents string) *TarFile

NewTarFile returns a new TarFile instance with the given file mode and contents.

type TestCleanup 

type TestCleanup interface {
	AddCleanup(testing.CleanupFunc)
}

TestCleanup is used to allow DumpTestLogsAfter to take any test suite that supports the standard cleanup function.

Source Files

View all Source files

Directories

Path Synopsis

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.