fix: better label block validation

src/rougail/output_hcl/export.py

@@ -115,8 +115,12 @@ class RougailOutputHcl(RougailOutputJson):
                     parent_obj[name] = []
                 block_to_insert = parent_obj[name]
             block_to_insert.extend(child_obj)
-        elif parent_is_block:
+        elif parent_is_block and child_obj.get("__is_block__", False):
             parent_obj.append({name: child_obj})
+        elif parent_is_block:
+            if not parent_obj:
+                parent_obj.append({})
+            parent_obj[-1][name] = child_obj
         else:
             parent_obj[name] = child_obj
 
@@ -148,6 +152,15 @@ class RougailOutputHcl(RougailOutputJson):
                 child_obj["__is_block__"] = True
                 quote_name = True
             elif hcl_type == "label_with_label":
+                if self.config == parent or not parent.information.get(
+                    "hcl_type", None
+                ):
+                    msg = _(
+                        'The family "{0}" has a hcl_type parameter to label but is not in a block'
+                    ).format(child.path())
+                    raise DictConsistencyError(
+                        msg, 502, child.information.get("ymlfiles", None)
+                    )
                 quote_name = True
         return quote_name
 

src/rougail/structural_hcl/annotator.py

@@ -19,6 +19,7 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
 
+from .i18n import _
 from rougail.annotator.variable import Walk
 from rougail.error import DictConsistencyError
 
@@ -51,12 +52,18 @@ class Annotator(Walk):
             information_value = None
             if hasattr(child, "hcl_type") and child.hcl_type == "label":
                 if is_label == False:
-                    raise Exception()
+                    msg = _('the family "{0}" is a label but there are others family which are not label in same parent family').format(child.path)
+                    raise DictConsistencyError(
+                        msg, 504, child.xmlfiles
+                    )
                 information_value = "label"
                 is_label = True
                 sub_is_block = True
             elif is_label:
-                raise Exception()
+                msg = _('the family "{0}" is a label but there are others family which are not label in same parent family').format(child.path)
+                raise DictConsistencyError(
+                    msg, 503, child.xmlfiles
+                )
             else:
                 is_label = False
             if self.parse_family(child_path, sub_is_block):

tests/errors/10-label-inside-label.yaml

@@ -0,0 +1,12 @@
+%YAML 1.2
+---
+version: 1.1
+
+a_block:
+  hcl_type: label
+
+  a_label:
+    hcl_type: label
+
+    a_variable: a value
+...

tests/errors/10-label-inside-label.yaml.errno

@@ -0,0 +1 @@
+502

tests/errors/10-mix-block-label.yaml

@@ -0,0 +1,17 @@
+%YAML 1.2
+---
+version: 1.1
+
+a_block:
+  hcl_type: block
+
+  a_block:
+    hcl_type: block
+
+    a_variable: a value
+
+  a_label:
+    hcl_type: label
+
+    a_variable: a value
+...

tests/errors/10-mix-block-label.yaml.errno

@@ -0,0 +1 @@
+504

tests/errors/10-mix-label-block.yaml

@@ -0,0 +1,17 @@
+%YAML 1.2
+---
+version: 1.1
+
+a_block:
+  hcl_type: block
+
+  a_label:
+    hcl_type: label
+
+    a_variable: a value
+
+  a_block:
+    hcl_type: block
+
+    a_variable: a value
+...

tests/errors/10-mix-label-block.yaml.errno

@@ -0,0 +1 @@
+503

tests/results/10-doc_family_inside_a_block.yaml.hcl

@@ -0,0 +1,8 @@
+stack {
+  a_family_1 = {
+    a_variable = "a value"
+  }
+  a_family_2 = {
+    a_variable = "a value"
+  }
+}

tests/structures/10-doc_family_inside_a_block.yaml

@@ -0,0 +1,15 @@
+%YAML 1.2
+---
+version: 1.1
+
+stack:
+  hcl_type: block
+
+  a_family_1:  # a family 1
+
+    a_variable: a value
+
+  a_family_2:  # a family 2
+
+    a_variable: a value
+...

tests/test_error.py

@@ -29,12 +29,12 @@ def _test_structural_files(test_file, ext):
     rougailconfig["main_structural_directories"] = [str(test_file.absolute())]
     ##################################
     rougail = Rougail(rougailconfig)
-    config = rougail.run()
-    config.information.set("description_type", "path_and_description")
-    config.property.read_only()
     with Path(str(test_file.absolute()) + ".errno").open() as fh:
         error_no = int(fh.read().strip())
     with raises(DictConsistencyError) as err:
