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