DBC Framework
DBC parsing and CAN signal decoding framework
Loading...
Searching...
No Matches
dbc_coverage_test.cpp
1// Additional regression coverage. Kept separate for review before the first run.
3#include "dbc_decoder.h"
4#include "dbc_parser.h"
5#include "dbc_statement_handler.h"
6#include "dbc_tree_builder.h"
7#include "typefactory.h"
8#include <QTemporaryFile>
9#include <QtTest>
10#include <array>
11#include <limits>
12#include <stdexcept>
13
14namespace {
15 DbcDatabase ParseText(const std::string &text) {
16 QTemporaryFile file;
17 if (!file.open()) throw std::runtime_error("Cannot create DBC fixture");
18 if (file.write(text.data(), static_cast<qint64>(text.size())) != static_cast<qint64>(text.size()) || !file.flush())
19 throw std::runtime_error("Cannot write DBC fixture");
20 return DbcParser().ParseFile(file.fileName().toStdString());
21 }
22
23 DecodeDatabase SingleSignal(const DecodeSignal &signal) {
24 DecodeFrame frame;
25 frame.canId = 17U;
26 frame.dlc = 16U;
27 frame.signals.push_back(signal);
28 return DecodeDatabase({frame});
29 }
30
31 // Independent reference: collect the visited bits first, then weight them.
32 // Motorola uses a linear MSB-first coordinate instead of sawtooth traversal.
33 std::uint64_t ReferenceExtract(const std::vector<std::uint8_t> &data,
34 ByteOrder order, unsigned start, unsigned length) {
35 std::uint64_t expected = 0;
36 for (unsigned i = 0; i < length; ++i) {
37 const unsigned coordinate = order == ByteOrder::Intel
38 ? start + i
39 : (start / 8U) * 8U + (7U - start % 8U) + i;
40 const unsigned bit = order == ByteOrder::Intel ? coordinate % 8U : 7U - coordinate % 8U;
41 const unsigned weight = order == ByteOrder::Intel ? i : length - 1U - i;
42 expected |= std::uint64_t((data.at(coordinate / 8U) >> bit) & 1U) << weight;
43 }
44 return expected;
45 }
46
47 struct FactoryBase {
48 virtual ~FactoryBase() = default;
49 virtual int Value() const = 0;
50 };
51 struct FactoryFirst : FactoryBase {
52 explicit FactoryFirst(std::unique_ptr<int> value) : value(std::move(value)) {}
53 int Value() const override { return *value; }
54 std::unique_ptr<int> value;
55 };
56 struct FactorySecond : FactoryFirst {
57 using FactoryFirst::FactoryFirst;
58 int Value() const override { return *value + 1; }
59 };
60}// namespace
61
62class CoverageTest : public QObject {
63 Q_OBJECT
64private Q_SLOTS:
65 void frameLookup();
66 void signedBoundaries_data();
67 void signedBoundaries();
68 void extraction_data();
69 void extraction();
70 void invalidSignalStatus_data();
71 void invalidSignalStatus();
72 void malformedRuntimeMultiplexing_data();
73 void malformedRuntimeMultiplexing();
74 void pgn_data();
75 void pgn();
76 void comments_data();
77 void comments();
78 void ignoredCommentStatements_data();
79 void ignoredCommentStatements();
80 void ambiguousValueReferences_data();
81 void ambiguousValueReferences();
82 void valueReferenceScope();
83 void fileFormatting_data();
84 void fileFormatting();
85 void missingFile();
86 void builders();
87 void physicalConversion_data();
88 void physicalConversion();
89 void multiplexingScenarios();
90 void multiplexingErrorLocations_data();
91 void multiplexingErrorLocations();
92 void escapedValueDescriptions();
93 void factory();
94};
95
96void CoverageTest::frameLookup() {
97 DbcDecoder decoder;
98 RawCanFrame raw;
99 raw.canId = 17U;
100 DecodeDatabase empty;
101 QVERIFY(decoder.FindFrame(empty, 17U, false) == nullptr);
102 const DecodedFrameValue absent = decoder.Decode(empty, raw);
103 QVERIFY(!absent.valid);
104 QVERIFY(absent.definition == nullptr);
105 QVERIFY(absent.signals.empty());
106 DecodeSignal signal;
107 signal.length = 8U;
108 DecodeDatabase database = SingleSignal(signal);
109 QVERIFY(decoder.FindFrame(database, 18U, false) == nullptr);
110 QVERIFY(decoder.FindFrame(database, 17U, true) == nullptr);
111 raw.isExtended = true;
112 QVERIFY(!decoder.Decode(database, raw).valid);
113 raw.isExtended = false;
114 raw.canId = 18U;
115 QVERIFY(!decoder.Decode(database, raw).valid);
116 raw.canId = 17U;
117 DecodeFrame noSignals;
118 noSignals.canId = 17U;
119 database = DecodeDatabase({noSignals});
120 const DecodedFrameValue matched = decoder.Decode(database, raw);
121 QVERIFY(matched.valid);
122 QCOMPARE(matched.definition.get(), &database.GetFrames()[0]);
123 QVERIFY(matched.signals.empty());
124}
125
126void CoverageTest::signedBoundaries_data() {
127 QTest::addColumn<int>("order");
128 QTest::addColumn<unsigned>("length");
129 QTest::addColumn<qlonglong>("expected");
130 for (int order = 0; order < 2; ++order) {
131 for (unsigned length: {1U, 2U, 7U, 8U, 31U, 32U, 63U}) {
132 const std::int64_t half = std::int64_t(1) << (length - 1U);
133 const std::array<std::int64_t, 4> values{{0, -1, -half, half - 1}};
134 for (unsigned index = 0; index < values.size(); ++index) {
135 const QByteArray name = QByteArray::number(order) + "-" + QByteArray::number(length) + "-" + QByteArray::number(index);
136 QTest::newRow(name.constData()) << order << length << qlonglong(values[index]);
137 }
138 }
139 }
140}
141
142void CoverageTest::signedBoundaries() {
143 QFETCH(int, order);
144 QFETCH(unsigned, length);
145 QFETCH(qlonglong, expected);
146 DecodeSignal signal;
147 signal.byteOrder = order == 0 ? ByteOrder::Intel : ByteOrder::Motorola;
148 signal.startBit = order == 0 ? 0U : 7U;
149 signal.length = length;
150 signal.valueType = ValueType::Signed;
151 RawCanFrame raw;
152 raw.canId = 17U;
153 raw.data.assign(8U, 0U);
154 const std::uint64_t bits = static_cast<std::uint64_t>(expected);
155 for (unsigned i = 0; i < length; ++i) {
156 const unsigned weight = order == 0 ? i : length - 1U - i;
157 const unsigned position = order == 0 ? i % 8U : 7U - i % 8U;
158 raw.data[i / 8U] |= static_cast<std::uint8_t>(((bits >> weight) & 1U) << position);
159 }
160 const DecodeDatabase database = SingleSignal(signal);
161 const DecodedFrameValue result = DbcDecoder().Decode(database, raw);
162 QVERIFY(result.signals[0].valid);
163 QVERIFY(std::holds_alternative<std::int64_t>(result.signals[0].rawValue));
164 QCOMPARE(std::get<std::int64_t>(result.signals[0].rawValue), static_cast<std::int64_t>(expected));
165}
166
167void CoverageTest::extraction_data() {
168 QTest::addColumn<int>("order");
169 QTest::addColumn<unsigned>("start");
170 QTest::addColumn<unsigned>("length");
171 for (int order = 0; order < 2; ++order)
172 for (unsigned start = 0; start < 16U; ++start)
173 for (unsigned length = 1; length <= 64U; ++length) {
174 const QByteArray name = QByteArray::number(order) + "-" + QByteArray::number(start) + "-" + QByteArray::number(length);
175 QTest::newRow(name.constData()) << order << start << length;
176 }
177}
178
179void CoverageTest::extraction() {
180 QFETCH(int, order);
181 QFETCH(unsigned, start);
182 QFETCH(unsigned, length);
183 DecodeSignal signal;
184 signal.byteOrder = order == 0 ? ByteOrder::Intel : ByteOrder::Motorola;
185 signal.startBit = start;
186 signal.length = length;
187 const DecodeDatabase database = SingleSignal(signal);
188 RawCanFrame raw;
189 raw.canId = 17U;
190 const std::vector<std::vector<std::uint8_t>> patterns = {
191 std::vector<std::uint8_t>(10U, 0U),
192 std::vector<std::uint8_t>(10U, 255U),
193 {0xA5, 0x3C, 0x81, 0x7E, 0x12, 0xD4, 0x69, 0xB0, 0x5A, 0xC3}};
194 for (const std::vector<std::uint8_t> &data: patterns) {
195 raw.data = data;
196 const unsigned firstCoordinate = order == 0 ? start : (start / 8U) * 8U + 7U - start % 8U;
197 raw.data.resize((firstCoordinate + length + 7U) / 8U);
198 const DecodedFrameValue decoded = DbcDecoder().Decode(database, raw);
199 QVERIFY(decoded.signals[0].valid);
200 QCOMPARE(std::get<std::uint64_t>(decoded.signals[0].rawValue), ReferenceExtract(data, signal.byteOrder, start, length));
201 }
202}
203
204void CoverageTest::invalidSignalStatus_data() {
205 QTest::addColumn<int>("order");
206 QTest::addColumn<unsigned>("start");
207 QTest::addColumn<unsigned>("length");
208 QTest::addColumn<unsigned>("bytes");
209 QTest::addColumn<int>("status");
210 for (int order = 0; order < 2; ++order) {
211 const unsigned start = order == 0 ? 0U : 7U;
212 const QByteArray prefix = QByteArray::number(order);
213 QTest::newRow((prefix + "-zero").constData()) << order << start << 0U << 1U << int(SignalDecodeStatus::InvalidDefinition);
214 QTest::newRow((prefix + "-65").constData()) << order << start << 65U << 9U << int(SignalDecodeStatus::InvalidDefinition);
215 QTest::newRow((prefix + "-empty").constData()) << order << start << 8U << 0U << int(SignalDecodeStatus::InsufficientPayload);
216 QTest::newRow((prefix + "-short").constData()) << order << start << 16U << 1U << int(SignalDecodeStatus::InsufficientPayload);
217 QTest::newRow((prefix + "-large-start").constData()) << order << std::numeric_limits<unsigned>::max() << 8U << 1U << int(SignalDecodeStatus::InvalidDefinition);
218 }
219}
220
221void CoverageTest::invalidSignalStatus() {
222 QFETCH(int, order);
223 QFETCH(unsigned, start);
224 QFETCH(unsigned, length);
225 QFETCH(unsigned, bytes);
226 QFETCH(int, status);
227 DecodeSignal signal;
228 signal.startBit = start;
229 signal.length = length;
230 signal.byteOrder = order == 0 ? ByteOrder::Intel : ByteOrder::Motorola;
231 if (status == int(SignalDecodeStatus::InvalidDefinition)) {
232 QVERIFY_THROWS_EXCEPTION(std::invalid_argument, (void) SingleSignal(signal));
233 return;
234 }
235 const DecodeDatabase database = SingleSignal(signal);
236 RawCanFrame raw;
237 raw.canId = 17U;
238 raw.data.assign(bytes, 255U);
239 const DecodedFrameValue decoded = DbcDecoder().Decode(database, raw);
240 QVERIFY(decoded.valid);
241 QVERIFY(!decoded.signals[0].valid);
242 QCOMPARE(int(decoded.signals[0].status), status);
243 QVERIFY(decoded.signals[0].GetValueDescription() == nullptr);
244}
245
246void CoverageTest::malformedRuntimeMultiplexing_data() {
247 QTest::addColumn<int>("kind");
248 QTest::newRow("two-selectors") << 0;
249 QTest::newRow("signed-selector") << 1;
250 QTest::newRow("65-bit-selector") << 2;
251 QTest::newRow("branch-out-of-range") << 3;
252}
253
254void CoverageTest::malformedRuntimeMultiplexing() {
255 QFETCH(int, kind);
256 DecodeSignal selector;
257 selector.length = 1U;
258 selector.multiplexing.role = MultiplexRole::Selector;
259 selector.name = "Selector";
260 std::vector<DecodeFrame> definitions = SingleSignal(selector).GetFrames();
261 DecodeSignal branch;
262 branch.name = "Branch";
263 branch.startBit = 8U;
264 branch.length = 8U;
265 branch.multiplexing.role = MultiplexRole::Branch;
266 branch.multiplexing.value = 1U;
267 definitions[0].signals.push_back(branch);
268 DecodeSignal ordinary;
269 ordinary.name = "Ordinary";
270 ordinary.startBit = 16U;
271 ordinary.length = 8U;
272 definitions[0].signals.push_back(ordinary);
273 if (kind == 0) {
274 selector.name = "SecondSelector";
275 definitions[0].signals.push_back(selector);
276 }
277 if (kind == 1) definitions[0].signals[0].valueType = ValueType::Signed;
278 if (kind == 2) definitions[0].signals[0].length = 65U;
279 if (kind == 3) definitions[0].signals[1].multiplexing.value = 2U;
280 QVERIFY_THROWS_EXCEPTION(std::invalid_argument, (void) DecodeDatabase(definitions));
281}
282
283void CoverageTest::pgn_data() {
284 QTest::addColumn<unsigned>("id");
285 QTest::addColumn<unsigned>("expected");
286 QTest::addColumn<bool>("hasPgn");
287 QTest::newRow("standard") << 0x7FFU << 0U << false;
288 for (unsigned dp: {0U, 1U})
289 for (unsigned pf: {239U, 240U})
290 for (unsigned ps: {0U, 0xABU}) {
291 const unsigned id = 0x80000000U | (dp << 24U) | (pf << 16U) | (ps << 8U) | 0x42U;
292 const unsigned expected = (dp << 16U) | (pf == 239U ? 0xEF00U : 0xF000U | ps);
293 const QByteArray name = QByteArray::number(dp) + "-" + QByteArray::number(pf) + "-" + QByteArray::number(ps);
294 QTest::newRow(name.constData()) << id << expected << true;
295 }
296}
297
298void CoverageTest::pgn() {
299 QFETCH(unsigned, id);
300 QFETCH(unsigned, expected);
301 QFETCH(bool, hasPgn);
302 const DbcDatabase parsed = ParseText("BO_ " + std::to_string(id) + " Frame: 8 ECU\n");
303 QCOMPARE(parsed.frames[0].hasPgn, hasPgn);
304 QCOMPARE(parsed.frames[0].pgn, expected);
305}
306
307void CoverageTest::comments_data() {
308 QTest::addColumn<QString>("before");
309 QTest::addColumn<QString>("after");
310 QTest::addColumn<QString>("frameComment");
311 QTest::addColumn<QString>("signalComment");
312 QTest::newRow("tabs") << QString::fromUtf8("") << QString::fromUtf8("CM_\tBO_ 1 \"Frame\";\nCM_\tSG_ 1 State \"Signal\";\n") << QString::fromUtf8("Frame") << QString::fromUtf8("Signal");
313 QTest::newRow("empty-overwrite") << QString::fromUtf8("") << QString::fromUtf8("CM_ BO_ 1 \"Old\";\nCM_ BO_ 1 \"\";\nCM_ SG_ 1 State \"Old\";\nCM_ SG_ 1 State \"\";\n") << QString::fromUtf8("") << QString::fromUtf8("");
314 QTest::newRow("last-wins") << QString::fromUtf8("") << QString::fromUtf8("CM_ BO_ 1 \"First\";\nCM_ BO_ 1 \"Last\";\nCM_ SG_ 1 State \"First\";\nCM_ SG_ 1 State \"Last\";\n") << QString::fromUtf8("Last") << QString::fromUtf8("Last");
315 QTest::newRow("missing-targets") << QString::fromUtf8("") << QString::fromUtf8("CM_ BO_ 2 \"Unknown\";\nCM_ SG_ 2 State \"Unknown\";\nCM_ SG_ 1 Missing \"Unknown\";\n") << QString::fromUtf8("") << QString::fromUtf8("");
316 // Current documented limitation: comments resolve only already parsed targets.
317 QTest::newRow("before-definitions") << QString::fromUtf8("CM_ BO_ 1 \"Early\";\nCM_ SG_ 1 State \"Early\";\n") << QString::fromUtf8("") << QString::fromUtf8("") << QString::fromUtf8("");
318 QTest::newRow("missing-quotes") << QString::fromUtf8("") << QString::fromUtf8("CM_ BO_ 1 Missing;\nCM_ SG_ 1 State \"Unclosed;\n") << QString::fromUtf8("") << QString::fromUtf8("");
319}
320
321void CoverageTest::comments() {
322 QFETCH(QString, before);
323 QFETCH(QString, after);
324 QFETCH(QString, frameComment);
325 QFETCH(QString, signalComment);
326 const DbcDatabase parsed = ParseText(before.toStdString() + "BO_ 1 Frame: 1 ECU\nSG_ State : 0|8@1+ (1,0) [0|255] \"\" ECU\n" + after.toStdString());
327 QCOMPARE(parsed.frames[0].comment, frameComment.toStdString());
328 QCOMPARE(parsed.frames[0].signals[0].comment, signalComment.toStdString());
329}
330
331void CoverageTest::ignoredCommentStatements_data() {
332 QTest::addColumn<QString>("statement");
333 QTest::newRow("empty") << QString();
334 QTest::newRow("wrong-keyword") << QStringLiteral("OTHER_ BO_ 1 \"Ignored\";");
335 QTest::newRow("keyword-prefix") << QStringLiteral("CM_OTHER BO_ 1 \"Ignored\";");
336 QTest::newRow("frame-without-cm") << QStringLiteral("BO_ 1 \"Ignored\";");
337 QTest::newRow("missing-subtype") << QStringLiteral("CM_");
338 QTest::newRow("global-comment") << QStringLiteral("CM_ \"Ignored\";");
339 QTest::newRow("node-comment") << QStringLiteral("CM_ BU_ ECU \"Ignored\";");
340 QTest::newRow("environment-comment") << QStringLiteral("CM_ EV_ State \"Ignored\";");
341 QTest::newRow("unknown-subtype") << QStringLiteral("CM_ OTHER_ 1 \"Ignored\";");
342}
343
344void CoverageTest::ignoredCommentStatements() {
345 QFETCH(QString, statement);
346 DbcDatabase database;
347 FrameInfo frame;
348 frame.canId = 1U;
349 frame.name = "Frame";
350 frame.comment = "Existing frame comment";
351 SignalInfo signal;
352 signal.name = "State";
353 signal.comment = "Existing signal comment";
354 frame.signals.push_back(signal);
355 database.frames.push_back(frame);
356 DbcParseContext context{database, &database.frames[0]};
357
358 // The handler is public: callers may bypass keyword dispatch. Ignored input
359 // must preserve existing metadata, including comments already assigned.
360 DbcCommentHandler().Handle(statement.toStdString(), context);
361 QCOMPARE(database.frames.size(), std::size_t(1));
362 QCOMPARE(database.frames[0].canId, 1U);
363 QCOMPARE(database.frames[0].name, frame.name);
364 QCOMPARE(database.frames[0].comment, frame.comment);
365 QCOMPARE(database.frames[0].signals.size(), std::size_t(1));
366 QCOMPARE(database.frames[0].signals[0].name, signal.name);
367 QCOMPARE(database.frames[0].signals[0].comment, signal.comment);
368 QCOMPARE(context.currentFrame, &database.frames[0]);
369}
370
371void CoverageTest::ambiguousValueReferences_data() {
372 QTest::addColumn<bool>("duplicateFrames");
373 QTest::addColumn<bool>("extended");
374 QTest::newRow("duplicate-standard-frames") << true << false;
375 QTest::newRow("duplicate-extended-frames") << true << true;
376 QTest::newRow("duplicate-signals-in-standard-frame") << false << false;
377 QTest::newRow("duplicate-signals-in-extended-frame") << false << true;
378}
379
380void CoverageTest::ambiguousValueReferences() {
381 QFETCH(bool, duplicateFrames);
382 QFETCH(bool, extended);
383 DbcDatabase database;
384 FrameInfo frame;
385 frame.canId = 1U;
386 frame.name = "Frame";
387 frame.isExtended = extended;
388 SignalInfo signal;
389 signal.name = "State";
390 frame.signals.push_back(signal);
391 if (!duplicateFrames) frame.signals.push_back(signal);
392 database.frames.push_back(frame);
393 if (duplicateFrames) database.frames.push_back(frame);
394
395 // ParseFile rejects duplicate definitions earlier. Construct the database
396 // through the public metadata API to exercise the resolver's own checks.
397 DbcParseContext context{database, nullptr};
398 context.lineNumber = 37U;
399 const std::string rawId = extended ? "2147483649" : "1";
400 DbcValueDescriptionHandler().Handle("VAL_ " + rawId + " State 0 \"Off\";", context);
401 QCOMPARE(context.pendingValues.size(), std::size_t(1));
402 QCOMPARE(context.pendingValues[0].lineNumber, std::size_t(37));
403 const std::string path = "manual database.dbc";
404 try {
405 context.ResolveValueDescriptions(path);
406 QFAIL("The resolver must reject an ambiguous target");
407 } catch (const std::runtime_error &error) {
408 const std::string message = duplicateFrames ? "Ambiguous VAL_ frame reference."
409 : "Ambiguous VAL_ signal reference: State";
410 QCOMPARE(std::string(error.what()), path + ":37: " + message);
411 }
412 // Ambiguity must be detected before applying any descriptions.
413 for (const FrameInfo &candidate: database.frames)
414 for (const SignalInfo &candidateSignal: candidate.signals)
415 QVERIFY(candidateSignal.valueDescriptions.empty());
416}
417
418void CoverageTest::valueReferenceScope() {
419 DbcDatabase database;
420 FrameInfo frame;
421 frame.canId = 1U;
422 SignalInfo signal;
423 signal.name = "State";
424 frame.signals.push_back(signal);
425 database.frames.push_back(frame);
426 frame.isExtended = true;
427 database.frames.push_back(frame);
428 frame.canId = 2U;
429 frame.isExtended = false;
430 database.frames.push_back(frame);
431
432 DbcParseContext context{database, nullptr};
433 const DbcValueDescriptionHandler handler;
434 context.lineNumber = 3U;
435 handler.Handle("VAL_ 1 State 0 \"Standard\";", context);
436 context.lineNumber = 7U;
437 handler.Handle("VAL_ 2147483649 State 0 \"Extended\";", context);
438 context.ResolveValueDescriptions("manual database.dbc");
439
440 const std::string *standard = FindValueDescription(database.frames[0].signals[0].valueDescriptions, std::uint64_t(0));
441 const std::string *extended = FindValueDescription(database.frames[1].signals[0].valueDescriptions, std::uint64_t(0));
442 QVERIFY(standard != nullptr);
443 QVERIFY(extended != nullptr);
444 QCOMPARE(*standard, std::string("Standard"));
445 QCOMPARE(*extended, std::string("Extended"));
446 QVERIFY(database.frames[2].signals[0].valueDescriptions.empty());
447}
448
449void CoverageTest::fileFormatting_data() {
450 QTest::addColumn<QString>("text");
451 QTest::addColumn<unsigned>("frames");
452 QTest::newRow("empty") << QString::fromUtf8("") << 0U;
453 QTest::newRow("whitespace") << QString::fromUtf8(" \t\r\n\n\t") << 0U;
454 QTest::newRow("unknown-only") << QString::fromUtf8("VERSION \"test\"\nBU_: ECU\nUNKNOWN_ data\n") << 0U;
455 QTest::newRow("no-final-newline") << QString::fromUtf8("BO_ 1 Frame: 1 ECU\nSG_ State : 0|8@1+ (1,0) [0|255] \"\" ECU") << 1U;
456 QTest::newRow("crlf") << QString::fromUtf8("\r\nBO_ 1 Frame: 1 ECU\r\nSG_ State : 0|8@1+ (1,0) [0|255] \"\" ECU\r\nCM_ BO_ 1 \"Comment\";\r\nVAL_ 1 State 0 \"Off\";\r\n") << 1U;
457}
458
459void CoverageTest::fileFormatting() {
460 QFETCH(QString, text);
461 QFETCH(unsigned, frames);
462 const DbcDatabase parsed = ParseText(text.toStdString());
463 QCOMPARE(parsed.frames.size(), std::size_t(frames));
464 if (frames) {
465 QCOMPARE(parsed.frames[0].signals.size(), std::size_t(1));
466 if (text.contains("\r\nBO_")) {
467 QCOMPARE(parsed.frames[0].comment, std::string("Comment"));
468 const std::string *description = FindValueDescription(parsed.frames[0].signals[0].valueDescriptions, std::uint64_t(0));
469 QVERIFY(description != nullptr);
470 QCOMPARE(*description, std::string("Off"));
471 }
472 }
473}
474
475void CoverageTest::missingFile() {
476 QTemporaryFile file;
477 QVERIFY(file.open());
478 const QString path = file.fileName();
479 QVERIFY(file.remove());
480 try {
481 DbcParser().ParseFile(path.toStdString());
482 QFAIL("Missing file must throw");
483 } catch (const std::runtime_error &error) {
484 QCOMPARE(std::string(error.what()), "Failed to open DBC file: " + path.toStdString());
485 }
486}
487
488void CoverageTest::builders() {
489 const DecodeDatabase emptyRuntime = DbcDecodeBuilder().Build(DbcDatabase());
490 QVERIFY(emptyRuntime.GetFrames().empty());
491 QVERIFY(!emptyRuntime.FindFrame(FrameKey(0U, false)));
492 const std::unique_ptr<TreeNode> emptyTree = DbcTreeBuilder().Build(DbcDatabase());
493 QCOMPARE(emptyTree->GetType(), NodeType::Root);
494 QCOMPARE(emptyTree->GetName(), std::string("dbc"));
495 QCOMPARE(emptyTree->GetChildCount(), std::size_t(0));
496 QVERIFY(emptyTree->GetFrame() == nullptr && emptyTree->GetSignal() == nullptr);
497 const DbcDatabase expected = ParseText(
498 "BO_ 256 Standard: 3 ECU1\n"
499 "SG_ Mode M : 0|8@1+ (2,3) [0|513] \"mode\" ECU1,ECU2\n"
500 "SG_ Branch m1 : 15|8@0- (-2,5) [-249|261] \"rpm\" ECU2,ECU3\n"
501 "SG_ Always : 16|8@1+ (0.25,-1) [-1|62.75] \"V\" ECU3\n"
502 "CM_ BO_ 256 \"Frame comment\";\nCM_ SG_ 256 Branch \"Branch comment\";\n"
503 "VAL_ 256 Branch -1 \"Negative\" 1 \"Positive\";\n"
504 "BO_ 2163212866 Extended: 8 ECU4\n");
505 DecodeDatabase runtime;
506 std::unique_ptr<TreeNode> tree;
507 {
508 DbcDatabase source = expected;
509 runtime = DbcDecodeBuilder().Build(source);
510 tree = DbcTreeBuilder().Build(source);
511 source.frames[0].name = "Changed";
512 source.frames[0].signals[1].receivers.clear();
513 source.frames[0].signals[1].valueDescriptions.clear();
514 source.frames.clear();
515 }
516 QCOMPARE(runtime.GetFrames().size(), expected.frames.size());
517 QCOMPARE(tree->GetChildCount(), expected.frames.size());
518 for (std::size_t i = 0; i < expected.frames.size(); ++i) {
519 const FrameInfo &frame = expected.frames[i];
520 const DecodeFrame &decodedFrame = runtime.GetFrames()[i];
521 const TreeNode *node = tree->GetChild(i);
522 QVERIFY(node && node->GetFrame());
523 QCOMPARE(node->GetType(), NodeType::Frame);
524 QCOMPARE(node->GetName(), frame.name);
525 QVERIFY(node->GetSignal() == nullptr);
526 QCOMPARE(runtime.FindFrame(FrameKey(frame.canId, frame.isExtended)).get(), &decodedFrame);
527 const FrameInfo &copied = *node->GetFrame();
528 QCOMPARE(copied.name, frame.name);
529 QCOMPARE(decodedFrame.name, frame.name);
530 QCOMPARE(copied.canId, frame.canId);
531 QCOMPARE(decodedFrame.canId, frame.canId);
532 QCOMPARE(copied.isExtended, frame.isExtended);
533 QCOMPARE(decodedFrame.isExtended, frame.isExtended);
534 QCOMPARE(copied.dlc, frame.dlc);
535 QCOMPARE(decodedFrame.dlc, frame.dlc);
536 QCOMPARE(copied.pgn, frame.pgn);
537 QCOMPARE(decodedFrame.pgn, frame.pgn);
538 QCOMPARE(copied.hasPgn, frame.hasPgn);
539 QCOMPARE(decodedFrame.hasPgn, frame.hasPgn);
540 QCOMPARE(copied.transmitter, frame.transmitter);
541 QCOMPARE(decodedFrame.transmitter, frame.transmitter);
542 QCOMPARE(copied.comment, frame.comment);
543 QCOMPARE(decodedFrame.comment, frame.comment);
544 QCOMPARE(node->GetChildCount(), frame.signals.size());
545 QCOMPARE(copied.signals.size(), frame.signals.size());
546 QCOMPARE(decodedFrame.signals.size(), frame.signals.size());
547 for (std::size_t j = 0; j < frame.signals.size(); ++j) {
548 const SignalInfo &original = frame.signals[j];
549 const DecodeSignal &target = decodedFrame.signals[j];
550 const TreeNode *leaf = node->GetChild(j);
551 QVERIFY(leaf && leaf->GetSignal());
552 QCOMPARE(leaf->GetType(), NodeType::Signal);
553 QCOMPARE(leaf->GetName(), original.name);
554 QVERIFY(leaf->GetFrame() == nullptr);
555 // Check both the frame payload copy and each child payload copy.
556 for (const SignalInfo *copy: {&copied.signals[j], leaf->GetSignal()}) {
557 QCOMPARE(copy->name, original.name);
558 QCOMPARE(copy->startBit, original.startBit);
559 QCOMPARE(copy->length, original.length);
560 QCOMPARE(copy->isLittleEndian, original.isLittleEndian);
561 QCOMPARE(copy->isSigned, original.isSigned);
562 QCOMPARE(copy->factor, original.factor);
563 QCOMPARE(copy->offset, original.offset);
564 QCOMPARE(copy->minimum, original.minimum);
565 QCOMPARE(copy->maximum, original.maximum);
566 QCOMPARE(copy->unit, original.unit);
567 QCOMPARE(copy->comment, original.comment);
568 QVERIFY(copy->receivers == original.receivers);
569 QVERIFY(copy->valueDescriptions == original.valueDescriptions);
570 QCOMPARE(copy->multiplexing.role, original.multiplexing.role);
571 QCOMPARE(copy->multiplexing.value, original.multiplexing.value);
572 }
573 QCOMPARE(target.name, original.name);
574 QCOMPARE(target.startBit, original.startBit);
575 QCOMPARE(target.length, original.length);
576 QCOMPARE(target.byteOrder, original.isLittleEndian ? ByteOrder::Intel : ByteOrder::Motorola);
577 QCOMPARE(target.valueType, original.isSigned ? ValueType::Signed : ValueType::Unsigned);
578 QCOMPARE(target.factor, original.factor);
579 QCOMPARE(target.offset, original.offset);
580 QCOMPARE(target.minimum, original.minimum);
581 QCOMPARE(target.maximum, original.maximum);
582 QCOMPARE(target.unit, original.unit);
583 QCOMPARE(target.comment, original.comment);
584 QVERIFY(target.receivers == original.receivers);
585 QVERIFY(target.valueDescriptions == original.valueDescriptions);
586 QCOMPARE(target.multiplexing.role, original.multiplexing.role);
587 QCOMPARE(target.multiplexing.value, original.multiplexing.value);
588 }
589 }
590}
591
592void CoverageTest::physicalConversion_data() {
593 QTest::addColumn<double>("factor");
594 QTest::addColumn<double>("offset");
595 QTest::addColumn<double>("expected");
596 QTest::newRow("zero-factor") << 0.0 << 7.0 << 7.0;
597 QTest::newRow("negative-factor") << -2.0 << 5.0 << -15.0;
598 QTest::newRow("above-declared-range") << 2.0 << 3.0 << 23.0;
599}
600
601void CoverageTest::physicalConversion() {
602 QFETCH(double, factor);
603 QFETCH(double, offset);
604 QFETCH(double, expected);
605 DecodeSignal signal;
606 signal.length = 8U;
607 signal.factor = factor;
608 signal.offset = offset;
609 signal.minimum = 0.0;
610 signal.maximum = 1.0;
611 const DecodeDatabase database = SingleSignal(signal);
612 RawCanFrame raw;
613 raw.canId = 17U;
614 raw.data = {10U};
615 const DecodedFrameValue decoded = DbcDecoder().Decode(database, raw);
616 QVERIFY(decoded.signals[0].valid);
617 QCOMPARE(std::get<std::uint64_t>(decoded.signals[0].rawValue), std::uint64_t(10));
618 QCOMPARE(decoded.signals[0].physicalValue, expected);
619}
620
621void CoverageTest::multiplexingScenarios() {
622 const DecodeDatabase selectorOnly = DbcDecodeBuilder().Build(ParseText(
623 "BO_ 1 Frame: 1 ECU\nSG_ Mode M : 0|1@1+ (1,0) [0|1] \"\" ECU\n"));
624 RawCanFrame raw;
625 raw.canId = 1U;
626 raw.data = {1U};
627 const DecodedFrameValue only = DbcDecoder().Decode(selectorOnly, raw);
628 QCOMPARE(only.signals.size(), std::size_t(1));
629 QVERIFY(only.signals[0].valid);
630 const DecodeDatabase database = DbcDecodeBuilder().Build(ParseText(
631 "BO_ 1 First: 3 ECU\n"
632 "SG_ Mode M : 0|1@1+ (1,0) [0|1] \"\" ECU\n"
633 "SG_ A m0 : 8|8@1+ (1,0) [0|255] \"\" ECU\n"
634 "SG_ B m0 : 16|8@1+ (1,0) [0|255] \"\" ECU\n"
635 "BO_ 2 Second: 2 ECU\n"
636 "SG_ Mode M : 0|1@1+ (1,0) [0|1] \"\" ECU\n"
637 "SG_ A m1 : 8|8@1+ (1,0) [0|255] \"\" ECU\n"));
638 raw.data = {0U, 42U, 99U};
639 const DecodedFrameValue first = DbcDecoder().Decode(database, raw);
640 QVERIFY(first.signals[1].valid && first.signals[2].valid);
641 QCOMPARE(std::get<std::uint64_t>(first.signals[1].rawValue), std::uint64_t(42));
642 QCOMPARE(std::get<std::uint64_t>(first.signals[2].rawValue), std::uint64_t(99));
643 raw.canId = 2U;
644 const DecodedFrameValue secondInactive = DbcDecoder().Decode(database, raw);
645 QCOMPARE(secondInactive.signals[1].status, SignalDecodeStatus::Inactive);
646 raw.data[0] = 1U;
647 QVERIFY(DbcDecoder().Decode(database, raw).signals[1].valid);
648 raw.canId = 1U;
649 const DecodedFrameValue firstInactive = DbcDecoder().Decode(database, raw);
650 QCOMPARE(firstInactive.signals[1].status, SignalDecodeStatus::Inactive);
651 QCOMPARE(firstInactive.signals[2].status, SignalDecodeStatus::Inactive);
652}
653
654void CoverageTest::multiplexingErrorLocations_data() {
655 QTest::addColumn<QString>("text");
656 QTest::addColumn<unsigned>("line");
657 QTest::addColumn<QString>("message");
658 const QString header = "BO_ 1 Frame: 3 ECU\n\n";
659 const QString selector = "SG_ Mode M : 0|1@1+ (1,0) [0|1] \"\" ECU\n";
660 const QString branch = "SG_ A m1 : 8|8@1+ (1,0) [0|255] \"\" ECU\n";
661 QTest::newRow("missing-selector") << header + branch << 3U << QString::fromUtf8("Multiplexed branch has no selector.");
662 QTest::newRow("second-selector") << header + selector + "\nSG_ Other M : 16|1@1+ (1,0) [0|1] \"\" ECU\n"
663 << 5U << QString::fromUtf8("Multiplexing requires one unsigned selector per frame.");
664 QTest::newRow("signed-selector") << header + "SG_ Mode M : 0|1@1- (1,0) [-1|0] \"\" ECU\n"
665 << 3U << QString::fromUtf8("Multiplexing requires one unsigned selector per frame.");
666 QTest::newRow("branch-range") << header + "SG_ A m2 : 8|8@1+ (1,0) [0|255] \"\" ECU\n" + selector << 3U << QString::fromUtf8("Branch value exceeds selector raw range.");
667 QTest::newRow("same-branch-overlap") << header + selector + branch + "SG_ B m1 : 15|8@0+ (1,0) [0|255] \"\" ECU\n"
668 << 5U << QString::fromUtf8("Signals overlap without mutually exclusive multiplexing conditions.");
669 QTest::newRow("selector-overlap") << header + selector + "SG_ A m1 : 0|1@1+ (1,0) [0|1] \"\" ECU\n"
670 << 4U << QString::fromUtf8("Signals overlap without mutually exclusive multiplexing conditions.");
671 QTest::newRow("unconditional-overlap") << header + selector + branch + "SG_ Always : 8|8@1+ (1,0) [0|255] \"\" ECU\n"
672 << 5U << QString::fromUtf8("Signals overlap without mutually exclusive multiplexing conditions.");
673 QTest::newRow("ordinary-overlap") << header + "SG_ A : 8|8@1+ (1,0) [0|255] \"\" ECU\nSG_ B : 15|8@0+ (1,0) [0|255] \"\" ECU\n"
674 << 4U << QString::fromUtf8("Signals overlap without mutually exclusive multiplexing conditions.");
675 QTest::newRow("extended-multiplexing") << header + "SG_MUL_VAL_ 1 A Mode 1-2;\n"
676 << 3U << QString::fromUtf8("Extended and nested multiplexing are unsupported.");
677 QTest::newRow("nested-marker") << header + "SG_ A m1M : 8|8@1+ (1,0) [0|255] \"\" ECU\n"
678 << 3U << QString::fromUtf8("Invalid or unsupported multiplexing marker.");
679}
680
681void CoverageTest::multiplexingErrorLocations() {
682 QFETCH(QString, text);
683 QFETCH(unsigned, line);
684 QFETCH(QString, message);
685 QTemporaryFile file;
686 QVERIFY(file.open());
687 const QByteArray content = text.toUtf8();
688 QCOMPARE(file.write(content), qint64(content.size()));
689 QVERIFY(file.flush());
690 try {
691 DbcParser().ParseFile(file.fileName().toStdString());
692 QFAIL("Expected multiplexing rejection");
693 } catch (const std::runtime_error &error) {
694 QCOMPARE(QString::fromStdString(error.what()), file.fileName() + ":" + QString::number(line) + ": " + message);
695 }
696}
697
698void CoverageTest::escapedValueDescriptions() {
699 const DbcDatabase parsed = ParseText(
700 "BO_ 1 Frame: 1 ECU\nSG_ State : 0|8@1+ (1,0) [0|255] \"\" ECU\n"
701 R"dbc(VAL_ 1 State -0 "Ноль" 1 "C:\\trace" 2 "\\\"quoted\"\\";)dbc"
702 "\n");
703 const ValueDescriptions &values = parsed.frames[0].signals[0].valueDescriptions;
704 QCOMPARE(values.size(), std::size_t(3));
705 QVERIFY(values.find(RawSignalValue(std::int64_t(0))) == values.end());
706 const std::string *zero = FindValueDescription(values, std::int64_t(0));
707 const std::string *path = FindValueDescription(values, std::uint64_t(1));
708 const std::string *quoted = FindValueDescription(values, std::uint64_t(2));
709 QVERIFY(zero && path && quoted);
710 QCOMPARE(*zero, std::string("Ноль"));
711 QCOMPARE(*path, std::string("C:\\trace"));
712 QCOMPARE(*quoted, std::string("\\\"quoted\"\\"));
713 QVERIFY(NormalizeValueKey(RawSignalValue(std::int64_t(0))) == RawSignalValue(std::uint64_t(0)));
714 QVERIFY(NormalizeValueKey(RawSignalValue(std::int64_t(-1))) == RawSignalValue(std::int64_t(-1)));
715}
716
717void CoverageTest::factory() {
719 QVERIFY(!factory.contains("value"));
720 QVERIFY_THROWS_EXCEPTION(std::out_of_range, static_cast<void>(factory.creator("missing")));
721 QVERIFY_THROWS_EXCEPTION(std::out_of_range, static_cast<void>(factory.create("missing", std::make_unique<int>(1))));
722 factory.registerType<FactoryFirst>("value");
723 QVERIFY(factory.contains("value"));
724 std::unique_ptr<int> argument = std::make_unique<int>(42);
725 const std::shared_ptr<FactoryBase> first = factory.create("value", std::move(argument));
726 QVERIFY(argument == nullptr);
727 QCOMPARE(first->Value(), 42);
728 const TypeFactory<std::string, FactoryBase, std::unique_ptr<int>>::CreatorFn creator = factory.creator("value");
729 QCOMPARE(creator(std::make_unique<int>(7))->Value(), 7);
730 factory.registerType<FactorySecond>("value");
731 QCOMPARE(factory.create("value", std::make_unique<int>(42))->Value(), 43);
732 QCOMPARE(first->Value(), 42);
733 QCOMPARE(creator(std::make_unique<int>(7))->Value(), 7);
734}
735
736int RunCoverageTests(int argc, char **argv) {
737 CoverageTest tests;
738 return QTest::qExec(&tests, argc, argv);
739}
740#include "dbc_coverage_test.moc"
Converts parsed DBC data into runtime decode database.
DecodeDatabase Build(const DbcDatabase &source) const
Build runtime decode database.
Runtime CAN decoder using prebuilt decode database.
Definition dbc_decoder.h:84
DecodedFrameValue Decode(const DecodeDatabase &database, const RawCanFrame &frame) const
Decode one raw CAN frame.
std::shared_ptr< const DecodeFrame > FindFrame(const DecodeDatabase &database, std::uint32_t canId, bool isExtended) const
Find frame definition by CAN ID.
Minimal DBC parser.
Definition dbc_parser.h:33
DbcDatabase ParseFile(const std::string &filePath) const
Parse DBC file.
Builds a simple tree from parsed DBC database.
std::unique_ptr< TreeNode > Build(const DbcDatabase &database) const
Build tree representation of parsed DBC data.
Immutable runtime snapshot. Copies share storage; reload replaces a snapshot. Owning lookup handles a...
std::shared_ptr< const DecodeFrame > FindFrame(const FrameKey &key) const
const std::vector< DecodeFrame > & GetFrames() const
Tree node for later use in model/view or other hierarchy consumers.
Definition tree_node.h:35
const SignalInfo * GetSignal() const
Get signal payload if node is signal.
Definition tree_node.cpp:64
const TreeNode * GetChild(std::size_t index) const
Get child by index.
Definition tree_node.cpp:38
const std::string & GetName() const
Get display name.
Definition tree_node.cpp:56
std::size_t GetChildCount() const
Get child count.
Definition tree_node.cpp:34
NodeType GetType() const
Get node type.
Definition tree_node.cpp:52
const FrameInfo * GetFrame() const
Get frame payload if node is frame.
Definition tree_node.cpp:60
Registry-based factory for creating objects by runtime identifier.
Definition typefactory.h:59
bool contains(const ClassId &id) const
Checks whether an id is registered.
BasePtr create(const ClassId &id, Args... args) const
Creates an instance for the given id using provided arguments.
Definition typefactory.h:97
void registerType(const ClassId &id)
Registers a Derived type under the given id.
Definition typefactory.h:76
CreatorFn creator(const ClassId &id) const
Returns creator function for the given id.
Definition typefactory.h:89
Created: 2026-03-13 Author: Deeaitch (Dim. Himro)
Created: 2026-03-13 Author: Deeaitch (Dim. Himro)
Created: 2026-03-13 Author: Deeaitch (Dim. Himro)
Created: 2026-03-13 Author: Deeaitch (Dim. Himro)
ByteOrder
Signal byte order used for runtime decoding.
ValueType
Signal numeric type.
Parsed DBC content stored in a simple internal form.
std::vector< FrameInfo > frames
Runtime-ready frame definition.
std::uint32_t pgn
std::string comment
std::uint8_t dlc
std::uint32_t canId
std::string name
std::string transmitter
Runtime-ready signal definition.
std::string unit
std::string name
ValueDescriptions valueDescriptions
ValueType valueType
std::uint32_t startBit
std::vector< std::string > receivers
ByteOrder byteOrder
std::uint32_t length
std::string comment
Fully decoded frame.
Definition dbc_decoder.h:71
std::shared_ptr< const DecodeFrame > definition
Definition dbc_decoder.h:72
FrameDecodeStatus status
Definition dbc_decoder.h:76
Describes one CAN frame from a DBC file.
Definition frame_info.h:24
bool isExtended
Definition frame_info.h:27
bool hasPgn
Definition frame_info.h:29
std::string transmitter
Definition frame_info.h:31
std::uint8_t dlc
Definition frame_info.h:30
std::string name
Definition frame_info.h:25
std::string comment
Definition frame_info.h:32
std::uint32_t pgn
Definition frame_info.h:28
std::uint32_t canId
Definition frame_info.h:26
Stable frame identifier: normalized CAN ID and frame type.
Raw CAN frame used for runtime or trace decoding.
Definition dbc_decoder.h:24
std::vector< std::uint8_t > data
Definition dbc_decoder.h:27
std::uint32_t canId
Definition dbc_decoder.h:25
bool isExtended
Definition dbc_decoder.h:26
Describes one signal inside a DBC frame.
Definition signal_info.h:24
std::uint32_t length
Definition signal_info.h:28
std::string unit
Definition signal_info.h:35
std::vector< std::string > receivers
Definition signal_info.h:36
std::string name
Definition signal_info.h:26
ValueDescriptions valueDescriptions
Definition signal_info.h:37
bool isSigned
Definition signal_info.h:30
double offset
Definition signal_info.h:32
std::string comment
Definition signal_info.h:38
std::uint32_t startBit
Definition signal_info.h:27
double minimum
Definition signal_info.h:33
double maximum
Definition signal_info.h:34
double factor
Definition signal_info.h:31
bool isLittleEndian
Definition signal_info.h:29