[GCU] Optimizing moves by adding generators for keys/tables (sonic-ne…

…t#2120)

#### What I did
Fixes sonic-net#2099

Grouping all fields under tables/keys to be added/deleted in 1 JsonChange.


**BEFORE** how did we generate moves to try?
- Start with the low level differences, low level means differences that has no children
- Then extend this low level by different extenders, the most used is the `UpperLevelMoveExtender`
- Extended the already extended moves to go upper in level, and do that multiple times until there are no possible moves to extend

The diagram below shows:
- Generation (low level):
```json
{"op":"replace", "path":"/ACL_RULE/SNMP_ACL|RULE_1/SRC_IP", "value": "1.1.1.1/21"}
{"op":"remove", "path":"/ACL_RULE/SNMP_ACL|RULE_2/PRIORITY"}
{"op":"remove", "path":"/ACL_RULE/SNMP_ACL|RULE_2/SRC_IP"}
{"op":"remove", "path":"/ACL_RULE/SNMP_ACL|RULE_2/IP_PROTOCOL"}
{"op":"remove", "path":"/ACL_RULE/SNMP_ACL|RULE_2/PACKET_ACTION"}
{"op":"add", "path":"/ACL_RULE/SNMP_ACL|RULE_3/PRIORITY", "value": "9997"}
{"op":"add", "path":"/ACL_RULE/SNMP_ACL|RULE_3/SRC_IP", "value": "3.3.3.3/20"}
{"op":"add", "path":"/ACL_RULE/SNMP_ACL|RULE_3/IP_PROTOCOL", "value": "17"}
{"op":"add", "path":"/ACL_RULE/SNMP_ACL|RULE_3/PACKET_ACTION", "value": "ACCEPT"}
```
- Extension - 1st level
```json
{"op":"replace", "path":"/ACL_RULE/SNMP_ACL|RULE_1", "value": {"PRIORITY": "9999","SRC_IP": "2.2.2.2/21","SRC_IP": "1.1.1.1/21","IP_PROTOCOL": "17","PACKET_ACTION": "ACCEPT"}}
{"op":"remove", "path":"/ACL_RULE/SNMP_ACL|RULE_2"}
{"op":"add", "path":"/ACL_RULE/SNMP_ACL|RULE_3", "value": {"PRIORITY": "9997","SRC_IP": "3.3.3.3/20","IP_PROTOCOL": "17","PACKET_ACTION": "ACCEPT"}}
```
- Extension - 2nd level
```json
{"op":"replace", "path":"/ACL_RULE", "value": {"SNMP_ACL|RULE_1": {"PRIORITY": "9999","SRC_IP": "1.1.1.1/21","IP_PROTOCOL": "17","PACKET_ACTION": "ACCEPT"},"SNMP_ACL|RULE_3": {"PRIORITY": "9997","SRC_IP": "3.3.3.3/20","IP_PROTOCOL": "17","PACKET_ACTION": "ACCEPT"},"SNMP_ACL|DEFAULT_RULE": {"PRIORITY": "1","ETHER_TYPE": "2048","PACKET_ACTION": "DROP"}}}
```
- Extension - 3rd level
 ```json
{"op":"replace", "path":"", "value": {"ACL_RULE": {"SNMP_ACL|RULE_1": {"PRIORITY": "9999","SRC_IP": "1.1.1.1/21","IP_PROTOCOL": "17","PACKET_ACTION": "ACCEPT"},"SNMP_ACL|RULE_3": {"PRIORITY": "9997","SRC_IP": "3.3.3.3/20","IP_PROTOCOL": "17","PACKET_ACTION": "ACCEPT"},"SNMP_ACL|DEFAULT_RULE": {"PRIORITY": "1","ETHER_TYPE": "2048","PACKET_ACTION": "DROP"}},"ACL_TABLE": {"SNMP_ACL": {"type": "CTRLPLANE","policy_desc": "SNMP_ACL","services": ["SNMP"]}}}}
```
![image](https://user-images.githubusercontent.com/3927651/160676723-29688656-3382-4247-8358-cb988cda5134.png)


**AFTER**
In this PR, we introduce a different kind of generator. The non-extendable generators i.e. generators that their moves do not get extended using the extenders. We added 2 generators:
- KeyLevelGenerator: if a whole key to be deleted or added, do that directly.
- TableLevelGenerator: if a whole table to be deleted or added, do that directly.

Only **enabled** KeyLevelGenerator, to enable **TableLevelGenerator** we have to confirm with Renuka if it is possible to update a whole table at once in the `ChangeApplier` (instead of just keys like it is today). We have to be able to update a table as a whole because within the table there can be internal dependencies between the object, so we have to guarantee all objects are deleted together. For the keys it is guaranteed for the whole key to be updated at once according to the `ChangeApplier`.

**Why non-extendable generators?**
Calling the non-extendable generators precedes the extendable ones, it is like checking for the low hanging fruits. If we use the same extenders for these new generators we will always go up the config tree. Imaging a move that tries to update a key but fails, then we call the extenders on this move. What will happen is the extenders will go up the config tree to the table level, will first try to replace the table, then try to delete the table. Deleting the table is a problem because it affects multiple more than intended and thus violates the minimum disruption guarantee. We decided to leave the extenders only for the LowLevelGenerator thus making sure we try all possible moves from the lowest levels and go up from there.

Another way to look at it is like this:
- Non-extendable generators do top-down search: Check tables, keys in this order
- Extendable generators and extenders do bottom-up approach: Check fields, keys, tables in this order

#### How I did it
Modifying the `MoveWrapper.Generate` method to allow for different type of move generators

#### How to verify it
Unit-test

Please check `tests/generic_config_updater/files/patch_sorter_test_success.json` to see how the moved generated got much compacted.

#### Previous command output (if the output of a command-line utility has changed)

#### New command output (if the output of a command-line utility has changed)

generic_config_updater/patch_sorter.py

@@ -290,29 +290,52 @@ def __hash__(self):
         return hash((self.op_type, self.path, json.dumps(self.value)))
 
 class MoveWrapper:
-    def __init__(self, move_generators, move_extenders, move_validators):
+    def __init__(self, move_generators, move_non_extendable_generators, move_extenders, move_validators):
         self.move_generators = move_generators
+        self.move_non_extendable_generators = move_non_extendable_generators
         self.move_extenders = move_extenders
         self.move_validators = move_validators
 
     def generate(self, diff):
+        """
+        Generates all possible moves to help transform diff.current_config to diff.target_config.
+
+        It starts by generating the non-extendable moves i.e. moves that will not extended to e.g. change its parent.
+        The non-extendable moves are mostly high level moves such as deleting/adding whole tables.
+
+        After that it generates extendable moves i.e. moves that can be extended to e.g. change its parent.
+        The extendable moves are typically very low level moves that can achieve the minimum disruption guarantee.
+
+        Lastly the moves are extended for example to try to replace the parent config instead, or by deleting
+        the dependencies of the config.
+        """
         processed_moves = set()
+        extended_moves = set()
         moves = deque([])
 
+        for move in self._generate_non_extendable_moves(diff):
+            if not(move in processed_moves):
+                processed_moves.add(move)
+                yield move
+
         for move in self._generate_moves(diff):
-            if move in processed_moves:
-                continue
-            processed_moves.add(move)
-            yield move
-            moves.extend(self._extend_moves(move, diff))
+            if not(move in processed_moves):
+                processed_moves.add(move)
+                yield move
+
+            if not(move in extended_moves):
+                extended_moves.add(move)
+                moves.extend(self._extend_moves(move, diff))
 
         while moves:
             move = moves.popleft()
-            if move in processed_moves:
-                continue
-            processed_moves.add(move)
-            yield move
-            moves.extend(self._extend_moves(move, diff))
+            if not(move in processed_moves):
+                processed_moves.add(move)
+                yield move
+
+            if not(move in extended_moves):
+                extended_moves.add(move)
+                moves.extend(self._extend_moves(move, diff))
 
     def validate(self, move, diff):
         for validator in self.move_validators:
@@ -328,6 +351,11 @@ def _generate_moves(self, diff):
             for move in generator.generate(diff):
                 yield move
 
+    def _generate_non_extendable_moves(self, diff):
+        for generator in self.move_non_extendable_generators:
+            for move in generator.generate(diff):
+                yield move
+
     def _extend_moves(self, move, diff):
         for extender in self.move_extenders:
             for newmove in extender.extend(move, diff):
@@ -921,6 +949,68 @@ def validate(self, move, diff):
 
         return True
 
+class TableLevelMoveGenerator:
+    """
+    A class that key level moves. The item name at the root level of ConfigDB is called 'Table'.
+
+    e.g.
+    {
+        "Table": ...
+    }
+
+    This class will generate moves to remove tables if they are in current, but not target. It also add tables
+    if they are in target but not current configs.
+    """
+
+    def generate(self, diff):
+        # Removing tables in current but not target
+        for tokens in self._get_non_existing_tables_tokens(diff.current_config, diff.target_config):
+            yield JsonMove(diff, OperationType.REMOVE, tokens)
+
+        # Adding tables in target but not current
+        for tokens in self._get_non_existing_tables_tokens(diff.target_config, diff.current_config):
+            yield JsonMove(diff, OperationType.ADD, tokens, tokens)
+
+    def _get_non_existing_tables_tokens(self, config1, config2):
+        for table in config1:
+            if not(table in config2):
+                yield [table]
+
+class KeyLevelMoveGenerator:
+    """
+    A class that key level moves. The item name at the root level of ConfigDB is called 'Table', the item
+    name in the Table level of ConfigDB is called key.
+
+    e.g.
+    {
+        "Table": {
+            "Key": ...
+        }
+    }
+
+    This class will generate moves to remove keys if they are in current, but not target. It also add keys
+    if they are in target but not current configs.
+    """
+    def generate(self, diff):
+        # Removing keys in current but not target
+        for tokens in self._get_non_existing_keys_tokens(diff.current_config, diff.target_config):
+            table = tokens[0]
+            # if table has a single key, delete the whole table because empty tables are not allowed in ConfigDB
+            if len(diff.current_config[table]) == 1:
+                yield JsonMove(diff, OperationType.REMOVE, [table])
+            else:
+                yield JsonMove(diff, OperationType.REMOVE, tokens)
+
+        # Adding keys in target but not current
+        for tokens in self._get_non_existing_keys_tokens(diff.target_config, diff.current_config):
+            yield JsonMove(diff, OperationType.ADD, tokens, tokens)
+
+    def _get_non_existing_keys_tokens(self, config1, config2):
+        for table in config1:
+            for key in config1[table]:
+                if not(table in config2) or not (key in config2[table]):
+                    yield [table, key]
+
 class LowLevelMoveGenerator:
     """
     A class to generate the low level moves i.e. moves corresponding to differences between current/target config
@@ -1407,6 +1497,8 @@ def __init__(self, operation_wrapper, config_wrapper, path_addressing):
 
     def create(self, algorithm=Algorithm.DFS):
         move_generators = [LowLevelMoveGenerator(self.path_addressing)]
+        # TODO: Enable TableLevelMoveGenerator once it is confirmed whole table can be updated at the same time
+        move_non_extendable_generators = [KeyLevelMoveGenerator()]
         move_extenders = [RequiredValueMoveExtender(self.path_addressing, self.operation_wrapper),
                           UpperLevelMoveExtender(),
                           DeleteInsteadOfReplaceMoveExtender(),
@@ -1419,7 +1511,7 @@ def create(self, algorithm=Algorithm.DFS):
                            RequiredValueMoveValidator(self.path_addressing),
                            NoEmptyTableMoveValidator(self.path_addressing)]
 
-        move_wrapper = MoveWrapper(move_generators, move_extenders, move_validators)
+        move_wrapper = MoveWrapper(move_generators, move_non_extendable_generators, move_extenders, move_validators)
 
         if algorithm == Algorithm.DFS:
             sorter = DfsSorter(move_wrapper)