[lib][feat] Improve model check (#2193)

Author: aquamatthias

fixlib/fixlib/baseresources.py

@@ -828,7 +828,7 @@ class BaseInstanceType(BaseType):
     kind: ClassVar[str] = "instance_type"
     kind_display: ClassVar[str] = "Instance Type"
     kind_description: ClassVar[str] = "An instance type."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "instance_type", "group": "compute"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "type", "group": "compute"}
     instance_type: Optional[str] = None
     instance_cores: float = 0.0
     instance_memory: float = 0.0
@@ -926,7 +926,7 @@ class BaseVolumeType(BaseType):
     kind: ClassVar[str] = "volume_type"
     kind_display: ClassVar[str] = "Volume Type"
     kind_description: ClassVar[str] = "A volume type."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "volume_type", "group": "storage"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "type", "group": "storage"}
     volume_type: Optional[str] = None
     ondemand_cost: Optional[float] = None
 
@@ -1049,7 +1049,7 @@ class BaseKeyPair(BaseResource):
     kind: ClassVar[str] = "keypair"
     kind_display: ClassVar[str] = "Key Pair"
     kind_description: ClassVar[str] = "A key pair."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "keypair", "group": "access_control"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "key", "group": "access_control"}
     fingerprint: str = ""
     _categories: ClassVar[List[Category]] = [Category.iam]
 
@@ -1166,7 +1166,7 @@ class BaseTunnel(BaseResource):
     kind: ClassVar[str] = "tunnel"
     kind_display: ClassVar[str] = "Networking Tunnel"
     kind_description: ClassVar[str] = "A networking tunnel."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "tunnel", "group": "networking"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "link", "group": "networking"}
     _categories: ClassVar[List[Category]] = [Category.networking]
 
 
@@ -1201,7 +1201,7 @@ class BaseRoute(BaseResource):
     kind: ClassVar[str] = "route"
     kind_display: ClassVar[str] = "Network Route"
     kind_description: ClassVar[str] = "A network route."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "route", "group": "networking"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "routing_table", "group": "networking"}
     _categories: ClassVar[List[Category]] = [Category.networking]
 
 
@@ -1210,7 +1210,7 @@ class BaseNetworkAcl(BaseResource):
     kind: ClassVar[str] = "network_acl"
     kind_display: ClassVar[str] = "Network ACL"
     kind_description: ClassVar[str] = "A network access control list."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "acl", "group": "networking"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "access_control", "group": "networking"}
     _categories: ClassVar[List[Category]] = [Category.networking, Category.security]
 
 
@@ -1237,7 +1237,7 @@ class BaseNetworkInterface(BaseResource):
     kind: ClassVar[str] = "network_interface"
     kind_display: ClassVar[str] = "Network Interface"
     kind_description: ClassVar[str] = "A network interface."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "network_interface", "group": "networking"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "endpoint", "group": "networking"}
     _categories: ClassVar[List[Category]] = [Category.networking]
     network_interface_status: str = ""
     network_interface_type: Optional[str] = None
@@ -1255,7 +1255,7 @@ class BaseIamPrincipal(BaseResource):
     kind_description: ClassVar[str] = (
         "An IAM principal is an entity that can be authenticated and authorized to access resources."
     )
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "iam_principal", "group": "access_control"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "user", "group": "access_control"}
     _categories: ClassVar[List[Category]] = [Category.iam]
 
 
@@ -1300,7 +1300,7 @@ class BaseInstanceProfile(BaseResource):
     kind: ClassVar[str] = "instance_profile"
     kind_display: ClassVar[str] = "Instance Profile"
     kind_description: ClassVar[str] = "An instance profile."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "instance_profile", "group": "access_control"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "profile", "group": "access_control"}
     _categories: ClassVar[List[Category]] = [Category.iam]
 
 
@@ -1373,7 +1373,7 @@ class BaseHealthCheck(BaseResource):
     kind: ClassVar[str] = "health_check"
     kind_display: ClassVar[str] = "Health Check"
     kind_description: ClassVar[str] = "A health check."
-    metadata: ClassVar[Dict[str, Any]] = {"icon": "health_check", "group": "compute"}
+    metadata: ClassVar[Dict[str, Any]] = {"icon": "health", "group": "compute"}
     _categories: ClassVar[List[Category]] = [Category.monitoring]
     check_interval: Optional[int] = None
     healthy_threshold: Optional[int] = None

fixlib/fixlib/core/model_check.py

@@ -9,6 +9,32 @@
 from fixlib.json import from_json
 from fixlib.types import Json
 
