[JENKINS-62454] Fix parsing of Gcc warnings when there are new lines between description lines (#1285)

Author: akash-manna-sky

src/main/java/edu/hm/hafner/analysis/parser/DoxygenParser.java

@@ -52,7 +52,7 @@ protected Optional<Issue> createIssue(final Matcher matcher, final LookaheadStre
             builder.setLineStart(matcher.group(4));
         }
 
-        while (lookahead.hasNext() && Gcc4CompilerParser.isMessageContinuation(lookahead)) {
+        while (lookahead.hasNext() && Gcc4CompilerParser.isMessageContinuation(lookahead, false)) {
             message.append('\n');
             message.append(lookahead.next());
         }

src/main/java/edu/hm/hafner/analysis/parser/Gcc4Cc1Parser.java

@@ -50,7 +50,7 @@ protected Optional<Issue> createIssue(final Matcher matcher, final LookaheadStre
         }
 
         var completeMessage = new StringBuilder(messageContent);
-        while (lookahead.hasNext() && Gcc4CompilerParser.isMessageContinuation(lookahead)) {
+        while (lookahead.hasNext() && Gcc4CompilerParser.isMessageContinuation(lookahead, false)) {
             completeMessage.append(' ');
             completeMessage.append(lookahead.next());
         }

src/main/java/edu/hm/hafner/analysis/parser/Gcc4CompilerParser.java

@@ -61,9 +61,14 @@ protected Optional<Issue> createIssue(final Matcher matcher, final LookaheadStre
 
         setCategory(builder, originalMessage);
 
-        while (lookahead.hasNext() && isMessageContinuation(lookahead)) {
+        boolean hasCodeSnippet = false;
+        while (lookahead.hasNext() && isMessageContinuation(lookahead, hasCodeSnippet)) {
+            var continuation = lookahead.next();
+            if (continuation.length() > 0 && Character.isWhitespace(continuation.charAt(0))) {
+                hasCodeSnippet = true;
+            }
             message.append('\n');
-            message.append(lookahead.next());
+            message.append(continuation);
         }
 
         var notes = getNotes(lookahead);
@@ -143,20 +148,26 @@ private String getNotes(final LookaheadStream lookahead) {
     }
 
     @SuppressWarnings("PMD.AvoidLiteralsInIfCondition")
-    static boolean isMessageContinuation(final LookaheadStream lookahead) {
+    static boolean isMessageContinuation(final LookaheadStream lookahead, final boolean hasCodeSnippet) {
         var peek = lookahead.peekNext();
         if (peek.length() < 3) {
             return false;
         }
+        return !startsWithInvalidCharacter(peek, hasCodeSnippet)
+                && !Strings.CI.containsAny(peek, "arning", "rror", "make");
+    }
+
+    @SuppressWarnings("PMD.AvoidLiteralsInIfCondition")
+    private static boolean startsWithInvalidCharacter(final String peek, final boolean hasCodeSnippet) {
         if (peek.charAt(0) == '/' || peek.charAt(0) == '[' || peek.charAt(0) == '<' || peek.charAt(0) == '=') {
-            return false;
+            return true;
         }
         if (peek.charAt(1) == ':') {
-            return false;
+            return true;
         }
         if (peek.charAt(2) == '/' || peek.charAt(0) == '\\') {
-            return false;
+            return true;
         }
-        return !Strings.CI.containsAny(peek, "arning", "rror", "make");
+        return hasCodeSnippet && peek.startsWith("In file included from");
     }
 }

src/test/java/edu/hm/hafner/analysis/parser/Gcc4CompilerParserTest.java

@@ -4,6 +4,8 @@
 import java.util.function.Predicate;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 
 import edu.hm.hafner.analysis.Issue;
 import edu.hm.hafner.analysis.Report;
@@ -763,4 +765,45 @@ void issue56815() {
                     .hasSeverity(Severity.ERROR);
         }
     }
+
+    /**
+     * Parses a warning log with consecutive warnings from different compilation units.
+     * The "In file included from" lines should not be treated as message continuation.
+     *
+     * @param fileName the name of the test file to parse
+     * @see <a href="https://issues.jenkins-ci.org/browse/JENKINS-62454">Issue 62454</a>
+     */
+    @ParameterizedTest(name = "[{index}] Parse {0}")
+    @ValueSource(strings = {"gcc4-issue62454-1.txt", "gcc4-issue62454-2.txt"})
+    @org.junitpioneer.jupiter.Issue("JENKINS-62454")
+    void issue62454(final String fileName) {
+        var warnings = parse(fileName);
+
+        assertThat(warnings).hasSize(3);
+
+        Iterator<? extends Issue> iterator = warnings.iterator();
+
+        try (var softly = new SoftAssertions()) {
+            softly.assertThat(iterator.next())
+                    .hasLineStart(84)
+                    .hasLineEnd(84)
+                    .hasMessage("comparison between signed and unsigned integer expressions [-Wsign-compare]\n  if (SYSTIME_DIFF(now, lastResult) > MS2ST(SAMPLING_TIME_IN_MS)) {")
+                    .hasFileName("src/ledpwm/PWMLedManager.cpp")
+                    .hasSeverity(Severity.WARNING_NORMAL);
+
+            softly.assertThat(iterator.next())
+                    .hasLineStart(96)
+                    .hasLineEnd(96)
+                    .hasMessage("comparison between signed and unsigned integer expressions [-Wsign-compare]\n    if(S2ST(lightSamplingTime) < SYSTIME_DIFF(now, lastStoredResult)) {")
+                    .hasFileName("src/ledpwm/PWMLedManager.cpp")
+                    .hasSeverity(Severity.WARNING_NORMAL);
+
+            softly.assertThat(iterator.next())
+                    .hasLineStart(26)
+                    .hasLineEnd(26)
+                    .hasMessage("'virtual void idata::AbstractThreadBase::initialize()' was hidden [-Woverloaded-virtual]\n  virtual void initialize();\n               ^~~~~~~~~~")
+                    .hasFileName("common/thread/abstract_thread.h")
+                    .hasSeverity(Severity.WARNING_NORMAL);
+        }
+    }
 }

src/test/resources/edu/hm/hafner/analysis/parser/gcc4-issue62454-1.txt

@@ -0,0 +1,11 @@
+src/ledpwm/PWMLedManager.cpp: In member function 'void PWMLedManager::updateLightSensorValue(int32_t)':
+src/ledpwm/PWMLedManager.cpp:84:36: warning: comparison between signed and unsigned integer expressions [-Wsign-compare]
+  if (SYSTIME_DIFF(now, lastResult) > MS2ST(SAMPLING_TIME_IN_MS)) {
+src/ledpwm/PWMLedManager.cpp:96:31: warning: comparison between signed and unsigned integer expressions [-Wsign-compare]
+    if(S2ST(lightSamplingTime) < SYSTIME_DIFF(now, lastStoredResult)) {
+In file included from common/obudisplay/UD/internalStateStorerThread.h:4:0,
+                 from src/services.h:21,
+                 from src/keyboard.cpp:16:
+common/thread/abstract_thread.h:26:15: warning: 'virtual void idata::AbstractThreadBase::initialize()' was hidden [-Woverloaded-virtual]
+  virtual void initialize();
+               ^~~~~~~~~~

src/test/resources/edu/hm/hafner/analysis/parser/gcc4-issue62454-2.txt

@@ -0,0 +1,13 @@
+src/ledpwm/PWMLedManager.cpp: In member function 'void PWMLedManager::updateLightSensorValue(int32_t)':
+src/ledpwm/PWMLedManager.cpp:84:36: warning: comparison between signed and unsigned integer expressions [-Wsign-compare]
+  if (SYSTIME_DIFF(now, lastResult) > MS2ST(SAMPLING_TIME_IN_MS)) {
+src/ledpwm/PWMLedManager.cpp:96:31: warning: comparison between signed and unsigned integer expressions [-Wsign-compare]
+    if(S2ST(lightSamplingTime) < SYSTIME_DIFF(now, lastStoredResult)) {
+
+
+In file included from common/obudisplay/UD/internalStateStorerThread.h:4:0,
+                 from src/services.h:21,
+                 from src/keyboard.cpp:16:
+common/thread/abstract_thread.h:26:15: warning: 'virtual void idata::AbstractThreadBase::initialize()' was hidden [-Woverloaded-virtual]
+  virtual void initialize();
+               ^~~~~~~~~~