changing some keys, so they do not contain blanks any more

adding fullSequence test to have a closed data flow from node/interface till formatted output

Author: juergenRe

meshtastic/formatter.py

@@ -76,7 +76,7 @@ def showMeshInfo(self, data: dict):
         owner = f"Owner: {data['Owner'][0]}({data['Owner'][1]})"
 
         myinfo = ""
-        if (dx := data.get('My Info', None)) is not None:
+        if (dx := data.get('MyInfo', None)) is not None:
             myinfo = f"My info: {json.dumps(dx)}"
 
         metadata = ""
@@ -93,7 +93,7 @@ def showNodeInfo(self, data: dict):
         if (dx := data.get('Preferences', None)) is not None:
             print(f"Preferences: {json.dumps(dx, indent=2)}")
 
-        if (dx := data.get('Module preferences', None)) is not None:
+        if (dx := data.get('ModulePreferences', None)) is not None:
             print(f"Module preferences: {json.dumps(dx, indent=2)}")
 
         if (dx := data.get('Channels', None)) is not None:

meshtastic/mesh_interface.py

@@ -197,13 +197,13 @@ def getInfo(self) -> dict:
         """retrieve object data"""
         objData: dict[str, Any] = {
             "Owner": [self.getLongName(), self.getShortName()],
-            "My Info": {},
+            "MyInfo": {},
             "Metadata": {},
             "Nodes": {}
         }
 
         if self.myInfo:
-            objData["My Info"] = MessageToDict(self.myInfo)
+            objData["MyInfo"] = MessageToDict(self.myInfo)
         if self.metadata:
             objData["Metadata"] = MessageToDict(self.metadata)
 

meshtastic/node.py

@@ -98,7 +98,7 @@ def getInfo(self) ->dict:
         if self.moduleConfig:
             modConfig = MessageToDict(self.moduleConfig)
         chanConfig = self.getChannelInfo()
-        info = {"Preferences": locConfig, "Module preferences": modConfig}
+        info = {"Preferences": locConfig, "ModulePreferences": modConfig}
         info.update(chanConfig)
         return info
 

meshtastic/tests/formatter-test-input/cfg1.json

@@ -3,7 +3,7 @@
     "Meshtastic Test",
     "MT"
   ],
-  "My Info": {
+  "MyInfo": {
     "myNodeNum": 1234,
     "minAppVersion": 30200,
     "deviceId": "S==",
@@ -72,7 +72,7 @@
       "ignoreMqtt": true
     }
   },
-  "Module preferences": {
+  "ModulePreferences": {
     "mqtt": {
       "address": "mqtt.meshtastic.org",
       "username": "meshdev",

meshtastic/tests/formatter-test-input/cfg2-OwnerOnly.json

@@ -3,10 +3,10 @@
     "Meshtastic Test",
     "MT"
   ],
-  "My Info": {},
+  "MyInfo": {},
   "Metadata": {},
   "Nodes": {},
   "Preferences": {},
-  "Module preferences": {},
+  "ModulePreferences": {},
   "Channels": []
 }

meshtastic/tests/formatter-test-input/cfg3-NoNodes.json

@@ -3,7 +3,7 @@
     "Meshtastic Test",
     "MT"
   ],
-  "My Info": {
+  "MyInfo": {
     "myNodeNum": 1234,
     "minAppVersion": 30200,
     "deviceId": "S==",
@@ -41,7 +41,7 @@
       "ignoreMqtt": true
     }
   },
