awstesting

README

AWS SDK for Go awstesting packages

awstesting is a collection of packages used internally by the SDK, and is subject to have breaking changes. This package is not internal so that if you really need to use its functionality, and understand breaking changes will be made, you are able to.

These packages will be refactored in the future so that the API generator and model parsers are exposed cleanly on their own.

Documentation

Index

• Variables
• func AssertJSON(t *testing.T, expect, actual string, msgAndArgs ...interface{}) bool
• func AssertQuery(t *testing.T, expect, actual string, msgAndArgs ...interface{}) bool
• func AssertURL(t *testing.T, expect, actual string, msgAndArgs ...interface{}) bool
• func AssertXML(t *testing.T, expect, actual string, msgAndArgs ...interface{}) bool
• func CleanupTLSBundleFiles(files ...string) error
• func CreateClientTLSCertFiles() (cert, key string, err error)
• func CreateTLSBundleFiles() (cert, key, ca string, err error)
• func CreateTLSServer(cert, key string, mux *http.ServeMux) (string, error)
• func DidPanic(fn func()) (bool, interface{})
• func Match(t *testing.T, regex, expected string)
• func NewClient(cfgs ...*aws.Config) *client.Client
• func NewTLSClientCertServer(handler http.Handler) (*httptest.Server, error)
• func PopEnv(env []string)
• func SortedKeys(m map[string]interface{}) []string
• func SprintExpectActual(expect, actual interface{}) string
• func StashEnv() []string
• type DiscardAt
  • func (d DiscardAt) WriteAt(p []byte, off int64) (n int, err error)
• type EndlessReader
  • func (e EndlessReader) Read(p []byte) (int, error)
• type FakeContext
  • func (c *FakeContext) Deadline() (deadline time.Time, ok bool)
  • func (c *FakeContext) Done() <-chan struct{}
  • func (c *FakeContext) Err() error
  • func (c *FakeContext) Value(key interface{}) interface{}
• type ReadCloser
  • func (r *ReadCloser) Close() error
  • func (r *ReadCloser) Read(b []byte) (int, error)
• type ZeroReader
  • func (r *ZeroReader) Read(b []byte) (int, error)

Variables

var (
	// TLSBundleCA is the CA PEM
	TLSBundleCA []byte

	// TLSBundleCert is the Server PEM
	TLSBundleCert []byte

	// TLSBundleKey is the Server private key PEM
	TLSBundleKey []byte

	// ClientTLSCert is the Client PEM
	ClientTLSCert []byte

	// ClientTLSKey is the Client private key PEM
	ClientTLSKey []byte
)

Functions

func AssertJSON

func AssertJSON(t *testing.T, expect, actual string, msgAndArgs ...interface{}) bool

AssertJSON verifies that the expect json string matches the actual.

func AssertQuery

func AssertQuery(t *testing.T, expect, actual string, msgAndArgs ...interface{}) bool

AssertQuery verifies the expect HTTP query string matches the actual.

func AssertURL

func AssertURL(t *testing.T, expect, actual string, msgAndArgs ...interface{}) bool

AssertURL verifies the expected URL is matches the actual.

func AssertXML

func AssertXML(t *testing.T, expect, actual string, msgAndArgs ...interface{}) bool

AssertXML verifies that the expect XML string matches the actual.

func CleanupTLSBundleFiles

func CleanupTLSBundleFiles(files ...string) error

CleanupTLSBundleFiles takes variadic list of files to be deleted.

func CreateClientTLSCertFiles

func CreateClientTLSCertFiles() (cert, key string, err error)

CreateClientTLSCertFiles returns a set of temporary files for the client certificate and key files.

func CreateTLSBundleFiles

func CreateTLSBundleFiles() (cert, key, ca string, err error)

CreateTLSBundleFiles returns the temporary filenames for the certificate key, and CA PEM content. These files should be deleted when no longer needed. CleanupTLSBundleFiles can be used for this cleanup.

