Documentation
¶
Index ¶
- Constants
- Variables
- func Context(c *gc.C) *cmd.Context
- func ContextForDir(c *gc.C, dir string) *cmd.Context
- func CustomEnvironConfig(c *gc.C, extra Attrs) *config.Config
- func EnvironConfig(c *gc.C) *config.Config
- func ExtractCommandsFromHelpOutput(ctx *cmd.Context) []string
- func FindJujuCoreImports(c *gc.C, packageName string) []string
- func InitCommand(c cmd.Command, args []string) error
- func MakeSampleJujuHome(c *gc.C)
- func MgoTestPackage(t *testing.T)
- func NewFlagSet() *gnuflag.FlagSet
- func RunCommand(c *gc.C, com cmd.Command, args ...string) (*cmd.Context, error)
- func RunCommandInDir(c *gc.C, com cmd.Command, args []string, dir string) (*cmd.Context, error)
- func Stderr(ctx *cmd.Context) string
- func Stdout(ctx *cmd.Context) string
- func TarGz(files ...*TarFile) ([]byte, string)
- func TestInit(c *gc.C, com cmd.Command, args []string, errPat string)
- func TestLockingFunction(lock *sync.Mutex, function func())
- func WriteEnvironments(c *gc.C, envConfig string, certNames ...string)
- type Attrs
- type BaseSuite
- type ContentAsserterC
- type FakeJujuHomeSuite
- type GitSuite
- type JujuOSEnvSuite
- type NotifyAsserterC
- type TarFile
Constants ¶
const ( SampleEnvName = "erewhemos" EnvDefault = "default:\n " + SampleEnvName + "\n" )
const DefaultMongoPassword = "conn-from-name-secret"
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.
const FakeDefaultSeries = "trusty"
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
const MultipleEnvConfig = EnvDefault + MultipleEnvConfigNoDefault
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 + ` `
const SampleCertName = "erewhemos"
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)
const SingleEnvConfig = EnvDefault + SingleEnvConfigNoDefault
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 ¶
var (
CACert, CAKey = mustNewCA()
CACertX509, CAKeyRSA = mustParseCertAndKey(CACert, CAKey)
ServerCert, ServerKey = mustNewServer()
Certs = serverCerts()
)
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.
var EnvironmentTag = names.NewEnvironTag("deadbeef-0bad-f00d-0000-4b1d0d06f00d")
EnvironmentTag is a defined known valid UUID that can be used in testing.
var LongAttempt = &utils.AttemptStrategy{ Total: LongWait, Delay: ShortWait, }
Functions ¶
func Context ¶
Context creates a simple command execution context with the current dir set to a newly created directory within the test directory.
func ContextForDir ¶
ContextForDir creates a simple command execution context with the current dir set to the specified directory.
func CustomEnvironConfig ¶
CustomEnvironConfig returns an environment configuration with additional specified keys added.
func EnvironConfig ¶
EnvironConfig returns a default environment configuration suitable for setting in the state.
func ExtractCommandsFromHelpOutput ¶
ExtractCommandsFromHelpOutput takes the standard output from the command context and looks for the "commands:" string and returns the commands output after that.
func FindJujuCoreImports ¶
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 ¶
InitCommand will create a new flag set, and call the Command's SetFlags and Init methods with the appropriate args.
func MakeSampleJujuHome ¶
MakeSampleJujuHome sets up a sample Juju environment.
func MgoTestPackage ¶
MgoTestPackage should be called to register the tests for any package that requires a secure connection to a MongoDB server.
func NewFlagSet ¶
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 ¶
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 ¶
RunCommandInDir works like RunCommand, but runs with a context that uses dir.
func Stderr ¶
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 ¶
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 ¶
TarGz returns the given files in gzipped tar-archive format, along with the sha256 checksum.
func TestInit ¶
TestInit checks that a command initialises correctly with the given set of arguments.
func TestLockingFunction ¶
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.
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.
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 (*BaseSuite) TearDownSuite ¶
func (*BaseSuite) TearDownTest ¶
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) 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 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) 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.
Source Files
Directories