opentofu/internal/addrs/module_instance_test.go

// Copyright (c) The OpenTofu Authors
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) 2023 HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package addrs

import (
	"fmt"
	"testing"
)

func TestModuleInstanceEqual_true(t *testing.T) {
	addrs := []string{
		"module.foo",
		"module.foo.module.bar",
		"module.foo[1].module.bar",
		`module.foo["a"].module.bar["b"]`,
		`module.foo["a"].module.bar.module.baz[3]`,
	}
	for _, m := range addrs {
		t.Run(m, func(t *testing.T) {
			addr, diags := ParseModuleInstanceStr(m)
			if len(diags) > 0 {
				t.Fatalf("unexpected diags: %s", diags.Err())
			}
			if !addr.Equal(addr) {
				t.Fatalf("expected %#v to be equal to itself", addr)
			}
		})
	}
}

func TestModuleInstanceEqual_false(t *testing.T) {
	testCases := []struct {
		left  string
		right string
	}{
		{
			"module.foo",
			"module.bar",
		},
		{
			"module.foo",
			"module.foo.module.bar",
		},
		{
			"module.foo[1]",
			"module.bar[1]",
		},
		{
			`module.foo[1]`,
			`module.foo["1"]`,
		},
		{
			"module.foo.module.bar",
			"module.foo[1].module.bar",
		},
		{
			`module.foo.module.bar`,
			`module.foo["a"].module.bar`,
		},
	}
	for _, tc := range testCases {
		t.Run(fmt.Sprintf("%s = %s", tc.left, tc.right), func(t *testing.T) {
			left, diags := ParseModuleInstanceStr(tc.left)
			if len(diags) > 0 {
				t.Fatalf("unexpected diags parsing %s: %s", tc.left, diags.Err())
			}
			right, diags := ParseModuleInstanceStr(tc.right)
			if len(diags) > 0 {
				t.Fatalf("unexpected diags parsing %s: %s", tc.right, diags.Err())
			}

			if left.Equal(right) {
				t.Fatalf("expected %#v not to be equal to %#v", left, right)
			}

			if right.Equal(left) {
				t.Fatalf("expected %#v not to be equal to %#v", right, left)
			}
		})
	}
}

func TestHasSameModule(t *testing.T) {
	tests := []struct {
		a string
		b string

		wantSame bool
	}{
		{
			"module.foo",
			"module.bar",
			false,
		},
		{
			"module.foo",
			"module.foo.module.bar",
			false,
		},
		{
			"module.foo[1]",
			"module.bar[1]",
			false,
		},
		{
			`module.foo[1]`,
			`module.foo["1"]`,
			true,
		},
		{
			"module.foo.module.bar",
			"module.foo[1].module.bar",
			true,
		},
		{
			`module.foo.module.bar`,
			`module.foo["a"].module.bar`,
			true,
		},
	}
	for _, test := range tests {
		t.Run(fmt.Sprintf("%#v.HasSameModule(%#v)", test.a, test.b), func(t *testing.T) {
			a, diags := ParseModuleInstanceStr(test.a)
			if len(diags) > 0 {
				t.Fatalf("invalid module instance address %s: %s", test.a, diags.Err())
			}
			b, diags := ParseModuleInstanceStr(test.b)
			if len(diags) > 0 {
				t.Fatalf("invalid module instance address %s: %s", test.b, diags.Err())
			}

			// "HasSameModule" is commutative, so we'll test it both ways at once
			gotAB := a.HasSameModule(b)
			gotBA := b.HasSameModule(a)

			if gotAB != test.wantSame {
				t.Errorf("wrong result\n1st: %s\n2nd: %s\ngot:  %t\nwant: %t", a, b, gotAB, test.wantSame)
			}
			if gotBA != test.wantSame {
				t.Errorf("wrong result\n1st: %s\n2nd: %s\ngot:  %t\nwant: %t", b, a, gotBA, test.wantSame)
			}
		})
	}
}

