More commsdsl2wireshark unittests.

arobenko · arobenko · commit 271321e3f392 · 2026-05-26T09:24:28.000+10:00
diff --git a/app/commsdsl2comms/test/test47/Schema.xml b/app/commsdsl2comms/test/test47/Schema.xml
@@ -1,8 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<schema name="test47"
-        endian="big"
-        version="5">
-
+<schema name="test47" endian="big" version="5">
     <description>
         Testing platforms and extra bundles.
     </description>
diff --git a/app/commsdsl2wireshark/src/WiresharkDataField.cpp b/app/commsdsl2wireshark/src/WiresharkDataField.cpp
@@ -232,14 +232,12 @@ std::string WiresharkDataField::wiresharkDissectLengthCodeInternal() const
 
     if (m_prefixField != nullptr) {
         static const std::string Templ =
-            "local prefix_tree = #^#TREE#$#:add(#^#PROTO#$#, #^#TVB#$#(#^#NEXT_OFFSET#$#, 0))\n"
-            "prefix_tree:set_hidden(true)\n"
-            "#^#RESULT#$#, #^#NEXT_OFFSET#$# = #^#READ_FUNC#$#(#^#TVB#$#, prefix_tree, #^#NEXT_OFFSET#$#, #^#LIMIT#$#, #^#FIELD#$#)\n"
+            "#^#RESULT#$#, #^#NEXT_OFFSET#$# = #^#READ_FUNC#$#(#^#TVB#$#, #^#TREE#$#, #^#NEXT_OFFSET#$#, #^#LIMIT#$#)\n"
             "if #^#RESULT#$# ~= #^#SUCCESS#$# then\n"
             "    return #^#RESULT#$#\n"
             "end\n"
             "\n"
-            "local len = #^#VALUE_FUNC#$#(#^#FIELD#$#)"
+            "local len = #^#VALUE_FUNC#$#()"
             ;
 
         auto& wiresharkGenerator = WiresharkGenerator::wiresharkCast(genGenerator());
@@ -250,8 +248,7 @@ std::string WiresharkDataField::wiresharkDissectLengthCodeInternal() const
             {"TVB", wiresharkTvbStr()},
             {"TREE", wiresharkTreeStr()},
             {"LIMIT", wiresharkOffsetLimitStr()},
-            {"FIELD", m_prefixField->wiresharkFieldObjName()},
-            {"VALUE_FUNC", wiresharkValueFuncName()},
+            {"VALUE_FUNC", m_prefixField->wiresharkValueFuncName()},
             {"SUCCESS", Wireshark::wiresharkStatusCodeStr(wiresharkGenerator, Wireshark::WiresharkStatusCode::Success)},
             {"PROTO", Wireshark::wiresharkProtocolObjName(wiresharkGenerator)},
         };
