feature: add RefList type for correct pluralisation when referencing …

…lists in variables

llamazure/tf/changelog.md

@@ -1,7 +1,14 @@
 # 0
 
+## 0.1
+
+### 0.1.0
+
+- fix : fix for TF considering NSG rules as subresources
+- feature : add RefList type for correct pluralisation when referencing variables that are lists
+
 ## 0.0
 
 ### 0.0.1
 
-- feature: easily generate nsg rules
+- feature : easily generate nsg rules

llamazure/tf/models.py

@@ -3,6 +3,7 @@
 from abc import ABC, abstractmethod
 from collections import defaultdict
 from dataclasses import dataclass
+from typing import Union
 
 
 class TFResource(ABC):
@@ -51,9 +52,22 @@ def register(resource: TFResource):
 		}
 
 
-def _pluralise(k: str, v: list[str], pluralise: str = "s") -> dict[str, str | list[str]]:
+@dataclass(frozen=True)
+class RefList:
+	"""A reference to a var containing a list"""
+
+	var: str
+
+
+TFList = Union[list[str], RefList]
+
+
+def _pluralise(k: str, v: TFList, pluralise: str = "s") -> dict[str, str | list[str]]:
 	"""Format the k-v pair, pluralising the k if necessary"""
-	if len(v) == 1:
-		return {k: v[0]}
+	if isinstance(v, RefList):
+		return {k + pluralise: [v.var]}
 	else:
-		return {k + pluralise: v}
+		if len(v) == 1:
+			return {k: v[0]}
+		else:
+			return {k + pluralise: v}

llamazure/tf/models_test.py

@@ -1,4 +1,4 @@
-from llamazure.tf.models import _pluralise
+from llamazure.tf.models import RefList, _pluralise
 
 
 class TestPluralise:
@@ -31,3 +31,8 @@ def test_multiple_elements_with_es_suffix(self):
 		result = _pluralise("box", ["box", "fox"], pluralise="es")
 		expected = {"boxes": ["box", "fox"]}
 		assert result == expected
+
+	def test_reflist(self):
+		result = _pluralise("apple", RefList("ref"))
+		expected = {"apples": ["ref"]}
+		assert result == expected

llamazure/tf/network.py

@@ -5,7 +5,7 @@
 from enum import Enum
 from typing import Generic, TypeVar
 
-from llamazure.tf.models import AnyTFResource, TFResource, _pluralise
+from llamazure.tf.models import AnyTFResource, TFList, TFResource, _pluralise
 
 T = TypeVar("T")
 
@@ -70,12 +70,12 @@ class NSGRule:
 	direction: Direction
 
 	protocol: str = "Tcp"
-	src_ports: list[str] = field(default_factory=lambda: ["*"])
-	src_addrs: list[str] = field(default_factory=lambda: ["*"])
-	src_sgids: list[str] = field(default_factory=lambda: [])
-	dst_ports: list[str] = field(default_factory=lambda: ["*"])
-	dst_addrs: list[str] = field(default_factory=lambda: ["*"])
-	dst_sgids: list[str] = field(default_factory=lambda: [])
+	src_ports: TFList = field(default_factory=lambda: ["*"])
+	src_addrs: TFList = field(default_factory=lambda: ["*"])
+	src_sgids: TFList = field(default_factory=lambda: [])
+	dst_ports: TFList = field(default_factory=lambda: ["*"])
+	dst_addrs: TFList = field(default_factory=lambda: ["*"])
+	dst_sgids: TFList = field(default_factory=lambda: [])
 
 	description: str = ""