fix: The CppCheck parser should retain the order of violations (#195)

The CppCheck parser handels individual locations of a warning as separate violations.
These violations are then returned to the caller as a sorted set, destroying the insertion order.
To visualize the affected locations in the original order, we need to store the insertion order
by adding a new property.

See https://issues.jenkins.io/browse/JENKINS-75217

Author: uhafner

violations-lib/src/main/java/se/bjurr/violations/lib/parsers/CPPCheckParser.java

@@ -38,6 +38,7 @@ public Set<Violation> parseReportOutput(
       Optional<String> verbose = null;
       String id = null;
       int errorIndex = -1;
+      int order = 0;
       boolean violationAddedFromError = false;
       String message = null;
       while (xmlr.hasNext()) {
@@ -106,6 +107,7 @@ public Set<Violation> parseReportOutput(
                     .setSeverity(severity) //
                     .setRule(id) //
                     .setGroup(Integer.toString(errorIndex)) //
+                    .setSpecific("order", order++)
                     .build();
             violations.add(v);
             violationAddedFromError = true;

violations-lib/src/test/java/se/bjurr/violations/lib/CPPCheckTest.java

@@ -54,6 +54,7 @@ public void testThatViolationsCanBeParsed() {
             .setMessage(MSG_1) //
             .setSeverity(INFO) //
             .setGroup("1") //
+            .setSpecific("order", 1)
             .build();
 
     final Violation v2 =
@@ -66,6 +67,7 @@ public void testThatViolationsCanBeParsed() {
             .setMessage(MSG_2) //
             .setSeverity(ERROR) //
             .setGroup("2") //
+            .setSpecific("order", 2)
             .build();
     ViolationAsserter.assertThat(actual) //
         .contains(v2, 2) //
@@ -269,6 +271,24 @@ public void testThatViolationsCanBeParsedFromIssue64519() {
         .isEqualTo(0);
   }
 
+  @Test
+  public void testThatViolationsCanBeParsedFromIssue75217() {
+    final String rootFolder = getRootFolder();
+
+    final Set<Violation> actual =
+        violationsApi() //
+            .withPattern(".*issue75217\\.xml$") //
+            .inFolder(rootFolder) //
+            .findAll(CPPCHECK) //
+            .violations();
+
+    assertThat(actual)
+        .hasSize(2)
+        .satisfiesExactly(
+            v -> assertThat(v.getSpecifics()).containsEntry("order", "1"),
+            v -> assertThat(v.getSpecifics()).containsEntry("order", "0"));
+  }
+
   @Test
   public void testThatColumnCanBeParsed() {
     final String rootFolder = getRootFolder();

violations-lib/src/test/resources/cppcheck/issue75217.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<results version="2">
+  <cppcheck version="2.0"/>
+  <errors>
+    <error id="missingOverride" severity="style" msg="The function 'reset' overrides a function in a base class but is not marked with a 'override' specifier." verbose="The function 'reset' overrides a function in a base class but is not marked with a 'override' specifier.">
+      <location file="derived.hpp" line="115" column="7" info="Function in derived class"/>
+      <location file="base.hpp" line="117" column="15" info="Virtual function in base class"/>
+      <symbol>reset</symbol>
+    </error>
+  </errors>
+</results>