toolbox

Documentation

Index

• func FindToolsDir() (string, error)
• type ToolFinder
  • func NewToolFinder() (ToolFinder, error)
  • func NewToolFinderWithDir(executableDir string) (ToolFinder, error)

Functions

func FindToolsDir

func FindToolsDir() (string, error)

FindToolsDir identifies the path to the local directory containing Thelma's bundled tools, and returning an error if it can't be found. It does this by trying to expand "../../tools" relative to $0 (the currently-running Thelma executable) Note that this location is correct:

• for installed Thelma instances running out of ~/.thelma/releases/current (thelma is located in ~/.thelma/releases/current/bin, tools are in ~/.thelma/releases/current/tools/bin)
• for locally-build Thelma compiled with `make build` (thelma is compiled to ./output/bin, third-party tools are downloaded ./output/tools/bin)
• for unpacked Thelma releases (release archives have thelma at ./bin/ and tools at ./tools/bin)

Types

type ToolFinder

type ToolFinder interface {
	// ExpandPath if `command` is the name of a tool that exists in the toolbox directory,
	// such as "kubectl", "helm", "argocd", return the fully-qualified path to that tool
	// within the toolbox directory.
	// (eg. "/Users/blah/.thelma/releases/v1.2.3/tools/bin/helm")
	// else, return the name unchanged (eg. "curl")
	ExpandPath(command string) string
}

ToolFinder exists to help shell.Runner instances resolve fully-qualified paths to Thelma's bundled tools

func NewToolFinder

func NewToolFinder() (ToolFinder, error)

NewToolFinder calls FindToolsDir to identify the location of Thelma's bundled tools and returns a new ToolFinder rooted at the tools dir's `bin` directory

func NewToolFinderWithDir

func NewToolFinderWithDir(executableDir string) (ToolFinder, error)

NewToolFinderWithDir FOR USE IN TESTS ONLY construct a new ToolFinder rooted at a custom tools directory