helpers

Documentation

Index

• Constants
• func AddOrReplaceEnvironment(env []string, newEnvName string, newEnvVal string) []string
• func AppGUID(appName string) string
• func BindRouteToApplication(app string, domain string, host string, path string)
• func CF(args ...string) *Session
• func CFWithEnv(envVars map[string]string, args ...string) *Session
• func CFWithStdin(stdin io.Reader, args ...string) *Session
• func ClearTarget()
• func CreateOrg(org string)
• func CreateOrgAndSpace(org string, space string)
• func CreateSpace(space string)
• func DestroyHomeDir(homeDir string)
• func DomainName(prefix ...string) string
• func GetAPI() string
• func GetAppGuid(appName string) string
• func GetCredentials() (string, string)
• func GetIsolationSegmentGUID(name string) string
• func GetOrgGUID(orgName string) string
• func InvalidAccessToken() string
• func IsolationSegmentName(name ...string) string
• func LoginCF() string
• func LogoutCF()
• func NewOrgName() string
• func NewSpaceName() string
• func PrefixedRandomName(namePrefix string) string
• func QuickDeleteOrg(orgName string)
• func QuotaName(name ...string) string
• func RandomName() string
• func RandomPassword() string
• func RandomUsername() string
• func RunIfExperimental(msg string)
• func SetAPI() (string, string)
• func SetConfig(cb func(conf *configv3.Config))
• func SetHomeDir() string
• func SetupReadOnlyOrgAndSpace() (string, string)
• func SkipIfExperimental(msg string)
• func TargetOrg(org string)
• func TargetOrgAndSpace(org string, space string)
• func TurnOffColors()
• func UnbindRouteToApplication(app string, domain string, host string, path string)
• func UnsetAPI()
• func WithBananaPantsApp(f func(dir string))
• func WithHelloWorldApp(f func(dir string))
• type Assets
  • func NewAssets() Assets
• type Domain
  • func NewDomain(org string, name string) Domain
  • func (d Domain) Create()
  • func (d Domain) CreateShared()
  • func (d Domain) CreateWithRouterGroup(routerGroup string)
  • func (d Domain) Delete()
  • func (d Domain) Share()
• type Plan
• type Route
  • func NewRoute(space string, domain string, hostname string, path string) Route
  • func (r Route) Create()
  • func (r Route) Delete()
• type SecurityGroup
  • func NewSecurityGroup(name string, protocol string, destination string, ports string, ...) SecurityGroup
  • func (s SecurityGroup) Create()
  • func (s SecurityGroup) Delete()
• type ServiceBroker
  • func NewServiceBroker(name string, path string, appsDomain string, serviceName string, ...) ServiceBroker
  • func (b ServiceBroker) Configure()
  • func (b ServiceBroker) Create()
  • func (b ServiceBroker) Delete()
  • func (b ServiceBroker) Destroy()
  • func (b ServiceBroker) Push()
  • func (b ServiceBroker) ToJSON() string

Constants

const (
	GUIDRegex = "[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12}"
	//IPAddressRegex = "\\d{1,3}.\\d{1,3}.\\d{1,3}.\\d{1,3}"
	ISO8601Regex = "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{1,3}[+-]\\d{4}"
)

const (
	DefaultMemoryLimit = "256M"
	DefaultDiskLimit   = "1G"
)

Functions

func AddOrReplaceEnvironment

func AddOrReplaceEnvironment(env []string, newEnvName string, newEnvVal string) []string

func AppGUID

func AppGUID(appName string) string

AppGUID returns the GUID for an app in the currently targeted space.

func BindRouteToApplication

func BindRouteToApplication(app string, domain string, host string, path string)

func CF

func CF(args ...string) *Session

func CFWithEnv

func CFWithEnv(envVars map[string]string, args ...string) *Session

func CFWithStdin

func CFWithStdin(stdin io.Reader, args ...string) *Session

func ClearTarget

func ClearTarget()

func CreateOrg

func CreateOrg(org string)

func CreateOrgAndSpace

func CreateOrgAndSpace(org string, space string)

func CreateSpace

func CreateSpace(space string)

func DestroyHomeDir

func DestroyHomeDir(homeDir string)

func DomainName

func DomainName(prefix ...string) string

func GetAPI

func GetAPI() string

func GetAppGuid

func GetAppGuid(appName string) string

func GetCredentials

func GetCredentials() (string, string)

func GetIsolationSegmentGUID

func GetIsolationSegmentGUID(name string) string

func GetOrgGUID

func GetOrgGUID(orgName string) string

func InvalidAccessToken

