Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DictTransformer - do not wrap type literals into ${ and } #186

Merged
merged 1 commit into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions hcl2/transformer.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ class DictTransformer(Transformer):

with_meta: bool

@staticmethod
def is_type_keyword(value: str) -> bool:
return value in {"bool", "number", "string"}

def __init__(self, with_meta: bool = False):
"""
:param with_meta: If set to true then adds `__start_line__` and `__end_line__`
Expand Down Expand Up @@ -301,6 +305,10 @@ def to_string_dollar(self, value: Any) -> Any:
if value.startswith('"') and value.endswith('"'):
value = str(value)[1:-1]
return self.process_escape_sequences(value)

if self.is_type_keyword(value):
return value

return f"${{{value}}}"
return value

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@
{
"some_var2": {
"description": "description",
"type": "${string}",
"type": "string",
"default": "${cidrsubnets(\"10.0.0.0/24\", 2, 2)}"
}
},
{
"some_var2": {
"some_var3": {
"description": "description",
"default": "${concat([{\"1\": \"1\"}], [{\"2\": \"2\"}])}"
}
Expand Down
4 changes: 2 additions & 2 deletions test/helpers/terraform-config-json/variables.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@
},
{
"options": {
"type": "${string}",
"type": "string",
"default": {}
}
},
{
"var_with_validation": {
"type": "${list(object({\"id\": \"${string}\", \"nested\": \"${list(object({\"id\": \"${string}\", \"type\": \"${string}\"}))}\"}))}",
"type": "${list(object({\"id\": \"string\", \"nested\": \"${list(object({\"id\": \"string\", \"type\": \"string\"}))}\"}))}",
"validation": [
{
"condition": "${!contains([for v in flatten(var.var_with_validation[*].id) : can(regex(\"^(A|B)$\", v))], false)}",
Expand Down
2 changes: 1 addition & 1 deletion test/helpers/terraform-config/multiline_expressions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ variable "some_var2" {
)
}

variable "some_var2" {
variable "some_var3" {
description = "description"
default = concat(
# comment 1
Expand Down
32 changes: 32 additions & 0 deletions test/unit/test_dict_transformer.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# pylint:disable=C0114,C0116,C0103,W0612

from unittest import TestCase

from hcl2.transformer import DictTransformer


class TestDictTransformer(TestCase):
"""Test behaviour of hcl2.transformer.DictTransformer class"""

@staticmethod
def build_dict_transformer(with_meta: bool = False) -> DictTransformer:
return DictTransformer(with_meta)

def test_to_string_dollar(self):
string_values = {
'"bool"': "bool",
'"number"': "number",
'"string"': "string",
"${value_1}": "${value_1}",
'"value_2': '${"value_2}',
'value_3"': '${value_3"}',
'"value_4"': "value_4",
"value_5": "${value_5}",
}

dict_transformer = self.build_dict_transformer()

for value, expected in string_values.items():
actual = dict_transformer.to_string_dollar(value)

self.assertEqual(actual, expected)
Loading