Merge ~sylvain-pineau/checkbox-ng:fail_valiadtion_on_missing_nested_parts into checkbox-ng:master

[Sylvain Pineau]

This patch makes manage.py validate failing if one of the nested part is not found. The current behavior is just logging warnings.

[Sylvain Pineau (sylvain-pineau)]

Does not play nicely with the sru provider and the missing pts testplan

Unmerged commits

44188d7... by Sylvain Pineau on 2021-11-19

Change: nested parts not found are now failing validation

test plan ids not found while performing a validation in context are now
causing the ./manage.py validate command to fail.
(instead of just logging warnings).

diff --git a/plainbox/impl/unit/testplan.py b/plainbox/impl/unit/testplan.py
index 96b5c9a..f209ae9 100644
--- a/plainbox/impl/unit/testplan.py
+++ b/plainbox/impl/unit/testplan.py
@@ -129,6 +129,26 @@ class NoBaseIncludeValidator(FieldValidatorBase):
                 raise NotImplementedError
 
 
+class NestedPartReferenceValidator(FieldValidatorBase):
+    """
+    Validator that checks if nested parts identifiers are valid test plans
+
+    """
+
+    def check_in_context(self, parent, unit, field, context):
+        id_map = context.compute_shared(
+            "field_value_map[id]", compute_value_map, context, 'id')
+        value_list, problems = unit.get_nested_part()
+        for unit_id in problems:
+            if unit_id not in id_map:
+                yield parent.error(
+                    unit, field, Problem.bad_reference,
+                    self.message or _(
+                        "test plan {!a} is not available"
+                    ).format(unit_id))
+                continue
+
+
 class TestPlanUnit(UnitWithId):
     """
     Test plan class
@@ -279,7 +299,8 @@ class TestPlanUnit(UnitWithId):
                         "unable to parse bootstrap_include: %s"), node.msg)
 
             V().visit(WordList.parse(self.bootstrap_include))
-        for tp_unit in self.get_nested_part():
+        tp_units, problems = self.get_nested_part()
+        for tp_unit in tp_units:
             job_ids.extend(tp_unit.get_bootstrap_job_ids())
         return job_ids
 
@@ -287,6 +308,7 @@ class TestPlanUnit(UnitWithId):
     def get_nested_part(self):
         """Compute and return a set of test plan ids from nested_part field."""
         nested_parts = []
+        problems = []
         if self.nested_part is not None:
             from plainbox.impl.session import SessionManager
             with SessionManager.get_throwaway_manager(self.provider_list) as m:
@@ -307,9 +329,8 @@ class TestPlanUnit(UnitWithId):
                     try:
                         nested_parts.append(context.get_unit(tp_id, 'test plan'))
                     except KeyError:
-                        logger.warning(_(
-                            "unable to find nested part: %s"), tp_id)
-        return nested_parts
+                        problems.append(tp_id)
+        return nested_parts, problems
 
     @instance_method_lru_cache(maxsize=None)
     def get_qualifier(self):
@@ -324,7 +345,8 @@ class TestPlanUnit(UnitWithId):
         qual_list.extend(self._gen_qualifiers('include', self.include, True))
         qual_list.extend(self._gen_qualifiers('exclude', self.exclude, False))
         qual_list.extend([self.get_bootstrap_qualifier(excluding=True)])
-        for tp_unit in self.get_nested_part():
+        tp_units, problems = self.get_nested_part()
+        for tp_unit in tp_units:
             qual_list.extend([tp_unit.get_qualifier()])
         return CompositeQualifier(qual_list)
 
@@ -340,7 +362,8 @@ class TestPlanUnit(UnitWithId):
         qual_list = []
         qual_list.extend(
             self._gen_qualifiers('include', self.mandatory_include, True))
-        for tp_unit in self.get_nested_part():
+        tp_units, problems = self.get_nested_part()
+        for tp_unit in tp_units:
             qual_list.extend([tp_unit.get_mandatory_qualifier()])
         return CompositeQualifier(qual_list)
 
@@ -356,7 +379,8 @@ class TestPlanUnit(UnitWithId):
             qual_list = [FieldQualifier(
                 'id', OperatorMatcher(operator.eq, target_id), field_origin,
                 not excluding) for target_id in self.get_bootstrap_job_ids()]
-        for tp_unit in self.get_nested_part():
+        tp_units, problems = self.get_nested_part()
+        for tp_unit in tp_units:
             qual_list.extend([tp_unit.get_bootstrap_qualifier(excluding)])
         return CompositeQualifier(qual_list)
 
@@ -577,6 +601,9 @@ class TestPlanUnit(UnitWithId):
             fields.mandatory_include: [
                 NoBaseIncludeValidator(),
             ],
+            fields.nested_part: [
+                NestedPartReferenceValidator(),
+            ],
             fields.bootstrap_include: [
                 concrete_validators.untranslatable,
                 NoBaseIncludeValidator(),
@@ -784,7 +811,8 @@ PatternMatcher('^job-[x-z]$'), inclusive=False)])
                 override_list.append((pattern, 'category_id', category_id))
 
         V().visit(OverrideFieldList.parse(testplan.category_overrides))
-        for tp_unit in testplan.get_nested_part():
+        tp_units, problems = testplan.get_nested_part()
+        for tp_unit in tp_units:
             override_list.extend(self._get_category_overrides(tp_unit))
         return override_list
 
@@ -813,7 +841,8 @@ PatternMatcher('^job-[x-z]$'), inclusive=False)])
 
             V().visit(OverrideFieldList.parse(
                 testplan.certification_status_overrides))
-        for tp_unit in testplan.get_nested_part():
+        tp_units, problems = testplan.get_nested_part()
+        for tp_unit in tp_units:
             override_list.extend(self._get_blocker_status_overrides(tp_unit))
         return override_list
 
@@ -843,6 +872,7 @@ PatternMatcher('^job-[x-z]$'), inclusive=False)])
                     override_list.append((pattern, field_value_list))
 
             V().visit(IncludeStmtList.parse(testplan.include))
-        for tp_unit in testplan.get_nested_part():
+        tp_units, problems = testplan.get_nested_part()
+        for tp_unit in tp_units:
             override_list.extend(self._get_inline_overrides(tp_unit))
         return override_list