Skip to content

Commit 1425a47

Browse files
reluscrelusc
committed
Adjust unit tests
1 parent ae54964 commit 1425a47

File tree

5 files changed

+269
-4
lines changed

5 files changed

+269
-4
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
.terraform
33
terraform.tfstate
44
terraform.tfvars
5+
terraform.tfvars.json
56
*.tfstate*
67
.terragrunt
78
.terragrunt-cache

‎modules/files/files.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,10 @@ func CopyFolderContentsWithFilter(source string, destination string, filter func
150150
return nil
151151
}
152152

153-
// PathContainsTerraformStateOrVars returns true if the path corresponds to a Terraform state file or .tfvars file.
153+
// PathContainsTerraformStateOrVars returns true if the path corresponds to a Terraform state file or .tfvars/.tfvars.json file.
154154
func PathContainsTerraformStateOrVars(path string) bool {
155155
filename := filepath.Base(path)
156-
return filename == "terraform.tfstate" || filename == "terraform.tfstate.backup" || filename == "terraform.tfvars"
156+
return filename == "terraform.tfstate" || filename == "terraform.tfstate.backup" || filename == "terraform.tfvars" || filename == "terraform.tfvars.json"
157157
}
158158

159159
// PathContainsTerraformState returns true if the path corresponds to a Terraform state file.

‎modules/files/files_test.go

+28
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,34 @@ func TestCopyTerragruntFolderToTemp(t *testing.T) {
173173
requireDirectoriesEqual(t, expectedDir, tmpDir)
174174
}
175175

176+
func TestPathContainsTerraformStateOrVars(t *testing.T) {
177+
var data = []struct {
178+
desc string
179+
path string
180+
contains bool
181+
}{
182+
{"contains tfvars", "./folder/terraform.tfvars", true},
183+
{"contains tfvars.json", "./folder/hello/terraform.tfvars.json", true},
184+
{"contains state", "./folder/hello/helloagain/terraform.tfstate", true},
185+
{"contains state backup", "./folder/pewpew/terraform.tfstate.backup", true},
186+
{"does not contain any", "./folder/pewpew/terraform.json", false},
187+
}
188+
189+
for _, tt := range data {
190+
tt := tt
191+
t.Run(tt.desc, func(t *testing.T) {
192+
result := PathContainsTerraformStateOrVars(tt.path)
193+
if result != tt.contains {
194+
if tt.contains {
195+
t.Errorf("Expected %s to contain Terraform related file", tt.path)
196+
} else {
197+
t.Errorf("Expected %s to not contain Terraform related file", tt.path)
198+
}
199+
}
200+
})
201+
}
202+
}
203+
176204
// Diffing two directories to ensure they have the exact same files, contents, etc and showing exactly what's different
177205
// takes a lot of code. Why waste time on that when this functionality is already nicely implemented in the Unix/Linux
178206
// "diff" command? We shell out to that command at test time.

‎modules/terraform/format.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ func FormatTerraformPluginDirAsArgs(pluginDir string) []string {
119119
return pluginArgs
120120
}
121121

