Fixup exceptions and add test framework

Author: sveinse

.env

@@ -0,0 +1 @@
+PYTHONPATH=src

.gitignore

@@ -2,25 +2,23 @@
 *.code-workspace
 .vscode/
 *.egg-info/
+.pytest_cache/
 build/
-
 htmlcov/
 .coverage
 .pylintrc
-
-objdictgen.new
-objdictgen.mod
-objdictgen.orig
+tmp/
 
 *.pyc
 *.bak
 *.whl
 __*
 !__*__.py
-tmp/
-objdictgen2/
-mirror-canfestival-3-asc/
-od-*
 
+objdictgen.new
+objdictgen.mod
+objdictgen.orig
+mirror-canfestival-3-asc/
+od-*/
 runall*.sh
 results-*.diff

setup.py

@@ -155,7 +155,7 @@
     # projects.
     extras_require={  # Optional
         'dev': ['pylint', 'flake8', 'mypy', 'black'],
-        'test': ['pytest', 'coverage', 'pytest-cov'],
+        'test': ['pytest', 'coverage', 'pytest-cov', 'pytest-mock'],
     },
 
     # If there are data files included in your packages that need to be

src/objdictgen/__init__.py

@@ -0,0 +1,3 @@
+
+def dbg(msg):  # pylint: disable=unused-argument
+    print(">> %s" % (msg,))

src/objdictgen/commondialogs.py

@@ -31,6 +31,7 @@
 import wx.grid
 
 from . import node as nod
+from . import dbg
 
 ScriptDirectory = os.path.split(__file__)[0]
 
@@ -356,12 +357,12 @@ def OnOK(self, event):  # pylint: disable=unused-argument
         error = []
         try:
             int(self.Index.GetValue(), 16)
-        except Exception:
+        except ValueError:
             error.append("Index")
         if self.radioButton2.GetValue() or self.radioButton3.GetValue():
             try:
                 int(self.Number.GetValue())
-            except Exception:
+            except ValueError:
                 error.append("Number")
         if len(error) > 0:
             text = ""
@@ -545,16 +546,16 @@ def OnOK(self, event):  # pylint: disable=unused-argument
             if valuetype == 0:
                 try:
                     int(self.Min.GetValue(), 16)
-                except Exception:
+                except ValueError:
                     error.append("Minimum")
                 try:
                     int(self.Max.GetValue(), 16)
-                except Exception:
+                except ValueError:
                     error.append("Maximum")
             elif valuetype == 1:
                 try:
                     int(self.Length.GetValue(), 16)
-                except Exception:
+                except ValueError:
                     error.append("Length")
             if len(error) > 0:
                 message = ""
@@ -764,7 +765,7 @@ def OnOK(self, event):  # pylint: disable=unused-argument
         if message != "":
             try:
                 _ = int(self.NodeID.GetValue(), 16)
-            except Exception:
+            except ValueError:
                 message = "Node ID must be integer!"
         if message != "":
             message = wx.MessageDialog(self, message, "ERROR", wx.OK | wx.ICON_ERROR)
@@ -1040,7 +1041,7 @@ def OnOK(self, event):  # pylint: disable=unused-argument
         if message != "":
             try:
                 _ = int(self.NodeID.GetValue(), 16)
-            except Exception:
+            except ValueError:
                 message = "Node ID must be integer!"
         if message != "":
             message = wx.MessageDialog(self, message, "ERROR", wx.OK | wx.ICON_ERROR)
@@ -1229,7 +1230,7 @@ def OnOK(self, event):  # pylint: disable=unused-argument
                     nodeid = int(nodeid, 16)
                 else:
                     nodeid = int(nodeid)
-            except Exception:
+            except ValueError:
                 message = wx.MessageDialog(self, "Slave Node ID must be a value in decimal or hexadecimal!", "Error", wx.OK | wx.ICON_ERROR)
                 message.ShowModal()
                 message.Destroy()
@@ -1314,7 +1315,7 @@ def __init__(self, parent, data, colnames):
         self.data = data
         self.colnames = colnames
         self.Parent = parent
-        # XXX
+        # NOTE
         # we need to store the row length and col length to
         # see if the table has changed size
         self._rows = self.GetNumberRows()
@@ -1525,8 +1526,8 @@ def OnValuesGridCellChange(self, event):
         value = self.Table.GetValue(row, col)
         try:
             self.Values[row][colname] = int(value, 16)