func TestIsForModule(t *testing.T) {
	tests := []struct {
		inst string
		mod  string

		want bool
	}{
		{
			"module.foo",
			"module.bar",
			false,
		},
		{
			"module.foo",
			"module.foo.module.bar",
			false,
		},
		{
			"module.foo[1]",
			"module.bar",
			false,
		},
		{
			`module.foo[1]`,
			`module.foo`,
			true,
		},
		{
			"module.foo[1].module.bar",
			"module.foo.module.bar",
			true,
		},
		{
			`module.foo["a"].module.bar`,
			`module.foo.module.bar`,
			true,
		},
	}
	for _, test := range tests {
		t.Run(fmt.Sprintf("%#v.IsForModule(%#v)", test.inst, test.mod), func(t *testing.T) {
			inst, diags := ParseModuleInstanceStr(test.inst)
			if len(diags) > 0 {
				t.Fatalf("invalid module instance address %s: %s", test.inst, diags.Err())
			}
			mod, diags := ParseModuleStr(test.mod)
			if len(diags) > 0 {
				t.Fatalf("invalid module address %s: %s", test.mod, diags.Err())
			}

			got := inst.IsForModule(mod)
			if got != test.want {
				t.Errorf("wrong result\ninstance: %s\nmodule:   %s\ngot:  %t\nwant: %t", inst, mod, got, test.want)
			}
		})
	}
}

func BenchmarkStringShort(b *testing.B) {
	addr, _ := ParseModuleInstanceStr(`module.foo`)
	for n := 0; n < b.N; n++ {
		addr.String()
	}
}

func BenchmarkStringLong(b *testing.B) {
	addr, _ := ParseModuleInstanceStr(`module.southamerica-brazil-region.module.user-regional-desktops.module.user-name`)
	for n := 0; n < b.N; n++ {
		addr.String()
	}
}

func TestModuleInstance_IsDeclaredByCall(t *testing.T) {
	tests := []struct {
		instance ModuleInstance
		call     AbsModuleCall
		want     bool
	}{
		{
			ModuleInstance{},
			AbsModuleCall{},
			false,
		},
		{
			mustParseModuleInstanceStr("module.child"),
			AbsModuleCall{},
			false,
		},
		{
			ModuleInstance{},
			AbsModuleCall{
				RootModuleInstance,
				ModuleCall{Name: "child"},
			},
			false,
		},
		{
			mustParseModuleInstanceStr("module.child"),
			AbsModuleCall{ // module.child
				RootModuleInstance,
				ModuleCall{Name: "child"},
			},
			true,
		},
		{
			mustParseModuleInstanceStr(`module.child`),
			AbsModuleCall{ // module.kinder.module.child
				mustParseModuleInstanceStr("module.kinder"),
				ModuleCall{Name: "child"},
			},
			false,
		},
		{
			mustParseModuleInstanceStr("module.kinder"),
			// module.kinder.module.child contains module.kinder, but is not itself an instance of module.kinder
			AbsModuleCall{
				mustParseModuleInstanceStr("module.kinder"),
				ModuleCall{Name: "child"},
			},
			false,
		},
		{
			mustParseModuleInstanceStr("module.child"),
			AbsModuleCall{
				mustParseModuleInstanceStr(`module.kinder["a"]`),
				ModuleCall{Name: "kinder"},
			},
			false,
		},
	}

	for _, test := range tests {
		t.Run(fmt.Sprintf("%q.IsCallInstance(%q)", test.instance, test.call.String()), func(t *testing.T) {
			got := test.instance.IsDeclaredByCall(test.call)
			if got != test.want {
				t.Fatal("wrong result")
			}
		})
	}
}

func mustParseModuleInstanceStr(str string) ModuleInstance {
	mi, diags := ParseModuleInstanceStr(str)
	if diags.HasErrors() {
		panic(diags.ErrWithWarnings())
	}
	return mi
}