8000 Merge pull request #1560 from gruntwork-io/terragrunt-stack-generate · gruntwork-io/terratest@1ce1b74 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1ce1b74

Browse files
james00012james00012
authored
Merge pull request #1560 from gruntwork-io/terragrunt-stack-generate
Implement support for `terragrunt stack init`
2 parents 3982e2d + 1323137 commit 1ce1b74

File tree

14 files changed

+223
-2
lines changed

14 files changed

+223
-2
lines changed

‎.circleci/config.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ env: &env
77
TERRAFORM_VERSION: 1.5.7
88
TOFU_VERSION: 1.8.0
99
PACKER_VERSION: 1.10.0
10-
TERRAGRUNT_VERSION: v0.69.8
10+
TERRAGRUNT_VERSION: v0.80.4
1111
OPA_VERSION: v0.33.1
1212
GO_VERSION: 1.21.1
1313
GO111MODULE: auto

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module github.com/gruntwork-io/terratest
22

33
go 1.23.0
44

5-
toolchain go1.24.1
5+
toolchain go1.24.2
66

77
require (
88
cloud.google.com/go v0.116.0 // indirect

‎modules/terragrunt/cmd.go‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
package terragrunt
2+
3+
import (
4+
"fmt"
5+
"regexp"
6+
"strings"
7+
8+
"github.com/gruntwork-io/terratest/modules/retry"
9+
"github.com/gruntwork-io/terratest/modules/shell"
10+
"github.com/gruntwork-io/terratest/modules/terraform"
11+
"github.com/gruntwork-io/terratest/modules/testing"
12+
)
13+
14+
func runTerragruntStackCommandE(t testing.TestingT, opts *Options, additionalArgs ...string) (string, error) {
15+
args := []string{"stack", "run"}
16+
{
17+
// check if we are using older version of terragrunt
18+
cmd := shell.Command{Command: opts.TerraformBinary, Args: []string{"-experiment", "stack"}}
19+
if err := shell.RunCommandE(t, cmd); err == nil {
20+
args = prepend(args, "-experiment", "stack")
21+
}
22+
}
23+
24+
options, args := terraform.GetCommonOptions(&opts.Options, args...)
25+
args = append(args, prepend(additionalArgs, "--")...)
26+
27+
cmd := generateCommand(options, args...)
28+
description := fmt.Sprintf("%s %v", options.TerraformBinary, args)
29+
30+
return retry.DoWithRetryableErrorsE(t, description, options.RetryableTerraformErrors, options.MaxRetries, options.TimeBetweenRetries, func() (string, error) {
31+
s, err := shell.RunCommandAndGetOutputE(t, cmd)
32+
if err != nil {
33+
return s, err
34+
}
35+
if err := hasWarning(opts, s); err != nil {
36+
return s, err
37+
}
38+
return s, err
39+
})
40+
}
41+
42+
func prepend(args []string, arg ...string) []string {
43+
return append(arg, args...)
44+
}
45+
46+
func hasWarning(opts *Options, out string) error {
47+
for k, v := range opts.WarningsAsErrors {
48+
str := fmt.Sprintf("\nWarning: %s[^\n]*\n", k)
49+
re, err := regexp.Compile(str)
50+
if err != nil {
51+
return fmt.Errorf("cannot compile regex for warning detection: %w", err)
52+
}
53+
m := re.FindAllString(out, -1)
54+
if len(m) == 0 {
55+
continue
56+
}
57+
return fmt.Errorf("warning(s) were found: %s:\n%s", v, strings.Join(m, ""))
58+
}
59+
return nil
60+
}
61+
62+
func generateCommand(options *terraform.Options, args ...string) shell.Command {
63+
cmd := shell.Command{
64+
Command: options.TerraformBinary,
65+
Args: args,
66+
WorkingDir: options.TerraformDir,
67+
Env: options.EnvVars,
68+
Logger: options.Logger,
69+
}
70+
return cmd
71+
}

‎modules/terragrunt/init.go‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
package terragrunt
2+
3+
import (
4+
"fmt"
5+
6+
"github.com/gruntwork-io/terratest/modules/terraform"
7+
"github.com/gruntwork-io/terratest/modules/testing"
8+
)
9+
10+
type Options struct {
11+
terraform.Options
12+
}
13+
14+
// TgStackInit calls terragrunt init and return stdout/stderr
15+
func TgStackInit(t testing.TestingT, options *Options) string {
16+
out, err := TgStackInitE(t, options)
17+
if err != nil {
18+
t.Fatal(err)
19+
}
20+
return out
21+
}
22+
23+
// TgStackInitE calls terragrunt init and return stdout/stderr
24+
func TgStackInitE(t testing.TestingT, options *Options) (string, error) {
25+
if options.TerraformBinary != "terragrunt" {
26+
return "", terraform.TgInvalidBinary(options.TerraformBinary)
27+
}
28+
return runTerragruntStackCommandE(t, options, initArgs(options)...)
29+
}
30+
31+
func initArgs(options *Options) []string {
32+
args := []string{"init", fmt.Sprintf("-upgrade=%t", options.Upgrade)}
33+
34+
// Append reconfigure option if specified
35+
if options.Reconfigure {
36+
args = append(args, "-reconfigure")
37+
}
38+
// Append combination of migrate-state and force-copy to suppress answer prompt
39+
if options.MigrateState {
40+
args = append(args, "-migrate-state", "-force-copy")
41+
}
42+
// Append no-color option if needed
43+
if options.NoColor {
44+
args = append(args, "-no-color")
45+
}
46+
47+
args = append(args, terraform.FormatTerraformBackendConfigAsArgs(options.BackendConfig)...)
48+
args = append(args, terraform.FormatTerraformPluginDirAsArgs(options.PluginDir)...)
49+
args = append(args, options.ExtraArgs.Init...)
50+
return args
51+
}

‎modules/terragrunt/init_test.go‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
package terragrunt
2+
3+
import (
4+
"path"
5+
"testing"
6+
7+
"github.com/gruntwork-io/terratest/modules/files"
8+
"github.com/gruntwork-io/terratest/modules/terraform"
9+
"github.com/stretchr/testify/require"
10+
)
11+
12+
func TestTerragruntStackInit(t *testing.T) {
13+
t.Parallel()
14+
15+
testFolder, err := files.CopyTerraformFolderToTemp("../../test/fixtures/terragrunt/terragrunt-stack-init", t.Name())
16+
require.NoError(t, err)
17+
18+
out, err := TgStackInitE(t, &Options{
19+
Options: terraform.Options{
20+
TerraformDir: path.Join(testFolder, "live"),
21+
TerraformBinary: "terragrunt",
22+
},
23+
})
24+
require.NoError(t, err)
25+
require.Contains(t, out, ".terragrunt-stack")
26+
require.Contains(t, out, "has been successfully initialized!")
27+
}

‎test/fixtures/terragrunt/terragrunt-stack-init/live/terragrunt.stack.hcl‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
unit "mother" {
2+
source = "../units/chicken"
3+
path = "mother"
4+
}
5+
6+
unit "father" {
7+
source = "../units/chicken"
8+
path = "father"
9+
}
10+
11+
unit "chick_1" {
12+
source = "../units/chick"
13+
path = "chicks/chick-1"
14+
}
15+
16+
unit "chick_2" {
17+
source = "../units/chick"
18+
path = "chicks/chick-2"
19+
}
20+

‎test/fixtures/terragrunt/terragrunt-stack-init/units/chick/main.tf‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
resource "local_file" "file" {
3+
content = "chick"
4+
filename = "${path.module}/test.txt"
5+
}
6+
7+
output "output" {
8+
value = local_file.file.filename
9+
}

‎test/fixtures/terragrunt/terragrunt-stack-init/units/chick/terragrunt.hcl‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
terraform {
3+
source = "."
4+
}

‎test/fixtures/terragrunt/terragrunt-stack-init/units/chicken/main.tf‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
resource "local_file" "file" {
3+
content = "chicken"
4+
filename = "${path.module}/test.txt"
5+
}
6+
7+
output "output" {
8+
value = local_file.file.filename
9+
}

‎test/fixtures/terragrunt/terragrunt-stack-init/units/chicken/terragrunt.hcl‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
terraform {
3+
source = "."
4+
}

0 commit comments

Comments
 (0)
0