[convert] add delete_obsolete_ecus (fix for #434) (#438)

Author: ebroecker

src/canmatrix/canmatrix.py

@@ -1567,6 +1567,17 @@ def add_define_default(self, name, value):  # type: (str, typing.Any) -> None
         if name in self.global_defines:
             self.global_defines[name].set_default(value)
 
+    def delete_obsolete_ecus(self):  # type: () -> None
+        """Delete all unused ECUs
+        """
+        used_ecus = [ecu for f in self.frames for ecu in f.transmitters]
+        used_ecus += [ecu for f in self.frames for ecu in f.receivers]
+        used_ecus += [ecu for f in self.frames for s in f.signals for ecu in s.receivers]
+        used_ecus += [ecu for s in self.signals for ecu in s.receivers]
+        ecus_to_delete = [ecu.name for ecu in self.ecus if ecu.name not in used_ecus]
+        for ecu in ecus_to_delete:
+            self.del_ecu(ecu)
+
     def delete_obsolete_defines(self):  # type: () -> None
         """Delete all unused Defines.
 

src/canmatrix/cli/convert.py

@@ -55,6 +55,7 @@ def get_formats():
 # manipulation and filter switches
 @click.option('--deleteObsoleteDefines/--no-deleteObsoleteDefines', 'deleteObsoleteDefines', default=False, help="delete defines from all ECUs, frames and Signals\nExample --deleteObsoleteDefines")
 @click.option('--deleteEcu', 'deleteEcu', help="delete Ecu form databases. (comma separated list)\nSyntax: --deleteEcu=myEcu,mySecondEcu")
+@click.option('--deleteObsoleteEcus/--no-deleteObsoleteEcus', 'deleteObsoleteEcus', default=False, help="delete ECUs which are not references as transmitter or receiver\nExample --deleteObsoleteEcus")
 @click.option('--renameEcu', 'renameEcu', help="rename Ecu form databases. (comma separated list)\nSyntax: --renameEcu=myOldEcu:myNewEcu,mySecondEcu:mySecondNewEcu")
 @click.option('--deleteSignal', 'deleteSignal', help="delete Signal form databases. (comma separated list)\nSyntax: --deleteSignal=mySignal1,mySecondSignal")
 @click.option('--renameSignal', 'renameSignal', help="rename Signal form databases. (comma separated list)\nSyntax: --renameSignal=myOldSignal:myNewSignal,mySecondSignal:mySecondNewSignal")

src/canmatrix/convert.py

@@ -195,6 +195,10 @@ def convert(infile, out_file_name, **options):  # type: (str, str, **str) -> Non
                 'deleteObsoleteDefines']:
             db.delete_obsolete_defines()
 
+        if 'deleteObsoleteEcus' in options and options[
+                'deleteObsoleteEcus']:
+            db.delete_obsolete_ecus()
+
         if 'recalcDLC' in options and options['recalcDLC']:
             db.recalc_dlc(options['recalcDLC'])
 

src/canmatrix/tests/test_canmatrix.py

@@ -943,6 +943,21 @@ def test_canmatrix_del_ecu_by_instance(empty_matrix):
     assert empty_matrix.ecus == [ecu2]
 
 
+def test_canmatrix_del_obsolete_ecus(empty_matrix):
+    empty_matrix.add_ecu(canmatrix.Ecu(name="Ecu1"))
+    empty_matrix.add_ecu(canmatrix.Ecu(name="Ecu2"))
+    frame1 = canmatrix.Frame(name="frame1", transmitters=["Ecu1"])
+    frame1.add_signal(canmatrix.Signal("signal1", receivers=["Ecu2"]))
+    empty_matrix.add_frame(frame1)
+    empty_matrix.delete_obsolete_ecus()
+    assert "Ecu1" in [ecu.name for ecu in empty_matrix.ecus]
+    assert "Ecu2" in [ecu.name for ecu in empty_matrix.ecus]
+    frame1.del_transmitter("Ecu1")
+    empty_matrix.delete_obsolete_ecus()
+    assert "Ecu1" not in [ecu.name for ecu in empty_matrix.ecus]
+    assert "Ecu2" in [ecu.name for ecu in empty_matrix.ecus]
+
+
 def test_canmatrix_rename_frame_by_name(empty_matrix):
     f = canmatrix.Frame(name="F1")
     empty_matrix.add_frame(f)