Add event handling tests and fix issue for createTxtFile

DEVSIX-5887

Author: ar3em

pdfocr-api/src/main/java/com/itextpdf/pdfocr/OcrProcessContext.java

@@ -26,7 +26,7 @@ This file is part of the iText (R) project.
  * Class for storing ocr processing context.
  */
 public class OcrProcessContext {
-    private final AbstractPdfOcrEventHelper ocrEventHelper;
+    private AbstractPdfOcrEventHelper ocrEventHelper;
 
     /**
      * Creates an instance of ocr process context
@@ -45,4 +45,13 @@ public OcrProcessContext(AbstractPdfOcrEventHelper eventHelper) {
     public AbstractPdfOcrEventHelper getOcrEventHelper() {
         return ocrEventHelper;
     }
+
+    /**
+     * Sets ocr event helper.
+     *
+     * @param eventHelper event helper
+     */
+    public void setOcrEventHelper(AbstractPdfOcrEventHelper eventHelper) {
+        this.ocrEventHelper = eventHelper;
+    }
 }

pdfocr-api/src/main/java/com/itextpdf/pdfocr/statistics/PdfOcrOutputTypeStatisticsAggregator.java

@@ -35,7 +35,7 @@ This file is part of the iText (R) project.
 /**
  * Statistics aggregator which aggregates types of ocr processing.
  */
