lib

Documentation

Index

• Constants
• Variables
• func ChangeSymlink(binVersionPath string, binPath string)
• func CheckDirExist(dir string) bool
• func CheckDirHasTGBin(dir, prefix string) bool
• func CheckDirWritable(dir string) bool
• func CheckFileExist(file string) bool
• func CheckSymlink(symlinkPath string) bool
• func ConvertExecutableExt(fpath string) string
• func CreateRecentFile(requestedVersion string, installPath string)
• func CreateSymlink(cwd string, dir string)
• func DownloadFromURL(installLocation string, mirrorURL string, tfversion string, ...) (string, error)
• func FileExistsAndIsNotDir(filename string) bool
• func GetCurrentDirectory() string
• func GetDefaultBin() string
• func GetFileName(configfile string) string
• func GetHomeDirectory() string
• func GetSemver(tfconstraint string, mirrorURL string) (string, error)
• func InitLogger(logLevel string) *slog.Logger
• func InstallLatestImplicitVersion(requestedVersion, customBinaryPath, installPath string, mirrorURL string, ...)
• func InstallLatestVersion(customBinaryPath, installPath string, mirrorURL string)
• func InstallOption(listAll bool, customBinaryPath, installPath string, mirrorURL string)
• func InstallVersion(arg, customBinaryPath, installPath string, mirrorURL string)
• func IsDirEmpty(name string) bool
• func Path(value string) string
• func PrintInvalidMinorTFVersion()
• func PrintInvalidTFVersion()
• func ReadLines(path string) (lines []string, err error)
• func RemoveFiles(src string)
• func RemoveSymlink(symlinkPath string)
• func RenameFile(src string, dest string)
• func SemVerParser(tfconstraint *string, tflist []string) (string, error)
• func ShowLatestImplicitVersion(requestedVersion, mirrorURL string, preRelease bool)
• func ShowLatestVersion(mirrorURL string)
• func Unzip(src string, dest string) ([]string, error)
• func UsageMessage()
• func WriteLines(lines []string, path string) (err error)
• type Command
  • func NewCommand(name string) *Command
  • func (cmd *Command) Find() func() string
  • func (cmd *Command) PathList() []string

Constants

const (
	DefaultMirror = "https://releases.hashicorp.com/terraform"
	DefaultLatest = ""

	InstallDir = ".terraform.versions"

	VersionPrefix = "terraform_"
)

Variables

var (
	PubKeyId     = "72D7468F"
	PubKeyPrefix = "hashicorp_"
	PubKeyUri    = "https://www.hashicorp.com/.well-known/pgp-key.txt"
)

var (
	NormalLogging = slog.Levels{slog.PanicLevel, slog.FatalLevel, slog.ErrorLevel, slog.WarnLevel, slog.InfoLevel}
	NoticeLogging = slog.Levels{slog.PanicLevel, slog.FatalLevel, slog.ErrorLevel, slog.WarnLevel, slog.InfoLevel, slog.NoticeLevel}
	DebugLogging  = slog.Levels{slog.PanicLevel, slog.FatalLevel, slog.ErrorLevel, slog.WarnLevel, slog.InfoLevel, slog.NoticeLevel, slog.DebugLevel}
	TraceLogging  = slog.Levels{slog.PanicLevel, slog.FatalLevel, slog.ErrorLevel, slog.WarnLevel, slog.InfoLevel, slog.NoticeLevel, slog.DebugLevel, slog.TraceLevel}
)

Functions

func ChangeSymlink

func ChangeSymlink(binVersionPath string, binPath string)

ChangeSymlink : move symlink to existing binary

func CheckDirExist

func CheckDirExist(dir string) bool

CheckDirExist : check if directory exist dir=path to file return bool

func CheckDirHasTGBin

func CheckDirHasTGBin(dir, prefix string) bool

CheckDirHasTGBin : // check binary exist (TODO UNIT TEST)

func CheckDirWritable

func CheckDirWritable(dir string) bool

Check if user has permission to directory : dir=path to file return bool

func CheckFileExist

func CheckFileExist(file string) bool

CheckFileExist : check if file exist in directory

func CheckSymlink

func CheckSymlink(symlinkPath string) bool

CheckSymlink : check file is symlink

