Merge branch 'async-events-commit-actions' into 'master'

Allow actions to be attached to transactions

See merge request briar/briar!1073

bramble-core/src/test/java/org/briarproject/bramble/db/DatabaseComponentImplTest.java

@@ -14,6 +14,7 @@ import org.briarproject.bramble.api.db.NoSuchGroupException;
 import org.briarproject.bramble.api.db.NoSuchLocalAuthorException;
 import org.briarproject.bramble.api.db.NoSuchMessageException;
 import org.briarproject.bramble.api.db.NoSuchTransportException;
+import org.briarproject.bramble.api.event.Event;
 import org.briarproject.bramble.api.event.EventBus;
 import org.briarproject.bramble.api.identity.Author;
 import org.briarproject.bramble.api.identity.LocalAuthor;
@@ -51,10 +52,12 @@ import org.briarproject.bramble.api.transport.TransportKeys;
 import org.briarproject.bramble.test.BrambleMockTestCase;
 import org.briarproject.bramble.test.CaptureArgumentAction;
 import org.jmock.Expectations;
+import org.jmock.Sequence;
 import org.junit.Test;
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.concurrent.Executor;
 import java.util.concurrent.atomic.AtomicReference;
 
 import static java.util.Arrays.asList;
@@ -87,9 +90,10 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 
 	@SuppressWarnings("unchecked")
 	private final Database<Object> database = context.mock(Database.class);
-	private final ShutdownManager shutdown =
+	private final ShutdownManager shutdownManager =
 			context.mock(ShutdownManager.class);
 	private final EventBus eventBus = context.mock(EventBus.class);
+	private final Executor eventExecutor = context.mock(Executor.class);
 
 	private final SecretKey key = getSecretKey();
 	private final Object txn = new Object();