-public class PdfOcrOutputTypeStatisticsAggregator extends AbstractStatisticsAggregator {
+class PdfOcrOutputTypeStatisticsAggregator extends AbstractStatisticsAggregator {
 
     private static final String STRING_FOR_DATA = "data";
     private static final String STRING_FOR_PDF = "pdf";

pdfocr-api/src/main/java/com/itextpdf/pdfocr/statistics/PdfOcrOutputTypeStatisticsEvent.java

@@ -81,7 +81,7 @@ public List<String> getStatisticsNames() {
      *
      * @return the statistics event type
      */
-    PdfOcrOutputType getPdfOcrStatisticsEventType() {
+    public PdfOcrOutputType getPdfOcrStatisticsEventType() {
         return type;
     }
 }

pdfocr-api/src/test/java/com/itextpdf/pdfocr/OcrPdfCreatorEventHelperTest.java

@@ -24,6 +24,10 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.commons.actions.AbstractProductITextEvent;
 import com.itextpdf.commons.actions.AbstractProductProcessITextEvent;
+import com.itextpdf.commons.actions.AbstractStatisticsEvent;
+import com.itextpdf.commons.actions.EventManager;
+import com.itextpdf.commons.actions.IEvent;
+import com.itextpdf.commons.actions.IEventHandler;
 import com.itextpdf.commons.actions.confirmations.EventConfirmationType;
 import com.itextpdf.commons.actions.contexts.IMetaInfo;
 import com.itextpdf.commons.actions.data.ProductData;
@@ -34,30 +38,51 @@ This file is part of the iText (R) project.
 import com.itextpdf.test.ExtendedITextTest;
 import com.itextpdf.test.annotations.type.UnitTest;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 
 @Category(UnitTest.class)
 public class OcrPdfCreatorEventHelperTest extends ExtendedITextTest {
     private static final ProductData DUMMY_PRODUCT_DATA =
             new ProductData("test-product", "inner_product", "1.0.0", 1900, 2100);
+    private StoreEventsHandler storeEventsHandler;
+
+    @Before
+    public void before() {
+        storeEventsHandler = new StoreEventsHandler();
+        EventManager.getInstance().register(storeEventsHandler);
+    }
+
+    @After
+    public void after() {
+        EventManager.getInstance().unregister(storeEventsHandler);
+        storeEventsHandler = null;
+    }
 
     @Test
     public void productContextBasedEventTest() {
         OcrPdfCreatorEventHelper helper = new OcrPdfCreatorEventHelper(new SequenceId(), new DummyMetaInfo());
         DummyITextEvent event = new DummyITextEvent();
         helper.onEvent(event);
 
-        // TODO DEVSIX-5887 assert event reached EventManager
+        Assert.assertEquals(1, storeEventsHandler.getEvents().size());
+        Assert.assertEquals(event, storeEventsHandler.getEvents().get(0));
     }
 
     @Test
-    public void statisticsEventTest() {
+    public void pdfOcrStatisticsEventTest() {
         OcrPdfCreatorEventHelper helper = new OcrPdfCreatorEventHelper(new SequenceId(), new DummyMetaInfo());
-        PdfOcrOutputTypeStatisticsEvent e = new PdfOcrOutputTypeStatisticsEvent(PdfOcrOutputType.PDF, DUMMY_PRODUCT_DATA);
+        PdfOcrOutputTypeStatisticsEvent e = new PdfOcrOutputTypeStatisticsEvent(PdfOcrOutputType.PDF,
+                DUMMY_PRODUCT_DATA);
         helper.onEvent(e);
 
-        // TODO DEVSIX-5887 assert event didn't reach EventManager
+        Assert.assertEquals(0, storeEventsHandler.getEvents().size());
     }
 
     @Test
@@ -66,7 +91,18 @@ public void customProductEventTest() {
         AbstractProductITextEvent event = new CustomProductITextEvent(DUMMY_PRODUCT_DATA);
         helper.onEvent(event);
 
-        // TODO DEVSIX-5887 assert event reached reach EventManager
+        Assert.assertEquals(1, storeEventsHandler.getEvents().size());
+        Assert.assertEquals(event, storeEventsHandler.getEvents().get(0));
+    }
+
+    @Test
+    public void customStatisticsEventTest() {
+        OcrPdfCreatorEventHelper helper = new OcrPdfCreatorEventHelper(new SequenceId(), new DummyMetaInfo());
+        CustomStatisticsEvent event = new CustomStatisticsEvent(DUMMY_PRODUCT_DATA);
+        helper.onEvent(event);
+
+        Assert.assertEquals(1, storeEventsHandler.getEvents().size());
+        Assert.assertEquals(event, storeEventsHandler.getEvents().get(0));
     }
 
     private static class DummyMetaInfo implements IMetaInfo {
@@ -89,4 +125,29 @@ protected CustomProductITextEvent(ProductData productData) {
             super(productData);
         }
     }
+
+    private static class CustomStatisticsEvent extends AbstractStatisticsEvent {
+
+        protected CustomStatisticsEvent(ProductData productData) {
+            super(productData);
+        }
+
+        @Override
+        public List<String> getStatisticsNames() {
+            return Collections.singletonList("custom-statistics");
+        }
+    }
+
+    private static class StoreEventsHandler implements IEventHandler {
+        private List<IEvent> events = new ArrayList<>();
+
+        public List<IEvent> getEvents() {
+            return events;
+        }
+
+        @Override
+        public void onEvent(IEvent event) {
+            events.add(event);
+        }
+    }
 }

pdfocr-api/src/test/java/com/itextpdf/pdfocr/OcrProcessContextTest.java

@@ -0,0 +1,61 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2021 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.pdfocr;
+
+import com.itextpdf.commons.actions.AbstractProductITextEvent;
+import com.itextpdf.commons.actions.confirmations.EventConfirmationType;
+import com.itextpdf.commons.actions.sequence.SequenceId;
+import com.itextpdf.test.ExtendedITextTest;
+import com.itextpdf.test.annotations.type.UnitTest;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+@Category(UnitTest.class)
+public class OcrProcessContextTest extends ExtendedITextTest {
+
+    @Test
+    public void setOcrEventHelperTest() {
+        AbstractPdfOcrEventHelper eventHelper = new CustomEventHelper();
+        OcrProcessContext context = new OcrProcessContext(eventHelper);
+        Assert.assertSame(eventHelper, context.getOcrEventHelper());
+    }
+
+    private static class CustomEventHelper extends AbstractPdfOcrEventHelper {
+        @Override
+        public void onEvent(AbstractProductITextEvent event) {
+            // Do nothing
+        }
+
+        @Override
+        public SequenceId getSequenceId() {
+            return null;
+        }
+
+        @Override
+        public EventConfirmationType getConfirmationType() {
+            return EventConfirmationType.ON_DEMAND;
+        }
+    }
+}

pdfocr-tesseract4/src/main/java/com/itextpdf/pdfocr/tesseract4/AbstractTesseract4OcrEngine.java

@@ -22,6 +22,8 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.pdfocr.tesseract4;
 
+import com.itextpdf.commons.actions.confirmations.ConfirmEvent;
+import com.itextpdf.commons.actions.confirmations.EventConfirmationType;
 import com.itextpdf.commons.actions.contexts.IMetaInfo;
 import com.itextpdf.commons.actions.data.ProductData;
 import com.itextpdf.commons.utils.MessageFormatUtil;
@@ -32,8 +34,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.pdfocr.OcrProcessContext;
 import com.itextpdf.pdfocr.PdfOcrMetaInfoContainer;
 import com.itextpdf.pdfocr.TextInfo;
-import com.itextpdf.pdfocr.statistics.PdfOcrOutputTypeStatisticsEvent;
 import com.itextpdf.pdfocr.statistics.PdfOcrOutputType;
+import com.itextpdf.pdfocr.statistics.PdfOcrOutputTypeStatisticsEvent;
 import com.itextpdf.pdfocr.tesseract4.actions.data.PdfOcrTesseract4ProductData;
 import com.itextpdf.pdfocr.tesseract4.actions.events.PdfOcrTesseract4ProductEvent;
 import com.itextpdf.pdfocr.tesseract4.exceptions.Tesseract4OcrException;
@@ -138,14 +140,36 @@ public void createTxtFile(final List<File> inputImages, final File txtFile,
                         Tesseract4LogMessageConstant.START_OCR_FOR_IMAGES,
                         inputImages.size()));
 
-        StringBuilder content = new StringBuilder();
-        for (File inputImage : inputImages) {
-            content.append(doImageOcr(inputImage, OutputFormat.TXT, ocrProcessContext));
+        AbstractPdfOcrEventHelper storedEventHelper;
+        if (ocrProcessContext.getOcrEventHelper() == null) {
+            storedEventHelper = new Tesseract4EventHelper();
+        } else {
+            storedEventHelper = ocrProcessContext.getOcrEventHelper();
         }
 
-        // write to file
-        TesseractHelper.writeToTextFile(txtFile.getAbsolutePath(),
-                content.toString());
+        PdfOcrTesseract4ProductEvent event = PdfOcrTesseract4ProductEvent.createProcessImageEvent(
+                storedEventHelper.getSequenceId(), null, storedEventHelper.getConfirmationType());
+        storedEventHelper.onEvent(event);
+
+        try {
+            // set Tesseract4FileResultEventHelper
+            ocrProcessContext.setOcrEventHelper(new Tesseract4FileResultEventHelper(storedEventHelper));
+
+            StringBuilder content = new StringBuilder();
+            for (File inputImage : inputImages) {
+                content.append(doImageOcr(inputImage, OutputFormat.TXT, ocrProcessContext));
+            }
+
+            // write to file
+            TesseractHelper.writeToTextFile(txtFile.getAbsolutePath(),
+                    content.toString());
+
+            if (event.getConfirmationType() == EventConfirmationType.ON_DEMAND) {
+                storedEventHelper.onEvent(new ConfirmEvent(event));
+            }
+        } finally {
+            ocrProcessContext.setOcrEventHelper(storedEventHelper);
+        }
     }
 
     /**
@@ -235,7 +259,8 @@ public final String doImageOcr(final File input,
             final OcrProcessContext ocrProcessContext) {
         String result = "";
         verifyImageFormatValidity(input);
-        ITesseractOcrResult processedData = processInputFiles(input, outputFormat, ocrProcessContext.getOcrEventHelper());
+        ITesseractOcrResult processedData = processInputFiles(input, outputFormat,
+                ocrProcessContext.getOcrEventHelper());
         if (processedData != null) {
             if (outputFormat.equals(OutputFormat.TXT)) {
                 result = ((StringTesseractOcrResult)processedData).getData();

pdfocr-tesseract4/src/main/java/com/itextpdf/pdfocr/tesseract4/Tesseract4EventHelper.java

@@ -34,6 +34,10 @@ This file is part of the iText (R) project.
  */
 class Tesseract4EventHelper extends AbstractPdfOcrEventHelper {
 
+    Tesseract4EventHelper() {
+        // do nothing
+    }
+
     @Override
     public void onEvent(AbstractProductITextEvent event) {
         if (event instanceof AbstractContextBasedITextEvent) {

pdfocr-tesseract4/src/main/java/com/itextpdf/pdfocr/tesseract4/Tesseract4ExecutableOcrEngine.java

@@ -196,7 +196,7 @@ void doTesseractOcr(final File inputImage,
 
             // confrim on_demand event
             if (event != null && event.getConfirmationType() == EventConfirmationType.ON_DEMAND) {
-                EventManager.getInstance().onEvent(new ConfirmEvent(event));
+                eventHelper.onEvent(new ConfirmEvent(event));
             }
         } catch (Tesseract4OcrException e) {
             LoggerFactory.getLogger(getClass())

pdfocr-tesseract4/src/main/java/com/itextpdf/pdfocr/tesseract4/Tesseract4FileResultEventHelper.java

@@ -0,0 +1,77 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2021 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.pdfocr.tesseract4;
+
+import com.itextpdf.commons.actions.AbstractProductITextEvent;
+import com.itextpdf.commons.actions.confirmations.ConfirmEvent;
+import com.itextpdf.commons.actions.confirmations.EventConfirmationType;
+import com.itextpdf.commons.actions.sequence.SequenceId;
+import com.itextpdf.pdfocr.AbstractPdfOcrEventHelper;
+import com.itextpdf.pdfocr.tesseract4.actions.events.PdfOcrTesseract4ProductEvent;
+
+/**
+ * Helper class for working with events.
+ */
+class Tesseract4FileResultEventHelper extends AbstractPdfOcrEventHelper {
+
+    private AbstractPdfOcrEventHelper wrappedEventHelper;
+
+    Tesseract4FileResultEventHelper() {
+        this(null);
+    }
+
+    Tesseract4FileResultEventHelper(AbstractPdfOcrEventHelper wrappedEventHelper) {
+        this.wrappedEventHelper = wrappedEventHelper == null ? new Tesseract4EventHelper() : wrappedEventHelper;
+    }
+
+    @Override
+    public void onEvent(AbstractProductITextEvent event) {
+        if (!isProcessImageEvent(event)
+                && !isConfirmForProcessImageEvent(event)) {
+            wrappedEventHelper.onEvent(event);
+        }
+    }
+
+    @Override
+    public SequenceId getSequenceId() {
+        return wrappedEventHelper.getSequenceId();
+    }
+
+    @Override
+    public EventConfirmationType getConfirmationType() {
+        return wrappedEventHelper.getConfirmationType();
+    }
+
+    private static boolean isProcessImageEvent(AbstractProductITextEvent event) {
+        return event instanceof PdfOcrTesseract4ProductEvent
+                && PdfOcrTesseract4ProductEvent.PROCESS_IMAGE.equals(
+                ((PdfOcrTesseract4ProductEvent) event).getEventType());
+    }
+
+    private static boolean isConfirmForProcessImageEvent(AbstractProductITextEvent event) {
+        return event instanceof ConfirmEvent
+                && ((ConfirmEvent) event).getConfirmedEvent() instanceof PdfOcrTesseract4ProductEvent
+                && PdfOcrTesseract4ProductEvent.PROCESS_IMAGE.equals(
+                ((ConfirmEvent) event).getConfirmedEvent().getEventType());
+    }
+}