func ConvertExecutableExt

func ConvertExecutableExt(fpath string) string

ConvertExecutableExt : convert excutable with local OS extension

func CreateRecentFile

func CreateRecentFile(requestedVersion string, installPath string)

CreateRecentFile : create RECENT file

func CreateSymlink

func CreateSymlink(cwd string, dir string)

CreateSymlink : create symlink or copy file to bin directory if windows

func DownloadFromURL

func DownloadFromURL(installLocation string, mirrorURL string, tfversion string, versionPrefix string, goos string, goarch string) (string, error)

DownloadFromURL : Downloads the terraform binary and its hash from the source url

func FileExistsAndIsNotDir

func FileExistsAndIsNotDir(filename string) bool

FileExistsAndIsNotDir checks if a file exists and is not a directory before we try using it to prevent further errors

func GetCurrentDirectory

func GetCurrentDirectory() string

GetCurrentDirectory : return the current directory

func GetDefaultBin

func GetDefaultBin() string

GetDefaultBin Get default binary path

func GetFileName

func GetFileName(configfile string) string

GetFileName : remove file ext. .tfswitch.config returns .tfswitch

func GetHomeDirectory

func GetHomeDirectory() string

GetHomeDirectory : return the user's home directory

func GetSemver

func GetSemver(tfconstraint string, mirrorURL string) (string, error)

GetSemver : returns version that will be installed based on server constraint provided

func InitLogger

func InitLogger(logLevel string) *slog.Logger

func InstallLatestImplicitVersion

func InstallLatestImplicitVersion(requestedVersion, customBinaryPath, installPath string, mirrorURL string, preRelease bool)

InstallLatestImplicitVersion install latest - argument (version) must be provided

func InstallLatestVersion

func InstallLatestVersion(customBinaryPath, installPath string, mirrorURL string)

InstallLatestVersion install latest stable tf version

func InstallOption

func InstallOption(listAll bool, customBinaryPath, installPath string, mirrorURL string)

InstallOption displays & installs tf version

listAll = true - all versions including beta and rc will be displayed
listAll = false - only official stable release are displayed

func InstallVersion

func InstallVersion(arg, customBinaryPath, installPath string, mirrorURL string)

InstallVersion install with provided version as argument

func IsDirEmpty

func IsDirEmpty(name string) bool

IsDirEmpty : check if directory is empty (TODO UNIT TEST)

func Path

func Path(value string) string

Path : returns path of directory value=path to file

func PrintInvalidMinorTFVersion

func PrintInvalidMinorTFVersion()

PrintInvalidMinorTFVersion Print invalid minor TF version

func PrintInvalidTFVersion

func PrintInvalidTFVersion()

PrintInvalidTFVersion Print invalid TF version

func ReadLines

func ReadLines(path string) (lines []string, err error)

ReadLines : Read a whole file into the memory and store it as array of lines

func RemoveFiles

func RemoveFiles(src string)

RemoveFiles : remove file

func RemoveSymlink

func RemoveSymlink(symlinkPath string)

RemoveSymlink : remove symlink

func RenameFile

func RenameFile(src string, dest string)

RenameFile : rename file name

func SemVerParser

func SemVerParser(tfconstraint *string, tflist []string) (string, error)

SemVerParser : Goes through the list of terraform version, return a valid tf version for contraint provided

func ShowLatestImplicitVersion

func ShowLatestImplicitVersion(requestedVersion, mirrorURL string, preRelease bool)

ShowLatestImplicitVersion show latest - argument (version) must be provided

func ShowLatestVersion

func ShowLatestVersion(mirrorURL string)

ShowLatestVersion show install latest stable tf version

func Unzip

func Unzip(src string, dest string) ([]string, error)

Unzip will decompress a zip archive, moving all files and folders within the zip file (parameter 1) to an output directory (parameter 2).

func UsageMessage

func UsageMessage()

func WriteLines

func WriteLines(lines []string, path string) (err error)

WriteLines : writes into file

Types

type Command

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

Command : type string

func NewCommand

func NewCommand(name string) *Command

NewCommand : get command

func (*Command) Find

func (cmd *Command) Find() func() string

Find : find all bin path

func (*Command) PathList

func (cmd *Command) PathList() []string

PathList : get bin path list