From 47cb634b02eab2314aca53cd395eb3fdba8f4037 Mon Sep 17 00:00:00 2001
From: Johan Helgstrand <johanhel@axis.com>
Date: Fri, 8 Mar 2024 09:46:13 +0100
Subject: [PATCH] Add line matching for multi-line pattern parse

Changed the reader for multli-line pattern scan from BufferedReader
to LineNumberReader which is a subclass of BufferedReader that adds
the feature of counting lines for all read operations, which can then
be used to set matching line for the found indication.
---
 .../jenkins/plugins/bfa/model/FailureReader.java       |  5 +++--
 .../bfa/model/MultilineBuildLogFailureReader.java      | 10 +++++-----
 .../jenkins/plugins/bfa/model/FailureReaderTest.java   | 10 ++++++----
 3 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureReader.java b/src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureReader.java
index 6e94663d..09eb3865 100644
--- a/src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureReader.java
+++ b/src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureReader.java
@@ -35,6 +35,7 @@
 
 import java.io.BufferedReader;
 import java.io.IOException;
+import java.io.LineNumberReader;
 import java.io.PrintStream;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -318,7 +319,7 @@ private static List<FoundFailureCause> convertToFoundFailureCauses(Map<FailureCa
      * @return a FoundIndication if we find the pattern, null if not.
      * @throws IOException if problems occur in the reader handling.
      */
-    protected FoundIndication scanMultiLineOneFile(Run build, BufferedReader reader, String currentFile)
+    protected FoundIndication scanMultiLineOneFile(Run build, LineNumberReader reader, String currentFile)
             throws IOException {
         TimerThread timerThread = new TimerThread(Thread.currentThread(), TIMEOUT_BLOCK);
         FoundIndication foundIndication = null;
@@ -338,7 +339,7 @@ protected FoundIndication scanMultiLineOneFile(Run build, BufferedReader reader,
                     Matcher matcher = pattern.matcher(new InterruptibleCharSequence(searchBuffer.toString()));
                     if (matcher.find()) {
                         foundIndication = new FoundIndication(build, pattern.pattern(), currentFile,
-                                removeConsoleNotes(matcher.group()), -1);
+                                removeConsoleNotes(matcher.group()), reader.getLineNumber());
                         break;
                     }
                     searchBuffer.delete(0, BUF_SIZE_BYTES - OVERLAP_BYTES);
diff --git a/src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/MultilineBuildLogFailureReader.java b/src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/MultilineBuildLogFailureReader.java
index 654fedb4..453d0ec5 100644
--- a/src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/MultilineBuildLogFailureReader.java
+++ b/src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/MultilineBuildLogFailureReader.java
@@ -24,8 +24,8 @@
 
 package com.sonyericsson.jenkins.plugins.bfa.model;
 
-import java.io.BufferedReader;
 import java.io.IOException;
+import java.io.LineNumberReader;
 import java.io.PrintStream;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -62,9 +62,9 @@ public MultilineBuildLogFailureReader(MultilineBuildLogIndication indication) {
      */
     @Override
     public FoundIndication scan(Run build) throws IOException {
-        BufferedReader reader = null;
+        LineNumberReader reader = null;
         try {
-            reader = new BufferedReader(build.getLogReader());
+            reader = new LineNumberReader(build.getLogReader());
             return scanMultiLineOneFile(build, reader, "log");
         } finally {
             if (reader != null) {
@@ -88,10 +88,10 @@ public FoundIndication scan(Run build) throws IOException {
      */
     public FoundIndication scan(Run build, PrintStream buildLog) {
         FoundIndication foundIndication = null;
-        BufferedReader reader = null;
+        LineNumberReader reader = null;
         long start = System.currentTimeMillis();
         try {
-            reader = new BufferedReader(build.getLogReader());
+            reader = new LineNumberReader(build.getLogReader());
             foundIndication = scanMultiLineOneFile(build, reader, "log");
         } catch (IOException ioe) {
             logger.log(Level.SEVERE, "[BFA] I/O problems during indication analysis: ", ioe);
diff --git a/src/test/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureReaderTest.java b/src/test/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureReaderTest.java
index af6ddda8..3334bb2f 100644
--- a/src/test/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureReaderTest.java
+++ b/src/test/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureReaderTest.java
@@ -29,6 +29,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.io.LineNumberReader;
 import java.io.PrintStream;
 import java.io.SequenceInputStream;
 import java.io.StringReader;
@@ -180,13 +181,14 @@ public void testScanOneFileWithFileTimeout() throws Exception {
     @Test
     public void testScanMultiLineOneFile() throws Exception {
         FailureReader reader = new TestReader(new MultilineBuildLogIndication(".*scan for me please.*"));
-        BufferedReader br = new BufferedReader(new StringReader("scan for me please will you!\nA second line"));
+        LineNumberReader br = new LineNumberReader(new StringReader("scan for me please will you!\nA second line"));
         long startTime = System.currentTimeMillis();
         FoundIndication indication = reader.scanMultiLineOneFile(null, br, "test");
         long elapsedTime = System.currentTimeMillis() - startTime;
         br.close();
         assertTrue("Unexpected long time to parse log: " + elapsedTime, elapsedTime <= 1000);
         assertNotNull("Expected to find an indication", indication);
+        assertEquals(indication.getMatchingLine(), 1);
     }
 
     /**
@@ -197,7 +199,7 @@ public void testScanMultiLineOneFile() throws Exception {
     public void testScanMultiLineOneFileWithBlockTimeout() throws Exception {
         // Evil input + expression. Will timeout every time.
         FailureReader reader = new TestReader(new MultilineBuildLogIndication("^(([a-z])+.)+[A-Z]([a-z])+$"));
-        BufferedReader br = new BufferedReader(new InputStreamReader(
+        LineNumberReader br = new LineNumberReader(new InputStreamReader(
                 new ByteArrayInputStream("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".getBytes())));
         long startTime = System.currentTimeMillis();
         FoundIndication indication = reader.scanMultiLineOneFile(null, br, "test");
@@ -221,7 +223,7 @@ public void testScanMultilineOneFileWithFileTimeout() throws Exception {
             zipStream.getNextEntry();
             inStream = new SequenceInputStream(inStream, zipStream);
         }
-        BufferedReader br = new QuadrupleDupleLineReader(new BufferedReader(new InputStreamReader(inStream)));
+        LineNumberReader br = new QuadrupleDupleLineReader(new BufferedReader(new InputStreamReader(inStream)));
         long startTime = System.currentTimeMillis();
         FoundIndication indication = reader.scanMultiLineOneFile(null, br, "test");
         long elapsedTime = System.currentTimeMillis() - startTime;
@@ -236,7 +238,7 @@ public void testScanMultilineOneFileWithFileTimeout() throws Exception {
      * and constructs the same line 15 times on top of the original.
      * This so that the scanning has more to work on and can timeout
      */
-    static class QuadrupleDupleLineReader extends BufferedReader {
+    static class QuadrupleDupleLineReader extends LineNumberReader {
 
         /**
          * Standard constructor