-        except Exception:
-            message = wx.MessageDialog(self, "\"%s\" is not a valid value!" % value, "Error", wx.OK | wx.ICON_ERROR)
+        except ValueError:
+            message = wx.MessageDialog(self, "'%s' is not a valid value!" % value, "Error", wx.OK | wx.ICON_ERROR)
             message.ShowModal()
             message.Destroy()
         wx.CallAfter(self.RefreshValues)

src/objdictgen/eds_utils.py

@@ -89,19 +89,19 @@ def GetValidTypeInfos(typename, items=None):
             elif values[0] == "BOOLEAN":
                 typeinfos = ("UNS8", None, "boolean", False)
             else:
-                raise ValueError("""!!! %s isn't a valid type for CanFestival.""" % typename)
+                raise ValueError("""!!! '%s' isn't a valid type for CanFestival.""" % typename)
             if typeinfos[2] not in ["visible_string", "domain"]:
                 internal_types[typename] = typeinfos
         else:
-            raise ValueError("""!!! %s isn't a valid type for CanFestival.""" % typename)
+            raise ValueError("""!!! '%s' isn't a valid type for CanFestival.""" % typename)
     return typeinfos
 
 
 def ComputeValue(type_, value):
     if type_ == "visible_string":
-        return "\"%s\"" % value, ""
+        return '"%s"' % value, ""
     elif type_ == "domain":
-        return "\"%s\"" % ''.join(["\\x%2.2x" % ord(char) for char in value]), ""
+        return '"%s"' % ''.join(["\\x%2.2x" % ord(char) for char in value]), ""
     elif type_.startswith("real"):
         return "%f" % value, ""
     else:  # value is integer; make sure to handle negative numbers correctly
@@ -119,7 +119,7 @@ def WriteFile(filepath, content):
 def GetTypeName(node, typenumber):
     typename = node.GetTypeName(typenumber)
     if typename is None:
-        raise ValueError("""!!! Datatype with value "0x%4.4X" isn't defined in CanFestival.""" % typenumber)
+        raise ValueError("""!!! Datatype with value '0x%4.4X' isn't defined in CanFestival.""" % typenumber)
     return typename
 
 
@@ -220,7 +220,7 @@ def GenerateFileContent(node, headerfilepath, pointers_dict=None):
             typeinfos = GetValidTypeInfos(typename, [values])
             if typename == "DOMAIN" and index in variablelist:
                 if not typeinfos[1]:
-                    raise ValueError("\nDomain variable not initialized\nindex : 0x%04X\nsubindex : 0x00" % index)
+                    raise ValueError("Domain variable not initialized, index: 0x%04X, subindex: 0x00" % index)
             texts["subIndexType"] = typeinfos[0]
             if typeinfos[1] is not None:
                 if params_infos["buffer_size"] != "":
@@ -273,7 +273,7 @@ def GenerateFileContent(node, headerfilepath, pointers_dict=None):
                                 sep = ""
                             value, comment = ComputeValue(typeinfos[2], value)
                             if len(value) == 2 and typename == "DOMAIN":
-                                raise ValueError("\nDomain variable not initialized\nindex : 0x%04X\nsubindex : 0x%02X" % (index, subindex))
+                                raise ValueError("Domain variable not initialized, index : 0x%04X, subindex : 0x%02X" % (index, subindex))
                             mappedVariableContent += "    %s%s%s\n" % (value, sep, comment)
                     mappedVariableContent += "  };\n"
                 else:
@@ -671,4 +671,4 @@ def GenerateFile(filepath, node, pointers_dict=None):
         WriteFile(objectdefinitionheaderpath, header_defs)
         return None
     except ValueError as message:
-        return "Unable to Generate C File\n%s" % message
+        return "Unable to Generate C File: %s" % message

src/objdictgen/gen_cfile.py

@@ -38,9 +38,8 @@
 from .nodelist import NodeList
 from .nodemanager import NodeManager
 from .networkeditortemplate import NetworkEditorTemplate
+from . import dbg
 
-if sys.version_info[0] >= 3:
-    unicode = str  # pylint: disable=invalid-name
 
 __version__ = "$Revision: 1.27 $"
 

src/objdictgen/networkedit.py

@@ -39,8 +39,6 @@ def RefreshCurrentIndexList(self):
         if selected == 0:
             window = self.NetworkNodes.GetPage(selected)
             window.RefreshIndexList()
