testcommon

Documentation

Index

• func Chdir(path string) func()
• func CheckGoroutineOutput(t *testing.T, out string)
• func CleanupDir(dir string)
• func ClearDockerEnv()
• func ContainerCheck(checkName string, checkState string) (bool, error)
• func CopyGlobalDdevDir(t *testing.T) string
• func CreateTmpDir(prefix string) string
• func EnsureLocalHTTPContent(t *testing.T, rawurl string, expectedContent string, timeoutSeconds ...int) (*http.Response, error)
• func GetCachedArchive(_, _, internalExtractionPath, sourceURL string) (string, string, error)
• func GetLocalHTTPResponse(t *testing.T, rawurl string, timeoutSecsAry ...int) (string, *http.Response, error)
• func OsTempDir() (string, error)
• func ResetGlobalDdevDir(t *testing.T, tmpXdgConfigHomeDir string)
• type PortPair
• type TestSite
  • func (site *TestSite) Chdir() func()
  • func (site *TestSite) Cleanup()
  • func (site *TestSite) Prepare() error
• type URIWithExpect

Functions

func Chdir

func Chdir(path string) func()

Chdir will change to the directory for the site specified by TestSite. It returns an anonymous function which will return to the original working directory when called.

func CheckGoroutineOutput

func CheckGoroutineOutput(t *testing.T, out string)

CheckgoroutineOutput makes sure that goroutines aren't beyond specified level

func CleanupDir

func CleanupDir(dir string)

CleanupDir removes a directory specified by string.

func ClearDockerEnv

func ClearDockerEnv()

ClearDockerEnv unsets env vars set in platform DockerEnv() so that they can be set by another test run.

func ContainerCheck

func ContainerCheck(checkName string, checkState string) (bool, error)

ContainerCheck determines if a given container name exists and matches a given state

func CopyGlobalDdevDir

func CopyGlobalDdevDir(t *testing.T) string

CopyGlobalDdevDir creates a temporary global config directory for DDEV using a temporary directory which is set to $XDG_CONFIG_HOME/ddev Don't forget to run ResetGlobalDdevDir(t, tmpXdgConfigHomeDir) in the test's cleanup function.

func CreateTmpDir

func CreateTmpDir(prefix string) string

CreateTmpDir creates a temporary directory in the homedir and returns its path as a string. It's important that it's in homedir since Colima doesn't mount things outside that.

func EnsureLocalHTTPContent

func EnsureLocalHTTPContent(t *testing.T, rawurl string, expectedContent string, timeoutSeconds ...int) (*http.Response, error)

EnsureLocalHTTPContent will verify a URL responds with a 200 and expected content string

func GetCachedArchive

func GetCachedArchive(_, _, internalExtractionPath, sourceURL string) (string, string, error)

GetCachedArchive returns a directory populated with the contents of the specified archive, either from cache or from downloading and creating cache. siteName is the site.Name used for storage prefixString is the prefix used to disambiguate downloads and extracts internalExtractionPath is the place in the archive to start extracting sourceURL is the actual URL to download. Returns the extracted path, the tarball path (both possibly cached), and an error value.

func GetLocalHTTPResponse

func GetLocalHTTPResponse(t *testing.T, rawurl string, timeoutSecsAry ...int) (string, *http.Response, error)

GetLocalHTTPResponse takes a URL and optional timeout in seconds, hits the local Docker for it, returns result Returns error (with the body) if not 200 status code.

func OsTempDir

func OsTempDir() (string, error)

OsTempDir gets os.TempDir() (usually provided by $TMPDIR) but expands any symlinks found within it. This wrapper function can prevent problems with docker-for-mac trying to use /var/..., which is not typically shared/mounted. It will be expanded via the /var symlink to /private/var/...

func ResetGlobalDdevDir

func ResetGlobalDdevDir(t *testing.T, tmpXdgConfigHomeDir string)

ResetGlobalDdevDir removes temporary $XDG_CONFIG_HOME directory

Types

type PortPair

type PortPair struct {
	HTTPPort  string
	HTTPSPort string
}

PortPair is for tests to use naming portsets for tests

type TestSite

type TestSite struct {
	// Name is the generic name of the site, and is used as the default dir.
	Name string
	// SourceURL is the URL of the source code tarball to be used for building the site.
	SourceURL string
	// ArchiveExtractionPath is the relative path within the tarball which should be extracted, ending with /
	ArchiveInternalExtractionPath string
	// FullSiteTarballURL is the URL of the tarball of a full site archive used for testing import.
	FullSiteTarballURL string
	// FilesTarballURL is the URL of the tarball of file uploads used for testing file import.
	FilesTarballURL string
	// FilesZipballURL is the URL of the zipball of file uploads used for testing file import.
	FilesZipballURL string
	// DBTarURL is the URL of the database dump tarball used for testing database import.
	DBTarURL string
	// DBZipURL is the URL of an optional zip-style db dump.
	DBZipURL string
	// Dir is the rooted full path of the test site
	Dir string
	// HTTPProbeURI is the URI that can be probed to look for a working web container
	HTTPProbeURI string
	// WebEnvironment is strings that will be used in web_environment
	WebEnvironment []string
	// PretestCmd will be executed on host before test
	PretestCmd string
	// Docroot is the subdirectory within the site that is the root/index.php
	Docroot string
	// Type is the type of application. This can be specified when a config file is not present
	// for a test site.
	Type string
	// Safe200URIWithExpectation provides a static URI with contents that it can be expected to contain.
	Safe200URIWithExpectation URIWithExpect
	// DynamicURI provides a dynamic (after db load) URI with contents we can expect.
	DynamicURI URIWithExpect
	// UploadDirs overrides the dirs used for upload_dirs
	UploadDirs []string
	// FilesImageURI is URI to a file loaded by import-files that is a jpg.
	FilesImageURI string
	// FullSiteArchiveExtPath is the path that should be extracted from inside an archive when
	// importing the files from a full site archive
	FullSiteArchiveExtPath string
}

TestSite describes a site for testing, with name, URL of tarball, and optional dir.

func (*TestSite) Chdir

func (site *TestSite) Chdir() func()

Chdir will change to the directory for the site specified by TestSite.

func (*TestSite) Cleanup

func (site *TestSite) Cleanup()

Cleanup removes the archive and codebase extraction for a site after a test run has completed.

func (*TestSite) Prepare

func (site *TestSite) Prepare() error

Prepare downloads and extracts a site codebase to a temporary directory.

type URIWithExpect

type URIWithExpect struct {
	URI    string
	Expect string
}

URIWithExpect pairs a URI like "/readme.html" with some substring content "should be found in URI"