Terraform version config detection #789

kennethtxytqw · 2019-09-25T17:46:15Z

TLDR

Added version detection using terraform-config-inspect
Added file content writing functionality to testing.TempDir

Assumptions made

Only when the user specify an exact version in the terraform configuration then do we use it. The specification requirements are in https://www.terraform.io/docs/configuration/terraform.html#specifying-a-required-terraform-version

= (or no operator): exact version equality

Anything else doesn't really make sense, we can fall back on server config as explained below(##Assumptions.2).
Version specified in atlantis.yaml takes precedence:
atlantis.yaml repo config > terraform.required_version > defaultTfVersion in atlantis server config
This way requires the least change to existing code.

Use of github.com/hashicorp/go-version

Offload interpretation of version number to the library.

Closes #71

kennethtxytqw · 2019-09-25T18:10:36Z

I don't understand. Why is the CI failing? Seems like it had trouble installing the dependency.

kennethtxytqw · 2019-10-01T06:30:20Z

@lkysow This is working on when I do make test-coverage on my local. Is this because it is using the testing image in the ci pipeline?

lkysow · 2019-10-01T15:01:15Z

You probably need to run go mod vendor since we run everything in vendor mode.

codecov · 2019-10-02T14:08:41Z

Codecov Report

❗ No coverage uploaded for pull request base (master@75da89e). Click here to learn what that means.
The diff coverage is 78.57%.

@@            Coverage Diff            @@
##             master     #789   +/-   ##
=========================================
  Coverage          ?   72.78%           
=========================================
  Files             ?       63           
  Lines             ?     4836           
  Branches          ?        0           
=========================================
  Hits              ?     3520           
  Misses            ?     1055           
  Partials          ?      261

