machine

Documentation

Overview

Package machine provides a number of utility functions encapsulating often-used sequences. I.e. create/delete applications/configurations, bind/unbind configurations, etc. This is done in the hope of enhancing the readability of various before/after blocks.

Index

• type Machine
  • func New(dir, user, password, adminToken, userToken, root, epinioBinaryPath string) Machine
  • func (m *Machine) BindAppConfiguration(appName, configurationName, namespace string)
  • func (m *Machine) CleanupApp(appName string)
  • func (m *Machine) CleanupConfiguration(configurationName string)
  • func (m *Machine) Client() *http.Client
  • func (m *Machine) CreateEpinioUser(role string, namespaces []string) (string, string)
  • func (m *Machine) Curl(method, uri string, requestBody io.Reader) (*http.Response, error)
  • func (m *Machine) DeleteApp(appName string)
  • func (m *Machine) DeleteAppchart(tempFile string)
  • func (m *Machine) DeleteConfigurations(configurationNames ...string)
  • func (m *Machine) DeleteConfigurationsUnbind(configurationNames ...string)
  • func (m *Machine) DeleteConfigurationsWithUnbind(configurationNames []string, unbind bool)
  • func (m *Machine) DeleteEpinioUser(username string) error
  • func (m *Machine) DeleteNamespace(namespace string)
  • func (m *Machine) DeleteService(serviceName string)
  • func (m *Machine) Epinio(dir, command string, arg ...string) (string, error)
  • func (m *Machine) EpinioCmd(command string, arg ...string) *exec.Cmd
  • func (m *Machine) EpinioPush(dir string, name string, arg ...string) (string, error)
  • func (m *Machine) GetPodNames(appName, namespaceName string) []string
  • func (m *Machine) GetSettings() (*settings.Settings, error)
  • func (m *Machine) GetSettingsFrom(location string) (*settings.Settings, error)
  • func (m *Machine) HaveConfiguration(configurationName string)
  • func (m *Machine) HaveServiceInstance(serviceName string)
  • func (m *Machine) MakeApp(appName string, instances int, deployFromCurrentDir bool) string
  • func (m *Machine) MakeAppWithDir(appName string, instances int, deployFromCurrentDir bool, appDir string, ...) string
  • func (m *Machine) MakeAppWithDirSimple(appName string, deployFromCurrentDir bool, appDir string) string
  • func (m *Machine) MakeAppchart(chartName string) string
  • func (m *Machine) MakeAppchartStateful(chartName string) string
  • func (m *Machine) MakeConfiguration(configurationName string)
  • func (m *Machine) MakeConfigurationFromFiles(configurationName, path string)
  • func (m *Machine) MakeContainerImageApp(appName string, instances int, containerImageURL string) string
  • func (m *Machine) MakeGitconfig(gitConfigName string)
  • func (m *Machine) MakeGitconfigWithoutCleanup(gitConfigName string)
  • func (m *Machine) MakeGolangApp(appName string, instances int, deployFromCurrentDir bool) string
  • func (m *Machine) MakeRoutedContainerImageApp(appName string, instances int, containerImageURL, route string, more ...string) string
  • func (m *Machine) MakeServiceInstance(serviceName, catalogService string)
  • func (m *Machine) MakeWebSocketConnection(authToken string, url string, subprotocols ...string) (*websocket.Conn, error)
  • func (m *Machine) SaveApplicationSpec(appName string)
  • func (m *Machine) SaveServerLogs(destination string)
  • func (m *Machine) SetupAndTargetNamespace(namespace string)
  • func (m *Machine) SetupNamespace(namespace string)
  • func (m *Machine) ShowStagingLogs(app string)
  • func (m *Machine) TargetNamespace(namespace string)
  • func (m *Machine) UnbindAppConfiguration(appName, configurationName, namespace string)
  • func (m *Machine) VerifyAppConfigurationBound(appName, configurationName, namespace string, offset int)
  • func (m *Machine) VerifyAppConfigurationNotbound(appName, configurationName, namespace string, offset int)
  • func (m *Machine) VerifyNamespaceNotExist(namespace string)
  • func (m *Machine) Versions()

Types

type Machine

type Machine struct {
	// contains filtered or unexported fields
}

func New

func New(dir, user, password, adminToken, userToken, root, epinioBinaryPath string) Machine

func (*Machine) BindAppConfiguration

func (m *Machine) BindAppConfiguration(appName, configurationName, namespace string)

func (*Machine) CleanupApp

func (m *Machine) CleanupApp(appName string)

func (*Machine) CleanupConfiguration

func (m *Machine) CleanupConfiguration(configurationName string)

func (*Machine) Client

func (m *Machine) Client() *http.Client

func (*Machine) CreateEpinioUser

func (m *Machine) CreateEpinioUser(role string, namespaces []string) (string, string)

CreateEpinioUser creates a new "user" BasicAuth Secret labeled as an Epinio User.

func (*Machine) Curl

func (m *Machine) Curl(method, uri string, requestBody io.Reader) (*http.Response, error)

Curl is used to make requests against a server

func (*Machine) DeleteApp

func (m *Machine) DeleteApp(appName string)

func (*Machine) DeleteAppchart

func (m *Machine) DeleteAppchart(tempFile string)

func (*Machine) DeleteConfigurations

func (m *Machine) DeleteConfigurations(configurationNames ...string)

func (*Machine) DeleteConfigurationsUnbind

