[bct] Support suppressions for features_added (Azure#37065)

* support suppressions for changelog reporting

* clean up

* fix type

* clean up imports

* add test

---------

Co-authored-by: Catalina Peralta <[email protected]>

Author: catalinaperalta

scripts/breaking_changes_checker/breaking_changes_tracker.py

@@ -597,15 +597,15 @@ def match(self, bc, ignored):
                 return False
         return True
 
-    def get_reportable_breaking_changes(self, ignore_changes: Dict) -> List:
+    def get_reportable_changes(self, ignore_changes: Dict, changes_list: List) -> List:
         ignored = []
         # Match all ignore rules that should apply to this package
         for ignored_package, ignore_rules in ignore_changes.items():
             if re.findall(ignored_package, self.package_name):
                 ignored.extend(ignore_rules)
 
-        # Remove ignored breaking changes from list of reportable changes
-        bc_copy = deepcopy(self.breaking_changes)
+        # Remove ignored changes from list of reportable changes
+        bc_copy = deepcopy(changes_list)
         for bc in bc_copy:
             _, bc_type, module_name, *args = bc
             class_name = args[0] if args else None
@@ -616,17 +616,17 @@ def get_reportable_breaking_changes(self, ignore_changes: Dict) -> List:
                 suppression = Suppression(*rule)
 
                 if suppression.parameter_or_property_name is not None:
-                    # If the ignore rule is for a property or parameter, we should check up to that level on the original breaking change
+                    # If the ignore rule is for a property or parameter, we should check up to that level on the original change
                     if self.match((bc_type, module_name, class_name, function_name, parameter_name), suppression):
-                        self.breaking_changes.remove(bc)
+                        changes_list.remove(bc)
                         break
                 elif self.match((bc_type, module_name, class_name, function_name), suppression):
-                    self.breaking_changes.remove(bc)
+                    changes_list.remove(bc)
                     break
 
     def report_changes(self) -> None:
         ignore_changes = self.ignore if self.ignore else IGNORE_BREAKING_CHANGES
-        self.get_reportable_breaking_changes(ignore_changes)
+        self.get_reportable_changes(ignore_changes, self.breaking_changes)
 
         # If there are no breaking changes after the ignore check, return early
         if not self.breaking_changes:

scripts/breaking_changes_checker/changelog_tracker.py

@@ -6,7 +6,7 @@
 # --------------------------------------------------------------------------------------------
 
 from enum import Enum
-from typing import Any, Dict, List, Union
+from typing import Any, Dict
 import jsondiff
 from breaking_changes_tracker import BreakingChangesTracker
 from breaking_changes_allowlist import IGNORE_BREAKING_CHANGES
@@ -155,10 +155,11 @@ def check_non_positional_parameter_added(self, current_parameters_node: Dict) ->
                     )
                 )
 
+
     def report_changes(self) -> None:
         ignore_changes = self.ignore if self.ignore else IGNORE_BREAKING_CHANGES
-        self.get_reportable_breaking_changes(ignore_changes)
-
+        self.get_reportable_changes(ignore_changes, self.breaking_changes)
+        self.get_reportable_changes(ignore_changes, self.features_added)
         # Code borrowed and modified from the previous change log tool
         def _build_md(content: list, title: str, buffer: list):
             buffer.append(title)

scripts/breaking_changes_checker/tests/test_changelog.py

@@ -441,6 +441,55 @@ def test_added_operation_group():
     assert msg == ChangelogTracker.ADDED_CLASS_PROPERTY_MSG
 
 
+def test_ignore_changes():
+    stable = {
+        "azure.contoso": {
+            "class_nodes": {
+                "ContosoClient": {
+                    "methods": {},
+                    "properties": {
+                        "bar": {
+                            "attr_type": "str"
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    current = {
+        "azure.contoso": {
+            "class_nodes": {
+                "ContosoClient": {
+                    "methods": {},
+                    "properties": {
+                        "bar": {
+                            "attr_type": "str"
+                        },
+                        "foo": {
+                            "attr_type": "DeviceGroupsOperations"
+                        },
+                        "zip": {
+                            "attr_type": "bool"
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    IGNORE = {
+        "azure-contoso": [("AddedOperationGroup", "*", "ContosoClient", "foo")]
+    }
+    diff = jsondiff.diff(stable, current)
+    bc = ChangelogTracker(stable, current, diff, "azure-contoso", ignore=IGNORE)
+    bc.run_checks()
+    bc.report_changes()
+    assert len(bc.features_added) == 1
+    msg, _, *args = bc.features_added[0]
+    assert msg == ChangelogTracker.ADDED_CLASS_PROPERTY_MSG
+
+
 def test_async_features_added_cleanup():
     features_added = [
         ("Message", "AddedClient", "azure.contoso.aio", "FooClient", "foo"),