From 93a6bf2f52499064e9a90f0432c4f314c266e93d Mon Sep 17 00:00:00 2001
From: akwizgran <michael@briarproject.org>
Date: Tue, 30 Oct 2018 16:04:25 +0000
Subject: [PATCH] Add logging to debug test failures.

---
 .../briar/test/BriarIntegrationTest.java      | 63 ++++++++++++++-----
 1 file changed, 49 insertions(+), 14 deletions(-)

diff --git a/briar-core/src/test/java/org/briarproject/briar/test/BriarIntegrationTest.java b/briar-core/src/test/java/org/briarproject/briar/test/BriarIntegrationTest.java
index c4743127b..005c06402 100644
--- a/briar-core/src/test/java/org/briarproject/briar/test/BriarIntegrationTest.java
+++ b/briar-core/src/test/java/org/briarproject/briar/test/BriarIntegrationTest.java
@@ -2,23 +2,26 @@ package org.briarproject.briar.test;
 
 import net.jodah.concurrentunit.Waiter;
 
+import org.briarproject.bramble.api.FormatException;
 import org.briarproject.bramble.api.client.ClientHelper;
 import org.briarproject.bramble.api.client.ContactGroupFactory;
 import org.briarproject.bramble.api.contact.Contact;
 import org.briarproject.bramble.api.contact.ContactId;
 import org.briarproject.bramble.api.contact.ContactManager;
 import org.briarproject.bramble.api.crypto.CryptoComponent;
+import org.briarproject.bramble.api.data.BdfList;
+import org.briarproject.bramble.api.data.BdfStringUtils;
 import org.briarproject.bramble.api.db.DatabaseComponent;
 import org.briarproject.bramble.api.db.DbException;
 import org.briarproject.bramble.api.event.Event;
 import org.briarproject.bramble.api.event.EventListener;
-import org.briarproject.bramble.api.identity.AuthorFactory;
 import org.briarproject.bramble.api.identity.IdentityManager;
 import org.briarproject.bramble.api.identity.LocalAuthor;
 import org.briarproject.bramble.api.lifecycle.LifecycleManager;
 import org.briarproject.bramble.api.nullsafety.MethodsNotNullByDefault;
 import org.briarproject.bramble.api.nullsafety.ParametersNotNullByDefault;
 import org.briarproject.bramble.api.sync.MessageFactory;
+import org.briarproject.bramble.api.sync.MessageId;
 import org.briarproject.bramble.api.sync.SyncSession;
 import org.briarproject.bramble.api.sync.SyncSessionFactory;
 import org.briarproject.bramble.api.sync.event.MessageStateChangedEvent;
@@ -55,21 +58,26 @@ import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.IOException;
+import java.util.concurrent.Executor;
+import java.util.concurrent.Semaphore;
 import java.util.concurrent.TimeoutException;
-import java.util.concurrent.atomic.AtomicInteger;
 import java.util.logging.Logger;
 
 import javax.annotation.Nullable;
 import javax.inject.Inject;
 
+import static java.util.concurrent.Executors.newSingleThreadExecutor;
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static java.util.logging.Level.WARNING;
 import static junit.framework.Assert.assertNotNull;
 import static org.briarproject.bramble.api.sync.ValidationManager.State.DELIVERED;
 import static org.briarproject.bramble.api.sync.ValidationManager.State.INVALID;
 import static org.briarproject.bramble.api.sync.ValidationManager.State.PENDING;
 import static org.briarproject.bramble.test.TestPluginConfigModule.MAX_LATENCY;
 import static org.briarproject.bramble.test.TestUtils.getSecretKey;
-import static org.junit.Assert.assertEquals;
+import static org.briarproject.bramble.util.LogUtils.logException;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 
 @MethodsNotNullByDefault
 @ParametersNotNullByDefault
@@ -103,8 +111,6 @@ public abstract class BriarIntegrationTest<C extends BriarIntegrationTestCompone
 	@Inject
 	protected ClientHelper clientHelper;
 	@Inject
-	protected AuthorFactory authorFactory;
-	@Inject
 	protected MessageFactory messageFactory;
 	@Inject
 	protected ContactGroupFactory contactGroupFactory;
@@ -124,11 +130,11 @@ public abstract class BriarIntegrationTest<C extends BriarIntegrationTestCompone
 	// objects accessed from background threads need to be volatile
 	private volatile Waiter validationWaiter;
 	private volatile Waiter deliveryWaiter;
-	private volatile AtomicInteger messageCounter = new AtomicInteger(0);
 
 	protected final static int TIMEOUT = 15000;
 	protected C c0, c1, c2;
 
+	private final Semaphore messageSemaphore = new Semaphore(0);
 	private final File testDir = TestUtils.getTestDirectory();
 	private final String AUTHOR0 = "Author 0";
 	private final String AUTHOR1 = "Author 1";
@@ -205,34 +211,57 @@ public abstract class BriarIntegrationTest<C extends BriarIntegrationTestCompone
 	}
 
 	private void listenToEvents() {
-		Listener listener0 = new Listener();
+		Listener listener0 = new Listener(c0);
 		c0.getEventBus().addListener(listener0);
-		Listener listener1 = new Listener();
+		Listener listener1 = new Listener(c1);
 		c1.getEventBus().addListener(listener1);
-		Listener listener2 = new Listener();
+		Listener listener2 = new Listener(c2);
 		c2.getEventBus().addListener(listener2);
 	}
 
 	private class Listener implements EventListener {
+
+		private final ClientHelper clientHelper;
+		private final Executor executor;
+
+		private Listener(C c) {
+			clientHelper = c.getClientHelper();
+			executor = newSingleThreadExecutor();
+		}
+
 		@Override
 		public void eventOccurred(Event e) {
 			if (e instanceof MessageStateChangedEvent) {
 				MessageStateChangedEvent event = (MessageStateChangedEvent) e;
 				if (!event.isLocal()) {
 					if (event.getState() == DELIVERED) {
-						LOG.info("Delivered new message");
-						messageCounter.addAndGet(1);
+						LOG.info("Delivered new message "
+								+ event.getMessageId());
+						loadAndLogMessage(event.getMessageId());
 						deliveryWaiter.resume();
 					} else if (event.getState() == INVALID ||
 							event.getState() == PENDING) {
 						LOG.info("Validated new " + event.getState().name() +
-								" message");
-						messageCounter.addAndGet(1);
+								" message " + event.getMessageId());
+						loadAndLogMessage(event.getMessageId());
 						validationWaiter.resume();
 					}
 				}
 			}
 		}
+
+		private void loadAndLogMessage(MessageId id) {
+			executor.execute(() -> {
+				try {
+					BdfList body = clientHelper.getMessageAsList(id);
+					LOG.info("Contents of " + id + ":\n"
+							+ BdfStringUtils.toString(body));
+				} catch (DbException | FormatException e) {
+					logException(LOG, WARNING, e);
+				}
+				messageSemaphore.release();
+			});
+		}
 	}
 
 	private void createAndRegisterIdentities() {
@@ -370,7 +399,13 @@ public abstract class BriarIntegrationTest<C extends BriarIntegrationTestCompone
 		} else {
 			validationWaiter.await(TIMEOUT, num);
 		}
-		assertEquals("Messages delivered", num, messageCounter.getAndSet(0));
+		try {
+			messageSemaphore.tryAcquire(num, TIMEOUT, MILLISECONDS);
+		} catch (InterruptedException e) {
+			LOG.info("Interrupted while waiting for messages");
+			Thread.currentThread().interrupt();
+			fail();
+		}
 	}
 
 	protected void removeAllContacts() throws DbException {