Impacted Files	Coverage Δ
server/events/project_command_builder.go	`82.2% <78.57%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 75da89e...1c624bd. Read the comment docs.

kennethtxytqw · 2019-10-02T14:22:59Z

@lkysow Ahhhh awesome thanks! Fixed!!! Love to hear your feedback/review for this PR! :)

kennethtxytqw · 2019-10-02T14:24:59Z

Actually I was thinking, with this PR we can output useful information for the users such as VAULT_ADDR defined in the vault providers, etc. Let me know what you think about this. I can do them in another PR. Wanna keep this one small-reviewable.

Some use cases:

Combined with https://github.com/runatlantis/atlantis/blob/master/CHANGELOG.md#v090 . There is potential to select the right way to generate relevant environment variables for the providers use. We only have to provide the information, users can write the logic themselves.

zytek · 2019-10-03T15:06:38Z

We are in the process of migrating from TF 0.11 to TF 0.12 across our mono-repo with multiple terraform "modules" (subdirs). Currently we use atlantis automatic mode for project detection, so we have no place to specify per-module terraform version. We bump required_version in each module during update process. This PR seems to ease our migration effort a lot, so thanks! Gonna give it a try this or the next week.

kennethtxytqw · 2019-10-03T15:43:27Z

Thanks @zytek ! Let me know if it breaks anything.

lkysow

Looking good! I have a couple comments.
Also can you split up the vendor updates and the code changes into two commits. I will want to do the vendoring myself just to be safe.

server/events/project_command_builder.go

testing/temp_files.go

server/events/project_command_builder_test.go

lkysow · 2019-10-04T22:05:11Z

Actually I was thinking, with this PR we can output useful information for the users such as VAULT_ADDR defined in the vault providers, etc. Let me know what you think about this. I can do them in another PR. Wanna keep this one small-reviewable.

Some use cases:

Using multiple Azure providers #771

Question: Multiple Atlantis Servers #653

how to pass in google provider credentials file to each run #223

Combined with https://github.com/runatlantis/atlantis/blob/master/CHANGELOG.md#v090 . There is potential to select the right way to generate relevant environment variables for the providers use. We only have to provide the information, users can write the logic themselves.

This sounds cool. In a separate ticket I'd be interested in some concrete use-cases.

kennethtxytqw · 2019-10-06T07:35:21Z

Looking good! I have a couple comments.
Also can you split up the vendor updates and the code changes into two commits. I will want to do the vendoring myself just to be safe.

Splitted the pr into two commits

byakku · 2019-10-07T11:42:44Z

@kennethtxytqw

Just tested newest version (8c676c2ff49e2eeaff038a3f05b68e442f85f0f3), it does not detect nor use good version.

What I expected:
Atlantis will dynamically choose correct terraform version based on atlantis.yaml or required_version in terraform.tf.

What is actually happening:
Atlantis picks default version and keeps using it despite having different value in terraform.tf.

When there is no default version, I've ran atlantis plan and it executed correctly (plan failed because module was using 0.11, not 0.12) and atlantis selected 0.12.9 as default version.

When I ran atlantis plan in repo with modules using 0.11 and 0.12 only those with 0.12 got planned properly, atlantis didn't detect/select other version correcty.

terraform-config-inspect returns correct version (specified in terraform.tf)

How to reproduce:
(Ofc build custom image based on this PR)

Create repository with at least 2 subdirs. Put any working .tf there
In dir1 put required_version = "0.12.9" in terraform.tf
In dir2 put required_version = "0.11.14" in terraform.tf
Trigger atlantis.

In logs I could see cannot determine required core from terraform configuration. in case with multi-directory PR containing 2 different terraform versions.

kennethtxytqw · 2019-10-07T15:59:35Z

Odd. I just added a test for multiple directory repo. It worked.

zytek · 2019-10-08T09:03:14Z

@kennethtxytqw any idea how can we assist in testing this? Our setup with @byakku is rather simple. One repo with a few dirs (ecr/ s3/ iam/ etc) and in each dir there is terraform.tf file with requires_version = "x.y.z" - a mix o 0.11 and 0.12. Atlantis default is set up to 0.11.14. And autodetection does not work.

edit: we have no atlantys.yaml file and rely only on atlantis autodiscovery/autodetection of projects

Example output from terraform-confit-inspect running in a dir:

➜  s3 git:(master) ✗ ~/go/bin/terraform-config-inspect

# Module `.`

Core Version Constraints:
* `0.12.9`
* `>= 0.12`

Provider Requirements:
* **aws:** (any version)
[trim]

kennethtxytqw · 2019-10-12T05:18:38Z

@zytek Why are there two ? Did you specify required_version in two places for the project?

Core Version Constraints:
* `0.12.9`
* `>= 0.12`

zytek · 2019-10-14T09:36:05Z

@kennethtxytqw we had version specified in terraform.tf file and a second one in versions.tf created by probably by terraform 0.12upgrade command that we had missed out.

Atlantis could provide more helpful error message in such case :)

Testing this PR agains proper project with only one version constrain right now.

zytek · 2019-10-14T15:38:50Z

server/events/project_command_builder.go

+	re := regexp.MustCompile(`^=?\s*([^\s]+)\s*$`)
+	matched := re.FindStringSubmatch(module.RequiredCore[0])
+	if len(matched) == 0 {
+		ctx.Log.Warn("did not specify exact version in terraform configuration.")


I would unify log levels here or switch those message priorities as the fact that a version was detected and is being use is IMHO more important than the fact that we fallback to defaults because no version was detected.

Hmmm you make sense. I will update my PR.

I added some more logs and unified as you suggested.

zytek · 2019-10-14T15:39:20Z

I can confirm now that this PR works as expected. One note added regarding log levels.

Just remember to not shoot yourself in the foot by leaving autogenerated versions.tf file and by deploying wrong docker image of atlantis ;-)

kennethtxytqw · 2019-10-15T13:34:08Z

I can confirm now that this PR works as expected. One note added regarding log levels.

Just remember to not shoot yourself in the foot by leaving autogenerated versions.tf file and by deploying wrong docker image of atlantis ;-)

HAHA got it! Thanks for testing it out. I tested it out too with this image https://hub.docker.com/r/yesyouken/atlantis feel free to use this one for testing

kennethtxytqw · 2019-10-20T13:52:54Z

I have tested this at my workplace for more than a week already. We have deprecated the use of terraform_version in atlantis.yaml and depend on the terraform configuration completely. Thanks for the help guys!

lkysow

Nice work, awesome PR

MPV · 2020-02-04T15:05:42Z

Anyone up for adding a mention of this in the documentation? 😅 https://www.runatlantis.io/docs/terraform-versions.html

Took a while for me to find this PR and see that this was actually really supported. ❤️

lkysow · 2020-02-04T15:54:39Z

@MPV do you feel up to it? You can edit it here: https://github.com/runatlantis/atlantis/blob/master/runatlantis.io/docs/terraform-versions.md

Updates for runatlantis#789 (comment)

kennethtxytqw · 2020-02-08T10:11:55Z

My bad should have done so in the same PR.

llamahunter · 2020-10-11T01:18:15Z

Why do general version constraints on the terraform.required_version 'not make sense'?

kennethtxytqw force-pushed the terraform-version-config-detection branch from f49d253 to c5384c7 Compare September 25, 2019 18:03

kennethtxytqw force-pushed the terraform-version-config-detection branch from c5384c7 to 4e696bb Compare September 28, 2019 16:53

lkysow requested changes Oct 4, 2019

View reviewed changes

server/events/project_command_builder.go Outdated Show resolved Hide resolved

server/events/project_command_builder.go Outdated Show resolved Hide resolved

testing/temp_files.go Show resolved Hide resolved

server/events/project_command_builder_test.go Show resolved Hide resolved

kennethtxytqw force-pushed the terraform-version-config-detection branch 4 times, most recently from 9d9f5d8 to 2d2e51f Compare October 6, 2019 07:30

kennethtxytqw force-pushed the terraform-version-config-detection branch from 8c676c2 to 51ddfbb Compare October 7, 2019 15:57

zytek reviewed Oct 14, 2019

View reviewed changes

kennethtxytqw force-pushed the terraform-version-config-detection branch from 51ddfbb to ceffad7 Compare October 15, 2019 15:09

kennethtxytqw added 2 commits October 15, 2019 23:17

Added terraform-config-inspect.

4db1ed8

go mod vendor

1c624bd

kennethtxytqw force-pushed the terraform-version-config-detection branch from 35a83d5 to 1c624bd Compare October 15, 2019 15:19

kennethtxytqw requested a review from lkysow October 20, 2019 06:25

lkysow approved these changes Oct 28, 2019

View reviewed changes

lkysow merged commit a02a663 into runatlantis:master Oct 28, 2019

kennethtxytqw added a commit to kennethtxytqw/atlantis that referenced this pull request Feb 8, 2020

Update terraform-versions.md

3ce88eb

Updates for runatlantis#789 (comment)

kennethtxytqw mentioned this pull request Feb 8, 2020

Update terraform-versions.md #927

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Terraform version config detection #789

Terraform version config detection #789

kennethtxytqw commented Sep 25, 2019 •

edited

kennethtxytqw commented Sep 25, 2019

kennethtxytqw commented Oct 1, 2019

lkysow commented Oct 1, 2019

codecov bot commented Oct 2, 2019 •

edited

kennethtxytqw commented Oct 2, 2019

kennethtxytqw commented Oct 2, 2019 •

edited

zytek commented Oct 3, 2019

kennethtxytqw commented Oct 3, 2019

lkysow left a comment

lkysow commented Oct 4, 2019

kennethtxytqw commented Oct 6, 2019

byakku commented Oct 7, 2019

kennethtxytqw commented Oct 7, 2019

zytek commented Oct 8, 2019 •

edited

kennethtxytqw commented Oct 12, 2019

zytek commented Oct 14, 2019

zytek Oct 14, 2019

kennethtxytqw Oct 15, 2019

kennethtxytqw Oct 15, 2019

zytek commented Oct 14, 2019

kennethtxytqw commented Oct 15, 2019 •

edited

kennethtxytqw commented Oct 20, 2019

lkysow left a comment

MPV commented Feb 4, 2020

lkysow commented Feb 4, 2020

kennethtxytqw commented Feb 8, 2020

llamahunter commented Oct 11, 2020

Terraform version config detection #789

Terraform version config detection #789

Conversation

kennethtxytqw commented Sep 25, 2019 • edited

TLDR

Assumptions made

Use of github.com/hashicorp/go-version

kennethtxytqw commented Sep 25, 2019

kennethtxytqw commented Oct 1, 2019

lkysow commented Oct 1, 2019

codecov bot commented Oct 2, 2019 • edited

Codecov Report

kennethtxytqw commented Oct 2, 2019

kennethtxytqw commented Oct 2, 2019 • edited

zytek commented Oct 3, 2019

kennethtxytqw commented Oct 3, 2019

lkysow left a comment

Choose a reason for hiding this comment

lkysow commented Oct 4, 2019

kennethtxytqw commented Oct 6, 2019

byakku commented Oct 7, 2019

kennethtxytqw commented Oct 7, 2019

zytek commented Oct 8, 2019 • edited

kennethtxytqw commented Oct 12, 2019

zytek commented Oct 14, 2019

zytek Oct 14, 2019

Choose a reason for hiding this comment

kennethtxytqw Oct 15, 2019

Choose a reason for hiding this comment

kennethtxytqw Oct 15, 2019

Choose a reason for hiding this comment

zytek commented Oct 14, 2019

kennethtxytqw commented Oct 15, 2019 • edited

kennethtxytqw commented Oct 20, 2019

lkysow left a comment

Choose a reason for hiding this comment

MPV commented Feb 4, 2020

lkysow commented Feb 4, 2020

kennethtxytqw commented Feb 8, 2020

llamahunter commented Oct 11, 2020

kennethtxytqw commented Sep 25, 2019 •

edited

codecov bot commented Oct 2, 2019 •

edited

kennethtxytqw commented Oct 2, 2019 •

edited

zytek commented Oct 8, 2019 •

edited

kennethtxytqw commented Oct 15, 2019 •

edited