122-
// FormatTerraformArgs will format multiple args with the arg name (e.g. "-var-file", []string{"foo.tfvars", "bar.tfvars"})
123-
// returns "-var-file foo.tfvars -var-file bar.tfvars"
122+
// FormatTerraformArgs will format multiple args with the arg name (e.g. "-var-file", []string{"foo.tfvars", "bar.tfvars", "baz.tfvars.json"})
123+
// returns "-var-file foo.tfvars -var-file bar.tfvars -var-file baz.tfvars.json"
124124
func FormatTerraformArgs(argName string, args []string) []string {
125125
argsList := []string{}
126126
for _, argValue := range args {

‎modules/terraform/var-file_test.go

+236
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,243 @@ func TestGetAllVariablesFromVarFileStructOut(t *testing.T) {
228228
err := GetAllVariablesFromVarFileE(t, randomFileName, &region)
229229
require.NoError(t, err)
230230
require.Equal(t, "us-east-2", region.AwsRegion)
231+
}
232+
233+
func TestGetVariablesFromVarFilesAsStringJSON(t *testing.T) {
234+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
235+
236+
testJSON := []byte(`
237+
{
238+
"aws_region": "us-east-2",
239+
"aws_account_id": "111111111111",
240+
"number_type": 2,
241+
"boolean_type": true,
242+
"tags": {
243+
"foo": "bar"
244+
},
245+
"list": ["item1"]
246+
}`)
247+
248+
WriteFile(t, randomFileName, testJSON)
249+
defer os.Remove(randomFileName)
250+
251+
stringVal := GetVariableAsStringFromVarFile(t, randomFileName, "aws_region")
252+
253+
boolString := GetVariableAsStringFromVarFile(t, randomFileName, "boolean_type")
254+
255+
numString := GetVariableAsStringFromVarFile(t, randomFileName, "number_type")
256+
257+
require.Equal(t, "us-east-2", stringVal)
258+
require.Equal(t, "true", boolString)
259+
require.Equal(t, "2", numString)
260+
261+
}
262+
263+
func TestGetVariablesFromVarFilesAsStringKeyDoesNotExistJSON(t *testing.T) {
264+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
265+
266+
testJSON := []byte(`
267+
{
268+
"aws_region": "us-east-2",
269+
"aws_account_id": "111111111111",
270+
"tags": {
271+
"foo": "bar"
272+
},
273+
"list": ["item1"]
274+
}`)
275+
276+
WriteFile(t, randomFileName, testJSON)
277+
defer os.Remove(randomFileName)
278+
279+
_, err := GetVariableAsStringFromVarFileE(t, randomFileName, "badkey")
280+
281+
require.Error(t, err)
282+
}
283+
284+
func TestGetVariableAsMapFromVarFileJSON(t *testing.T) {
285+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
286+
expected := make(map[string]string)
287+
expected["foo"] = "bar"
288+
289+
testJSON := []byte(`
290+
{
291+
"aws_region": "us-east-2",
292+
"aws_account_id": "111111111111",
293+
"tags": {
294+
"foo": "bar"
295+
},
296+
"list": ["item1"]
297+
}`)
298+
299+
WriteFile(t, randomFileName, testJSON)
300+
defer os.Remove(randomFileName)
301+
302+
val := GetVariableAsMapFromVarFile(t, randomFileName, "tags")
303+
require.Equal(t, expected, val)
304+
}
305+
306+
func TestGetVariableAsMapFromVarFileNotMapJSON(t *testing.T) {
307+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
308+
309+
testJSON := []byte(`
310+
{
311+
"aws_region": "us-east-2",
312+
"aws_account_id": "111111111111",
313+
"tags": {
314+
"foo": "bar"
315+
},
316+
"list": ["item1"]
317+
}`)
318+
319+
WriteFile(t, randomFileName, testJSON)
320+
defer os.Remove(randomFileName)
321+
322+
_, err := GetVariableAsMapFromVarFileE(t, randomFileName, "aws_region")
323+
324+
require.Error(t, err)
325+
}
326+
327+
func TestGetVariableAsMapFromVarFileKeyDoesNotExistJSON(t *testing.T) {
328+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
329+
330+
testJSON := []byte(`
331+
{
332+
"aws_region": "us-east-2",
333+
"aws_account_id": "111111111111",
334+
"tags": {
335+
"foo": "bar"
336+
},
337+
"list": ["item1"]
338+
}`)
339+
340+
WriteFile(t, randomFileName, testJSON)
341+
defer os.Remove(randomFileName)
342+
343+
_, err := GetVariableAsMapFromVarFileE(t, randomFileName, "badkey")
344+
345+
require.Error(t, err)
346+
}
347+
348+
func TestGetVariableAsListFromVarFileJSON(t *testing.T) {
349+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
350+
expected := []string{"item1"}
351+
352+
testJSON := []byte(`
353+
{
354+
"aws_region": "us-east-2",
355+
"aws_account_id": "111111111111",
356+
"tags": {
357+
"foo": "bar"
358+
},
359+
"list": ["item1"]
360+
}`)
361+
362+
WriteFile(t, randomFileName, testJSON)
363+
defer os.Remove(randomFileName)
364+
365+
val := GetVariableAsListFromVarFile(t, randomFileName, "list")
231366

367+
require.Equal(t, expected, val)
368+
}
369+
370+
func TestGetVariableAsListNotListJSON(t *testing.T) {
371+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
372+
373+
testJSON := []byte(`
374+
{
375+
"aws_region": "us-east-2",
376+
"aws_account_id": "111111111111",
377+
"tags": {
378+
"foo": "bar"
379+
},
380+
"list": ["item1"]
381+
}`)
382+
383+
WriteFile(t, randomFileName, testJSON)
384+
defer os.Remove(randomFileName)
385+
386+
_, err := GetVariableAsListFromVarFileE(t, randomFileName, "tags")
387+
388+
require.Error(t, err)
389+
}
390+
391+
func TestGetVariableAsListKeyDoesNotExistJSON(t *testing.T) {
392+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
393+
394+
testJSON := []byte(`
395+
{
396+
"aws_region": "us-east-2",
397+
"aws_account_id": "111111111111",
398+
"tags": {
399+
"foo": "bar"
400+
},
401+
"list": ["item1"]
402+
}`)
403+
404+
WriteFile(t, randomFileName, testJSON)
405+
defer os.Remove(randomFileName)
406+
407+
_, err := GetVariableAsListFromVarFileE(t, randomFileName, "badkey")
408+
409+
require.Error(t, err)
410+
}
411+
412+
func TestGetAllVariablesFromVarFileBadFileJSON(t *testing.T) {
413+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
414+
testJSON := []byte(`
415+
{
416+
thiswillnotwork
417+
}`)
418+
419+
WriteFile(t, randomFileName, testJSON)
420+
defer os.Remove(randomFileName)
421+
422+
var variables map[string]interface{}
423+
err := GetAllVariablesFromVarFileE(t, randomFileName, &variables)
424+
require.Error(t, err)
425+
426+
// HCL library could change their error string, so we are only testing the error string contains what we add to it
427+
require.Regexp(t, fmt.Sprintf("^%s:3,7-22: ", randomFileName), err.Error())
428+
}
429+
430+
func TestGetAllVariablesFromVarFileJSON(t *testing.T) {
431+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
432+
testJSON := []byte(`
433+
{
434+
"aws_region": "us-east-2"
435+
}
436+
`)
437+
438+
WriteFile(t, randomFileName, testJSON)
439+
defer os.Remove(randomFileName)
440+
441+
var variables map[string]interface{}
442+
err := GetAllVariablesFromVarFileE(t, randomFileName, &variables)
443+
require.NoError(t, err)
444+
445+
expected := make(map[string]interface{})
446+
expected["aws_region"] = "us-east-2"
447+
448+
require.Equal(t, expected, variables)
449+
}
450+
451+
func TestGetAllVariablesFromVarFileStructOutJSON(t *testing.T) {
452+
randomFileName := fmt.Sprintf("./%s.tfvars.json", random.UniqueId())
453+
testJSON := []byte(`
454+
{
455+
"aws_region": "us-east-2"
456+
}
457+
`)
458+
459+
WriteFile(t, randomFileName, testJSON)
460+
defer os.Remove(randomFileName)
461+
462+
var region struct {
463+
AwsRegion string `cty:"aws_region"`
464+
}
465+
err := GetAllVariablesFromVarFileE(t, randomFileName, &region)
466+
require.NoError(t, err)
467+
require.Equal(t, "us-east-2", region.AwsRegion)
232468
}
233469

234470
// Helper function to write a file to the filesystem

0 commit comments

Comments
 (0)