Merge pull request #294 from hbz-5.0.1-hbzAddTest

Author: cboehme

.gitignore

@@ -29,6 +29,7 @@ build
 .classpath
 .project
 .settings/
+bin/
 
 # Ignore IntelliJ project files:
 *.ipr

metafacture-flowcontrol/src/main/java/org/metafacture/flowcontrol/ObjectPipeDecoupler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013, 2014 Deutsche Nationalbibliothek
+ * Copyright 2013-2019 Deutsche Nationalbibliothek and others
  *
  * Licensed under the Apache License, Version 2.0 the "License";
  * you may not use this file except in compliance with the License.
@@ -33,6 +33,7 @@
  * @param <T> Object type
  *
  * @author Markus Micheal Geipel
+ * @author Pascal Christoph (dr0i)
  */
 @In(Object.class)
 @Out(Object.class)
@@ -49,15 +50,15 @@ public final class ObjectPipeDecoupler<T> implements ObjectPipe<T, ObjectReceive
     private boolean debug;
 
     public ObjectPipeDecoupler() {
-        queue = new LinkedBlockingQueue<Object>(DEFAULT_CAPACITY);
+        queue = new LinkedBlockingQueue<>(DEFAULT_CAPACITY);
     }
 
     public ObjectPipeDecoupler(final int capacity) {
-        queue = new LinkedBlockingQueue<Object>(capacity);
+        queue = new LinkedBlockingQueue<>(capacity);
     }
 
     public ObjectPipeDecoupler(final String capacity) {
-        queue = new LinkedBlockingQueue<Object>(Integer.parseInt(capacity));
+        queue = new LinkedBlockingQueue<>(Integer.parseInt(capacity));
     }
 
     public void setDebug(final boolean debug) {
@@ -73,7 +74,7 @@ public void process(final T obj) {
         try {
             queue.put(obj);
             if (debug) {
-                LOG.info("Current buffer size: " + queue.size());
+                LOG.info("Current buffer size: {}", queue.size());
             }
         } catch (InterruptedException e) {
             Thread.currentThread().interrupt();
@@ -97,13 +98,17 @@ public <R extends ObjectReceiver<T>> R setReceiver(final R receiver) {
 
     @Override
     public void resetStream() {
-        queue.add(Feeder.BLUE_PILL);
+        try {
+            queue.put(Feeder.BLUE_PILL);
+        } catch (InterruptedException e) {
+            Thread.currentThread().interrupt();
+        }
     }
 
     @Override
     public void closeStream() {
-        queue.add(Feeder.RED_PILL);
         try {
+            queue.put(Feeder.RED_PILL);
             thread.join();
         } catch (InterruptedException e) {
             Thread.currentThread().interrupt();
@@ -147,6 +152,7 @@ public void run() {
                 }
             } catch (InterruptedException e) {
                 Thread.currentThread().interrupt();
+                return;
             }
         }
     }

metafacture-flowcontrol/src/main/java/org/metafacture/flowcontrol/ObjectThreader.java

@@ -0,0 +1,108 @@
+/* Copyright 2019 Pascal Christoph (hbz), and others.
+ * 
+ * Licensed under the Apache License, Version 2.0 the "License";
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.metafacture.flowcontrol;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.metafacture.framework.FluxCommand;
+import org.metafacture.framework.ObjectPipe;
+import org.metafacture.framework.ObjectReceiver;
+import org.metafacture.framework.Tee;
+import org.metafacture.framework.annotations.Description;
+import org.metafacture.framework.annotations.In;
+import org.metafacture.framework.annotations.Out;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Divides incoming objects and distributes them to added receivers. These
+ * receivers are coupled with an
+ * {@link org.metafacture.flowcontrol.ObjectPipeDecoupler}, so each added
+ * receiver runs in its own thread.
+ * 
+ * @param <T> Object type
+ *
+ * @author Pascal Christoph (dr0i)
+ * @author Fabian Steeg (fsteeg)
+ * 
+ */
+@In(Object.class)
+@Out(Object.class)
+@Description("Incoming objects are distributed to the added receivers, running in their own threads.")
+@FluxCommand("thread-object-tee")
+public class ObjectThreader<T> implements Tee<ObjectReceiver<T>>, ObjectPipe<T, ObjectReceiver<T>> {
+
+    private static final Logger LOG = LoggerFactory.getLogger(ObjectThreader.class);
+    private final List<ObjectReceiver<T>> receivers = new ArrayList<ObjectReceiver<T>>();
+    private int objectNumber = 0;
+
+    @Override
+    public void process(final T obj) {
+        receivers.get(objectNumber).process(obj);
+        if (objectNumber == receivers.size() - 1) {
+            objectNumber = 0;
+        } else {
+            objectNumber++;
+        }
+    }
+
+    @Override
+    public Tee<ObjectReceiver<T>> addReceiver(final ObjectReceiver<T> receiver) {
+        LOG.info("Adding thread {}", (receivers.size() + 1));
+        ObjectPipeDecoupler<T> opd = new ObjectPipeDecoupler<>();
+        opd.setReceiver(receiver);
+        receivers.add(opd);
+        return this;
+    }
+
+    @Override
+    public <R extends ObjectReceiver<T>> R setReceiver(final R receiver) {
+        receivers.clear();
+        addReceiver(receiver);
+        return receiver;
+    }
+
+    @Override
+    public <R extends ObjectReceiver<T>> R setReceivers(R receiver, ObjectReceiver<T> lateralReceiver) {
+        receivers.clear();
+        addReceiver(receiver);
+        addReceiver(lateralReceiver);
+        return receiver;
+    }
+
+    @Override
+    public void resetStream() {
+        receivers.forEach(ObjectReceiver::resetStream);
+    }
+
+    @Override
+    public void closeStream() {
+        receivers.forEach(ObjectReceiver::closeStream);
+    }
+
+    @Override
+    public Tee<ObjectReceiver<T>> removeReceiver(ObjectReceiver<T> receiver) {
+        receivers.remove(receiver);
+        return this;
+    }
+
+    @Override
+    public Tee<ObjectReceiver<T>> clearReceivers() {
+        receivers.clear();
+        return this;
+    }
+}

metafacture-flowcontrol/src/main/resources/flux-commands.properties

@@ -20,3 +20,4 @@ batch-reset org.metafacture.flowcontrol.StreamBatchResetter
 reset-object-batch org.metafacture.flowcontrol.ObjectBatchResetter
 defer-stream org.metafacture.flowcontrol.StreamDeferrer
 catch-stream-exception org.metafacture.flowcontrol.StreamExceptionCatcher
+thread-object-tee org.metafacture.flowcontrol.ObjectThreader

metafacture-flowcontrol/src/test/java/org/metafacture/flowcontrol/ObjectThreaderTest.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2019 Pascal Christoph, hbz.
+ *
+ * Licensed under the Apache License, Version 2.0 the "License";
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.metafacture.flowcontrol;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.atMost;
+import static org.mockito.Mockito.atLeast;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.metafacture.flowcontrol.ObjectThreader;
+import org.metafacture.framework.ObjectReceiver;
+
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+/**
+ * Tests for class {@link ObjectThreader} (which itself uses
+ * {@link org.metafacture.flowcontrol.ObjectPipeDecoupler} to thread receivers).
+ *
+ * @author Pascal Christoph (dr0i)
+ *
+ */
+public final class ObjectThreaderTest {
+
+	@Mock
+	private ObjectReceiver<String> receiverThread1;
+	@Mock
+	private ObjectReceiver<String> receiverThread2;
+
+	private final ObjectThreader<String> objectThreader = new ObjectThreader<>();
+	private static final int ACTIVE_THREADS_AT_BEGINNING = Thread.getAllStackTraces().keySet().size();
+
+	@Before
+	public void setup() {
+		MockitoAnnotations.initMocks(this);
+		objectThreader//
+				.addReceiver(receiverThread1)//
+				.addReceiver(receiverThread2);
+	}
+
+	@Test
+	public void shouldSplitAllObjectsToAllThreadedDownStreamReceivers() throws InterruptedException {
+		objectThreader.process("a");
+		objectThreader.process("b");
+		objectThreader.process("a");
+		objectThreader.process("c");
+		// check if two more threads were indeed created
+		assertThat(Thread.getAllStackTraces().keySet().size() - ACTIVE_THREADS_AT_BEGINNING).isEqualTo(2);
+		objectThreader.closeStream();
+		// verify thread 1
+		verify(receiverThread1, atLeast(2)).process("a");
+		verify(receiverThread1, atMost(0)).process("b");
+		verify(receiverThread1, atMost(0)).process("c");
+		// verify thread 2
+		verify(receiverThread2, atMost(0)).process("a");
+		verify(receiverThread2, atLeast(1)).process("b");
+		verify(receiverThread2, atLeast(1)).process("c");
+	}
+
+}