Merge pull request #32 from BedeGaming/remote-state-casing

config: tweak remote_state bindings to be consistent with Terraform

Author: brikis98

README.md

@@ -59,9 +59,9 @@ lock = {
 }
 
 # Configure Terragrunt to automatically store tfstate files in an S3 bucket
-remoteState = {
+remote_state = {
   backend = "s3"
-  backendConfigs = {
+  config {
     encrypt = "true"
     bucket = "my-bucket"
     key = "terraform.tfstate"
@@ -214,9 +214,9 @@ docs](https://www.terraform.io/docs/state/remote/) for the requirements to use a
 For remote state management, Terragrunt supports the following settings in `.terragrunt`:
 
 ```hcl
-remoteState = {
+remote_state = {
   backend = "s3"
-  backendConfigs = {
+  config {
     key1 = "value1"
     key2 = "value2"
     key3 = "value3"

config/config.go

@@ -19,14 +19,14 @@ type TerragruntConfig struct {
 
 // terragruntConfigFile represents the configuration supported in the .terragrunt file
 type terragruntConfigFile struct {
-	Lock        *LockConfig `json:"lock,omitempty"`
-	RemoteState *remote.RemoteState
+	Lock        *LockConfig         `hcl:"lock,omitempty"`
+	RemoteState *remote.RemoteState `hcl:"remote_state"`
 }
 
 // LockConfig represents generic configuration for Lock providers
 type LockConfig struct {
-	Backend string            `json:"backend"`
-	Config  map[string]string `json:"config"`
+	Backend string            `hcl:"backend"`
+	Config  map[string]string `hcl:"config"`
 }
 
 // ReadTerragruntConfig the Terragrunt config file from its default location

config/config_test.go

@@ -85,7 +85,7 @@ func TestParseTerragruntConfigRemoteStateMinimalConfig(t *testing.T) {
 
 	config :=
 		`
-	remoteState = {
+    remote_state = {
 	  backend = "s3"
 	}
 	`
@@ -96,15 +96,15 @@ func TestParseTerragruntConfigRemoteStateMinimalConfig(t *testing.T) {
 	assert.Nil(t, terragruntConfig.Lock)
 	assert.NotNil(t, terragruntConfig.RemoteState)
 	assert.Equal(t, "s3", terragruntConfig.RemoteState.Backend)
-	assert.Empty(t, terragruntConfig.RemoteState.BackendConfigs)
+	assert.Empty(t, terragruntConfig.RemoteState.Config)
 }
 
 func TestParseTerragruntConfigRemoteStateMissingBackend(t *testing.T) {
 	t.Parallel()
 
 	config :=
 		`
-	remoteState = {
+	remote_state = {
 	}
 	`
 
@@ -117,9 +117,9 @@ func TestParseTerragruntConfigRemoteStateFullConfig(t *testing.T) {
 
 	config :=
 		`
-	remoteState = {
+	remote_state = {
 	  backend = "s3"
-	  backendConfigs = {
+	  config = {
 	    encrypt = "true"
 	    bucket = "my-bucket"
 	    key = "terraform.tfstate"
@@ -134,11 +134,11 @@ func TestParseTerragruntConfigRemoteStateFullConfig(t *testing.T) {
 	assert.Nil(t, terragruntConfig.Lock)
 	assert.NotNil(t, terragruntConfig.RemoteState)
 	assert.Equal(t, "s3", terragruntConfig.RemoteState.Backend)
-	assert.NotEmpty(t, terragruntConfig.RemoteState.BackendConfigs)
-	assert.Equal(t, "true", terragruntConfig.RemoteState.BackendConfigs["encrypt"])
-	assert.Equal(t, "my-bucket", terragruntConfig.RemoteState.BackendConfigs["bucket"])
-	assert.Equal(t, "terraform.tfstate", terragruntConfig.RemoteState.BackendConfigs["key"])
-	assert.Equal(t, "us-east-1", terragruntConfig.RemoteState.BackendConfigs["region"])
+	assert.NotEmpty(t, terragruntConfig.RemoteState.Config)
+	assert.Equal(t, "true", terragruntConfig.RemoteState.Config["encrypt"])
+	assert.Equal(t, "my-bucket", terragruntConfig.RemoteState.Config["bucket"])
+	assert.Equal(t, "terraform.tfstate", terragruntConfig.RemoteState.Config["key"])
+	assert.Equal(t, "us-east-1", terragruntConfig.RemoteState.Config["region"])
 }
 
 func TestParseTerragruntConfigRemoteStateAndDynamoDbFullConfig(t *testing.T) {
@@ -156,9 +156,9 @@ func TestParseTerragruntConfigRemoteStateAndDynamoDbFullConfig(t *testing.T) {
       }
 	}
 
-	remoteState = {
+	remote_state = {
 	  backend = "s3"
-	  backendConfigs = {
+	  config {
 	    encrypt = "true"
 	    bucket = "my-bucket"
 	    key = "terraform.tfstate"
@@ -180,11 +180,11 @@ func TestParseTerragruntConfigRemoteStateAndDynamoDbFullConfig(t *testing.T) {
 
 	assert.NotNil(t, terragruntConfig.RemoteState)
 	assert.Equal(t, "s3", terragruntConfig.RemoteState.Backend)
-	assert.NotEmpty(t, terragruntConfig.RemoteState.BackendConfigs)
-	assert.Equal(t, "true", terragruntConfig.RemoteState.BackendConfigs["encrypt"])
-	assert.Equal(t, "my-bucket", terragruntConfig.RemoteState.BackendConfigs["bucket"])
-	assert.Equal(t, "terraform.tfstate", terragruntConfig.RemoteState.BackendConfigs["key"])
-	assert.Equal(t, "us-east-1", terragruntConfig.RemoteState.BackendConfigs["region"])
+	assert.NotEmpty(t, terragruntConfig.RemoteState.Config)
+	assert.Equal(t, "true", terragruntConfig.RemoteState.Config["encrypt"])
+	assert.Equal(t, "my-bucket", terragruntConfig.RemoteState.Config["bucket"])
+	assert.Equal(t, "terraform.tfstate", terragruntConfig.RemoteState.Config["key"])
+	assert.Equal(t, "us-east-1", terragruntConfig.RemoteState.Config["region"])
 }
 
 func TestParseTerragruntConfigInvalidLockBackend(t *testing.T) {

remote/remote_state.go

@@ -1,16 +1,17 @@
 package remote
 
 import (
-	"github.com/gruntwork-io/terragrunt/util"
-	"github.com/gruntwork-io/terragrunt/shell"
 	"fmt"
+
 	"github.com/gruntwork-io/terragrunt/errors"
+	"github.com/gruntwork-io/terragrunt/shell"
+	"github.com/gruntwork-io/terragrunt/util"
 )
 
 // Configuration for Terraform remote state
 type RemoteState struct {
-	Backend        string
-	BackendConfigs map[string]string
+	Backend string            `hcl:"backend"`
+	Config  map[string]string `hcl:"config"`
 }
 
 // Fill in any default configuration for remote state
@@ -79,12 +80,12 @@ func (remoteState RemoteState) toTerraformRemoteConfigArgs() []string {
 	baseArgs := []string{"remote", "config", "-backend", remoteState.Backend}
 
 	backendConfigArgs := []string{}
-	for key, value := range remoteState.BackendConfigs {
+	for key, value := range remoteState.Config {
 		arg := fmt.Sprintf("-backend-config=%s=%s", key, value)
 		backendConfigArgs = append(backendConfigArgs, arg)
 	}
 
 	return append(baseArgs, backendConfigArgs...)
 }
 
-var RemoteBackendMissing = fmt.Errorf("The remoteState.backend field cannot be empty")
+var RemoteBackendMissing = fmt.Errorf("The remoteState.backend field cannot be empty")

remote/remote_state_test.go

@@ -1,21 +1,22 @@
 package remote
 
 import (
+	"strings"
 	"testing"
+
 	"github.com/stretchr/testify/assert"
-	"strings"
 )
 
 func TestToTerraformRemoteConfigArgs(t *testing.T) {
 	t.Parallel()
 
 	remoteState := RemoteState{
 		Backend: "s3",
-		BackendConfigs: map[string]string {
+		Config: map[string]string{
 			"encrypt": "true",
-			"bucket": "my-bucket",
-			"key": "terraform.tfstate",
-			"region": "us-east-1",
+			"bucket":  "my-bucket",
+			"key":     "terraform.tfstate",
+			"region":  "us-east-1",
 		},
 	}
 	args := remoteState.toTerraformRemoteConfigArgs()
@@ -39,4 +40,4 @@ func assertRemoteConfigArgsEqual(t *testing.T, actualArgs []string, expectedArgs
 	for _, expectedArg := range expected {
 		assert.Contains(t, actualArgs, expectedArg)
 	}
-}
+}

test/fixture/.terragrunt

@@ -10,9 +10,9 @@ lock = {
 }
 
 # Configure Terragrunt to automatically store tfstate files in an S3 bucket
-remoteState = {
+remote_state = {
   backend = "s3"
-  backendConfigs = {
+  config {
     encrypt = "true"
     bucket = "gruntwork-terragrunt-tests"
     key = "terraform.tfstate"