python-hcl2/test/unit/test_builder.py at db97a0c7de53a207b7e7cc2102a5301543a92b53 · amplify-education/python-hcl2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# pylint:disable=C0116

"""Test building an HCL file from scratch"""

from pathlib import Path
from unittest import TestCase

import hcl2
import hcl2.builder


HELPERS_DIR = Path(__file__).absolute().parent.parent / "helpers"
HCL2_DIR = HELPERS_DIR / "terraform-config"
JSON_DIR = HELPERS_DIR / "terraform-config-json"
HCL2_FILES = [str(file.relative_to(HCL2_DIR)) for file in HCL2_DIR.iterdir()]


class TestBuilder(TestCase):
    """Test building a variety of hcl files"""

    # print any differences fully to the console
    maxDiff = None

    def test_build_blocks_tf(self):
        builder = hcl2.Builder()

        builder.block("block", a=1)
        builder.block("block", ["label"], b=2)

        self.compare_filenames(builder, "blocks.tf")

    def test_build_escapes_tf(self):
        builder = hcl2.Builder()

        builder.block("block", ["block_with_newlines"], a="line1\nline2")

        self.compare_filenames(builder, "escapes.tf")

    def test_locals_embdedded_condition_tf(self):
        builder = hcl2.Builder()

        builder.block(
            "locals",
            terraform={
                "channels": "${(local.running_in_ci ? local.ci_channels : local.local_channels)}",
                "authentication": [],
                "foo": None,
            },
        )

        self.compare_filenames(builder, "locals_embedded_condition.tf")

    def test_locals_embedded_function_tf(self):
        builder = hcl2.Builder()

        function_test = (
            "${var.basename}-${var.forwarder_function_name}_"
            '${md5("${var.vpc_id}${data.aws_region.current.name}")}'
        )
        builder.block("locals", function_test=function_test)

        self.compare_filenames(builder, "locals_embedded_function.tf")

    def test_locals_embedded_interpolation_tf(self):
        builder = hcl2.Builder()

        attributes = {
            "simple_interpolation": "prefix:${var.foo}-suffix",
            "embedded_interpolation": "(long substring without interpolation); "
            '${module.special_constants.aws_accounts["aaa-${local.foo}-${local.bar}"]}/us-west-2/key_foo',
            "escaped_interpolation": "prefix:$${aws:username}-suffix",
        }

        builder.block("locals", **attributes)

        self.compare_filenames(builder, "string_interpolations.tf")

    def test_provider_function_tf(self):
        builder = hcl2.Builder()

        builder.block(
            "locals",
            name2='${provider::test2::test("a")}',
            name3='${test("a")}',
        )

        self.compare_filenames(builder, "provider_function.tf")

    def compare_filenames(self, builder: hcl2.Builder, filename: str):
        hcl_dict = builder.build()
        hcl_ast = hcl2.reverse_transform(hcl_dict)
        hcl_content_built = hcl2.writes(hcl_ast)

        hcl_path = (HCL2_DIR / filename).absolute()
        with hcl_path.open("r") as hcl_file:
            hcl_file_content = hcl_file.read()
            self.assertMultiLineEqual(
                hcl_content_built,
                hcl_file_content,
                f"file {filename} does not match its programmatically built version.",
            )