Improve anchor definition in conditional mark (sonic-net#21943)

PR sonic-net#20326 introduced anchors in the conditional mark yaml files.
The anchors are defined in a dummy entry for test_pretest.py.

PR sonic-net#20382 updated code to add exception for the sort checking of test_pretest.py in conditional mark yaml files.

These changes made it complicated when we do need to skip something for test_pretest.py.

This change fixed the problem by using a real dummy entry for defining the yaml anchors.

The code of skipping test_pretest.py in sort checking in conditional mark yaml file is also removed.

This change also improved a variable name in conditional mark and fixed a few typos.

Signed-off-by: Xin Wang <[email protected]>
Signed-off-by: Andoni Sanguesa <[email protected]>

Author: wangxin

.hooks/pre_commit_hooks/check_conditional_mark_sort.py

@@ -14,14 +14,6 @@ def main():
                 for line in file_contents:
                     if re.match('^[a-zA-Z]', line):
                         conditions.append(line.strip().rstrip(":"))
-                if conditions[0] == 'test_pretest.py':
-                    del conditions[0]  # This is at front where it should be
-                if 'test_pretest.py' in conditions:
-                    print("===========================================================================")
-                    print("test_pretest.py should be the first item in ")
-                    print("tests/common/plugins/conditional_mark/tests_mark_conditions*.yaml")
-                    print("===========================================================================")
-                    return 1
                 sorted_conditions = conditions[:]
                 sorted_conditions.sort()
                 for i in range(len(conditions)):

tests/common/plugins/conditional_mark/__init__.py

@@ -78,10 +78,10 @@ def load_conditions(session):
     conditions_list = list()
 
     conditions_files = session.config.option.mark_conditions_files
-    for condition in conditions_files:
-        if '*' in condition:
-            conditions_files.remove(condition)
-            files = glob.glob(condition)
+    for condition_file in conditions_files:
+        if '*' in condition_file:
+            conditions_files.remove(condition_file)
+            files = glob.glob(condition_file)
             for file in files:
                 if file not in conditions_files:
                     conditions_files.append(file)
@@ -643,7 +643,7 @@ def pytest_collection(session):
 
 
 def pytest_collection_modifyitems(session, config, items):
-    """Hook for adding marks to test cases based on conditions defind in a centralized file.
+    """Hook for adding marks to test cases based on conditions defined in a centralized file.
 
     Args:
         session (obj): Pytest session object.

tests/common/plugins/conditional_mark/tests_mark_conditions.yaml

@@ -2,43 +2,41 @@
 #####        Define Anchors       #####
 #######################################
 
-# yaml files don't let an anchor be defined outside a yaml entry, so this block just
-# creates an entry for pre-test but ensure it will always run, then the other
-# conditions can just be used to define anchors for further use in this file
-
-test_pretest.py:
-  skip:
-    reason: "Dummy entry to allow anchors to be defined at the top of this file"
-    conditions_logical_operator: and
-    conditions:
-      - "False" # Ensure pretest always runs
-      - &lossyTopos |
-          topo_name in [
-            't0-isolated-d128u128s1', 't0-isolated-v6-d128u128s1',
-            't0-isolated-d128u128s2', 't0-isolated-v6-d128u128s2',
-            't0-isolated-d16u16s1', 't0-isolated-v6-d16u16s1',
-            't0-isolated-d16u16s2', 't0-isolated-v6-d16u16s2',
-            't0-isolated-d256u256s2', 't0-isolated-v6-d256u256s2',
-            't0-isolated-d32u32s2', 't0-isolated-v6-d32u32s2',
-            't1-isolated-d224u8', 't1-isolated-v6-d224u8',
-            't1-isolated-d28u1', 't1-isolated-v6-d28u1',
-            't1-isolated-d448u15-lag', 't1-isolated-v6-d448u15-lag',
-            't1-isolated-d448u16', 't1-isolated-v6-d448u16',
-            't1-isolated-d56u1-lag', 't1-isolated-v6-d56u1-lag',
-            't1-isolated-d56u2', 't1-isolated-v6-d56u2' ]
-      - &noVxlanTopos |
-          topo_name in [
-            't0-isolated-d32u32s2', 't0-isolated-d256u256s2',
-            't0-isolated-d96u32s2', 't0-isolated-v6-d32u32s2',
-            't0-isolated-v6-d256u256s2', 't0-isolated-v6-d96u32s2',
-            't1-isolated-d56u2', 't1-isolated-d56u1-lag',
-            't1-isolated-d448u15-lag', 't1-isolated-d128',
-            't1-isolated-d32', 't1-isolated-v6-d56u2',
-            't1-isolated-v6-d56u1-lag', 't1-isolated-v6-d448u15-lag',
-            't1-isolated-v6-d128' ]
-
-#######################################
-#####          cutsom_acl         #####
+# This entry should not match any tests, it is just for defining anchors
+# yaml files don't let an anchor be defined outside a yaml entry, so this entry just
+# creates an entry defining anchors by &anchor_name. The anchors are like variables that can be reused
+# in later conditions by syntax like *anchor_name.
+# The name of this entry can ensure that is is sorted to the top of the file.
+# Because it does not match any tests, so the schema of this entry can be flexible.
+0000aaaa_dummy_entry:
+  anchors:
+    - &lossyTopos |
+        topo_name in [
+          't0-isolated-d128u128s1', 't0-isolated-v6-d128u128s1',
+          't0-isolated-d128u128s2', 't0-isolated-v6-d128u128s2',
+          't0-isolated-d16u16s1', 't0-isolated-v6-d16u16s1',
+          't0-isolated-d16u16s2', 't0-isolated-v6-d16u16s2',
+          't0-isolated-d256u256s2', 't0-isolated-v6-d256u256s2',
+          't0-isolated-d32u32s2', 't0-isolated-v6-d32u32s2',
+          't1-isolated-d224u8', 't1-isolated-v6-d224u8',
+          't1-isolated-d28u1', 't1-isolated-v6-d28u1',
+          't1-isolated-d448u15-lag', 't1-isolated-v6-d448u15-lag',
+          't1-isolated-d448u16', 't1-isolated-v6-d448u16',
+          't1-isolated-d56u1-lag', 't1-isolated-v6-d56u1-lag',
+          't1-isolated-d56u2', 't1-isolated-v6-d56u2' ]
+    - &noVxlanTopos |
+        topo_name in [
+          't0-isolated-d32u32s2', 't0-isolated-d256u256s2',
+          't0-isolated-d96u32s2', 't0-isolated-v6-d32u32s2',
+          't0-isolated-v6-d256u256s2', 't0-isolated-v6-d96u32s2',
+          't1-isolated-d56u2', 't1-isolated-d56u1-lag',
+          't1-isolated-d448u15-lag', 't1-isolated-d128',
+          't1-isolated-d32', 't1-isolated-v6-d56u2',
+          't1-isolated-v6-d56u1-lag', 't1-isolated-v6-d448u15-lag',
+          't1-isolated-v6-d128' ]
+
+#######################################
+#####          custom_acl         #####
 #######################################
 acl:
   skip: