Extract provider version from .terraform.lock.hcl

khos2ow · khos2ow · commit 57cf3dbd1f47 · 2021-05-31T13:31:51.000-04:00
If .terraform.lock.hcl exists in module path, try to extract the exact
provider version being used as opposed to provided constraints.

Signed-off-by: Khosrow Moossavi &lt;khos2ow@gmail.com&gt;
diff --git a/go.mod b/go.mod
@@ -6,6 +6,7 @@ require (
 	github.com/BurntSushi/toml v0.3.1
 	github.com/hashicorp/go-plugin v1.4.0
 	github.com/hashicorp/go-version v1.3.0
+	github.com/hashicorp/hcl/v2 v2.0.0
 	github.com/iancoleman/orderedmap v0.2.0
 	github.com/imdario/mergo v0.3.11
 	github.com/mitchellh/go-homedir v1.1.0
diff --git a/internal/terraform/module.go b/internal/terraform/module.go
@@ -23,6 +23,8 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/hashicorp/hcl/v2/hclsimple"
+
 	terraformsdk "github.com/terraform-docs/plugin-sdk/terraform"
 	"github.com/terraform-docs/terraform-config-inspect/tfconfig"
 	"github.com/terraform-docs/terraform-docs/internal/reader"
@@ -152,7 +154,7 @@ func loadModuleItems(tfmodule *tfconfig.Module, options *Options) (*Module, erro
 	if err != nil {
 		return nil, err
 	}
-	providers := loadProviders(tfmodule)
+	providers := loadProviders(tfmodule, options)
 	requirements := loadRequirements(tfmodule)
 	resources := loadResources(tfmodule)
 
@@ -398,14 +400,37 @@ func loadOutputValues(options *Options) (map[string]*output, error) {
 	return terraformOutputs, err
 }
 
-func loadProviders(tfmodule *tfconfig.Module) []*Provider {
+func loadProviders(tfmodule *tfconfig.Module, options *Options) []*Provider {
+	type provider struct {
+		Name        string   `hcl:"name,label"`
+		Version     string   `hcl:"version"`
+		Constraints *string  `hcl:"constraints"`
+		Hashes      []string `hcl:"hashes"`
+	}
+	type lockfile struct {
+		Provider []provider `hcl:"provider,block"`
+	}
+	lock := make(map[string]provider)
+	var lf lockfile
+
+	filename := filepath.Join(options.Path, ".terraform.lock.hcl")
+	if err := hclsimple.DecodeFile(filename, nil, &lf); err == nil {
+		for i := range lf.Provider {
+			segments := strings.Split(lf.Provider[i].Name, "/")
+			name := segments[len(segments)-1]
+			lock[name] = lf.Provider[i]
+		}
+	}
+
 	resources := []map[string]*tfconfig.Resource{tfmodule.ManagedResources, tfmodule.DataResources}
 	discovered := make(map[string]*Provider)
 
 	for _, resource := range resources {
 		for _, r := range resource {
 			var version = ""
-			if rv, ok := tfmodule.RequiredProviders[r.Provider.Name]; ok && len(rv.VersionConstraints) > 0 {
+			if l, ok := lock[r.Provider.Name]; ok {
+				version = l.Version
+			} else if rv, ok := tfmodule.RequiredProviders[r.Provider.Name]; ok && len(rv.VersionConstraints) > 0 {
 				version = strings.Join(rv.VersionConstraints, " ")
 			}
 
diff --git a/internal/terraform/module_test.go b/internal/terraform/module_test.go
@@ -679,6 +679,13 @@ func TestLoadProviders(t *testing.T) {
 				providers: 3,
 			},
 		},
+		{
+			name: "load module providers from path",
+			path: "with-lock-file",
+			expected: expected{
+				providers: 3,
+			},
+		},
 		{
 			name: "load module providers from path",
 			path: "no-providers",
@@ -690,8 +697,11 @@ func TestLoadProviders(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			assert := assert.New(t)
+			options, _ := NewOptions().With(&Options{
+				Path: tt.path,
+			})
 			module, _ := loadModule(filepath.Join("testdata", tt.path))
-			providers := loadProviders(module)
+			providers := loadProviders(module, options)
 
 			assert.Equal(tt.expected.providers, len(providers))
 		})
diff --git a/internal/terraform/testdata/with-lock-file/.terraform.lock.hcl b/internal/terraform/testdata/with-lock-file/.terraform.lock.hcl
diff --git a/internal/terraform/testdata/with-lock-file/main.tf b/internal/terraform/testdata/with-lock-file/main.tf
@@ -0,0 +1,33 @@
+/**
+ * Example of 'foo_bar' module in `foo_bar.tf`.
+ *
+ * - list item 1
+ * - list item 2
+ *
+ * Even inline **formatting** in _here_ is possible.
+ * and some [link](https://domain.com/)
+ */
+
+terraform {
+  required_version = ">= 0.12"
+  required_providers {
+    aws = ">= 2.15.0"
+  }
+}
+
+resource "tls_private_key" "baz" {}
+
+data "aws_caller_identity" "current" {
+  provider = "aws"
+}
+
+resource "null_resource" "foo" {}
+
+module "foo" {
+  source  = "bar"
+  version = "1.2.3"
+}
+
+module "foobar" {
+  source  = "git@github.com:module/path?ref=v7.8.9"
+}
diff --git a/internal/terraform/testdata/with-lock-file/outputs.tf b/internal/terraform/testdata/with-lock-file/outputs.tf
@@ -0,0 +1,14 @@
+output C {
+  description = "It's unquoted output."
+  value       = "c"
+}
+
+output "A" {
+  description = "A description"
+  value       = "a"
+}
+
+// B description
+output "B" {
+  value = "b"
+}
diff --git a/internal/terraform/testdata/with-lock-file/variables.tf b/internal/terraform/testdata/with-lock-file/variables.tf
@@ -0,0 +1,30 @@
+// D description
+variable "D" {
+  default = "d"
+}
+
+variable "B" {
+  default = "b"
+}
+
+variable "E" {
+  default = ""
+}
+
+# A Description
+# in multiple lines
+variable A {}
+
+variable "C" {
+  description = "C description"
+  default = "c"
+}
+
+variable "F" {
+  description = "F description"
+}
+
+variable "G" {
+  description = "G description"
+  default     = null
+}