-  "Module preferences": {
+  "ModulePreferences": {
     "mqtt": {
       "address": "mqtt.meshtastic.org",
       "username": "meshdev",

meshtastic/tests/formatter-test-input/cfg4-NoPrefs.json

@@ -3,7 +3,7 @@
     "Meshtastic Test",
     "MT"
   ],
-  "My Info": {
+  "MyInfo": {
     "myNodeNum": 1234,
     "minAppVersion": 30200,
     "deviceId": "S==",

meshtastic/tests/formatter-test-input/cfg5-NoChannels.json

@@ -3,7 +3,7 @@
     "Meshtastic Test",
     "MT"
   ],
-  "My Info": {
+  "MyInfo": {
     "myNodeNum": 1234,
     "minAppVersion": 30200,
     "deviceId": "S==",

meshtastic/tests/test_formatter.py

@@ -3,17 +3,23 @@
 import json
 from pathlib import Path
 import re
-from unittest.mock import MagicMock, patch
 
+from unittest.mock import MagicMock
 import pytest
 
 import meshtastic
-import meshtastic.formatter
-from meshtastic.formatter import FormatterFactory, AbstractFormatter, InfoFormatter
+# from meshtastic.formatter import FormatterFactory, AbstractFormatter, InfoFormatter
+from ..protobuf import config_pb2
+from ..formatter import FormatterFactory, AbstractFormatter, InfoFormatter
+from ..mesh_interface import MeshInterface
+try:
+    # Depends upon the powermon group, not installed by default
+    from ..slog import LogSet
+    from ..powermon import SimPowerSupply
+except ImportError:
+    pytest.skip("Can't import LogSet or SimPowerSupply", allow_module_level=True)
 
 
-# from ..formatter import FormatterFactory, FormatAsText
-
 def pskBytes(d):
     """Implement a hook to decode psk to byte as needed for the test"""
     if '__psk__' in d:
@@ -23,7 +29,7 @@ def pskBytes(d):
 
 @pytest.mark.unit
 def test_factory():
-    ff = meshtastic.formatter.FormatterFactory()
+    ff = FormatterFactory()
     assert len(ff.infoFormatters) > 0
 
     # test for at least default formatter which should be returned when passed an empty string
@@ -47,24 +53,24 @@ def test_factory():
 @pytest.mark.unit
 @pytest.mark.parametrize("inFile, expected", [
     ("cfg1.json", {
-        "len": 4161,
-        "keys": ["Owner", "My Info", "Metadata", "Nodes", "Preferences", "Module preferences", "Channels", "publicURL"]
+        "len": 4159,
+        "keys": ["Owner", "MyInfo", "Metadata", "Nodes", "Preferences", "ModulePreferences", "Channels", "publicURL"]
     }),
     ("cfg2-OwnerOnly.json", {
-        "len": 169,
-        "keys": ["Owner", "My Info", "Metadata", "Nodes", "Preferences", "Module preferences", "Channels"]
+        "len": 167,
+        "keys": ["Owner", "MyInfo", "Metadata", "Nodes", "Preferences", "ModulePreferences", "Channels"]
     }),
     ("cfg3-NoNodes.json", {
-        "len": 3413,
-        "keys": ["Owner", "My Info", "Metadata", "Preferences", "Module preferences", "Channels", "publicURL"]
+        "len": 3411,
+        "keys": ["Owner", "MyInfo", "Metadata", "Preferences", "ModulePreferences", "Channels", "publicURL"]
     }),
     ("cfg4-NoPrefs.json", {
-        "len": 2354,
-        "keys": ["Owner", "My Info", "Metadata", "Channels", "publicURL"]
+        "len": 2353,
+        "keys": ["Owner", "MyInfo", "Metadata", "Channels", "publicURL"]
     }),
     ("cfg5-NoChannels.json", {
-        "len": 597,
-        "keys": ["Owner", "My Info", "Metadata", "publicURL"]
+        "len": 596,
+        "keys": ["Owner", "MyInfo", "Metadata", "publicURL"]
     })
 ])
 def test_jsonFormatter(inFile, expected):
@@ -132,7 +138,7 @@ def test_ExceptionAbstractClass():
 
 @pytest.mark.unit
 @pytest.mark.parametrize("inCfg, expected", [
-    (("cfg1.json", 'json'), {"len": 4162}),
+    (("cfg1.json", 'json'), {"len": 4160}),
     (("cfg1.json", 'txt'), {"len": 2390}),
     (("cfg1.json", None), {"len": 2390})
     ])
@@ -145,3 +151,52 @@ def test_InfoFormatter(capsys, inCfg, expected):
 
     out, _ = capsys.readouterr()
     assert len(out) == expected['len']
+
+@pytest.mark.unit
+@pytest.mark.usefixtures("reset_mt_config")
+@pytest.mark.parametrize("inFmt, expected", [
+    ('json', {"len": 556, "keys": ["!9388f81c", "Unknown f81c", "44:17:93:88:f8:1c", "https://meshtastic.org/e/#EgA"]}),
+    ('txt', {"len": 539, "keys": ["!9388f81c", "Unknown f81c", "44:17:93:88:f8:1c", "https://meshtastic.org/e/#EgA"]}),
+    (None, {"len": 539, "keys": ["!9388f81c", "Unknown f81c", "44:17:93:88:f8:1c", "https://meshtastic.org/e/#EgA"]})
+    ])
+def test_fullSequenceTest(capsys, inFmt, expected):
+    """Test formatter when exporting data from an instantiated mesh interface
+    --> close the loop of data"""
+    iface = MeshInterface(noProto=True)
+
+    NODE_ID = "!9388f81c"
+    NODE_NUM = 2475227164
+    node = {
+            "num": NODE_NUM,
+            "user": {
+                "id": NODE_ID,
+                "longName": "Unknown f81c",
+                "shortName": "?1C",
+                "macaddr": "RBeTiPgc",
+                "hwModel": "TBEAM",
+            },
+            "position": {},
+            "lastHeard": 1640204888,
+        }
+
+    iface.nodes = {NODE_ID: node}
+    iface.nodesByNum = {NODE_NUM: node}
+
+    myInfo = MagicMock()
+    iface.myInfo = myInfo
+
+    iface.localNode.localConfig.lora.CopyFrom(config_pb2.Config.LoRaConfig())
+
+    # Also get some coverage of the structured logging/power meter stuff by turning it on as well
+    log_set = LogSet(iface, None, SimPowerSupply())
+
+    ifData = iface.getInfo()
+    ifData.update(iface.localNode.getInfo())
+    iface.close()
+    log_set.close()
+
+    InfoFormatter().format(ifData, inFmt)
+
+    out, _ = capsys.readouterr()
+    print(out)
+    assert len(out) == expected['len']

meshtastic/tests/test_mesh_interface.py

@@ -68,14 +68,14 @@ def test_MeshInterface(capsys):
     assert len(ifData.get('Owner', [])) == 2
     assert ifData['Owner'][0] is None
     assert ifData['Owner'][1] is None
-    assert 'My Info' in ifData.keys()
+    assert 'MyInfo' in ifData.keys()
     assert 'Metadata' in ifData.keys()
     assert 'Nodes' in ifData.keys()
     assert len(ifData['Nodes']) > 0
 
     # test node data
     assert 'Preferences' in nodeData.keys()
-    assert 'Module preferences' in nodeData.keys()
+    assert 'ModulePreferences' in nodeData.keys()
     assert 'Channels' in nodeData.keys()
     assert 'publicURL' in nodeData.keys()
     assert 'adminURL' in nodeData.keys()