Add CheckVirus action

Virus check should be done in a separated event so that upload event
result won't be affected by the virus check result.

ref: eng/shared/release#1578

Author: elsaferrara

src/e3/anod/action/__init__.py

@@ -359,6 +359,29 @@ def __str__(self) -> str:
         return f"upload source {self.source_name}"
 
 
+class CheckVirus(Action):
+    """CheckVirus Action.
+
+    Check virus on uploaded component.
+    """
+
+    __slots__ = ("uid", "data", "anod_instance")
+
+    def __init__(self, data: Anod):
+        """Initialize a CheckVirus object.
+
+        :param data: Anod instance
+        """
+        data_uid = data.uid.split(".")
+        data_uid[-1] = "check_virus"
+        uid = ".".join(data_uid)
+        super().__init__(uid=uid, data=data)
+        self.anod_instance = data
+
+    def __str__(self) -> str:
+        return f"check for viruses in {self.uid.rsplit('.', 1)[0]}"
+
+
 class Decision(Action, metaclass=abc.ABCMeta):
     """Decision Action.
 

src/e3/anod/context.py

@@ -22,6 +22,7 @@
     UploadBinaryComponent,
     UploadSource,
     UploadSourceComponent,
+    CheckVirus,
 )
 from e3.anod.deps import Dependency
 from e3.anod.error import AnodError
@@ -398,8 +399,10 @@ def add_anod_action(
                 spec = build_action.data
                 if spec.component is not None and upload:
                     upload_bin: UploadBinaryComponent | UploadSourceComponent
+                    check_virus: None | CheckVirus = None
                     if spec.has_package:
                         upload_bin = UploadBinaryComponent(spec)
+                        check_virus = CheckVirus(spec)
                     else:
                         upload_bin = UploadSourceComponent(spec)
                     self.add(upload_bin)
@@ -410,7 +413,12 @@ def add_anod_action(
                             plan_line=plan_line,
                             plan_args=plan_args,
                         )
-                    self.connect(self.root, upload_bin)
+                    if check_virus:
+                        self.add(check_virus)
+                        self.connect(self.root, check_virus)
+                        self.connect(check_virus, upload_bin)
+                    else:
+                        self.connect(self.root, upload_bin)
                     self.connect(upload_bin, build_action)
 
         elif primitive == "install":
@@ -961,7 +969,7 @@ def schedule(self, resolver: ResolverType) -> DAG:
             for which a decision should be taken
         """
         rev = self.tree.reverse_graph(enable_checks=False)
-        uploads: list[tuple[Upload, frozenset[VertexID]]] = []
+        uploads: list[tuple[Upload | CheckVirus, frozenset[VertexID], bool]] = []
         dag = DAG()
 
         # Retrieve existing tags
@@ -981,8 +989,14 @@ def schedule(self, resolver: ResolverType) -> DAG:
                 # to apply the triggers based on the current list of scheduled
                 # actions.
                 action.apply_triggers(dag)
-            elif isinstance(action, Upload):
-                uploads.append((action, self.tree.get_predecessors(uid)))
+            elif isinstance(action, (Upload, CheckVirus)):
+                uploads.append(
+                    (
+                        action,
+                        self.tree.get_predecessors(uid),
+                        "root" in self.tree.get_successors(uid),
+                    )
+                )
             else:
                 if TYPE_CHECKING:
                     assert isinstance(action, Action)
@@ -1057,15 +1071,24 @@ def schedule(self, resolver: ResolverType) -> DAG:
                                 a, predecessors=[uid], enable_checks=False
                             )
 
-        # Handle Upload nodes. Add the node only if all predecessors
-        # are scheduled.
-        for action, predecessors in uploads:
-            if len([p for p in predecessors if p not in dag]) == 0:
+        # Handle uploads related nodes.
+        # Upload nodes were added to the uploads list from a reverse DAG, we
+        # have to reverse the list to have the correct sequence.
+        uploads.reverse()
+        for upload_action, predecessors, connect_to_root in uploads:
+            # Add the node only if all predecessors are scheduled.
+            p_not_in_dag = [p for p in predecessors if p not in dag]
+            if len(p_not_in_dag) == 0:
                 dag.update_vertex(
-                    action.uid, action, predecessors=predecessors, enable_checks=False
-                )
-                # connect upload to the root node
-                dag.update_vertex(
-                    "root", predecessors=[action.uid], enable_checks=False
+                    upload_action.uid,
+                    upload_action,
+                    predecessors=predecessors,
+                    enable_checks=False,
                 )
+                # Last action of the uploads should be connected to the dag's root.
+                if connect_to_root:
+                    dag.update_vertex(
+                        "root", predecessors=[upload_action.uid], enable_checks=False
+                    )
+
         return dag

tests/tests_e3/anod/action/main_test.py

@@ -83,6 +83,9 @@ class Spec(e3.anod.spec.Anod):
     upload_source = action.UploadSourceComponent(data=build_spec)
     assert str(upload_source).startswith("upload source metadata of ")
 
+    check_virus = action.CheckVirus(data=build_spec)
+    assert str(check_virus).startswith("check for viruses in ")
+
     a_decision = action.CreateSourceOrDownload(
         root=root, left=create_source, right=download_source
     )

tests/tests_e3/anod/context_test.py

@@ -137,14 +137,15 @@ def test_add_anod_action3(self):
         # declared
         ac = self.create_context()
         ac.add_anod_action("spec3", env=ac.default_env, primitive="build")
-        assert len(ac.tree) == 6, ac.tree.as_dot()
+        assert len(ac.tree) == 7, ac.tree.as_dot()
         result = ac.schedule(ac.always_download_source_resolver)
-        assert len(result) == 4, result.as_dot()
+        assert len(result) == 5, result.as_dot()
         assert set(result.vertex_data.keys()) == {
             "root",
             "x86-linux.spec3.build",
             "x86-linux.spec3.install",
             "x86-linux.spec3.upload_bin",
+            "x86-linux.spec3.check_virus",
         }
 
     def test_add_anod_action4(self):
@@ -153,14 +154,15 @@ def test_add_anod_action4(self):
         #   build primitive
         ac = self.create_context()
         ac.add_anod_action("spec4", env=ac.default_env, primitive="build")
-        assert len(ac.tree) == 6, ac.tree.as_dot()
+        assert len(ac.tree) == 7, ac.tree.as_dot()
         result = ac.schedule(ac.always_download_source_resolver)
-        assert len(result) == 4, result.as_dot()
+        assert len(result) == 5, result.as_dot()
         assert set(result.vertex_data.keys()) == {
             "root",
             "x86-linux.spec4.build",
             "x86-linux.spec4.install",
             "x86-linux.spec4.upload_bin",
+            "x86-linux.spec4.check_virus",
         }
 
     def test_add_anod_action4_2(self):