func InvalidAccessToken() string

func IsolationSegmentName

func IsolationSegmentName(name ...string) string

func LoginCF

func LoginCF() string

func LogoutCF

func LogoutCF()

func NewOrgName

func NewOrgName() string

func NewSpaceName

func NewSpaceName() string

func PrefixedRandomName

func PrefixedRandomName(namePrefix string) string

func QuickDeleteOrg

func QuickDeleteOrg(orgName string)

func QuotaName

func QuotaName(name ...string) string

func RandomName

func RandomName() string

func RandomPassword

func RandomPassword() string

func RandomUsername

func RandomUsername() string

func RunIfExperimental

func RunIfExperimental(msg string)

RunIfExperimental is for tests that should be skipped if CF_CLI_EXPERIMENTAL is set to false.

func SetAPI

func SetAPI() (string, string)

func SetConfig

func SetConfig(cb func(conf *configv3.Config))

func SetHomeDir

func SetHomeDir() string

func SetupReadOnlyOrgAndSpace

func SetupReadOnlyOrgAndSpace() (string, string)

func SkipIfExperimental

func SkipIfExperimental(msg string)

SkipIfExperimental is for tests that should be skipped if CF_CLI_EXPERIMENTAL is set to true.

func TargetOrg

func TargetOrg(org string)

func TargetOrgAndSpace

func TargetOrgAndSpace(org string, space string)

func TurnOffColors

func TurnOffColors()

func UnbindRouteToApplication

func UnbindRouteToApplication(app string, domain string, host string, path string)

func UnsetAPI

func UnsetAPI()

func WithBananaPantsApp

func WithBananaPantsApp(f func(dir string))

WithBananaPantsApp creates a simple application to use with your CLI command (typically CF Push). When pushing, be aware of specifying '-b staticfile_buildpack" so that your app will correctly start up with the proper buildpack.

func WithHelloWorldApp

func WithHelloWorldApp(f func(dir string))

WithHelloWorldApp creates a simple application to use with your CLI command (typically CF Push). When pushing, be aware of specifying '-b staticfile_buildpack" so that your app will correctly start up with the proper buildpack.

Types

type Assets

type Assets struct {
	ServiceBroker string
}

func NewAssets

func NewAssets() Assets

type Domain

type Domain struct {
	Org  string
	Name string
}

func NewDomain

func NewDomain(org string, name string) Domain

func (Domain) Create

func (d Domain) Create()

func (Domain) CreateShared

func (d Domain) CreateShared()

func (Domain) CreateWithRouterGroup

func (d Domain) CreateWithRouterGroup(routerGroup string)

func (Domain) Delete

func (d Domain) Delete()

func (Domain) Share

func (d Domain) Share()

type Plan

type Plan struct {
	Name string `json:"name"`
	ID   string `json:"id"`
}

type Route

type Route struct {
	Space  string
	Host   string
	Domain string
	Path   string
}

func NewRoute

func NewRoute(space string, domain string, hostname string, path string) Route

func (Route) Create

func (r Route) Create()

func (Route) Delete

func (r Route) Delete()

type SecurityGroup

type SecurityGroup struct {
	Name        string `json:"-"`
	Protocol    string `json:"protocol"`
	Destination string `json:"destination"`
	Ports       string `json:"ports"`
	Description string `json:"description"`
}

func NewSecurityGroup

func NewSecurityGroup(name string, protocol string, destination string, ports string, description string) SecurityGroup

func (SecurityGroup) Create

func (s SecurityGroup) Create()

func (SecurityGroup) Delete

func (s SecurityGroup) Delete()

type ServiceBroker

type ServiceBroker struct {
	Name       string
	Path       string
	AppsDomain string
	Service    struct {
		Name            string `json:"name"`
		ID              string `json:"id"`
		DashboardClient struct {
			ID          string `json:"id"`
			Secret      string `json:"secret"`
			RedirectUri string `json:"redirect_uri"`
		}
	}
	SyncPlans  []Plan
	AsyncPlans []Plan
}

func NewServiceBroker

func NewServiceBroker(name string, path string, appsDomain string, serviceName string, planName string) ServiceBroker

func (ServiceBroker) Configure

func (b ServiceBroker) Configure()

func (ServiceBroker) Create

func (b ServiceBroker) Create()

func (ServiceBroker) Delete

func (b ServiceBroker) Delete()

func (ServiceBroker) Destroy

func (b ServiceBroker) Destroy()

func (ServiceBroker) Push

func (b ServiceBroker) Push()

func (ServiceBroker) ToJSON

func (b ServiceBroker) ToJSON() string