+# fmt: off
+
+# Possible group value: any addition needs to be supported in the frontend
+ResourceGroups: Set[str] = {
+    "access_control", "compute", "control", "database", "generative_ai",
+    "group", "managed_kubernetes", "misc", "networking", "storage"
+}
+# Possible icon value: any addition needs to be supported in the frontend
+ResourceIcons: Set[str] = {
+    "access_control", "account", "alarm", "application", "autoscaling_group", "backup",
+    "bucket", "cdn", "certificate", "cloud", "cluster", "config", "connection", "container",
+    "database", "dns", "dns_record", "endpoint", "environment", "firewall", "function",
+    "gateway", "graph_root", "group", "health", "host", "image", "instance", "job", "key",
+    "link", "load_balancer", "lock", "log", "network", "network_address", "network_share",
+    "plan", "policy", "profile", "provider", "proxy", "queue", "quota", "region",
+    "repository", "resource", "role", "routing_table", "security_group", "service",
+    "snapshot", "stack", "subnet", "type", "user", "vault", "version", "volume", "zone",
+}
+# Define classes that should be ignored for the resource check
+IgnoredClasses: Set[str] = {
+    "aws_resource", "aws_account", "aws_region",
+    "microsoft_resource",
+    "gcp_resource", "gcp_region", "gcp_project", "gcp_zone", "gcp_region_quota"
+}
+# fmt: on
+
 
 @define
 class CheckProp:
@@ -111,11 +137,19 @@ def check_not_redeclared(root: CheckClass, clazz: CheckClass, props: Set[str]) -
 
 
 def check_model_class(clazz: Type[BaseResource]) -> None:
-    if clazz.__name__.startswith("Aws"):  # Currently only AWS resources provide this information
-        if "kind_display" not in vars(clazz):
-            raise AttributeError(f"Class {clazz.__name__} does not have a kind_display attribute")
-        if "kind_description" not in vars(clazz):
-            raise AttributeError(f"Class {clazz.__name__} does not have a kind_description attribute")
+    name = clazz.__name__
+    kind = clazz.kind
+    if any(kind.startswith(a) for a in ["aws", "gcp", "azure", "microsoft"]):  # only selected providers support this
+        props = vars(clazz)
+        if "kind_display" not in props:
+            raise AttributeError(f"Class {name} does not have a kind_display attribute")
+        assert clazz.kind_service is not None, f"Class {name} does not have a kind_service attribute"
+
+    # make sure metadata is valid
+    if icon := clazz.metadata.get("icon"):
+        assert icon in ResourceIcons, f"{name} has unknown icon {icon}"
+    if group := clazz.metadata.get("group"):
+        assert group in ResourceGroups, f"{name} has unknown group {group}"
 
 
 def load_plugin_classes(*base: Type[BaseResource]) -> Set[Type[BaseResource]]:
@@ -172,7 +206,8 @@ def check_overlap(*base: Type[BaseResource]) -> None:
 
         if issubclass(model, BaseResource) and not getattr(model, "__abstractmethods__"):
             # check that the model class is not abstract and has no abstract methods
-            check_model_class(model)
+            if model.kind not in IgnoredClasses:
+                check_model_class(model)
 
     check_overlap_for(resource_classes_to_fixcore_model(model_classes, aggregate_root=BaseResource))
 

plugins/azure/fix_plugin_azure/resource/base.py

@@ -82,6 +82,7 @@ def parse_json(
 @define(eq=False, slots=False)
 class MicrosoftResource(BaseResource):
     kind: ClassVar[str] = "microsoft_resource"
+    kind_display: ClassVar[str] = "Microsoft Resource"
     # The mapping to transform the incoming API json into the internal representation.
     mapping: ClassVar[Dict[str, Bender]] = {}
     # Which API to call and what to expect in the result.

plugins/azure/fix_plugin_azure/resource/microsoft_graph.py

@@ -20,6 +20,8 @@
 @define(eq=False, slots=False)
 class MicrosoftGraphEntity(MicrosoftResource):
     kind: ClassVar[str] = "microsoft_graph_entity"
+    kind_display: ClassVar[str] = "Microsoft Graph Entity"
+    kind_service: ClassVar[Optional[str]] = "graph"
     mapping: ClassVar[Dict[str, Bender]] = {
         "id": S("id"),
         "deleted_date_time": S("deletedDateTime"),
@@ -1047,6 +1049,7 @@ def add_transitive(gp: MicrosoftGraphGroup) -> None:
 class MicrosoftGraphOrganization(MicrosoftGraphEntity, BaseAccount):
     kind: ClassVar[str] = "microsoft_graph_organization"
     kind_service: ClassVar[Optional[str]] = "entra_id"
+    kind_display: ClassVar[str] = "Microsoft Graph Organization"
     api_spec: ClassVar[MicrosoftRestSpec] = RestApiSpec(
         "graph",
         "https://graph.microsoft.com/v1.0/organization",
@@ -1131,6 +1134,7 @@ def deferred_edge_to_subscription(cls, builder: GraphBuilder) -> None:
 class MicrosoftGraphOrganizationRoot(MicrosoftGraphEntity, BaseRegion):
     kind: ClassVar[str] = "microsoft_graph_organization_root"
     kind_service: ClassVar[Optional[str]] = "entra_id"
+    kind_display: ClassVar[str] = "Microsoft Graph Organization Root"
 
 
 @define(eq=False, slots=False)