Merge pull request #538 from runatlantis/tf-download

Autodownload tf versions. Add --default-tf-version.

.circleci/config.yml

@@ -7,11 +7,11 @@ jobs:
     steps:
     - checkout
     - run: make test-coverage
-    - run: make check-fmt
-    - run: make check-lint
     - run:
         name: post coverage to codecov.io
         command: bash <(curl -s https://codecov.io/bash)
+    - run: make check-fmt
+    - run: make check-lint
   e2e:
     working_directory: /go/src/github.com/runatlantis/atlantis
     docker:

Makefile

@@ -37,18 +37,18 @@ go-generate: ## Run go generate in all packages
 #echo "this doesn't work anymore: go generate \$\$(go list ./... | grep -v e2e | grep -v vendor | grep -v static)"
 
 test: ## Run tests
-	@go test -race -short $(PKG)
+	@go test -short $(PKG)
 
 test-all: ## Run tests including integration
 	@go test $(PKG)
 
 test-coverage:
 	@mkdir -p .cover
-	@go test -coverpkg $(PKG_COMMAS) -coverprofile .cover/cover.out $(PKG)
+	@go test -covermode atomic -coverprofile .cover/cover.out $(PKG)
 
 test-coverage-html:
 	@mkdir -p .cover
-	@go test -coverpkg $(PKG_COMMAS) -coverprofile .cover/cover.out $(PKG)
+	@go test -covermode atomic -coverprofile .cover/cover.out $(PKG)
 	go tool cover -html .cover/cover.out
 
 dist: ## Package up everything in static/ using go-bindata-assetfs so it can be served by a single binary

cmd/server.go

@@ -47,6 +47,7 @@ const (
 	ConfigFlag                 = "config"
 	CheckoutStrategyFlag       = "checkout-strategy"
 	DataDirFlag                = "data-dir"
+	DefaultTFVersionFlag       = "default-tf-version"
 	GHHostnameFlag             = "gh-hostname"
 	GHTokenFlag                = "gh-token"
 	GHUserFlag                 = "gh-user"
@@ -192,6 +193,11 @@ var stringFlags = []stringFlag{
 			" Only set if using TFE as a backend." +
 			" Should be specified via the ATLANTIS_TFE_TOKEN environment variable for security.",
 	},
+	{
+		name: DefaultTFVersionFlag,
+		description: "Terraform version to default to (ex. v0.12.0). Will download if not yet on disk." +
+			" If not set, Atlantis uses the terraform binary in its PATH.",
+	},
 }
 var boolFlags = []boolFlag{
 	{
@@ -383,10 +389,11 @@ func (s *ServerCmd) run() error {
 
 	// Config looks good. Start the server.
 	server, err := s.ServerCreator.NewServer(userConfig, server.Config{
-		AllowForkPRsFlag:    AllowForkPRsFlag,
-		AllowRepoConfigFlag: AllowRepoConfigFlag,
-		AtlantisURLFlag:     AtlantisURLFlag,
-		AtlantisVersion:     s.AtlantisVersion,
+		AllowForkPRsFlag:     AllowForkPRsFlag,
+		AllowRepoConfigFlag:  AllowRepoConfigFlag,
+		AtlantisURLFlag:      AtlantisURLFlag,
+		AtlantisVersion:      s.AtlantisVersion,
+		DefaultTFVersionFlag: DefaultTFVersionFlag,
 	})
 	if err != nil {
 		return errors.Wrap(err, "initializing server")

cmd/server_test.go

@@ -341,6 +341,7 @@ func TestExecute_Defaults(t *testing.T) {
 	Equals(t, dataDir, passedConfig.DataDir)
 
 	Equals(t, "branch", passedConfig.CheckoutStrategy)
+	Equals(t, "", passedConfig.DefaultTFVersion)
 	Equals(t, "github.com", passedConfig.GithubHostname)
 	Equals(t, "token", passedConfig.GithubToken)
 	Equals(t, "user", passedConfig.GithubUser)
@@ -446,6 +447,7 @@ func TestExecute_Flags(t *testing.T) {
 		cmd.BitbucketWebhookSecretFlag: "bitbucket-secret",
 		cmd.CheckoutStrategyFlag:       "merge",
 		cmd.DataDirFlag:                "/path",
+		cmd.DefaultTFVersionFlag:       "v0.11.0",
 		cmd.GHHostnameFlag:             "ghhostname",
 		cmd.GHTokenFlag:                "token",
 		cmd.GHUserFlag:                 "user",
@@ -477,6 +479,7 @@ func TestExecute_Flags(t *testing.T) {
 	Equals(t, "bitbucket-secret", passedConfig.BitbucketWebhookSecret)
 	Equals(t, "merge", passedConfig.CheckoutStrategy)
 	Equals(t, "/path", passedConfig.DataDir)
+	Equals(t, "v0.11.0", passedConfig.DefaultTFVersion)
 	Equals(t, "ghhostname", passedConfig.GithubHostname)
 	Equals(t, "token", passedConfig.GithubToken)
 	Equals(t, "user", passedConfig.GithubUser)
@@ -509,6 +512,7 @@ bitbucket-user: "bitbucket-user"
 bitbucket-webhook-secret: "bitbucket-secret"
 checkout-strategy: "merge"
 data-dir: "/path"
+default-tf-version: "v0.11.0"
 gh-hostname: "ghhostname"
 gh-token: "token"
 gh-user: "user"
@@ -544,6 +548,7 @@ tfe-token: my-token
 	Equals(t, "bitbucket-secret", passedConfig.BitbucketWebhookSecret)
 	Equals(t, "merge", passedConfig.CheckoutStrategy)
 	Equals(t, "/path", passedConfig.DataDir)
+	Equals(t, "v0.11.0", passedConfig.DefaultTFVersion)
 	Equals(t, "ghhostname", passedConfig.GithubHostname)
 	Equals(t, "token", passedConfig.GithubToken)
 	Equals(t, "user", passedConfig.GithubUser)
@@ -576,6 +581,7 @@ bitbucket-user: "bitbucket-user"
 bitbucket-webhook-secret: "bitbucket-secret"
 checkout-strategy: "merge"
 data-dir: "/path"
+default-tf-version: "v0.11.0"
 gh-hostname: "ghhostname"
 gh-token: "token"
 gh-user: "user"
@@ -607,6 +613,7 @@ tfe-token: my-token
 		"BITBUCKET_WEBHOOK_SECRET": "override-bitbucket-secret",
 		"CHECKOUT_STRATEGY":        "branch",
 		"DATA_DIR":                 "/override-path",
+		"DEFAULT_TF_VERSION":       "v0.12.0",
 		"GH_HOSTNAME":              "override-gh-hostname",
 		"GH_TOKEN":                 "override-gh-token",
 		"GH_USER":                  "override-gh-user",
@@ -642,6 +649,7 @@ tfe-token: my-token
 	Equals(t, "override-bitbucket-secret", passedConfig.BitbucketWebhookSecret)
 	Equals(t, "branch", passedConfig.CheckoutStrategy)
 	Equals(t, "/override-path", passedConfig.DataDir)
+	Equals(t, "v0.12.0", passedConfig.DefaultTFVersion)
 	Equals(t, "override-gh-hostname", passedConfig.GithubHostname)
 	Equals(t, "override-gh-token", passedConfig.GithubToken)
 	Equals(t, "override-gh-user", passedConfig.GithubUser)
@@ -674,6 +682,7 @@ bitbucket-user: "bitbucket-user"
 bitbucket-webhook-secret: "bitbucket-secret"
 checkout-strategy: "merge"
 data-dir: "/path"
+default-tf-version: "v0.11.0"
 gh-hostname: "ghhostname"
 gh-token: "token"
 gh-user: "user"
@@ -705,6 +714,7 @@ tfe-token: my-token
 		cmd.BitbucketWebhookSecretFlag: "override-bitbucket-secret",
 		cmd.CheckoutStrategyFlag:       "branch",
 		cmd.DataDirFlag:                "/override-path",
+		cmd.DefaultTFVersionFlag:       "v0.12.0",
 		cmd.GHHostnameFlag:             "override-gh-hostname",
 		cmd.GHTokenFlag:                "override-gh-token",
 		cmd.GHUserFlag:                 "override-gh-user",
@@ -734,6 +744,7 @@ tfe-token: my-token
 	Equals(t, "override-bitbucket-secret", passedConfig.BitbucketWebhookSecret)
 	Equals(t, "branch", passedConfig.CheckoutStrategy)
 	Equals(t, "/override-path", passedConfig.DataDir)
+	Equals(t, "v0.12.0", passedConfig.DefaultTFVersion)
 	Equals(t, "override-gh-hostname", passedConfig.GithubHostname)
 	Equals(t, "override-gh-token", passedConfig.GithubToken)
 	Equals(t, "override-gh-user", passedConfig.GithubUser)
@@ -768,6 +779,7 @@ func TestExecute_FlagEnvVarOverride(t *testing.T) {
 		"BITBUCKET_WEBHOOK_SECRET": "bitbucket-secret",
 		"CHECKOUT_STRATEGY":        "merge",
 		"DATA_DIR":                 "/path",
+		"DEFAULT_TF_VERSION":       "v0.11.0",
 		"GH_HOSTNAME":              "gh-hostname",
 		"GH_TOKEN":                 "gh-token",
 		"GH_USER":                  "gh-user",
@@ -807,6 +819,7 @@ func TestExecute_FlagEnvVarOverride(t *testing.T) {
 		cmd.BitbucketWebhookSecretFlag: "override-bitbucket-secret",
 		cmd.CheckoutStrategyFlag:       "branch",
 		cmd.DataDirFlag:                "/override-path",
+		cmd.DefaultTFVersionFlag:       "v0.12.0",
 		cmd.GHHostnameFlag:             "override-gh-hostname",
 		cmd.GHTokenFlag:                "override-gh-token",
 		cmd.GHUserFlag:                 "override-gh-user",
@@ -838,6 +851,7 @@ func TestExecute_FlagEnvVarOverride(t *testing.T) {
 	Equals(t, "override-bitbucket-secret", passedConfig.BitbucketWebhookSecret)
 	Equals(t, "branch", passedConfig.CheckoutStrategy)
 	Equals(t, "/override-path", passedConfig.DataDir)
+	Equals(t, "v0.12.0", passedConfig.DefaultTFVersion)
 	Equals(t, "override-gh-hostname", passedConfig.GithubHostname)
 	Equals(t, "override-gh-token", passedConfig.GithubToken)
 	Equals(t, "override-gh-user", passedConfig.GithubUser)

runatlantis.io/.vuepress/config.js

@@ -71,7 +71,9 @@ module.exports = {
                         ['customizing-atlantis', 'Overview'],
                         'atlantis-yaml-reference',
                         'upgrading-atlantis-yaml-to-version-2',
-                        'apply-requirements'
+                        'apply-requirements',
+                        'checkout-strategy',
+                        'terraform-versions'
                     ]
                 },
                 {
@@ -82,7 +84,6 @@ module.exports = {
                         'locking',
                         'autoplanning',
                         'automerging',
-                        'checkout-strategy',
                         'security'
                     ]
                 }

runatlantis.io/docs/atlantis-yaml-reference.md

@@ -96,7 +96,7 @@ workflow: myworkflow
 | dir                | string                                            | none    | yes      | The directory of this project relative to the repo root. Use `.` for the root. For example if the project was under `./project1` then use `project1`                                                                  |
 | workspace          | string                                            | default | no       | The [Terraform workspace](https://www.terraform.io/docs/state/workspaces.html) for this project. Atlantis will switch to this workplace when planning/applying and will create it if it doesn't exist.                |
 | autoplan           | [Autoplan](atlantis-yaml-reference.html#autoplan) | none    | no       | A custom autoplan configuration. If not specified, will use the default algorithm. See [Autoplanning](autoplanning.html).                                                                                             |
-| terraform_version  | string                                            | none    | no       | A specific Terraform version to use when running commands for this project. Requires there to be a binary in the Atlantis `PATH` with the name `terraform{VERSION}`, ex. `terraform0.11.0`                            |
+| terraform_version  | string                                            | none    | no       | A specific Terraform version to use when running commands for this project. Must be [Semver compatible](https://semver.org/), ex. `v0.11.0`, `0.12.0-beta1`.                                                          |
 | apply_requirements | array[string]                                     | []      | no       | Requirements that must be satisfied before `atlantis apply` can be run. Currently the only supported requirements are `approved` and `mergeable`. See [Apply Requirements](apply-requirements.html) for more details. |
 | workflow           | string                                            | none    | no       | A custom workflow. If not specified, Atlantis will use its default workflow.                                                                                                                                          |
 

runatlantis.io/docs/deployment.md

@@ -383,14 +383,14 @@ Once you're done, see [Next Steps](#next-steps).
 Atlantis has an [official](https://hub.docker.com/r/runatlantis/atlantis/) Docker image: `runatlantis/atlantis`.
 
 #### Customization
-If you need to modify the Docker image that we provide, for instance to add a specific version of Terraform, you can do something like this:
+If you need to modify the Docker image that we provide, for instance to add the terragrunt binary, you can do something like this:
 
 1. Create a custom docker file
     ```dockerfile
     FROM runatlantis/atlantis:{latest version}
 
     # copy a terraform binary of the version you need
-    COPY terraform /usr/local/bin/terraform
+    COPY terragrunt /usr/local/bin/terrgrunt
     ```
 
 1. Build your Docker image

runatlantis.io/docs/requirements.md

@@ -83,12 +83,8 @@ an `atlantis.yaml` file to tell it to use `-var-file={YOUR_FILE}`.
 See [atlantis.yaml Use Cases](/guide/atlantis-yaml-use-cases.html#using-tfvars-files) for more details.
 
 ## Terraform Versions
-By default, Atlantis will use the `terraform` executable that is in its path.
-To use a specific version of Terraform:
-1. Install the desired version of Terraform into the `$PATH` of where Atlantis is
- running and name it `terraform{version}`, ex. `terraform0.8.8`.
-2. Create an `atlantis.yaml` file for your repo and set the `terraform_version` key.
-See [atlantis.yaml Use Cases](/guide/atlantis-yaml-use-cases.html#terraform-versions) for more details.
+Atlantis supports all Terraform versions (including 0.12) and can be configured
+to use different versions for different repositories/projects. See [Terraform Versions](/docs/terraform-versions.html)l
 
 ## Next Steps
 * If your Terraform setup meets the Atlantis requirements, head back to our [Installation Guide](installation-guide.html) to get started

runatlantis.io/docs/terraform-versions.md

@@ -0,0 +1,20 @@
+# Terraform Versions
+
+You can customize which version of Terraform Atlantis defaults to by setting
+the `--default-tf-version` flag (ex. `--default-tf-version=v0.12.0`).
+
+If you wish to use a different version than the default for a specific repo or project, you need
+to create an `atlantis.yaml` file and set the `terraform_version` key:
+```yaml
+version: 2
+projects:
+- dir: .
+  terraform_version: v0.10.5
+```
+See [atlantis.yaml Use Cases](/guide/atlantis-yaml-use-cases.html#terraform-versions) for more details.
+
+::: tip NOTE
+Atlantis will automatically download the version specified.
+:::
+
+

runatlantis.io/guide/atlantis-yaml-use-cases.md

@@ -222,6 +222,11 @@ workflows:
       - run: terragrunt apply -no-color $PLANFILE
 ```
 
+::: warning
+Atlantis will need to have the `terragrunt` binary in its PATH.
+If you're using Docker you can build your own image, see [Customization](/docs/deployment.html#customization).
+:::
+
 ## Running custom commands
 Atlantis supports running custom commands. In this example, we want to run
 a script after every `apply`:
@@ -255,7 +260,7 @@ isn't set, Atlantis will use the default plan workflow which is what we want in
 
 ## Terraform Versions
 If you'd like to use a different version of Terraform than what is in Atlantis'
-`PATH` then set the `terraform_version` key:
+`PATH` or is set by the `--default-tf-version` flag, then set the `terraform_version` key:
 
 ```yaml
 version: 2
@@ -264,9 +269,7 @@ projects:
   terraform_version: 0.10.0
 ```
 
-Atlantis will then execute all Terraform commands with `terraform0.10.0` instead
-of `terraform`. This requires that the 0.10.0 binary is in Atlantis's `PATH` with the
-name `terraform0.10.0`.
+Atlantis will automatically download and use this version.
 
 ## Requiring Approvals For Production
 In this example, we only want to require `apply` approvals for the `production` directory.