+        config = rougail.run()
+        config.information.set("description_type", "path_and_description")
+        config.property.read_only()
         generated_output = RougailOutput(config, rougailconfig=rougailconfig).run()[1]
     assert err.value.errno == error_no, f'expected errno: {error_no}, errno: {err.value.errno}, msg: {err}'
 

tests/test_subconfig.py

@@ -5,7 +5,6 @@ from rougail.output_hcl import RougailOutputHcl as RougailOutput
 from rougail.error import DictConsistencyError
 
 
-
 def _test_subconfig(error):
     rougailconfig = RougailConfig.copy()
     ##################################

tests/test_types.py

@@ -0,0 +1,37 @@
+from pytest import raises
+from pathlib import Path
+from rougail import Rougail, RougailConfig
+from rougail.output_hcl import RougailOutputHcl as RougailOutput
+from rougail.error import DictConsistencyError
+
+
+def _test_types(name):
+    rougailconfig = RougailConfig.copy()
+    ##################################
+    rougailconfig['step.output'] = 'hcl'
+    rougailconfig["main_namespace"] = None
+    rougailconfig["types"] = [str((Path(__file__).parent / 'types' / name / 'types').absolute())]
+    rougailconfig["main_structural_directories"] = [str((Path(__file__).parent / 'types' / name / 'structures').absolute())]
+    ##################################
+    rougail = Rougail(rougailconfig)
+    config = rougail.run()
+    config.information.set("description_type", "path_and_description")
+    config.property.read_only()
+    generated_output = RougailOutput(config, rougailconfig=rougailconfig).run()[1]
+    output_file = Path(__file__).parent / 'types' / name / 'rougail.hcl'
+    if not output_file.is_file():
+        if not output_file.parent.is_dir():
+            output_file.parent.mkdir()
+        with output_file.open('w') as outfh:
+            outfh.write(generated_output)
+    with output_file.open() as outfh:
+         attented_output = outfh.read()
+    assert generated_output == attented_output, f'filename {output_file}'
+
+
+def test_types_01():
+    _test_types('01-types')
+
+
+def test_types_02():
+    _test_types('02-double')

tests/types/01-types/rougail.hcl

@@ -0,0 +1,8 @@
+a_new_block_1 "a_label" {
+  an_attribute = "a value"
+}
+
+
+a_new_block_2 "a_label" {
+  an_attribute = "a value"
+}

tests/types/01-types/structures/00-main.yml

@@ -0,0 +1,13 @@
+%YAML 1.2
+---
+version: 1.1
+
+a_new_block_1:
+  type: a_block
+
+a_new_block_2:
+  hcl_type: block
+
+  a_label:
+    type: a_label
+...

tests/types/01-types/types/00-main.yml

@@ -0,0 +1,20 @@
+%YAML 1.2
+---
+version: 1.1
+
+a_block:
+  description: A block is a family with hcl_type attribute
+  hcl_type: block
+
+  a_label:
+    description: A label is also a family with hcl_type attribute
+    hcl_type: label
+
+    an_attribute: a value  # An attribute in a block
+
+a_label:
+  description: A label is also a family with hcl_type attribute
+  hcl_type: label
+
+  an_attribute: a value  # An attribute in a block
+...

tests/types/02-double/rougail.hcl

@@ -0,0 +1,8 @@
+a_new_block_1 "a_label" {
+  an_attribute = "a value new"
+}
+
+
+a_new_block_2 "a_label" {
+  an_attribute = "a value new"
+}

tests/types/02-double/structures/00-main.yml

@@ -0,0 +1,13 @@
+%YAML 1.2
+---
+version: 1.1
+
+a_new_block_1:
+  type: a_block
+
+a_new_block_2:
+  hcl_type: block
+
+  a_label:
+    type: a_label
+...

tests/types/02-double/types/00-main.yml

@@ -0,0 +1,20 @@
+%YAML 1.2
+---
+version: 1.1
+
+a_block_ori:
+  description: A block is a family with hcl_type attribute
+  hcl_type: block
+
+  a_label:
+    description: A label is also a family with hcl_type attribute
+    hcl_type: label
+
+    an_attribute: a value  # An attribute in a block
+
+a_label_ori:
+  description: A label is also a family with hcl_type attribute
+  hcl_type: label
+
+  an_attribute: a value  # An attribute in a block
+...

tests/types/02-double/types/10-main.yml

@@ -0,0 +1,16 @@
+%YAML 1.2
+---
+version: 1.1
+
+a_block:
+  type: a_block_ori
+  
+  a_label:
+
+    an_attribute: a value new
+
+a_label:
+  type: a_label_ori
+
+  an_attribute: a value new
+...