[inventory][chore] Remove phantom property (#2207)

Author: aquamatthias

fixcore/fixcore/model/graph_access.py

@@ -30,7 +30,7 @@
 from fixcore.model.resolve_in_graph import GraphResolver, NodePath, ResolveProp
 from fixcore.model.typed_model import from_js
 from fixcore.types import Json, EdgeType, JsonElement
-from fixcore.util import utc, utc_str, value_in_path, set_value_in_path, value_in_path_get, path_exists
+from fixcore.util import utc, utc_str, value_in_path, set_value_in_path, path_exists
 
 log = logging.getLogger(__name__)
 
@@ -477,6 +477,7 @@ def resolve(self) -> None:
 
     def __resolve_count_descendants(self) -> None:
         visited: Set[str] = set()
+        empty_set: Set[str] = set()
 
         def count_successors_by(node_id: NodeId, edge_type: EdgeType, path: List[str]) -> Dict[str, int]:
             result: Dict[str, int] = {}
@@ -487,7 +488,7 @@ def count_successors_by(node_id: NodeId, edge_type: EdgeType, path: List[str]) -
                     if elem_id not in visited:
                         visited.add(elem_id)
                         elem = self.nodes[elem_id]
-                        if not value_in_path_get(elem, NodePath.is_phantom, False):
+                        if "phantom" not in elem.get("kinds_set", empty_set):
                             extracted = value_in_path(elem, path)
                             if isinstance(extracted, str):
                                 result[extracted] = result.get(extracted, 0) + 1

fixcore/fixcore/model/resolve_in_graph.py

@@ -20,7 +20,6 @@ class NodePath:
     descendant_summary = ["metadata", "descendant_summary"]
     descendant_count = ["metadata", "descendant_count"]
     python_type = ["metadata", "python_type"]
-    is_phantom = ["metadata", "phantom"]
     from_node = ["from"]
     to_node = ["to"]
     edge_type = ["edge_type"]

fixcore/fixcore/static/api-doc.yaml

@@ -780,7 +780,6 @@ paths:
                   name: root
                 metadata:
                   cleaned: false
-                  phantom: true
                   protected: false
             application/yaml:
               example: |
@@ -795,7 +794,6 @@ paths:
                 metadata:
                     python_type: fixlib.baseresources.GraphRoot
                     cleaned: false
-                    phantom: true
                     protected: false
                 kinds:
                     - graph_root
@@ -813,7 +811,6 @@ paths:
                 metadata:
                     python_type: fixlib.baseresources.Cloud
                     cleaned: false
-                    phantom: false
                     protected: false
                     descendant_summary:
                         onelogin_account: 1
@@ -983,7 +980,6 @@ paths:
                   name: root
                 metadata:
                   cleaned: false
-                  phantom: true
                   protected: false
             application/yaml:
               example: |
@@ -998,7 +994,6 @@ paths:
                 metadata:
                     python_type: fixlib.baseresources.GraphRoot
                     cleaned: false
-                    phantom: true
                     protected: false
                 kinds:
                     - graph_root
@@ -1016,7 +1011,6 @@ paths:
                 metadata:
                     python_type: fixlib.baseresources.Cloud
                     cleaned: false
-                    phantom: false
                     protected: false
                     descendant_summary:
                         onelogin_account: 1
@@ -1454,7 +1448,6 @@ paths:
                   name: root
                 metadata:
                   cleaned: false
-                  phantom: true
                   protected: false
             application/yaml:
               example: |
@@ -1469,7 +1462,6 @@ paths:
                 metadata:
                     python_type: fixlib.baseresources.GraphRoot
                     cleaned: false
-                    phantom: true
                     protected: false
                 kinds:
                     - graph_root
@@ -1487,7 +1479,6 @@ paths:
                 metadata:
                     python_type: fixlib.baseresources.Cloud
                     cleaned: false
-                    phantom: false
                     protected: false
                     descendant_summary:
                         onelogin_account: 1

fixcore/tests/fixcore/model/graph_access_test.py

@@ -201,8 +201,11 @@ def add_node(node_id: NodeId) -> None:
             "kind": kind,
             "some": {"deep": {"nested": node_id}},
         }
+        kinds = [kind]
+        metadata = {}
         # for sake of testing: declare parent as phantom resource
-        metadata = {"phantom": True} if kind == "parent" else {}
+        if kind == "parent":
+            kinds.append("phantom")
         if node_id.startswith(replace_on):
             metadata["replace"] = True
         g.add_node(
@@ -211,8 +214,8 @@ def add_node(node_id: NodeId) -> None:
             reported=reported,
             metadata=metadata,
             kind=kind,
-            kinds=[kind],
-            kinds_set={kind},
+            kinds=kinds,
+            kinds_set=set(kinds),
         )
 
     def add_edge(from_node: str, to_node: str, edge_type: EdgeType = EdgeTypes.default) -> None:

fixlib/fixlib/baseresources.py

@@ -253,13 +253,9 @@ class BaseResource(ABC):
     the resource within the Graph. The name is used for display purposes. Tags are
     key/value pairs that get exported in the GRAPHML view.
 
-    There's also class variables, kind, phantom and reference_kinds.
+    There's also class variables, kind, and reference_kinds.
     `kind` is a string describing the type of resource, e.g. 'aws_ec2_instance'
        or 'some_cloud_load_balancer'.
-    `phantom` is a bool describing whether the resource actually exists within
-       the cloud or if it's just a phantom resource like pricing information
-       or usage quota. I.e. some information relevant to the cloud account
-       but not actually existing in the form of a usable resource.
     `reference_kinds` is a list of kinds that can be connected to this resource for
        the related edge type as successor or predecessor.
     """
@@ -268,7 +264,6 @@ class BaseResource(ABC):
     kind_display: ClassVar[str] = "Resource"
     kind_description: ClassVar[str] = "A generic resource."
     kind_service: ClassVar[Optional[str]] = None
-    phantom: ClassVar[bool] = False
     reference_kinds: ClassVar[ModelReference] = {}
     metadata: ClassVar[Dict[str, Any]] = {"icon": "resource", "group": "misc"}
 
@@ -455,7 +450,7 @@ def clean(self) -> bool:
     @clean.setter
     @unless_protected
     def clean(self, value: bool) -> None:
-        if self.phantom and value:
+        if isinstance(self, PhantomBaseResource) and value:
             raise ValueError(f"Can't cleanup phantom resource {self.rtdname}")
 
         clean_str = "" if value else "not "
@@ -491,7 +486,7 @@ def protected(self, value: bool) -> None:
     @metrics_resource_cleanup.time()
     @unless_protected
     def cleanup(self, graph: Optional[Any] = None) -> bool:
-        if self.phantom:
+        if isinstance(self, PhantomBaseResource):
             raise RuntimeError(f"Can't cleanup phantom resource {self.rtdname}")
 
         if self.cleaned:
@@ -540,7 +535,7 @@ def pre_cleanup(self, graph: Optional[Any] = None) -> bool:
         if graph is None:
             graph = self._graph
 
-        if self.phantom:
+        if isinstance(self, PhantomBaseResource):
             raise RuntimeError(f"Can't cleanup phantom resource {self.rtdname}")
 
         if self.cleaned:
@@ -759,7 +754,6 @@ class PhantomBaseResource(BaseResource):
     kind: ClassVar[str] = "phantom_resource"
     kind_display: ClassVar[str] = "Phantom Resource"
     kind_description: ClassVar[str] = "A generic phantom resource."
-    phantom: ClassVar[bool] = True
 
     def update_tag(self, key: str, value: str) -> bool:
         log.error(f"Resource {self.rtdname} is a phantom resource and does not maintain tags")

fixlib/fixlib/core/model_export.py

@@ -339,7 +339,6 @@ def node_to_dict(node: BaseResource, changes_only: bool = False, include_revisio
                 "metadata": {
                     "python_type": type_str(node),
                     "cleaned": node.cleaned,
-                    "phantom": node.phantom,
                     "protected": node.protected,
                     "categories": node.categories(),
                     **node._metadata,

plugins/aws/fix_plugin_aws/__init__.py

@@ -21,6 +21,7 @@
     Cloud,
     metrics_resource_cleanup_exceptions,
     metrics_resource_pre_cleanup_exceptions,
+    PhantomBaseResource,
 )
 from fixlib.config import Config, RunningConfig
 from fixlib.core.actions import CoreFeedback
@@ -272,7 +273,7 @@ def pre_cleanup(config: Config, resource: BaseResource, graph: Graph) -> bool:
                 resource.log("Modification was requested even though resource is protected" " - refusing")
                 return False
 
-            if resource.phantom:
+            if isinstance(resource, PhantomBaseResource):
                 log.warning(f"Can't cleanup phantom resource {resource.rtdname}")
                 return False
 
@@ -314,7 +315,7 @@ def pre_cleanup(config: Config, resource: BaseResource, graph: Graph) -> bool:
     @staticmethod
     def cleanup(config: Config, resource: BaseResource, graph: Graph) -> bool:
         if isinstance(resource, AwsResource):
-            if resource.phantom:
+            if isinstance(resource, PhantomBaseResource):
                 raise RuntimeError(f"Can't cleanup phantom resource {resource.rtdname}")
 
             if resource.cleaned: