1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
|
package main
/*
* Version 0.12.0
* Compatible with Mac OS X AND other LINUX OS ONLY
*/
/*** OPERATION WORKFLOW ***/
/*
* 1- Create /usr/local/terraform directory if does not exist
* 2- Download zip file from url to /usr/local/terraform
* 3- Unzip the file to /usr/local/terraform
* 4- Rename the file from `terraform` to `terraform_version`
* 5- Remove the downloaded zip file
* 6- Read the existing symlink for terraform (Check if it's a homebrew symlink)
* 7- Remove that symlink (Check if it's a homebrew symlink)
* 8- Create new symlink to binary `terraform_version`
*/
import (
"fmt"
"io/ioutil"
"log"
"os"
"path/filepath"
"strings"
semver "github.com/hashicorp/go-version"
"github.com/hashicorp/hcl/v2/gohcl"
"github.com/hashicorp/hcl/v2/hclparse"
"github.com/hashicorp/terraform-config-inspect/tfconfig"
"github.com/manifoldco/promptui"
"github.com/pborman/getopt"
"github.com/spf13/viper"
lib "github.com/warrensbox/terraform-switcher/lib"
)
const (
defaultMirror = "https://releases.hashicorp.com/terraform"
defaultBin = "/usr/local/bin/terraform" //default bin installation dir
defaultLatest = ""
tfvFilename = ".terraform-version"
rcFilename = ".tfswitchrc"
tomlFilename = ".tfswitch.toml"
tgHclFilename = "terragrunt.hcl"
versionPrefix = "terraform_"
)
var version = "0.12.0\n"
func main() {
dir := lib.GetCurrentDirectory()
custBinPath := getopt.StringLong("bin", 'b', lib.ConvertExecutableExt(defaultBin), "Custom binary path. Ex: tfswitch -b "+lib.ConvertExecutableExt("/Users/username/bin/terraform"))
listAllFlag := getopt.BoolLong("list-all", 'l', "List all versions of terraform - including beta and rc")
latestPre := getopt.StringLong("latest-pre", 'p', defaultLatest, "Latest pre-release implicit version. Ex: tfswitch --latest-pre 0.13 downloads 0.13.0-rc1 (latest)")
showLatestPre := getopt.StringLong("show-latest-pre", 'P', defaultLatest, "Show latest pre-release implicit version. Ex: tfswitch --show-latest-pre 0.13 prints 0.13.0-rc1 (latest)")
latestStable := getopt.StringLong("latest-stable", 's', defaultLatest, "Latest implicit version based on a constraint. Ex: tfswitch --latest-stable 0.13.0 downloads 0.13.7 and 0.13 downloads 0.15.5 (latest)")
showLatestStable := getopt.StringLong("show-latest-stable", 'S', defaultLatest, "Show latest implicit version. Ex: tfswitch --show-latest-stable 0.13 prints 0.13.7 (latest)")
latestFlag := getopt.BoolLong("latest", 'u', "Get latest stable version")
showLatestFlag := getopt.BoolLong("show-latest", 'U', "Show latest stable version")
mirrorURL := getopt.StringLong("mirror", 'm', defaultMirror, "Install from a remote API other than the default. Default: "+defaultMirror)
chDirPath := getopt.StringLong("chdir", 'c', dir, "Switch to a different working directory before executing the given command. Ex: tfswitch --chdir terraform_project will run tfswitch in the terraform_project directory")
versionFlag := getopt.BoolLong("version", 'v', "Displays the version of tfswitch")
defaultVersion := getopt.StringLong("default", 'd', defaultLatest, "Default to this version in case no other versions could be detected. Ex: tfswitch --default 1.2.4")
helpFlag := getopt.BoolLong("help", 'h', "Displays help message")
_ = versionFlag
getopt.Parse()
args := getopt.Args()
homedir := lib.GetHomeDirectory()
TFVersionFile := filepath.Join(*chDirPath, tfvFilename) //settings for .terraform-version file in current directory (tfenv compatible)
RCFile := filepath.Join(*chDirPath, rcFilename) //settings for .tfswitchrc file in current directory (backward compatible purpose)
TOMLConfigFile := filepath.Join(*chDirPath, tomlFilename) //settings for .tfswitch.toml file in current directory (option to specify bin directory)
HomeTOMLConfigFile := filepath.Join(homedir, tomlFilename) //settings for .tfswitch.toml file in home directory (option to specify bin directory)
TGHACLFile := filepath.Join(*chDirPath, tgHclFilename) //settings for terragrunt.hcl file in current directory (option to specify bin directory)
switch {
case *versionFlag:
//if *versionFlag {
fmt.Printf("\nVersion: %v\n", version)
case *helpFlag:
//} else if *helpFlag {
usageMessage()
/* Checks if the .tfswitch.toml file exist in home or current directory
* This block checks to see if the tfswitch toml file is provided in the current path.
* If the .tfswitch.toml file exist, it has a higher precedence than the .tfswitchrc file
* You can specify the custom binary path and the version you desire
* If you provide a custom binary path with the -b option, this will override the bin value in the toml file
* If you provide a version on the command line, this will override the version value in the toml file
*/
case fileExists(TOMLConfigFile) || fileExists(HomeTOMLConfigFile):
version := ""
binPath := *custBinPath
if fileExists(TOMLConfigFile) { //read from toml from current directory
version, binPath = getParamsTOML(binPath, *chDirPath)
} else { // else read from toml from home directory
version, binPath = getParamsTOML(binPath, homedir)
}
switch {
/* GIVEN A TOML FILE, */
/* show all terraform version including betas and RCs*/
case *listAllFlag:
listAll := true //set list all true - all versions including beta and rc will be displayed
installOption(listAll, &binPath, mirrorURL)
/* latest pre-release implicit version. Ex: tfswitch --latest-pre 0.13 downloads 0.13.0-rc1 (latest) */
case *latestPre != "":
preRelease := true
installLatestImplicitVersion(*latestPre, custBinPath, mirrorURL, preRelease)
/* latest implicit version. Ex: tfswitch --latest 0.13 downloads 0.13.5 (latest) */
case *latestStable != "":
preRelease := false
installLatestImplicitVersion(*latestStable, custBinPath, mirrorURL, preRelease)
/* latest stable version */
case *latestFlag:
installLatestVersion(custBinPath, mirrorURL)
/* version provided on command line as arg */
case len(args) == 1:
installVersion(args[0], &binPath, mirrorURL)
/* provide an tfswitchrc file (IN ADDITION TO A TOML FILE) */
case fileExists(RCFile) && len(args) == 0:
readingFileMsg(rcFilename)
tfversion := retrieveFileContents(RCFile)
installVersion(tfversion, &binPath, mirrorURL)
/* if .terraform-version file found (IN ADDITION TO A TOML FILE) */
case fileExists(TFVersionFile) && len(args) == 0:
readingFileMsg(tfvFilename)
tfversion := retrieveFileContents(TFVersionFile)
installVersion(tfversion, &binPath, mirrorURL)
/* if versions.tf file found (IN ADDITION TO A TOML FILE) */
case checkTFModuleFileExist(*chDirPath) && len(args) == 0:
installTFProvidedModule(*chDirPath, &binPath, mirrorURL)
/* if Terraform Version environment variable is set */
case checkTFEnvExist() && len(args) == 0 && version == "":
tfversion := os.Getenv("TF_VERSION")
fmt.Printf("Terraform version environment variable: %s\n", tfversion)
installVersion(tfversion, custBinPath, mirrorURL)
/* if terragrunt.hcl file found (IN ADDITION TO A TOML FILE) */
case fileExists(TGHACLFile) && checkVersionDefinedHCL(&TGHACLFile) && len(args) == 0:
installTGHclFile(&TGHACLFile, &binPath, mirrorURL)
// if no arg is provided - but toml file is provided
case version != "":
installVersion(version, &binPath, mirrorURL)
default:
listAll := false //set list all false - only official release will be displayed
installOption(listAll, &binPath, mirrorURL)
}
/* show all terraform version including betas and RCs*/
case *listAllFlag:
installWithListAll(custBinPath, mirrorURL)
/* latest pre-release implicit version. Ex: tfswitch --latest-pre 0.13 downloads 0.13.0-rc1 (latest) */
case *latestPre != "":
preRelease := true
installLatestImplicitVersion(*latestPre, custBinPath, mirrorURL, preRelease)
/* show latest pre-release implicit version. Ex: tfswitch --latest-pre 0.13 downloads 0.13.0-rc1 (latest) */
case *showLatestPre != "":
preRelease := true
showLatestImplicitVersion(*showLatestPre, custBinPath, mirrorURL, preRelease)
/* latest implicit version. Ex: tfswitch --latest 0.13 downloads 0.13.5 (latest) */
case *latestStable != "":
preRelease := false
installLatestImplicitVersion(*latestStable, custBinPath, mirrorURL, preRelease)
/* show latest implicit stable version. Ex: tfswitch --latest 0.13 downloads 0.13.5 (latest) */
case *showLatestStable != "":
preRelease := false
showLatestImplicitVersion(*showLatestStable, custBinPath, mirrorURL, preRelease)
/* latest stable version */
case *latestFlag:
installLatestVersion(custBinPath, mirrorURL)
/* show latest stable version */
case *showLatestFlag:
showLatestVersion(custBinPath, mirrorURL)
/* version provided on command line as arg */
case len(args) == 1:
installVersion(args[0], custBinPath, mirrorURL)
/* provide an tfswitchrc file */
case fileExists(RCFile) && len(args) == 0:
readingFileMsg(rcFilename)
tfversion := retrieveFileContents(RCFile)
installVersion(tfversion, custBinPath, mirrorURL)
/* if .terraform-version file found */
case fileExists(TFVersionFile) && len(args) == 0:
readingFileMsg(tfvFilename)
tfversion := retrieveFileContents(TFVersionFile)
installVersion(tfversion, custBinPath, mirrorURL)
/* if versions.tf file found */
case checkTFModuleFileExist(*chDirPath) && len(args) == 0:
installTFProvidedModule(*chDirPath, custBinPath, mirrorURL)
/* if terragrunt.hcl file found */
case fileExists(TGHACLFile) && checkVersionDefinedHCL(&TGHACLFile) && len(args) == 0:
installTGHclFile(&TGHACLFile, custBinPath, mirrorURL)
/* if Terraform Version environment variable is set */
case checkTFEnvExist() && len(args) == 0:
tfversion := os.Getenv("TF_VERSION")
fmt.Printf("Terraform version environment variable: %s\n", tfversion)
installVersion(tfversion, custBinPath, mirrorURL)
/* if default version is provided - Pick this instead of going for prompt */
case *defaultVersion != "":
installVersion(*defaultVersion, custBinPath, mirrorURL)
// if no arg is provided
default:
listAll := false //set list all false - only official release will be displayed
installOption(listAll, custBinPath, mirrorURL)
}
}
/* Helper functions */
// install with all possible versions, including beta and rc
func installWithListAll(custBinPath, mirrorURL *string) {
listAll := true //set list all true - all versions including beta and rc will be displayed
installOption(listAll, custBinPath, mirrorURL)
}
// install latest stable tf version
func installLatestVersion(custBinPath, mirrorURL *string) {
tfversion, _ := lib.GetTFLatest(*mirrorURL)
lib.Install(tfversion, *custBinPath, *mirrorURL)
}
// show install latest stable tf version
func showLatestVersion(custBinPath, mirrorURL *string) {
tfversion, _ := lib.GetTFLatest(*mirrorURL)
fmt.Printf("%s\n", tfversion)
}
// install latest - argument (version) must be provided
func installLatestImplicitVersion(requestedVersion string, custBinPath, mirrorURL *string, preRelease bool) {
_, err := semver.NewConstraint(requestedVersion)
if err != nil {
fmt.Printf("error parsing constraint: %s\n", err)
}
//if lib.ValidMinorVersionFormat(requestedVersion) {
tfversion, err := lib.GetTFLatestImplicit(*mirrorURL, preRelease, requestedVersion)
if err == nil && tfversion != "" {
lib.Install(tfversion, *custBinPath, *mirrorURL)
}
fmt.Printf("Error parsing constraint: %s\n", err)
lib.PrintInvalidMinorTFVersion()
}
// show latest - argument (version) must be provided
func showLatestImplicitVersion(requestedVersion string, custBinPath, mirrorURL *string, preRelease bool) {
if lib.ValidMinorVersionFormat(requestedVersion) {
tfversion, _ := lib.GetTFLatestImplicit(*mirrorURL, preRelease, requestedVersion)
if len(tfversion) > 0 {
fmt.Printf("%s\n", tfversion)
} else {
fmt.Println("The provided terraform version does not exist. Try `tfswitch -l` to see all available versions.")
os.Exit(1)
}
} else {
lib.PrintInvalidMinorTFVersion()
}
}
// install with provided version as argument
func installVersion(arg string, custBinPath *string, mirrorURL *string) {
if lib.ValidVersionFormat(arg) {
requestedVersion := arg
//check to see if the requested version has been downloaded before
installLocation := lib.GetInstallLocation()
installFileVersionPath := lib.ConvertExecutableExt(filepath.Join(installLocation, versionPrefix+requestedVersion))
recentDownloadFile := lib.CheckFileExist(installFileVersionPath)
if recentDownloadFile {
lib.ChangeSymlink(installFileVersionPath, *custBinPath)
fmt.Printf("Switched terraform to version %q \n", requestedVersion)
lib.AddRecent(requestedVersion) //add to recent file for faster lookup
os.Exit(0)
}
//if the requested version had not been downloaded before
listAll := true //set list all true - all versions including beta and rc will be displayed
tflist, _ := lib.GetTFList(*mirrorURL, listAll) //get list of versions
exist := lib.VersionExist(requestedVersion, tflist) //check if version exist before downloading it
if exist {
lib.Install(requestedVersion, *custBinPath, *mirrorURL)
} else {
fmt.Println("The provided terraform version does not exist. Try `tfswitch -l` to see all available versions.")
os.Exit(1)
}
} else {
lib.PrintInvalidTFVersion()
fmt.Println("Args must be a valid terraform version")
usageMessage()
os.Exit(1)
}
}
//retrive file content of regular file
func retrieveFileContents(file string) string {
fileContents, err := ioutil.ReadFile(file)
if err != nil {
fmt.Printf("Failed to read %s file. Follow the README.md instructions for setup. https://github.com/warrensbox/terraform-switcher/blob/master/README.md\n", tfvFilename)
fmt.Printf("Error: %s\n", err)
os.Exit(1)
}
tfversion := strings.TrimSuffix(string(fileContents), "\n")
return tfversion
}
// Print message reading file content of :
func readingFileMsg(filename string) {
fmt.Printf("Reading file %s \n", filename)
}
// fileExists checks if a file exists and is not a directory before we try using it to prevent further errors.
func fileExists(filename string) bool {
info, err := os.Stat(filename)
if os.IsNotExist(err) {
return false
}
return !info.IsDir()
}
// fileExists checks if a file exists and is not a directory before we
// try using it to prevent further errors.
func checkTFModuleFileExist(dir string) bool {
module, _ := tfconfig.LoadModule(dir)
if len(module.RequiredCore) >= 1 {
return true
}
return false
}
// checkTFEnvExist - checks if the TF_VERSION environment variable is set
func checkTFEnvExist() bool {
tfversion := os.Getenv("TF_VERSION")
if tfversion != "" {
return true
}
return false
}
/* parses everything in the toml file, return required version and bin path */
func getParamsTOML(binPath string, dir string) (string, string) {
path := lib.GetHomeDirectory()
if dir == path {
path = "home directory"
} else {
path = "current directory"
}
fmt.Printf("Reading configuration from %s\n", path+" for "+tomlFilename) //takes the default bin (defaultBin) if user does not specify bin path
configfileName := lib.GetFileName(tomlFilename) //get the config file
viper.SetConfigType("toml")
viper.SetConfigName(configfileName)
viper.AddConfigPath(dir)
errs := viper.ReadInConfig() // Find and read the config file
if errs != nil {
fmt.Printf("Unable to read %s provided\n", tomlFilename) // Handle errors reading the config file
fmt.Println(errs)
os.Exit(1) // exit immediately if config file provided but it is unable to read it
}
bin := viper.Get("bin") // read custom binary location
if binPath == lib.ConvertExecutableExt(defaultBin) && bin != nil { // if the bin path is the same as the default binary path and if the custom binary is provided in the toml file (use it)
binPath = os.ExpandEnv(bin.(string))
}
//fmt.Println(binPath) //uncomment this to debug
version := viper.Get("version") //attempt to get the version if it's provided in the toml
if version == nil {
version = ""
}
return version.(string), binPath
}
func usageMessage() {
fmt.Print("\n\n")
getopt.PrintUsage(os.Stderr)
fmt.Println("Supply the terraform version as an argument, or choose from a menu")
}
/* 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 installOption(listAll bool, custBinPath, mirrorURL *string) {
tflist, _ := lib.GetTFList(*mirrorURL, listAll) //get list of versions
recentVersions, _ := lib.GetRecentVersions() //get recent versions from RECENT file
tflist = append(recentVersions, tflist...) //append recent versions to the top of the list
tflist = lib.RemoveDuplicateVersions(tflist) //remove duplicate version
if len(tflist) == 0 {
fmt.Println("[ERROR] : List is empty")
os.Exit(1)
}
/* prompt user to select version of terraform */
prompt := promptui.Select{
Label: "Select Terraform version",
Items: tflist,
}
_, tfversion, errPrompt := prompt.Run()
tfversion = strings.Trim(tfversion, " *recent") //trim versions with the string " *recent" appended
if errPrompt != nil {
log.Printf("Prompt failed %v\n", errPrompt)
os.Exit(1)
}
lib.Install(tfversion, *custBinPath, *mirrorURL)
os.Exit(0)
}
// install when tf file is provided
func installTFProvidedModule(dir string, custBinPath, mirrorURL *string) {
fmt.Printf("Reading required version from terraform file\n")
module, _ := tfconfig.LoadModule(dir)
tfconstraint := module.RequiredCore[0] //we skip duplicated definitions and use only first one
installFromConstraint(&tfconstraint, custBinPath, mirrorURL)
}
// install using a version constraint
func installFromConstraint(tfconstraint *string, custBinPath, mirrorURL *string) {
tfversion, err := lib.GetSemver(tfconstraint, mirrorURL)
if err == nil {
lib.Install(tfversion, *custBinPath, *mirrorURL)
}
fmt.Println(err)
fmt.Println("No version found to match constraint. Follow the README.md instructions for setup. https://github.com/warrensbox/terraform-switcher/blob/master/README.md")
os.Exit(1)
}
// Install using version constraint from terragrunt file
func installTGHclFile(tgFile *string, custBinPath, mirrorURL *string) {
fmt.Printf("Terragrunt file found: %s\n", *tgFile)
parser := hclparse.NewParser()
file, diags := parser.ParseHCLFile(*tgFile) //use hcl parser to parse HCL file
if diags.HasErrors() {
fmt.Println("Unable to parse HCL file")
os.Exit(1)
}
var version terragruntVersionConstraints
gohcl.DecodeBody(file.Body, nil, &version)
installFromConstraint(&version.TerraformVersionConstraint, custBinPath, mirrorURL)
}
type terragruntVersionConstraints struct {
TerraformVersionConstraint string `hcl:"terraform_version_constraint"`
}
// check if version is defined in hcl file /* lazy-emergency fix - will improve later */
func checkVersionDefinedHCL(tgFile *string) bool {
parser := hclparse.NewParser()
file, diags := parser.ParseHCLFile(*tgFile) //use hcl parser to parse HCL file
if diags.HasErrors() {
fmt.Println("Unable to parse HCL file")
os.Exit(1)
}
var version terragruntVersionConstraints
gohcl.DecodeBody(file.Body, nil, &version)
if version == (terragruntVersionConstraints{}) {
return false
}
return true
}
|