-        else:
-            pass
 
     def RefreshNetworkNodes(self):
         if self.NetworkNodes.GetPageCount() > 0:
@@ -61,7 +59,7 @@ def OnNodeSelectedChanged(self, event):
             if selected >= 0:
                 window = self.NetworkNodes.GetPage(selected)
                 self.NodeList.SetCurrentSelected(window.GetIndex())
-            wx.CallAfter(self.RefreshMainMenu)  # FIXME: Missing. Should be from where?
+            wx.CallAfter(self.RefreshMainMenu)  # FIXME: Missing symbol. From where?
             wx.CallAfter(self.RefreshStatusBar)
         event.Skip()
 

src/objdictgen/networkeditortemplate.py

@@ -32,18 +32,16 @@
 import sys
 import re
 import pickle
+from collections import OrderedDict
+from future.utils import raise_from
 
 from .nosis import pickle as nosis
+from . import dbg
 
 if sys.version_info[0] >= 3:
     unicode = str  # pylint: disable=invalid-name
 
 
-def dbg(s):  # pylint: disable=unused-argument
-    pass
-    # print(">> %s"% (s,))
-
-
 #
 # Dictionary of translation between access symbol and their signification
 #
@@ -431,7 +429,7 @@ def StringFormat(text, idx, sub):  # pylint: disable=unused-argument
     result = name_model.match(text)
     if result:
         fmt = result.groups()
-        # FIXME: Using eval is not good
+        # FIXME: Using eval is not safe
         dbg("EVAL in StringFormat(): '%s'" % (fmt[1],))
         return fmt[0] % eval(fmt[1])
     else:
@@ -761,9 +759,7 @@ def IsMappingEntry(self, index):
         """
         Check if an entry exists in the User Mapping Dictionary and returns the answer.
         """
-        if index in self.UserMapping:
-            return True
-        return False
+        return index in self.UserMapping
 
     def AddMappingEntry(self, index, subindex=None, name="Undefined", struct=0, size=None, nbmax=None, default=None, values=None):
         """
@@ -967,7 +963,7 @@ def CompileValue(self, value, index, compute=True):
         if isinstance(value, (str, unicode)) and value.upper().find("$NODEID") != -1:
             base = self.GetBaseIndex(index)  # NOTE: Don't change this, as the eval() below depend on it
             try:
-                # FIXME: Using eval is not good
+                # FIXME: Using eval is not safe
                 dbg("EVAL in CompileValue(): '%s'" % (value,))
                 raw = eval(value)
                 if compute:

src/objdictgen/node.py

@@ -27,8 +27,9 @@
 
 import os
 import shutil
+import errno
+from future.utils import raise_from
 
-from .node import Node
 from . import eds_utils
 
 
@@ -112,12 +113,12 @@ def LoadProject(self, root, netname=None):
 
         self.Root = root
         if not os.path.exists(self.Root):
-            return "\"%s\" folder doesn't exist" % self.Root
+            return "'%s' folder doesn't exist" % self.Root
 
         eds_folder = self.GetEDSFolder()
         if not os.path.exists(eds_folder):
             os.mkdir(eds_folder)
-            # return "\"%s\" folder doesn't contain a \"eds\" folder"%self.Root
+            # return "'%s' folder doesn't contain a 'eds' folder"%self.Root
 
         files = os.listdir(eds_folder)
         for file in files:
@@ -172,15 +173,15 @@ def AddSlaveNode(self, nodename, nodeid, eds):
             self.Changed = True
             return None
         else:
-            return "\"%s\" EDS file is not available" % eds
+            return "'%s' EDS file is not available" % eds
 
     def RemoveSlaveNode(self, index):
         if index in self.SlaveNodes:
             self.SlaveNodes.pop(index)
             self.Changed = True
             return None
         else:
-            return "Node with \"0x%2.2X\" ID doesn't exist"
+            return "Node with '0x%2.2X' ID doesn't exist"
 
     def LoadMasterNode(self, netname=None):
         if netname:
@@ -227,7 +228,7 @@ def LoadSlaveNodes(self, netname=None):
                                 return result
                 self.Changed = False
             except SyntaxError as message:
-                return "Unable to load CPJ file\n%s" % message
+                return "Unable to load CPJ file: %s" % message
         return None
 
     def SaveNodeList(self, netname=None):