Merge ~d0ugal/maas:node-metadata-lp-1891027-2.7 into maas:2.7

[Dougal Matthews]

LP: #1891027 Use simpler nodemetadata matching

This simplifies the node metadata matching with a python comparisons and
removes the regular expression and pattern matching
support.

[Adam Collard (adam-collard)]

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b node-metadata-lp-1891027-2.7 lp:~d0ugal/maas/+git/maas into -b 2.7 lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: f96d25cf5efbaca02a0fcf5efb80ff167634b7a6

review: Approve

diff --git a/src/metadataserver/models/scriptset.py b/src/metadataserver/models/scriptset.py
index 1f1bf65..fb10603 100644
--- a/src/metadataserver/models/scriptset.py
+++ b/src/metadataserver/models/scriptset.py
@@ -4,8 +4,6 @@
 __all__ = ["ScriptSet", "get_status_from_qs", "translate_result_type"]
 
 from datetime import timedelta
-import fnmatch
-import re
 
 from django.contrib.postgres.fields import ArrayField
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
@@ -229,26 +227,21 @@ class ScriptSetManager(Manager):
             script_type=script_type,
         )
         modaliases = script_set.node.modaliases
-        regexes = []
-        for nmd in script_set.node.nodemetadata_set.filter(
+        hw_pairs_qs = script_set.node.nodemetadata_set.filter(
             Q(key__startswith="system_")
             | Q(key__startswith="mainboard_")
             | Q(key__startswith="firmware_")
             | Q(key__startswith="chassis_")
-        ):
-            regexes.append("%s:%s" % (nmd.key, fnmatch.translate(nmd.value)))
-        if len(regexes) > 0:
-            node_hw_regex = re.compile("^%s$" % "|".join(regexes), re.I)
-        else:
-            node_hw_regex = None
+        ).values_list("key", "value")
+        hw_pairs = [":".join(t) for t in hw_pairs_qs]
         for script in qs:
             # If a script with the for_hardware field is selected by tag only
             # add it if matching hardware is found.
             if script.for_hardware:
                 found_hw_match = False
-                if node_hw_regex is not None:
+                if hw_pairs:
                     for hardware in script.for_hardware:
-                        if node_hw_regex.search(hardware) is not None:
+                        if hardware in hw_pairs:
                             found_hw_match = True
                             break
                 matches = filter_modaliases(modaliases, *script.ForHardware)
@@ -469,18 +462,13 @@ class ScriptSet(CleanSave, Model):
         if modaliases is None:
             modaliases = self.node.modaliases
 
-        regexes = []
-        for nmd in self.node.nodemetadata_set.filter(
+        hw_pairs_qs = self.node.nodemetadata_set.filter(
             Q(key__startswith="system_")
             | Q(key__startswith="mainboard_")
             | Q(key__startswith="firmware_")
             | Q(key__startswith="chassis_")
-        ):
-            regexes.append("%s:%s" % (nmd.key, fnmatch.translate(nmd.value)))
-        if len(regexes) > 0:
-            node_hw_regex = re.compile("^%s$" % "|".join(regexes), re.I)
-        else:
-            node_hw_regex = None
+        ).values_list("key", "value")
+        hw_pairs = [":".join(t) for t in hw_pairs_qs]
 
         # Remove scripts autoselected at the start of commissioning but updated
         # commissioning data shows the Script is no longer applicable.
@@ -496,9 +484,9 @@ class ScriptSet(CleanSave, Model):
                 modaliases, *script_result.script.ForHardware
             )
             found_hw_match = False
-            if node_hw_regex is not None:
+            if hw_pairs:
                 for hardware in script_result.script.for_hardware:
-                    if node_hw_regex.search(hardware) is not None:
+                    if hardware in hw_pairs:
                         found_hw_match = True
                         break
             matches = filter_modaliases(
@@ -518,9 +506,9 @@ class ScriptSet(CleanSave, Model):
         scripts = scripts.exclude(name__in=[s.name for s in self])
         for script in scripts:
             found_hw_match = False
-            if node_hw_regex is not None:
+            if hw_pairs:
                 for hardware in script.for_hardware:
-                    if node_hw_regex.search(hardware) is not None:
+                    if hardware in hw_pairs:
                         found_hw_match = True
                         break
             matches = filter_modaliases(modaliases, *script.ForHardware)
diff --git a/src/metadataserver/models/tests/test_scriptset.py b/src/metadataserver/models/tests/test_scriptset.py
index d3597cb..5085090 100644
--- a/src/metadataserver/models/tests/test_scriptset.py
+++ b/src/metadataserver/models/tests/test_scriptset.py
@@ -1201,6 +1201,29 @@ class TestScriptSet(MAASServerTestCase):
             [script_result.name for script_result in script_set],
         )
 
+    def test_select_for_hardware_scripts_with_bracket_in_firmware(self):
+        # Regression test for LP:1891213
+        node = factory.make_Node()
+        factory.make_NodeMetadata(
+            node=node,
+            key="mainboard_firmware_version",
+            value="-[IVE156L-2.61]-",
+        )
+        script = factory.make_Script(
+            script_type=SCRIPT_TYPE.COMMISSIONING,
+            for_hardware=["mainboard_firmware_version:-[IVE156L-2.61]-"],
+        )
+        script_set = ScriptSet.objects.create_commissioning_script_set(
+            node, [random.choice(script.tags)]
+        )
+
+        script_set.select_for_hardware_scripts()
+
+        self.assertItemsEqual(
+            list(NODE_INFO_SCRIPTS) + [script.name],
+            [script_result.name for script_result in script_set],
+        )
+
     def test_regenerate_storage(self):
         node = factory.make_Node(interface=True)
         script_set = factory.make_ScriptSet(node=node)