cloudfoundry

Documentation

Index

• type AuthenticationUtils
• type CFUtils
  • func (cf *CFUtils) Login(options LoginOptions) error
  • func (cf *CFUtils) LoginCheck(options LoginOptions) (bool, error)
  • func (cf *CFUtils) Logout() error
  • func (cf *CFUtils) ReadServiceKey(options ServiceKeyOptions) (string, error)
• type CfUtilsMock
  • func (cf *CfUtilsMock) Cleanup()
  • func (cf *CfUtilsMock) Login(options LoginOptions) error
  • func (cf *CfUtilsMock) Logout() error
• type LoginOptions
• type Manifest
  • func ReadManifest(name string) (Manifest, error)
• type ServiceKeyOptions

Types

type AuthenticationUtils

type AuthenticationUtils interface {
	Login(options LoginOptions) error
	Logout() error
}

AuthenticationUtils - interface for cloud foundry login and logout

type CFUtils

type CFUtils struct {
	// In order to avoid clashes between parallel workflows requiring cf login/logout
	// this instance of command.ExecRunner can be configured accordingly by settings the
	// environment variables CF_HOME to distict directories.
	// In order to ensure plugins installed to the cf cli are found environment variables
	// CF_PLUGIN_HOME can be set accordingly.
	Exec command.ExecRunner
	// contains filtered or unexported fields
}

CFUtils ...

func (*CFUtils) Login

func (cf *CFUtils) Login(options LoginOptions) error

Login logs user in to Cloud Foundry via cf cli. Checks if user is logged in first, if not perform 'cf login' command with appropriate parameters

func (*CFUtils) LoginCheck

func (cf *CFUtils) LoginCheck(options LoginOptions) (bool, error)

LoginCheck checks if user is logged in to Cloud Foundry with the receiver provided to the function call.

func (*CFUtils) Logout

func (cf *CFUtils) Logout() error

Logout logs User out of Cloud Foundry Logout can be perforned via 'cf logout' command regardless if user is logged in or not

func (*CFUtils) ReadServiceKey

func (cf *CFUtils) ReadServiceKey(options ServiceKeyOptions) (string, error)

ReadServiceKey reads a cloud foundry service key based on provided service instance and service key name parameters

type CfUtilsMock

type CfUtilsMock struct {
	LoginError  error
	LogoutError error
}

CfUtilsMock - mock for CfUtils

func (*CfUtilsMock) Cleanup

func (cf *CfUtilsMock) Cleanup()

Cleanup for CfUtilsMock

func (*CfUtilsMock) Login

func (cf *CfUtilsMock) Login(options LoginOptions) error

Login mock implementation

func (*CfUtilsMock) Logout

func (cf *CfUtilsMock) Logout() error

Logout mock implementation

type LoginOptions

type LoginOptions struct {
	CfAPIEndpoint string
	CfOrg         string
	CfSpace       string
	Username      string
	Password      string
	CfLoginOpts   []string
}

LoginOptions for logging in to CF

type Manifest

type Manifest interface {
	GetFileName() string
	GetAppName(index int) (string, error)
	ApplicationHasProperty(index int, name string) (bool, error)
	GetApplicationProperty(index int, name string) (interface{}, error)
	Transform() error
	IsModified() bool
	GetApplications() ([]map[string]interface{}, error)
	WriteManifest() error
}

Manifest ...

func ReadManifest

func ReadManifest(name string) (Manifest, error)

ReadManifest Reads the manifest denoted by 'name'

type ServiceKeyOptions

type ServiceKeyOptions struct {
	CfAPIEndpoint     string
	CfOrg             string
	CfSpace           string
	CfServiceInstance string
	CfServiceKeyName  string
	Username          string
	Password          string
}

ServiceKeyOptions for reading CF Service Key