diff --git a/app/commsdsl2wireshark/src/WiresharkField.cpp b/app/commsdsl2wireshark/src/WiresharkField.cpp
@@ -798,12 +798,11 @@ std::string WiresharkField::wiresharkDissectCodeImpl(const WiresharkField* refFi
     auto prependFileName = relPath + strings::genPrependFileSuffixStr();
     auto extendFileName = relPath + strings::genExtendFileSuffixStr();
 
-    bool replaced = false;
     bool extended = false;
     util::GenReplacementMap repl = {
         {"REG", wiresharkFieldRegistration(refField)},
         {"NAME", wiresharkDissectName(refField)},
-        {"REPLACE", wiresharkGenerator.genReadCodeInjectCode(replaceFileName, "Replace this function body", &replaced)},
+        {"REPLACE", m_customCode.m_read},
         {"PREPEND", wiresharkGenerator.genReadCodeInjectCode(prependFileName, "Prepend here")},
         {"EXTEND", wiresharkGenerator.genReadCodeInjectCode(extendFileName, "Extend function above", &extended)},
         {"NAME_VAR", wiresharkNameDefInternal(refField)},
@@ -816,7 +815,7 @@ std::string WiresharkField::wiresharkDissectCodeImpl(const WiresharkField* refFi
         repl["MEMBERS"] = wiresharkMembersDissectCodeImpl();
     }
 
-    if (!replaced) {
+    if (!m_customCode.m_hasRead) {
         repl["BODY"] = wiresharkDissectBodyInternal(refField);
     }
 
@@ -1033,16 +1032,15 @@ std::string WiresharkField::wiresharkValidFuncCodeImpl(const WiresharkField* ref
     auto replaceFileName = relPath + strings::genReplaceFileSuffixStr();
     auto extendFileName = relPath + strings::genExtendFileSuffixStr();
 
-    bool replaced = false;
     bool extended = false;
     util::GenReplacementMap repl = {
         {"NAME", wiresharkValidFuncName(refField)},
-        {"REPLACE", wiresharkGenerator.genReadCodeInjectCode(replaceFileName, "Replace this function body", &replaced)},
+        {"REPLACE", m_customCode.m_valid},
         {"EXTEND", wiresharkGenerator.genReadCodeInjectCode(extendFileName, "Extend function above", &extended)},
         {"FIELD", wiresharkFieldStr()},
     };
 
-    if (!replaced) {
+    if (!m_customCode.m_hasValid) {
         repl["BODY"] = wiresharkValidFuncBodyImpl(refField);
     }
 
@@ -1259,7 +1257,8 @@ bool WiresharkField::wiresharkHasOverrideCode() const
     return
         m_customCode.m_hasRead ||
         m_customCode.m_hasValid ||
-        m_customCode.m_hasName;
+        m_customCode.m_hasName ||
+        m_customCode.m_hasValue;
 }
 
 std::string WiresharkField::wiresharkDissectSignature()
@@ -1586,16 +1585,15 @@ std::string WiresharkField::wiresharkValueFuncCodeInternal(const WiresharkField*
     auto replaceFileName = relPath + strings::genReplaceFileSuffixStr();
     auto extendFileName = relPath + strings::genExtendFileSuffixStr();
 
-    bool replaced = false;
     bool extended = false;
     util::GenReplacementMap repl = {
         {"NAME", wiresharkValueFuncName(refField)},
-        {"REPLACE", wiresharkGenerator.genReadCodeInjectCode(replaceFileName, "Replace this function body", &replaced)},
+        {"REPLACE", m_customCode.m_value},
         {"EXTEND", wiresharkGenerator.genReadCodeInjectCode(extendFileName, "Extend function above", &extended)},
         {"FIELD", wiresharkFieldStr()},
     };
 
-    if (!replaced) {
+    if (!m_customCode.m_hasValue) {
         repl["BODY"] = wiresharkValueFuncBodyImpl(refField);
     }
 
diff --git a/app/commsdsl2wireshark/src/WiresharkIdLayer.cpp b/app/commsdsl2wireshark/src/WiresharkIdLayer.cpp
@@ -77,7 +77,12 @@ std::string WiresharkIdLayer::wiresharkExtraDissectCodeImpl() const
     DissectMap map;
     for (auto* m : messages) {
         auto& wiresharkMsg = WiresharkMessage::wiresharkCast(*m);
-        map[m->genParseObj().parseId()].push_back(wiresharkMsg.wiresharkDissectName());
+        auto dissectName = wiresharkMsg.wiresharkDissectName();
+        if (dissectName.empty()) {
+            continue;
+        }
+
+        map[m->genParseObj().parseId()].push_back(std::move(dissectName));
     }
 
     util::GenStringsList elems;
diff --git a/app/commsdsl2wireshark/src/WiresharkMessage.cpp b/app/commsdsl2wireshark/src/WiresharkMessage.cpp
@@ -42,6 +42,10 @@ WiresharkMessage::~WiresharkMessage() = default;
 
 std::string WiresharkMessage::wiresharkDissectName() const
 {
+    if (!genIsReferenced()) {
+        return strings::genEmptyString();
+    }
+
     auto& wiresharkGenerator = WiresharkGenerator::wiresharkCast(genGenerator());
     return wiresharkGenerator.wiresharkDissectNameFor(*this);
 }
diff --git a/app/commsdsl2wireshark/src/WiresharkStringField.cpp b/app/commsdsl2wireshark/src/WiresharkStringField.cpp
@@ -267,14 +267,12 @@ std::string WiresharkStringField::wiresharkDissectLengthCodeInternal() const
 
     if (m_prefixField != nullptr) {
         static const std::string Templ =
-            "local prefix_tree = #^#TREE#$#:add(#^#PROTO#$#, #^#TVB#$#(#^#NEXT_OFFSET#$#, 0))\n"
-            "prefix_tree:set_hidden(true)\n"
-            "#^#RESULT#$#, #^#NEXT_OFFSET#$# = #^#READ_FUNC#$#(#^#TVB#$#, prefix_tree, #^#NEXT_OFFSET#$#, #^#LIMIT#$#, #^#FIELD#$#)\n"
+            "#^#RESULT#$#, #^#NEXT_OFFSET#$# = #^#READ_FUNC#$#(#^#TVB#$#, #^#TREE#$#, #^#NEXT_OFFSET#$#, #^#LIMIT#$#)\n"
             "if #^#RESULT#$# ~= #^#SUCCESS#$# then\n"
             "    return #^#RESULT#$#\n"
             "end\n"
             "\n"
-            "local len = #^#VALUE_FUNC#$#(#^#FIELD#$#)"
+            "local len = #^#VALUE_FUNC#$#()"
             ;
 
         auto& wiresharkGenerator = WiresharkGenerator::wiresharkCast(genGenerator());
@@ -285,7 +283,6 @@ std::string WiresharkStringField::wiresharkDissectLengthCodeInternal() const
             {"TVB", wiresharkTvbStr()},
             {"TREE", wiresharkTreeStr()},
             {"LIMIT", wiresharkOffsetLimitStr()},
-            {"FIELD", m_prefixField->wiresharkFieldObjName()},
             {"VALUE_FUNC", m_prefixField->wiresharkValueFuncName()},
             {"SUCCESS", Wireshark::wiresharkStatusCodeStr(wiresharkGenerator, Wireshark::WiresharkStatusCode::Success)},
             {"PROTO", Wireshark::wiresharkProtocolObjName(wiresharkGenerator)},
diff --git a/app/commsdsl2wireshark/test/test18/src/test18.lua-test18_local.frame_TestFrame12Layers_Id_read.replace b/app/commsdsl2wireshark/test/test18/src/test18.lua-test18_local.frame_TestFrame12Layers_Id_read.replace
@@ -0,0 +1 @@
+-- TODO: implement custom read
diff --git a/app/commsdsl2wireshark/test/test18/src/test18.lua-test18_local.frame_TestFrame12Layers_Size_read.replace b/app/commsdsl2wireshark/test/test18/src/test18.lua-test18_local.frame_TestFrame12Layers_Size_read.replace
@@ -0,0 +1 @@
+-- TODO: implement custom read
diff --git a/app/commsdsl2wireshark/test/test47/commsdsl2wireshark.params b/app/commsdsl2wireshark/test/test47/commsdsl2wireshark.params
@@ -0,0 +1 @@
+--force-platform Plat1
diff --git a/app/commsdsl2wireshark/test/test47/test47.py b/app/commsdsl2wireshark/test/test47/test47.py
@@ -0,0 +1,24 @@
+import sys
+
+from commsdsl_pcap_gen import *
+
+def do_frame(id, payload):
+    prefix = struct.pack('>B', id)
+    return prefix + payload
+
+def pcap1(f):
+    seq = 1000
+    msg3_payload = struct.pack('')
+    msg3 = do_frame(3, msg3_payload)
+    msg4_payload = struct.pack('')
+    msg4 = do_frame(4, msg4_payload) # Expected invalid id
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg3) + len(msg4), seq)
+    commsdsl_write_packet(f, header + msg3 + msg4, time.time())
+
+def main():
+    with open(sys.argv[1], 'wb') as f:
+        commsdsl_write_pcap_header(f)
+        pcap1(f)
+
+if __name__ == '__main__':
+    main()
diff --git a/app/commsdsl2wireshark/test/test48/src/test48.lua-test48_local.field_Length2_value.replace b/app/commsdsl2wireshark/test/test48/src/test48.lua-test48_local.field_Length2_value.replace
@@ -1 +1 @@
--- TODO
+return test48_local.field_Length2Members_Len_value()
diff --git a/app/commsdsl2wireshark/test/test48/src/test48.lua-test48_local.field_Length3_value.replace b/app/commsdsl2wireshark/test/test48/src/test48.lua-test48_local.field_Length3_value.replace
@@ -1 +1 @@
--- TODO
+return test48_local.field_Length3Members_Len_value()
diff --git a/app/commsdsl2wireshark/test/test48/src/test48.lua-test48_local.field_Length_value.replace b/app/commsdsl2wireshark/test/test48/src/test48.lua-test48_local.field_Length_value.replace
@@ -1 +1,6 @@
--- TODO
+local short_val = test48_local.field_LengthMembers_Short_value()
+if short_val ~= 0xff then
+    return short_val;
+end
+
+return test48_local.field_LengthMembers_LongMembers_ActLong_value()
diff --git a/app/commsdsl2wireshark/test/test48/test48.py b/app/commsdsl2wireshark/test/test48/test48.py
@@ -0,0 +1,66 @@
+import sys
+
+from commsdsl_pcap_gen import *
+
+def do_frame_short(sync, size, id, payload):
+    prefix = struct.pack('>HBB', sync, size, id)
+    return prefix + payload
+
+def do_frame_long(sync, size, id, payload):
+    prefix = struct.pack('>HBHB', sync, 0xff, size, id)
+    return prefix + payload
+
+def pcap1(f):
+    seq = 1000
+    msg1_payload = struct.pack('>BBBBBH', 0, 1, 2, 1, 2, 3)
+    msg1 = do_frame_short(0xabcd, 1 + len(msg1_payload), 1, msg1_payload)
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg1), seq)
+    commsdsl_write_packet(f, header + msg1, time.time())
+
+def pcap2(f):
+    seq = 2000
+    msg2_payload = struct.pack('>BH3sB', 0xff, 3, b"bla", 0x11)
+    msg2 = do_frame_long(0xabcd, 1 + len(msg2_payload), 2, msg2_payload)
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg2), seq)
+    commsdsl_write_packet(f, header + msg2, time.time())
+
+def pcap3(f):
+    seq = 3000
+    msg3_payload = struct.pack('>B3s', 3, b"\x01\x02\x03")
+    msg3 = do_frame_long(0xabcd, 1 + len(msg3_payload), 3, msg3_payload)
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg3), seq)
+    commsdsl_write_packet(f, header + msg3, time.time())
+
+def pcap4(f):
+    seq = 4000
+    msg4_payload = struct.pack('>BHHH', 0xff, 4, 1, 2)
+    msg4 = do_frame_short(0xabcd, 1 + len(msg4_payload), 4, msg4_payload)
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg4), seq)
+    commsdsl_write_packet(f, header + msg4, time.time())
+
+def pcap5(f):
+    seq = 5000
+    msg5_payload = struct.pack('>HB3sBH3s', 10 | (0x1 << 14), 3, b"bla", 0xff, 3, b"abc")
+    msg5 = do_frame_long(0xabcd, 1 + len(msg5_payload), 5, msg5_payload)
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg5), seq)
+    commsdsl_write_packet(f, header + msg5, time.time())
+
+def pcap6(f):
+    seq = 6000
+    msg6_payload = struct.pack('>H3s', 3 | (0xf << 12), b"bla")
+    msg6 = do_frame_short(0xabcd, 1 + len(msg6_payload), 6, msg6_payload)
+    header = commsdsl_create_ethernet_ip_tcp_headers(len(msg6), seq)
+    commsdsl_write_packet(f, header + msg6, time.time())
+
+def main():
+    with open(sys.argv[1], 'wb') as f:
+        commsdsl_write_pcap_header(f)
+        pcap1(f)
+        pcap2(f)
+        pcap3(f)
+        pcap4(f)
+        pcap5(f)
+        pcap6(f)
+
+if __name__ == '__main__':
+    main()

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,10 @@ WiresharkMessage::~WiresharkMessage() = default;`
`42`	`42`
`43`	`43`	`std::string WiresharkMessage::wiresharkDissectName() const`
`44`	`44`	`{`
	`45`	`+ if (!genIsReferenced()) {`
	`46`	`+ return strings::genEmptyString();`
	`47`	`+ }`
	`48`	`+`
`45`	`49`	`auto& wiresharkGenerator = WiresharkGenerator::wiresharkCast(genGenerator());`
`46`	`50`	`return wiresharkGenerator.wiresharkDissectNameFor(*this);`
`47`	`51`	`}`