1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
|
/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2025 Cppcheck team.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "sarifreport.h"
#include "errorlogger.h"
#include "errortypes.h"
#include "fixture.h"
#include "helpers.h"
#include <cmath>
#include <string>
#include <vector>
class TestSarifReport : public TestFixture
{
public:
TestSarifReport() : TestFixture("TestSarifReport")
{}
private:
void run() override
{
TEST_CASE(emptyReport);
TEST_CASE(singleError);
TEST_CASE(multipleErrors);
TEST_CASE(errorWithoutLocation);
TEST_CASE(errorWithMultipleLocations);
TEST_CASE(differentSeverityLevels);
TEST_CASE(securityRelatedErrors);
TEST_CASE(cweTagsPresent);
TEST_CASE(noCweNoSecurity);
TEST_CASE(inconclusiveCertainty);
TEST_CASE(criticalErrorId);
TEST_CASE(emptyDescriptions);
TEST_CASE(locationBoundaryValues);
TEST_CASE(duplicateRuleIds);
TEST_CASE(customProductName);
TEST_CASE(versionHandling);
TEST_CASE(securitySeverityMapping);
TEST_CASE(versionWithSpace);
TEST_CASE(customProductNameAndVersion);
TEST_CASE(normalizeLineColumnToOne);
TEST_CASE(internalAndDebugSeverity);
TEST_CASE(problemSeverityMapping);
TEST_CASE(mixedLocationAndNoLocation);
}
// Helper to create an ErrorMessage
static ErrorMessage createErrorMessage(const std::string& id,
Severity severity,
const std::string& msg,
const std::string& file = "test.cpp",
int line = 10,
int column = 5,
int cweId = 0,
Certainty certainty = Certainty::normal)
{
ErrorMessage::FileLocation loc(file, line, column);
ErrorMessage errorMessage({loc}, file, severity, msg, id, certainty);
if (cweId > 0)
{
errorMessage.cwe = CWE(cweId);
}
return errorMessage;
}
// Helper to parse JSON and validate structure
static bool parseAndValidateJson(const std::string& json, picojson::value& root)
{
std::string parseError = picojson::parse(root, json);
return parseError.empty() && root.is<picojson::object>();
}
void emptyReport()
{
SarifReport report;
std::string sarif = report.serialize("TestProduct");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
ASSERT_EQUALS("2.1.0", root.at("version").get<std::string>());
ASSERT(root.at("$schema").get<std::string>().find("sarif-schema-2.1.0") != std::string::npos);
// From SARIF specification (https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790730):
// Although the order in which properties appear in a JSON object value is not semantically significant, the version property SHOULD appear first.
ASSERT_EQUALS("{\n \"version\": \"2.1.0\"", sarif.substr(0,22));
const picojson::array& runs = root.at("runs").get<picojson::array>();
ASSERT_EQUALS(1U, runs.size());
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(0U, results.size());
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(0U, rules.size());
}
void singleError()
{
SarifReport report;
report.addFinding(createErrorMessage("nullPointer", Severity::error, "Null pointer dereference"));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
// Check results
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(1U, results.size());
const picojson::object& result = results[0].get<picojson::object>();
ASSERT_EQUALS("nullPointer", result.at("ruleId").get<std::string>());
ASSERT_EQUALS("error", result.at("level").get<std::string>());
const picojson::object& message = result.at("message").get<picojson::object>();
ASSERT_EQUALS("Null pointer dereference", message.at("text").get<std::string>());
// Check rules
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(1U, rules.size());
const picojson::object& rule = rules[0].get<picojson::object>();
ASSERT_EQUALS("nullPointer", rule.at("id").get<std::string>());
}
void multipleErrors()
{
SarifReport report;
report.addFinding(createErrorMessage("error1", Severity::error, "Error 1", "file1.cpp", 10, 5));
report.addFinding(createErrorMessage("error2", Severity::warning, "Error 2", "file2.cpp", 20, 10));
report.addFinding(createErrorMessage("error3", Severity::style, "Error 3", "file3.cpp", 30, 15));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(3U, results.size());
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(3U, rules.size());
}
void errorWithoutLocation()
{
SarifReport report;
// Create error without location (empty callStack)
ErrorMessage errorMessage(
{}, "test.cpp", Severity::error, "Error without location", "testError", Certainty::normal);
report.addFinding(errorMessage);
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
// Should have no results (GitHub doesn't support findings without locations)
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(0U, results.size());
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(0U, rules.size());
}
void errorWithMultipleLocations()
{
SarifReport report;
ErrorMessage::FileLocation loc1("test1.cpp", 10, 5);
ErrorMessage::FileLocation loc2("test2.cpp", 20, 10);
ErrorMessage::FileLocation loc3("test3.cpp", 30, 15);
ErrorMessage errorMessage({loc1, loc2, loc3},
"test1.cpp",
Severity::error,
"Error with multiple locations",
"multiLocError",
Certainty::normal);
report.addFinding(errorMessage);
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(1U, results.size());
const picojson::object& result = results[0].get<picojson::object>();
const picojson::array& locations = result.at("locations").get<picojson::array>();
ASSERT_EQUALS(3U, locations.size());
// Verify each location
const picojson::object& loc1Obj = locations[0].get<picojson::object>();
const picojson::object& physLoc1 = loc1Obj.at("physicalLocation").get<picojson::object>();
const picojson::object& region1 = physLoc1.at("region").get<picojson::object>();
ASSERT_EQUALS(10, static_cast<int>(region1.at("startLine").get<double>()));
ASSERT_EQUALS(5, static_cast<int>(region1.at("startColumn").get<double>()));
}
void differentSeverityLevels()
{
SarifReport report;
report.addFinding(createErrorMessage("error1", Severity::error, "Error severity"));
report.addFinding(createErrorMessage("warning1", Severity::warning, "Warning severity"));
report.addFinding(createErrorMessage("style1", Severity::style, "Style severity"));
report.addFinding(createErrorMessage("perf1", Severity::performance, "Performance severity"));
report.addFinding(createErrorMessage("port1", Severity::portability, "Portability severity"));
report.addFinding(createErrorMessage("info1", Severity::information, "Information severity"));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(6U, results.size());
// Check severity mappings
ASSERT_EQUALS("error", results[0].get<picojson::object>().at("level").get<std::string>()); // error
ASSERT_EQUALS("error", results[1].get<picojson::object>().at("level").get<std::string>()); // warning
ASSERT_EQUALS("warning", results[2].get<picojson::object>().at("level").get<std::string>()); // style
ASSERT_EQUALS("warning", results[3].get<picojson::object>().at("level").get<std::string>()); // performance
ASSERT_EQUALS("warning", results[4].get<picojson::object>().at("level").get<std::string>()); // portability
ASSERT_EQUALS("note", results[5].get<picojson::object>().at("level").get<std::string>()); // information
}
void securityRelatedErrors()
{
SarifReport report;
// Add errors with CWE IDs
report.addFinding(createErrorMessage("nullPointer", Severity::error, "Null pointer", "test.cpp", 10, 5, 476));
report.addFinding(
createErrorMessage("bufferOverflow", Severity::error, "Buffer overflow", "test.cpp", 20, 5, 121));
report.addFinding(createErrorMessage("memleak", Severity::warning, "Memory leak", "test.cpp", 30, 5, 401));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
for (const auto& rule : rules)
{
const picojson::object& r = rule.get<picojson::object>();
const picojson::object& props = r.at("properties").get<picojson::object>();
// Should have security-severity
ASSERT(props.find("security-severity") != props.end());
// Should have tags with security and CWE
ASSERT(props.find("tags") != props.end());
const picojson::array& tags = props.at("tags").get<picojson::array>();
bool hasSecurityTag = false;
bool hasCweTag = false;
for (const auto& tag : tags)
{
const std::string& tagStr = tag.get<std::string>();
if (tagStr == "security")
hasSecurityTag = true;
if (tagStr.find("external/cwe/cwe-") == 0)
hasCweTag = true;
}
ASSERT(hasSecurityTag);
ASSERT(hasCweTag);
}
}
void cweTagsPresent()
{
SarifReport report;
report.addFinding(createErrorMessage("testError", Severity::error, "Test error", "test.cpp", 10, 5, 119));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(1U, rules.size());
const picojson::object& rule = rules[0].get<picojson::object>();
const picojson::object& props = rule.at("properties").get<picojson::object>();
const picojson::array& tags = props.at("tags").get<picojson::array>();
bool foundCwe119 = false;
for (const auto& tag : tags)
{
if (tag.get<std::string>() == "external/cwe/cwe-119")
foundCwe119 = true;
}
ASSERT(foundCwe119);
}
void noCweNoSecurity()
{
SarifReport report;
// Error without CWE ID should not have security properties
report.addFinding(createErrorMessage("styleError", Severity::style, "Style error", "test.cpp", 10, 5, 0));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(1U, rules.size());
const picojson::object& rule = rules[0].get<picojson::object>();
const picojson::object& props = rule.at("properties").get<picojson::object>();
// Should NOT have security-severity
ASSERT(props.find("security-severity") == props.end());
// Should NOT have tags (or if present, no security tag)
if (props.find("tags") != props.end())
{
const picojson::array& tags = props.at("tags").get<picojson::array>();
for (const auto& tag : tags)
{
ASSERT(tag.get<std::string>() != "security");
}
}
}
void inconclusiveCertainty()
{
SarifReport report;
report.addFinding(
createErrorMessage("test1", Severity::error, "Conclusive", "test.cpp", 10, 5, 0, Certainty::normal));
report.addFinding(createErrorMessage(
"test2", Severity::error, "Inconclusive", "test.cpp", 20, 5, 0, Certainty::inconclusive));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(2U, rules.size());
// Check precision values
const picojson::object& rule1 = rules[0].get<picojson::object>();
const picojson::object& props1 = rule1.at("properties").get<picojson::object>();
ASSERT_EQUALS("high", props1.at("precision").get<std::string>());
const picojson::object& rule2 = rules[1].get<picojson::object>();
const picojson::object& props2 = rule2.at("properties").get<picojson::object>();
ASSERT_EQUALS("medium", props2.at("precision").get<std::string>());
}
void criticalErrorId()
{
SarifReport report;
// Use a critical error ID (from ErrorLogger::isCriticalErrorId)
report.addFinding(createErrorMessage("syntaxError", Severity::error, "Syntax error"));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(1U, results.size());
const picojson::object& result = results[0].get<picojson::object>();
// Critical errors should always map to "error" level
ASSERT_EQUALS("error", result.at("level").get<std::string>());
}
void emptyDescriptions()
{
SarifReport report;
report.addFinding(createErrorMessage("testError", Severity::error, "Test error"));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(1U, rules.size());
const picojson::object& rule = rules[0].get<picojson::object>();
// All descriptions should be empty for GitHub integration
ASSERT_EQUALS("", rule.at("name").get<std::string>());
ASSERT_EQUALS("", rule.at("shortDescription").get<picojson::object>().at("text").get<std::string>());
ASSERT_EQUALS("", rule.at("fullDescription").get<picojson::object>().at("text").get<std::string>());
ASSERT_EQUALS("", rule.at("help").get<picojson::object>().at("text").get<std::string>());
}
void locationBoundaryValues()
{
SarifReport report;
// Test with line/column values that are 0
// Note: Negative values don't work correctly if FileLocation uses unsigned types
ErrorMessage::FileLocation loc1("test.cpp", 0, 0);
ErrorMessage::FileLocation loc2("test.cpp", 1, 1);
ErrorMessage errorMessage1({loc1}, "test.cpp", Severity::error, "Error at 0,0", "error1", Certainty::normal);
ErrorMessage errorMessage2({loc2}, "test.cpp", Severity::error, "Error at 1,1", "error2", Certainty::normal);
report.addFinding(errorMessage1);
report.addFinding(errorMessage2);
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(2U, results.size());
// Check first result (0,0 should be normalized to 1,1)
{
const picojson::object& res = results[0].get<picojson::object>();
const picojson::array& locations = res.at("locations").get<picojson::array>();
const picojson::object& loc = locations[0].get<picojson::object>();
const picojson::object& physLoc = loc.at("physicalLocation").get<picojson::object>();
const picojson::object& region = physLoc.at("region").get<picojson::object>();
int line = static_cast<int>(region.at("startLine").get<double>());
int column = static_cast<int>(region.at("startColumn").get<double>());
// 0 should be normalized to 1
ASSERT_EQUALS(1, line);
ASSERT_EQUALS(1, column);
}
// Check second result (1,1 should stay as 1,1)
{
const picojson::object& res = results[1].get<picojson::object>();
const picojson::array& locations = res.at("locations").get<picojson::array>();
const picojson::object& loc = locations[0].get<picojson::object>();
const picojson::object& physLoc = loc.at("physicalLocation").get<picojson::object>();
const picojson::object& region = physLoc.at("region").get<picojson::object>();
int line = static_cast<int>(region.at("startLine").get<double>());
int column = static_cast<int>(region.at("startColumn").get<double>());
ASSERT_EQUALS(1, line);
ASSERT_EQUALS(1, column);
}
}
void duplicateRuleIds()
{
SarifReport report;
// Add multiple errors with the same rule ID
report.addFinding(createErrorMessage("duplicateId", Severity::error, "First error", "file1.cpp", 10, 5));
report.addFinding(createErrorMessage("duplicateId", Severity::error, "Second error", "file2.cpp", 20, 10));
report.addFinding(createErrorMessage("duplicateId", Severity::error, "Third error", "file3.cpp", 30, 15));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
// Should have 3 results but only 1 rule
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(3U, results.size());
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(1U, rules.size());
const picojson::object& rule = rules[0].get<picojson::object>();
ASSERT_EQUALS("duplicateId", rule.at("id").get<std::string>());
}
void customProductName()
{
SarifReport report;
report.addFinding(createErrorMessage("testError", Severity::error, "Test error"));
// Test with custom product name
std::string sarif = report.serialize("CustomChecker");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
// Should use "Cppcheck" as default when custom name doesn't parse
ASSERT_EQUALS("Cppcheck", driver.at("name").get<std::string>());
}
void versionHandling()
{
SarifReport report;
report.addFinding(createErrorMessage("testError", Severity::error, "Test error"));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
// Should have a semantic version
ASSERT(driver.find("semanticVersion") != driver.end());
const std::string version = driver.at("semanticVersion").get<std::string>();
// Version should not contain spaces (they should be stripped)
ASSERT(version.find(' ') == std::string::npos);
}
void securitySeverityMapping()
{
// Test the detailed security-severity mapping for different severity levels with CWE
SarifReport report;
// Error with CWE should get 9.9 (critical)
report.addFinding(createErrorMessage("error1", Severity::error, "Error with CWE", "test.cpp", 10, 5, 119));
// Warning with CWE should get 8.5 (high)
report.addFinding(
createErrorMessage("warning1", Severity::warning, "Warning with CWE", "test.cpp", 20, 5, 120));
// Style/Performance/Portability with CWE should get 5.5 (medium)
report.addFinding(createErrorMessage("style1", Severity::style, "Style with CWE", "test.cpp", 30, 5, 398));
report.addFinding(
createErrorMessage("perf1", Severity::performance, "Performance with CWE", "test.cpp", 40, 5, 407));
report.addFinding(
createErrorMessage("port1", Severity::portability, "Portability with CWE", "test.cpp", 50, 5, 562));
// Information with CWE should get 2.0 (low)
report.addFinding(createErrorMessage("info1", Severity::information, "Info with CWE", "test.cpp", 60, 5, 561));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
// Check each rule's security-severity value
for (const auto& rule : rules)
{
const picojson::object& r = rule.get<picojson::object>();
const std::string& id = r.at("id").get<std::string>();
const picojson::object& props = r.at("properties").get<picojson::object>();
ASSERT(props.find("security-severity") != props.end());
const std::string& severity = props.at("security-severity").get<std::string>();
double severityValue = std::stod(severity);
if (id == "error1")
{
// Use a tolerance for floating-point comparison to avoid warning
ASSERT(std::abs(severityValue - 9.9) < 0.01);
}
else if (id == "warning1")
{
ASSERT(std::abs(severityValue - 8.5) < 0.01);
}
else if (id == "style1" || id == "perf1" || id == "port1")
{
ASSERT(std::abs(severityValue - 5.5) < 0.01);
}
else if (id == "info1")
{
ASSERT(std::abs(severityValue - 2.0) < 0.01);
}
}
}
void versionWithSpace()
{
// Test that version strings with spaces are properly truncated
SarifReport report;
report.addFinding(createErrorMessage("testError", Severity::error, "Test error"));
// This test would need a way to inject a version with a space
// The current implementation gets version from CppCheck::version()
// This test verifies the space-trimming logic works
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const std::string& version = driver.at("semanticVersion").get<std::string>();
// Version should not contain any spaces
ASSERT(version.find(' ') == std::string::npos);
}
void customProductNameAndVersion()
{
// Test custom product name that includes version info
SarifReport report;
report.addFinding(createErrorMessage("testError", Severity::error, "Test error"));
// Test with product name that might parse differently
std::string sarif = report.serialize("MyChecker-1.0.0");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
// Should have a name (either parsed or default)
ASSERT(driver.find("name") != driver.end());
ASSERT(driver.find("semanticVersion") != driver.end());
}
void normalizeLineColumnToOne()
{
SarifReport report;
// Test with 0 values
ErrorMessage::FileLocation loc0("test.cpp", 0, 0);
ErrorMessage errorMessage0({loc0}, "test.cpp", Severity::error, "Error at 0", "error0", Certainty::normal);
report.addFinding(errorMessage0);
// Test with positive values
ErrorMessage::FileLocation locPos("test.cpp", 10, 5);
ErrorMessage errorMessagePos(
{locPos}, "test.cpp", Severity::error, "Error at positive", "errorPos", Certainty::normal);
report.addFinding(errorMessagePos);
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(2U, results.size());
// Check first result with 0,0
const picojson::object& res0 = results[0].get<picojson::object>();
const picojson::array& locations0 = res0.at("locations").get<picojson::array>();
const picojson::object& loc0_obj = locations0[0].get<picojson::object>();
const picojson::object& physLoc0 = loc0_obj.at("physicalLocation").get<picojson::object>();
const picojson::object& region0 = physLoc0.at("region").get<picojson::object>();
int line0 = static_cast<int>(region0.at("startLine").get<double>());
int column0 = static_cast<int>(region0.at("startColumn").get<double>());
// 0 values should be normalized to 1
ASSERT(line0 == 1);
ASSERT(column0 == 1);
// Check second result with positive values
const picojson::object& res1 = results[1].get<picojson::object>();
const picojson::array& locations1 = res1.at("locations").get<picojson::array>();
const picojson::object& loc1_obj = locations1[0].get<picojson::object>();
const picojson::object& physLoc1 = loc1_obj.at("physicalLocation").get<picojson::object>();
const picojson::object& region1 = physLoc1.at("region").get<picojson::object>();
ASSERT_EQUALS(10, static_cast<int>(region1.at("startLine").get<double>()));
ASSERT_EQUALS(5, static_cast<int>(region1.at("startColumn").get<double>()));
}
void internalAndDebugSeverity()
{
// Test internal and debug severity levels
// Based on the implementation in sarifSeverity():
// - internal -> error
// - debug -> note
// - none -> note
SarifReport report;
// Create errors with internal and debug severities
ErrorMessage::FileLocation loc1("test.cpp", 10, 5);
ErrorMessage::FileLocation loc2("test.cpp", 20, 10);
ErrorMessage::FileLocation loc3("test.cpp", 30, 15);
ErrorMessage internal(
{loc1}, "test.cpp", Severity::internal, "Internal message", "internalError", Certainty::normal);
ErrorMessage debug({loc2}, "test.cpp", Severity::debug, "Debug message", "debugError", Certainty::normal);
ErrorMessage none({loc3}, "test.cpp", Severity::none, "None message", "noneError", Certainty::normal);
report.addFinding(internal);
report.addFinding(debug);
report.addFinding(none);
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(3U, results.size());
// Check the actual mapping
const picojson::object& res0 = results[0].get<picojson::object>();
const picojson::object& res1 = results[1].get<picojson::object>();
const picojson::object& res2 = results[2].get<picojson::object>();
const std::string level0 = res0.at("level").get<std::string>();
const std::string level1 = res1.at("level").get<std::string>();
const std::string level2 = res2.at("level").get<std::string>();
// Actual implementation behavior:
ASSERT_EQUALS("error", level0); // internal -> error
ASSERT_EQUALS("note", level1); // debug -> note
ASSERT_EQUALS("note", level2); // none -> note
}
void problemSeverityMapping()
{
// Test that problem.severity property matches the SARIF severity
SarifReport report;
report.addFinding(createErrorMessage("error1", Severity::error, "Error"));
report.addFinding(createErrorMessage("warning1", Severity::warning, "Warning"));
report.addFinding(createErrorMessage("style1", Severity::style, "Style"));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
for (const auto& rule : rules)
{
const picojson::object& r = rule.get<picojson::object>();
const picojson::object& props = r.at("properties").get<picojson::object>();
const picojson::object& defaultConfig = r.at("defaultConfiguration").get<picojson::object>();
// problem.severity should match defaultConfiguration.level
const std::string& problemSeverity = props.at("problem.severity").get<std::string>();
const std::string& defaultLevel = defaultConfig.at("level").get<std::string>();
ASSERT_EQUALS(defaultLevel, problemSeverity);
}
}
void mixedLocationAndNoLocation()
{
// Test a mix of findings with and without locations
SarifReport report;
// Add findings with locations
report.addFinding(createErrorMessage("withLoc1", Severity::error, "Error with location", "test.cpp", 10, 5));
report.addFinding(
createErrorMessage("withLoc2", Severity::warning, "Warning with location", "test.cpp", 20, 5));
// Add findings without locations
ErrorMessage noLoc1({}, "test.cpp", Severity::error, "Error without location", "noLoc1", Certainty::normal);
ErrorMessage noLoc2({}, "test.cpp", Severity::warning, "Warning without location", "noLoc2", Certainty::normal);
report.addFinding(noLoc1);
report.addFinding(noLoc2);
// Add more with locations
report.addFinding(createErrorMessage("withLoc3", Severity::style, "Style with location", "test.cpp", 30, 5));
std::string sarif = report.serialize("Cppcheck");
picojson::value json;
ASSERT(parseAndValidateJson(sarif, json));
const picojson::object& root = json.get<picojson::object>();
const picojson::array& runs = root.at("runs").get<picojson::array>();
const picojson::object& cur_run = runs[0].get<picojson::object>();
// Should only have results for findings with locations
const picojson::array& results = cur_run.at("results").get<picojson::array>();
ASSERT_EQUALS(3U, results.size());
// Should only have rules for findings with locations
const picojson::object& tool = cur_run.at("tool").get<picojson::object>();
const picojson::object& driver = tool.at("driver").get<picojson::object>();
const picojson::array& rules = driver.at("rules").get<picojson::array>();
ASSERT_EQUALS(3U, rules.size());
// Verify the rule IDs are only for findings with locations
std::set<std::string> ruleIds;
for (const auto& rule : rules)
{
const picojson::object& r = rule.get<picojson::object>();
ruleIds.insert(r.at("id").get<std::string>());
}
ASSERT(ruleIds.find("withLoc1") != ruleIds.end());
ASSERT(ruleIds.find("withLoc2") != ruleIds.end());
ASSERT(ruleIds.find("withLoc3") != ruleIds.end());
ASSERT(ruleIds.find("noLoc1") == ruleIds.end());
ASSERT(ruleIds.find("noLoc2") == ruleIds.end());
}
};
REGISTER_TEST(TestSarifReport)
|