helper

Documentation

Index

• func CopyDirectory(source string, destination string) error
• func CopyFile(source string, destination string) error
• func CopySymlink(source string, destination string) error
• func ExtractTar(source string, destination string, stripComponents int) error
• func ExtractTarGz(source string, destination string, stripComponents int) error
• func ExtractTarXz(source string, destination string, stripComponents int) error
• func ExtractZip(source string, destination string, stripComponents int) error
• func FileExists(file string) (bool, error)
• func FindFiles(root string, pattern *regexp.Regexp) ([]string, error)
• func FindMainModule(application application.Application) (string, bool, error)
• func HasFile(root string, pattern *regexp.Regexp) (bool, error)
• func ReadBuildpackYaml(buildpackYAMLPath string, config interface{}) error
• func WriteFile(filename string, perm os.FileMode, format string, args ...interface{}) error
• func WriteFileFromReader(filename string, perm os.FileMode, source io.Reader) error
• func WriteSymlink(oldName string, newName string) error
• type ApplicationRoute
• type ApplicationRoutes
  • func DefaultApplicationRoutes() (ApplicationRoutes, error)
• type Credentials
  • func FindServiceCredentials(filter string, credentials ...string) (Credentials, bool, error)

Functions

func CopyDirectory

func CopyDirectory(source string, destination string) error

CopyDirectory copies source to destination recursively.

func CopyFile

func CopyFile(source string, destination string) error

CopyFile copies source to destination. Before writing, it creates all required parent directories for the destination.

func CopySymlink

func CopySymlink(source string, destination string) error

CopySymlink copies source to destination. Before writing, it creates all required parent directories for the destination.

func ExtractTar

func ExtractTar(source string, destination string, stripComponents int) error

ExtractTar extracts a source TAR file to a destination directory. An arbitrary number of top-level directory components can be stripped from each path.

func ExtractTarGz

func ExtractTarGz(source string, destination string, stripComponents int) error

ExtractTarGz extracts source GZIP'd TAR file to a destination directory. An arbitrary number of top-level directory components can be stripped from each path.

func ExtractTarXz

func ExtractTarXz(source string, destination string, stripComponents int) error

ExtractTarXz extracts source XZ TAR file to a destination directory.

func ExtractZip

func ExtractZip(source string, destination string, stripComponents int) error

ExtractZip extracts source ZIP file to a destination directory. An arbitrary number of top-level directory components can be stripped from each path.

func FileExists

func FileExists(file string) (bool, error)

FileExists returns whether a file exists taking into account various error cases.

func FindFiles

func FindFiles(root string, pattern *regexp.Regexp) ([]string, error)

FindFiles searches a directory structure for files matching the provided pattern, returning their full paths if found.

func FindMainModule

func FindMainModule(application application.Application) (string, bool, error)

FindMainModule examines a package.json file in the root of the Application and returns the value for "main" if it exists. If it does not exist, returns false.

func HasFile

func HasFile(root string, pattern *regexp.Regexp) (bool, error)

HasFile searches a directory structure for a file matching the provided pattern, returning true if found.

func ReadBuildpackYaml

func ReadBuildpackYaml(buildpackYAMLPath string, config interface{}) error

func WriteFile

func WriteFile(filename string, perm os.FileMode, format string, args ...interface{}) error

WriteFile writes a file with the given content. Before writing, it creates all required parent directories for the file.

func WriteFileFromReader

func WriteFileFromReader(filename string, perm os.FileMode, source io.Reader) error

WriteFileFromReader writes a file with the given content from a io.Reader. Before writing, it creates all required parent directories for the file.

func WriteSymlink

func WriteSymlink(oldName string, newName string) error

WriteSymlink creates newName as a symbolic link to oldName. Before writing, it creates all required parent directories for the newName.

Types

type ApplicationRoute

type ApplicationRoute struct {
	// Port is the port exposed as part of the route.
	Port int `json:"port"`

	// URI is the URI exposed by the route.
	URI string `json:"uri"`
}

ApplicationRoute represents a route exposed by the platform to an application.

type ApplicationRoutes

type ApplicationRoutes map[string]ApplicationRoute

ApplicationRoutes is a map of route name to ApplicationRoute.

func DefaultApplicationRoutes

func DefaultApplicationRoutes() (ApplicationRoutes, error)

DefaultApplicationRoutes creates a new instance of ApplicationRoutes, extracting the value from the CNB_APP_ROUTES environment variable.

type Credentials

type Credentials map[string]interface{}

Credentials is the collection of credentials available exposed by a service.

func FindServiceCredentials

func FindServiceCredentials(filter string, credentials ...string) (Credentials, bool, error)

FindServiceCredentials returns the credentials payload for given service. The selected service is one who's BindingName, InstanceName, Label, or Tags contain the filter and has the required credentials. Returns the credentials and true if exactly one service is matched, otherwise false.

NOTE: This function should ONLY be used in helper applications executed at launch time. It is BY DESIGN that credential values are not available when the buildpack is executing.