func CreateTLSServer

func CreateTLSServer(cert, key string, mux *http.ServeMux) (string, error)

CreateTLSServer will create the TLS server on an open port using the certificate and key. The address will be returned that the server is running on.

func DidPanic

func DidPanic(fn func()) (bool, interface{})

DidPanic returns if the function paniced and returns true if the function paniced.

func Match

func Match(t *testing.T, regex, expected string)

Match is a testing helper to test for testing error by comparing expected with a regular expression.

func NewClient

func NewClient(cfgs ...*aws.Config) *client.Client

NewClient creates and initializes a generic service client for testing.

func NewTLSClientCertServer

func NewTLSClientCertServer(handler http.Handler) (*httptest.Server, error)

NewTLSClientCertServer creates a new HTTP test server initialize to require HTTP clients authenticate with TLS client certificates.

func PopEnv

func PopEnv(env []string)

PopEnv takes the list of the environment values and injects them into the process's environment variable data. Clears any existing environment values that may already exist.

Deprecated: PopEnv exists for backward compatibility and may be removed from the future iterations. It is not `internal` so that if you really need to use its functionality, and understand breaking changes will be made, you are able to.

func SortedKeys

func SortedKeys(m map[string]interface{}) []string

SortedKeys returns a sorted slice of keys of a map.

func SprintExpectActual

func SprintExpectActual(expect, actual interface{}) string

SprintExpectActual returns a string for test failure cases when the actual value is not the same as the expected.

func StashEnv

func StashEnv() []string

StashEnv stashes the current environment variables and returns an array of all environment values as key=val strings.

Deprecated: StashEnv exists for backward compatibility and may be removed from the future iterations. It is not `internal` so that if you really need to use its functionality, and understand breaking changes will be made, you are able to.

Types

type DiscardAt

type DiscardAt struct{}

DiscardAt is an io.WriteAt that discards the requested bytes to be written

func (DiscardAt) WriteAt

func (d DiscardAt) WriteAt(p []byte, off int64) (n int, err error)

WriteAt discards the given []byte slice and returns len(p) bytes as having been written at the given offset. It will never return an error.

type EndlessReader

type EndlessReader struct{}

EndlessReader is an io.Reader that will always return that bytes have been read.

func (EndlessReader) Read

func (e EndlessReader) Read(p []byte) (int, error)

Read will report that it has read len(p) bytes in p. The content in the []byte will be unmodified. This will never return an error.

type FakeContext

type FakeContext struct {
	Error  error
	DoneCh chan struct{}
}

A FakeContext provides a simple stub implementation of a Context

func (*FakeContext) Deadline

func (c *FakeContext) Deadline() (deadline time.Time, ok bool)

Deadline always will return not set

func (*FakeContext) Done

func (c *FakeContext) Done() <-chan struct{}

Done returns a read channel for listening to the Done event

func (*FakeContext) Err

func (c *FakeContext) Err() error

Err returns the error, is nil if not set.

func (*FakeContext) Value

func (c *FakeContext) Value(key interface{}) interface{}

Value ignores the Value and always returns nil

type ReadCloser

type ReadCloser struct {
	Size   int
	Closed bool

	FillData func(bool, []byte, int, int)
	// contains filtered or unexported fields
}

ReadCloser is a io.ReadCloser for unit testing. Designed to test for leaks and whether a handle has been closed

func (*ReadCloser) Close

func (r *ReadCloser) Close() error

Close sets Closed to true and returns no error

func (*ReadCloser) Read

func (r *ReadCloser) Read(b []byte) (int, error)

Read will call FillData and fill it with whatever data needed. Decrements the size until zero, then return io.EOF.

type ZeroReader

type ZeroReader struct{}

ZeroReader is a io.Reader which will always write zeros to the byte slice provided.

func (*ZeroReader) Read

func (r *ZeroReader) Read(b []byte) (int, error)

Read fills the provided byte slice with zeros returning the number of bytes written.