[bct] Add specific messages for enums in the changelog (Azure#37216)

* add enum specific messages for changelog

* add test

* nit remove comment

---------

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

Author: catalinaperalta

scripts/breaking_changes_checker/changelog_tracker.py

@@ -18,6 +18,8 @@ class ChangeType(str, Enum):
     ADDED_CLASS_METHOD = "AddedClassMethod"
     ADDED_CLASS_METHOD_PARAMETER = "AddedClassMethodParameter"
     ADDED_CLASS_PROPERTY = "AddedClassProperty"
+    ADDED_ENUM = "AddedEnum"
+    ADDED_ENUM_MEMBER = "AddedEnumMember"
     ADDED_FUNCTION_PARAMETER = "AddedFunctionParameter"
     ADDED_OPERATION_GROUP = "AddedOperationGroup"
 
@@ -36,6 +38,10 @@ class ChangelogTracker(BreakingChangesTracker):
         "Function `{}` added parameter `{}`"
     ADDED_CLASS_PROPERTY_MSG = \
         "Model `{}` added property `{}`"
+    ADDED_ENUM_MSG = \
+        "Added enum `{}`"
+    ADDED_ENUM_MEMBER_MSG = \
+        "Enum `{}` added member `{}`"
     ADDED_OPERATION_GROUP_MSG = \
         "Client `{}` added operation group `{}`"
 
@@ -71,6 +77,14 @@ def run_non_breaking_class_level_diff_checks(self, module: Dict) -> None:
                             self.module_name, class_name
                         )
                         self.features_added.append(fa)
+                    elif class_components.get("type", None) == "Enum":
+                        # This is a new enum
+                        fa = (
+                            self.ADDED_ENUM_MSG,
+                            ChangeType.ADDED_ENUM,
+                            self.module_name, class_name
+                        )
+                        self.features_added.append(fa)
                     else:
                         # This is a new class
                         fa = (
@@ -135,6 +149,12 @@ def run_non_breaking_class_level_diff_checks(self, module: Dict) -> None:
                                         ChangeType.ADDED_OPERATION_GROUP,
                                         self.module_name, self.class_name, property_name
                                     )
+                            if stable_class_nodes[self.class_name]["type"] == "Enum":
+                                fa = (
+                                    self.ADDED_ENUM_MEMBER_MSG,
+                                    ChangeType.ADDED_ENUM_MEMBER,
+                                    self.module_name, class_name, property_name
+                                )
                             self.features_added.append(fa)
 
 

scripts/breaking_changes_checker/tests/test_changelog.py

@@ -32,6 +32,7 @@ def test_new_class_property_added():
         "azure.ai.contentsafety": {
             "class_nodes": {
                 "AnalyzeTextResult": {
+                    "type": None,
                     "methods": {},
                     "properties": {
                         "blocklists_match": "Optional",
@@ -47,6 +48,7 @@ def test_new_class_property_added():
         "azure.ai.contentsafety": {
             "class_nodes": {
                 "AnalyzeTextResult": {
+                    "type": None,
                     "methods": {},
                     "properties": {
                         "blocklists_match": "Optional",
@@ -144,6 +146,7 @@ def test_new_class_property_added_init():
         "azure.ai.contentsafety": {
             "class_nodes": {
                 "AnalyzeTextResult": {
+                    "type": None,
                     "methods": {
                         "__init__": {
                             "parameters": {
@@ -177,6 +180,7 @@ def test_new_class_property_added_init():
         "azure.ai.contentsafety": {
             "class_nodes": {
                 "AnalyzeTextResult": {
+                    "type": None,
                     "methods": {
                         "__init__": {
                             "parameters": {
@@ -390,6 +394,7 @@ def test_added_operation_group():
         "azure.contoso": {
             "class_nodes": {
                 "ContosoClient": {
+                    "type": None,
                     "methods": {},
                     "properties": {
                         "bar": {
@@ -405,6 +410,7 @@ def test_added_operation_group():
         "azure.contoso": {
             "class_nodes": {
                 "ContosoClient": {
+                    "type": None,
                     "methods": {},
                     "properties": {
                         "bar": {
@@ -438,6 +444,7 @@ def test_ignore_changes():
         "azure.contoso": {
             "class_nodes": {
                 "ContosoClient": {
+                    "type": None,
                     "methods": {},
                     "properties": {
                         "bar": {
@@ -453,6 +460,7 @@ def test_ignore_changes():
         "azure.contoso": {
             "class_nodes": {
                 "ContosoClient": {
+                    "type": None,
                     "methods": {},
                     "properties": {
                         "bar": {
@@ -497,3 +505,53 @@ def test_async_features_added_cleanup():
     assert len(ct.features_added) == 2
     assert ct.features_added[0] == ("Message", "AddedClient", "azure.contoso", "FooClient", "foo")
     assert ct.features_added[1] == ("Message", "AddedClassMethod", "azure.contoso", "FooClient", "from_connection_string")
+
+
+def test_new_enum_added():
+    current = {
+        "azure.contoso.widgetmanager": {
+            "class_nodes": {
+                "WidgetEnum": {
+                    "type": "Enum",
+                    "methods": {},
+                    "properties": {
+                        "a": "a",
+                        "b": "b",
+                    }
+                },
+                "ManagerEnum": {
+                    "type": "Enum",
+                    "methods": {},
+                    "properties": {
+                        "foo": "foo",
+                        "bar": "bar",
+                    }
+                },
+            }
+        }
+    }
+
+    stable = {
+        "azure.contoso.widgetmanager": {
+            "class_nodes": {
+                "ManagerEnum": {
+                    "type": "Enum",
+                    "methods": {},
+                    "properties": {
+                        "foo": "foo",
+                    }
+                },
+            }
+        }
+    }
+
+    bc = ChangelogTracker(stable, current, "azure-contoso-widgetmanager")
+    bc.run_checks()
+
+    assert len(bc.features_added) == 2
+    msg, _, *args = bc.features_added[0]
+    assert msg == ChangelogTracker.ADDED_ENUM_MEMBER_MSG
+    assert args == ['azure.contoso.widgetmanager', 'ManagerEnum', 'bar']
+    msg, _, *args = bc.features_added[1]
+    assert msg == ChangelogTracker.ADDED_ENUM_MSG
+    assert args == ['azure.contoso.widgetmanager', 'WidgetEnum']