@@ -132,9 +136,10 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 	}
 
 	private DatabaseComponent createDatabaseComponent(Database<Object> database,
-			EventBus eventBus, ShutdownManager shutdown) {
+			EventBus eventBus, Executor eventExecutor,
+			ShutdownManager shutdownManager) {
 		return new DatabaseComponentImpl<>(database, Object.class, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 	}
 
 	@Test
@@ -144,7 +149,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			// open()
 			oneOf(database).open(key, null);
 			will(returnValue(false));
-			oneOf(shutdown).addShutdownHook(with(any(Runnable.class)));
+			oneOf(shutdownManager).addShutdownHook(with(any(Runnable.class)));
 			will(returnValue(shutdownHandle));
 			// startTransaction()
 			oneOf(database).startTransaction();
@@ -207,7 +212,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).close();
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		assertFalse(db.open(key, null));
 		db.transaction(false, transaction -> {
@@ -238,7 +243,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).abortTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				db.addLocalMessage(transaction, message, metadata, true));
@@ -263,7 +268,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(eventBus).broadcast(with(any(MessageSharedEvent.class)));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				db.addLocalMessage(transaction, message, metadata, true));
@@ -281,7 +286,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			exactly(17).of(database).abortTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		try {
 			db.transaction(false, transaction ->
@@ -438,7 +443,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			exactly(3).of(database).abortTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		try {
 			db.transaction(false, transaction ->
@@ -481,7 +486,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			will(returnValue(true));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		try {
 			db.transaction(false, transaction ->
@@ -565,7 +570,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			will(returnValue(true));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		try {
 			db.transaction(false, transaction ->
@@ -668,7 +673,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			exactly(5).of(database).abortTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		try {
 			db.transaction(false, transaction ->
@@ -727,7 +732,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).commitTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction -> {
 			Ack a = db.generateAck(transaction, contactId, 123);
@@ -761,7 +766,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(eventBus).broadcast(with(any(MessagesSentEvent.class)));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				assertEquals(messages, db.generateBatch(transaction, contactId,
@@ -786,7 +791,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).commitTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction -> {
 			Offer o = db.generateOffer(transaction, contactId, 123, maxLatency);
@@ -810,7 +815,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).commitTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction -> {
 			Request r = db.generateRequest(transaction, contactId, 123);
@@ -844,7 +849,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(eventBus).broadcast(with(any(MessagesSentEvent.class)));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				assertEquals(messages, db.generateRequestedBatch(transaction,
@@ -865,7 +870,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(eventBus).broadcast(with(any(MessagesAckedEvent.class)));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction -> {
 			Ack a = new Ack(singletonList(messageId));
@@ -903,7 +908,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(eventBus).broadcast(with(any(MessageToAckEvent.class)));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction -> {
 			// Receive the message twice
@@ -931,7 +936,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(eventBus).broadcast(with(any(MessageToAckEvent.class)));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				db.receiveMessage(transaction, contactId, message));
@@ -949,7 +954,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).commitTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				db.receiveMessage(transaction, contactId, message));
@@ -989,7 +994,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(eventBus).broadcast(with(any(MessageToRequestEvent.class)));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		Offer o = new Offer(asList(messageId, messageId1,
 				messageId2, messageId3));
@@ -1012,7 +1017,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(eventBus).broadcast(with(any(MessageRequestedEvent.class)));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		Request r = new Request(singletonList(messageId));
 		db.transaction(false, transaction ->
@@ -1042,7 +1047,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 					GroupVisibilityUpdatedEvent.class, 0));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				db.setGroupVisibility(transaction, contactId, groupId,
@@ -1076,7 +1081,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 					GroupVisibilityUpdatedEvent.class, 0));
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				db.setGroupVisibility(transaction, contactId, groupId,
@@ -1102,7 +1107,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).commitTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction ->
 				db.setGroupVisibility(transaction, contactId, groupId,
@@ -1132,7 +1137,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).commitTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction -> {
 			db.updateTransportKeys(transaction, keys);
@@ -1171,7 +1176,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).commitTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(true, transaction -> {
 			// With visible group - return stored status
@@ -1221,7 +1226,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).commitTransaction(txn);
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(true, transaction -> {
 			// With visible group - return stored status
@@ -1287,7 +1292,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 		}});
 
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		db.transaction(false, transaction -> {
 			// First merge should broadcast an event
@@ -1330,7 +1335,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 		}});
 
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		assertNotNull(db.startTransaction(firstTxnReadOnly));
 		db.startTransaction(secondTxnReadOnly);
@@ -1351,7 +1356,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 		}});
 
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		try {
 			db.transaction(false, transaction ->
@@ -1380,7 +1385,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 		}});
 
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		try {
 			db.transaction(false, transaction ->
@@ -1401,7 +1406,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			// open()
 			oneOf(database).open(key, null);
 			will(returnValue(false));
-			oneOf(shutdown).addShutdownHook(with(any(Runnable.class)));
+			oneOf(shutdownManager).addShutdownHook(with(any(Runnable.class)));
 			will(returnValue(shutdownHandle));
 			// startTransaction()
 			oneOf(database).startTransaction();
@@ -1441,7 +1446,7 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 			oneOf(database).close();
 		}});
 		DatabaseComponent db = createDatabaseComponent(database, eventBus,
-				shutdown);
+				eventExecutor, shutdownManager);
 
 		assertFalse(db.open(key, null));
 		db.transaction(false, transaction -> {
@@ -1455,4 +1460,43 @@ public class DatabaseComponentImplTest extends BrambleMockTestCase {
 		});
 		db.close();
 	}
+
+	@Test
+	public void testCommitActionsOccurInOrder() throws Exception {
+		TestEvent action1 = new TestEvent();
+		Runnable action2 = () -> {
+		};
+		TestEvent action3 = new TestEvent();
+		Runnable action4 = () -> {
+		};
+
+		Sequence sequence = context.sequence("sequence");
+		context.checking(new Expectations() {{
+			oneOf(database).startTransaction();
+			will(returnValue(txn));
+			inSequence(sequence);
+			oneOf(database).commitTransaction(txn);
+			inSequence(sequence);
+			oneOf(eventBus).broadcast(action1);
+			inSequence(sequence);
+			oneOf(eventExecutor).execute(action2);
+			inSequence(sequence);
+			oneOf(eventBus).broadcast(action3);
+			inSequence(sequence);
+			oneOf(eventExecutor).execute(action4);
+			inSequence(sequence);
+		}});
+		DatabaseComponent db = createDatabaseComponent(database, eventBus,
+				eventExecutor, shutdownManager);
+
+		db.transaction(false, transaction -> {
+			transaction.attach(action1);
+			transaction.attach(action2);
+			transaction.attach(action3);
+			transaction.attach(action4);
+		});
+	}
+
+	private static class TestEvent extends Event {
+	}
 }