func (m *Machine) DeleteConfigurationsUnbind(configurationNames ...string)

func (*Machine) DeleteConfigurationsWithUnbind

func (m *Machine) DeleteConfigurationsWithUnbind(configurationNames []string, unbind bool)

func (*Machine) DeleteEpinioUser

func (m *Machine) DeleteEpinioUser(username string) error

DeleteEpinioUser deletes the relevant Kubernetes secret if it exists.

func (*Machine) DeleteNamespace

func (m *Machine) DeleteNamespace(namespace string)

func (*Machine) DeleteService

func (m *Machine) DeleteService(serviceName string)

func (*Machine) Epinio

func (m *Machine) Epinio(dir, command string, arg ...string) (string, error)

Epinio invokes the `epinio` binary, running the specified command. It returns the command output and/or error. dir parameter defines the directory from which the command should be run. It defaults to the current dir if left empty.

func (*Machine) EpinioCmd

func (m *Machine) EpinioCmd(command string, arg ...string) *exec.Cmd

EpinioCmd creates a Cmd to run the Epinio client

func (*Machine) EpinioPush

func (m *Machine) EpinioPush(dir string, name string, arg ...string) (string, error)

EpinioPush shows the staging log if the error indicates that staging failed

func (*Machine) GetPodNames

func (m *Machine) GetPodNames(appName, namespaceName string) []string

func (*Machine) GetSettings

func (m *Machine) GetSettings() (*settings.Settings, error)

func (*Machine) GetSettingsFrom

func (m *Machine) GetSettingsFrom(location string) (*settings.Settings, error)

func (*Machine) HaveConfiguration

func (m *Machine) HaveConfiguration(configurationName string)

func (*Machine) HaveServiceInstance

func (m *Machine) HaveServiceInstance(serviceName string)

func (*Machine) MakeApp

func (m *Machine) MakeApp(appName string, instances int, deployFromCurrentDir bool) string

func (*Machine) MakeAppWithDir

func (m *Machine) MakeAppWithDir(appName string, instances int, deployFromCurrentDir bool, appDir string, more ...string) string

func (*Machine) MakeAppWithDirSimple

func (m *Machine) MakeAppWithDirSimple(appName string, deployFromCurrentDir bool, appDir string) string

func (*Machine) MakeAppchart

func (m *Machine) MakeAppchart(chartName string) string

func (*Machine) MakeAppchartStateful

func (m *Machine) MakeAppchartStateful(chartName string) string

func (*Machine) MakeConfiguration

func (m *Machine) MakeConfiguration(configurationName string)

func (*Machine) MakeConfigurationFromFiles

func (m *Machine) MakeConfigurationFromFiles(configurationName, path string)

func (*Machine) MakeContainerImageApp

func (m *Machine) MakeContainerImageApp(appName string, instances int, containerImageURL string) string

func (*Machine) MakeGitconfig

func (m *Machine) MakeGitconfig(gitConfigName string)

func (*Machine) MakeGitconfigWithoutCleanup

func (m *Machine) MakeGitconfigWithoutCleanup(gitConfigName string)

func (*Machine) MakeGolangApp

func (m *Machine) MakeGolangApp(appName string, instances int, deployFromCurrentDir bool) string

func (*Machine) MakeRoutedContainerImageApp

func (m *Machine) MakeRoutedContainerImageApp(appName string, instances int, containerImageURL, route string, more ...string) string

func (*Machine) MakeServiceInstance

func (m *Machine) MakeServiceInstance(serviceName, catalogService string)

func (*Machine) MakeWebSocketConnection

func (m *Machine) MakeWebSocketConnection(authToken string, url string, subprotocols ...string) (*websocket.Conn, error)

func (*Machine) SaveApplicationSpec

func (m *Machine) SaveApplicationSpec(appName string)

SaveApplicationSpec is a debugging helper function saving the specified application's manifest and helm data (values, chart) into file and directory named after the application.

Note: Intended use is debugging of a test case. Most tests cases will not need this as part of their regular operation.

__Attention__: The created files and directory are __not cleaned up automatically__

func (*Machine) SaveServerLogs

func (m *Machine) SaveServerLogs(destination string)

SaveServerLogs is a debugging helper function saving the test server's logs (last 3 minutes) into the specified file.

Note: Intended use is debugging of a test case. Most tests cases will not need this as part of their regular operation.

__Attention__: The created file is __not cleaned up automatically__

func (*Machine) SetupAndTargetNamespace

func (m *Machine) SetupAndTargetNamespace(namespace string)

func (*Machine) SetupNamespace

func (m *Machine) SetupNamespace(namespace string)

func (*Machine) ShowStagingLogs

func (m *Machine) ShowStagingLogs(app string)

func (*Machine) TargetNamespace

func (m *Machine) TargetNamespace(namespace string)

func (*Machine) UnbindAppConfiguration

func (m *Machine) UnbindAppConfiguration(appName, configurationName, namespace string)

func (*Machine) VerifyAppConfigurationBound

func (m *Machine) VerifyAppConfigurationBound(appName, configurationName, namespace string, offset int)

func (*Machine) VerifyAppConfigurationNotbound

func (m *Machine) VerifyAppConfigurationNotbound(appName, configurationName, namespace string, offset int)

func (*Machine) VerifyNamespaceNotExist

func (m *Machine) VerifyNamespaceNotExist(namespace string)

func (*Machine) Versions

func (m *Machine) Versions()