Fixup bugs and add testing

Author: sveinse

src/objdictgen/__main__.py

@@ -283,6 +283,9 @@ def main(debugopts: DebugOpts, args: Sequence[str]|None = None):
         lines = list(format_diff_nodes(od1, od2, data=opts.data, raw=opts.raw,
                              internal=opts.internal, show=opts.show))
 
+        for line in lines:
+            print(line)
+
         errcode = 1 if lines else 0
         if errcode:
             print(f"{objdictgen.ODG_PROGRAM}: '{opts.od1}' and '{opts.od2}' differ")

src/objdictgen/jsonod.py

@@ -1409,7 +1409,7 @@ def diff(node1: Node, node2: Node, internal=False) -> TDiffNodes:
 
         # Simply diff the python data structure for the nodes
         diff = deepdiff.DeepDiff(node1.__dict__, node2.__dict__, exclude_paths=[
-            "root.IndexOrder"
+            "IndexOrder"
         ], view='tree')
 
     else:

src/objdictgen/printing.py

@@ -333,7 +333,8 @@ def _pprint(text: str, prefix: str = '        '):
             yield prefix + line
 
     for index in sorted(diffs):
-        yield f"{Fore.LIGHTYELLOW_EX}{index}{rst}"
+        if data or raw or internal:
+            yield f"{Fore.LIGHTYELLOW_EX}{index}{rst}"
         entries = diffs[index]
         for chtype, change, path in entries:
 
@@ -349,20 +350,24 @@ def _pprint(text: str, prefix: str = '        '):
                 yield f"<<      {ppath}only in {Fore.MAGENTA}LEFT{rst}"
                 if show:
                     yield from _pprint(change.t1, "        <   ")
+
             elif 'added' in chtype:
                 yield f"     >> {ppath}only in {Fore.BLUE}RIGHT{rst}"
                 if show:
                     yield from _pprint(change.t2, "        >   ")
+
             elif 'changed' in chtype:
                 yield f"<< - >> {ppath}changed value from '{Fore.GREEN}{change.t1}{rst}' to '{Fore.GREEN}{change.t2}{rst}'"
                 if show:
                     yield from _pprint(change.t1, "        <   ")
                     yield from _pprint(change.t2, "        >   ")
+
             elif 'type_changes' in chtype:
                 yield f"<< - >> {ppath}changed type and value from '{Fore.GREEN}{change.t1}{rst}' to '{Fore.GREEN}{change.t2}{rst}'"
                 if show:
                     yield from _pprint(change.t1, "        <   ")
                     yield from _pprint(change.t2, "        >   ")
+
             elif 'diff' in chtype:
                 start = path[0:2]
                 if start == '  ':
@@ -402,10 +407,10 @@ def text_diff(od1: Node, od2: Node, data_mode: bool=False) -> TDiffNodes:
         entry1: TIndexEntry = {}
         entry2: TIndexEntry = {}
         if index in keys1:
-            text1 = list(format_od_object(od1, index))
+            text1 = list(format_od_object(od1, index, unused=True))
             entry1 = od1.GetIndexEntry(index)
         if index in keys2:
-            text2 = list(format_od_object(od2, index))
+            text2 = list(format_od_object(od2, index, unused=True))
             entry2 = od2.GetIndexEntry(index)
 
         if data_mode:

tests/test_jsonod.py

@@ -1,9 +1,11 @@
+""" Test the jsonod module. """
 import re
 from pprint import pprint
 import datetime
 from freezegun import freeze_time
+import pytest
 from objdictgen import Node
-from objdictgen.jsonod import generate_jsonc, generate_node, remove_jsonc
+from objdictgen.jsonod import generate_jsonc, generate_node, remove_jsonc, diff
 from .test_odcompare import shave_equal
 
 
@@ -160,3 +162,21 @@ def test_jsonod_comments(odpath):
         if '"$date"' in a or '"$tool"' in a:
             continue
         assert a == b
+
+
+@pytest.mark.parametrize("filepair", [
+    ("slave-emcy.json", "slave-heartbeat.json"),
+])
+def test_jsonod_diff(odpath, filepair):
+    """ Test the diff function in the jsonod module. """
+
+    m1 = Node.LoadFile(odpath / filepair[0])
+    m2 = Node.LoadFile(odpath / filepair[1])
+
+    diffs = diff(m1, m2)
+
+    assert set(diffs.keys()) == {"Index 4116", "Index 4119", "Header fields"}
+
+    diffs = diff(m1, m2, internal=True)
+
+    assert set(diffs.keys()) == {"Dictionary", "Description"}

tests/test_utils.py

@@ -1,16 +1,16 @@
 """Test utils module."""
 
-import colorama
+from colorama import Fore, Style
 from objdictgen import utils
 
 
 def test_utils_remove_color():
     """Test remove_color function."""
     assert utils.remove_color("Hello, World!") == "Hello, World!"
 
-    assert utils.remove_color(colorama.Fore.RED + "Hello, World!") == "Hello, World!"
+    assert utils.remove_color(Fore.RED + "Hello, World!") == "Hello, World!"
 
-    assert utils.remove_color(colorama.Fore.RED + "Hello, World!" + colorama.Style.RESET_ALL) == "Hello, World!"
+    assert utils.remove_color(Fore.RED + "Hello, World!" + Style.RESET_ALL) == "Hello, World!"
 
 
 def test_utils_strip_brackets():
@@ -77,3 +77,40 @@ def test_utils_copy_in_order():
     assert utils.copy_in_order(d, ["b", "d"]) == {"b": 2, "a": 1, "c": 3}
 
     assert utils.copy_in_order(d, []) == d
+
+
+def test_utils_diff_colored_lines():
+    """Test diff_colored_lines function."""
+
+    lines1 = ["Hello", "World"]
+    lines2 = ["Hello", "World!"]
+
+    out = list(utils.diff_colored_lines(lines1, lines2))
+
+    assert out == ["  Hello", "- World", "+ World!" ]
+
+
+    lines1 = [f"{Fore.RED}Hello", f"{Fore.GREEN}World"]
+    lines2 = ["Hello", "World!"]
+
+    out = list(utils.diff_colored_lines(lines1, lines2))
+
+    assert out == [f"  {Fore.RED}Hello", f"- {Fore.GREEN}World", "+ World!" ]
+
+
+    lines1 = ["Hello", "World!"]
+    lines2 = [f"{Fore.RED}Hello", f"{Fore.GREEN}World"]
+
+    out = list(utils.diff_colored_lines(lines1, lines2))
+
+    assert out == [f"  {Fore.RED}Hello", "- World!", f"+ {Fore.GREEN}World" ]
+
+
+def test_utils_diff_highlight_changes():
+    """Test highlight_changes function."""
+
+    lines = ["  Hello", "- World", "+ Friend"]
+
+    out = list(utils.highlight_changes(lines))
+
+    assert out == ["  Hello", "- World", "? ^^ ^", "+ Friend", "? ^ ^^^"]