Merge branch '41-alias-author-info' into 'master'

Refactor Author.Status into dedicated AuthorInfo class and add alias

See merge request briar/briar!968

bramble-core/src/main/java/org/briarproject/bramble/contact/ContactManagerImpl.java

@@ -10,6 +10,9 @@ import org.briarproject.bramble.api.db.NoSuchContactException;
 import org.briarproject.bramble.api.db.Transaction;
 import org.briarproject.bramble.api.identity.Author;
 import org.briarproject.bramble.api.identity.AuthorId;
+import org.briarproject.bramble.api.identity.AuthorInfo;
+import org.briarproject.bramble.api.identity.IdentityManager;
+import org.briarproject.bramble.api.identity.LocalAuthor;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import org.briarproject.bramble.api.transport.KeyManager;
 
@@ -23,6 +26,10 @@ import javax.annotation.concurrent.ThreadSafe;
 import javax.inject.Inject;
 
 import static org.briarproject.bramble.api.identity.AuthorConstants.MAX_AUTHOR_NAME_LENGTH;
+import static org.briarproject.bramble.api.identity.AuthorInfo.Status.OURSELVES;
+import static org.briarproject.bramble.api.identity.AuthorInfo.Status.UNKNOWN;
+import static org.briarproject.bramble.api.identity.AuthorInfo.Status.UNVERIFIED;
+import static org.briarproject.bramble.api.identity.AuthorInfo.Status.VERIFIED;
 import static org.briarproject.bramble.util.StringUtils.toUtf8;
 
 @ThreadSafe
@@ -31,12 +38,15 @@ class ContactManagerImpl implements ContactManager {
 
 	private final DatabaseComponent db;
 	private final KeyManager keyManager;
+	private final IdentityManager identityManager;
 	private final List<ContactHook> hooks;
 
 	@Inject
-	ContactManagerImpl(DatabaseComponent db, KeyManager keyManager) {
+	ContactManagerImpl(DatabaseComponent db, KeyManager keyManager,
+			IdentityManager identityManager) {
 		this.db = db;
 		this.keyManager = keyManager;
+		this.identityManager = identityManager;
 		hooks = new CopyOnWriteArrayList<>();
 	}
 
@@ -191,4 +201,23 @@ class ContactManagerImpl implements ContactManager {
 		db.removeContact(txn, c);
 	}
 
+	@Override
+	public AuthorInfo getAuthorInfo(AuthorId a) throws DbException {
+		return db.transactionWithResult(true, txn -> getAuthorInfo(txn, a));
+	}
+
+	@Override
+	public AuthorInfo getAuthorInfo(Transaction txn, AuthorId authorId)
+			throws DbException {
+		LocalAuthor localAuthor = identityManager.getLocalAuthor(txn);
+		if (localAuthor.getId().equals(authorId))
+			return new AuthorInfo(OURSELVES);
+		Collection<Contact> contacts = db.getContactsByAuthorId(txn, authorId);
+		if (contacts.isEmpty()) return new AuthorInfo(UNKNOWN);
+		if (contacts.size() > 1) throw new AssertionError();
+		Contact c = contacts.iterator().next();
+		if (c.isVerified()) return new AuthorInfo(VERIFIED, c.getAlias());
+		else return new AuthorInfo(UNVERIFIED, c.getAlias());
+	}
+
 }

bramble-core/src/main/java/org/briarproject/bramble/identity/IdentityManagerImpl.java

@@ -1,29 +1,21 @@
 package org.briarproject.bramble.identity;
 
-import org.briarproject.bramble.api.contact.Contact;
 import org.briarproject.bramble.api.crypto.CryptoComponent;
 import org.briarproject.bramble.api.crypto.KeyPair;
 import org.briarproject.bramble.api.db.DatabaseComponent;
 import org.briarproject.bramble.api.db.DbException;
 import org.briarproject.bramble.api.db.Transaction;
-import org.briarproject.bramble.api.identity.Author.Status;
 import org.briarproject.bramble.api.identity.AuthorFactory;
-import org.briarproject.bramble.api.identity.AuthorId;
 import org.briarproject.bramble.api.identity.IdentityManager;
 import org.briarproject.bramble.api.identity.LocalAuthor;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 
-import java.util.Collection;
 import java.util.logging.Logger;
 
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.ThreadSafe;
 import javax.inject.Inject;
 
-import static org.briarproject.bramble.api.identity.Author.Status.OURSELVES;
-import static org.briarproject.bramble.api.identity.Author.Status.UNKNOWN;
-import static org.briarproject.bramble.api.identity.Author.Status.UNVERIFIED;
-import static org.briarproject.bramble.api.identity.Author.Status.VERIFIED;
 import static org.briarproject.bramble.util.LogUtils.logDuration;
 import static org.briarproject.bramble.util.LogUtils.now;
 
@@ -118,26 +110,4 @@ class IdentityManagerImpl implements IdentityManager {
 		return db.getLocalAuthors(txn).iterator().next();
 	}
 
-	@Override
-	public Status getAuthorStatus(AuthorId authorId) throws DbException {
-		Transaction txn = db.startTransaction(true);
-		try {
-			return getAuthorStatus(txn, authorId);
-		} finally {
-			db.endTransaction(txn);
-		}
-	}
-
-	@Override
-	public Status getAuthorStatus(Transaction txn, AuthorId authorId)
-			throws DbException {
-		if (getLocalAuthor(txn).getId().equals(authorId)) return OURSELVES;
-		Collection<Contact> contacts = db.getContactsByAuthorId(txn, authorId);
-		if (contacts.isEmpty()) return UNKNOWN;
-		for (Contact c : contacts) {
-			if (c.isVerified()) return VERIFIED;
-		}
-		return UNVERIFIED;
-	}
-
 }

bramble-core/src/test/java/org/briarproject/bramble/contact/ContactManagerImplTest.java

@@ -5,10 +5,14 @@ import org.briarproject.bramble.api.contact.ContactId;
 import org.briarproject.bramble.api.contact.ContactManager;
 import org.briarproject.bramble.api.crypto.SecretKey;
 import org.briarproject.bramble.api.db.DatabaseComponent;
+import org.briarproject.bramble.api.db.DbException;
 import org.briarproject.bramble.api.db.NoSuchContactException;
 import org.briarproject.bramble.api.db.Transaction;
 import org.briarproject.bramble.api.identity.Author;
 import org.briarproject.bramble.api.identity.AuthorId;
+import org.briarproject.bramble.api.identity.AuthorInfo;
+import org.briarproject.bramble.api.identity.IdentityManager;
+import org.briarproject.bramble.api.identity.LocalAuthor;
 import org.briarproject.bramble.api.transport.KeyManager;
 import org.briarproject.bramble.test.BrambleMockTestCase;
 import org.briarproject.bramble.test.DbExpectations;
@@ -21,12 +25,20 @@ import java.util.Collection;
 import java.util.Collections;
 import java.util.Random;
 
+import static java.util.Collections.emptyList;
+import static java.util.Collections.singletonList;
 import static org.briarproject.bramble.api.identity.AuthorConstants.MAX_AUTHOR_NAME_LENGTH;
+import static org.briarproject.bramble.api.identity.AuthorInfo.Status.OURSELVES;
+import static org.briarproject.bramble.api.identity.AuthorInfo.Status.UNKNOWN;
+import static org.briarproject.bramble.api.identity.AuthorInfo.Status.UNVERIFIED;
+import static org.briarproject.bramble.api.identity.AuthorInfo.Status.VERIFIED;
 import static org.briarproject.bramble.test.TestUtils.getAuthor;
+import static org.briarproject.bramble.test.TestUtils.getLocalAuthor;
 import static org.briarproject.bramble.test.TestUtils.getRandomId;
 import static org.briarproject.bramble.test.TestUtils.getSecretKey;
 import static org.briarproject.bramble.util.StringUtils.getRandomString;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 
 public class ContactManagerImplTest extends BrambleMockTestCase {
@@ -34,17 +46,20 @@ public class ContactManagerImplTest extends BrambleMockTestCase {
 	private final Mockery context = new Mockery();
 	private final DatabaseComponent db = context.mock(DatabaseComponent.class);
 	private final KeyManager keyManager = context.mock(KeyManager.class);
+	private final IdentityManager identityManager =
+			context.mock(IdentityManager.class);
 	private final ContactManager contactManager;
 	private final ContactId contactId = new ContactId(42);
 	private final Author remote = getAuthor();
 	private final AuthorId local = new AuthorId(getRandomId());
+	private final LocalAuthor localAuthor = getLocalAuthor();
 	private final String alias = getRandomString(MAX_AUTHOR_NAME_LENGTH);
 	private final boolean verified = false, active = true;
 	private final Contact contact =
 			new Contact(contactId, remote, local, alias, verified, active);
 
 	public ContactManagerImplTest() {
-		contactManager = new ContactManagerImpl(db, keyManager);
+		contactManager = new ContactManagerImpl(db, keyManager, identityManager);
 	}
 
 	@Test
@@ -109,7 +124,7 @@ public class ContactManagerImplTest extends BrambleMockTestCase {
 			oneOf(db).startTransaction(true);
 			will(returnValue(txn));
 			oneOf(db).getContactsByAuthorId(txn, remote.getId());
-			will(returnValue(Collections.emptyList()));
+			will(returnValue(emptyList()));
 			oneOf(db).endTransaction(txn);
 		}});
 
@@ -208,4 +223,79 @@ public class ContactManagerImplTest extends BrambleMockTestCase {
 		assertTrue(contactManager.contactExists(remote.getId(), local));
 	}
 
+	@Test
+	public void testGetAuthorStatus() throws Exception {
+		Transaction txn = new Transaction(null, true);
+		Collection<Contact> contacts = singletonList(
+				new Contact(new ContactId(1), remote, localAuthor.getId(),
+						alias, false, true));
+
+		context.checking(new DbExpectations() {{
+			oneOf(db).transactionWithResult(with(equal(true)),
+					withDbCallable(txn));
+			oneOf(identityManager).getLocalAuthor(txn);
+			will(returnValue(localAuthor));
+			oneOf(db).getContactsByAuthorId(txn, remote.getId());
+			will(returnValue(contacts));
+		}});
+		AuthorInfo authorInfo =
+				contactManager.getAuthorInfo(txn, remote.getId());
+		assertEquals(UNVERIFIED, authorInfo.getStatus());
+		assertEquals(alias, contact.getAlias());
+	}
+
+	@Test
+	public void testGetAuthorStatusTransaction() throws DbException {
+		Transaction txn = new Transaction(null, true);
+
+		// check unknown author
+		context.checking(new Expectations() {{
+			oneOf(identityManager).getLocalAuthor(txn);
+			will(returnValue(localAuthor));
+			oneOf(db).getContactsByAuthorId(txn, remote.getId());
+			will(returnValue(emptyList()));
+		}});
+		AuthorInfo authorInfo =
+				contactManager.getAuthorInfo(txn, remote.getId());
+		assertEquals(UNKNOWN, authorInfo.getStatus());
+		assertNull(authorInfo.getAlias());
+
+		// check unverified contact
+		Collection<Contact> contacts = singletonList(
+				new Contact(new ContactId(1), remote, localAuthor.getId(),
+						alias, false, true));
+		checkAuthorStatusContext(txn, remote.getId(), contacts);
+		authorInfo = contactManager.getAuthorInfo(txn, remote.getId());
+		assertEquals(UNVERIFIED, authorInfo.getStatus());
+		assertEquals(alias, contact.getAlias());
+
+		// check verified contact
+		contacts = singletonList(new Contact(new ContactId(1), remote,
+				localAuthor.getId(), alias, true, true));
+		checkAuthorStatusContext(txn, remote.getId(), contacts);
+		authorInfo = contactManager.getAuthorInfo(txn, remote.getId());
+		assertEquals(VERIFIED, authorInfo.getStatus());
+		assertEquals(alias, contact.getAlias());
+
+		// check ourselves
+		context.checking(new Expectations() {{
+			oneOf(identityManager).getLocalAuthor(txn);
+			will(returnValue(localAuthor));
+			never(db).getContactsByAuthorId(txn, remote.getId());
+		}});
+		authorInfo = contactManager.getAuthorInfo(txn, localAuthor.getId());
+		assertEquals(OURSELVES, authorInfo.getStatus());
+		assertNull(authorInfo.getAlias());
+	}
+
+	private void checkAuthorStatusContext(Transaction txn, AuthorId authorId,
+			Collection<Contact> contacts) throws DbException {
+		context.checking(new Expectations() {{
+			oneOf(identityManager).getLocalAuthor(txn);
+			will(returnValue(localAuthor));
+			oneOf(db).getContactsByAuthorId(txn, authorId);
+			will(returnValue(contacts));
+		}});
+	}
+
 }

bramble-core/src/test/java/org/briarproject/bramble/identity/IdentityManagerImplTest.java

@@ -1,7 +1,5 @@
 package org.briarproject.bramble.identity;
 
-import org.briarproject.bramble.api.contact.Contact;
-import org.briarproject.bramble.api.contact.ContactId;
 import org.briarproject.bramble.api.crypto.CryptoComponent;
 import org.briarproject.bramble.api.crypto.KeyPair;
 import org.briarproject.bramble.api.crypto.PrivateKey;
@@ -9,9 +7,7 @@ import org.briarproject.bramble.api.crypto.PublicKey;
 import org.briarproject.bramble.api.db.DatabaseComponent;
 import org.briarproject.bramble.api.db.DbException;
 import org.briarproject.bramble.api.db.Transaction;
-import org.briarproject.bramble.api.identity.Author;
 import org.briarproject.bramble.api.identity.AuthorFactory;
-import org.briarproject.bramble.api.identity.AuthorId;
 import org.briarproject.bramble.api.identity.IdentityManager;
 import org.briarproject.bramble.api.identity.LocalAuthor;
 import org.briarproject.bramble.test.BrambleMockTestCase;
@@ -19,17 +15,10 @@ import org.jmock.Expectations;
 import org.junit.Before;
 import org.junit.Test;
 
-import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 
-import static org.briarproject.bramble.api.identity.Author.Status.OURSELVES;
-import static org.briarproject.bramble.api.identity.Author.Status.UNKNOWN;
-import static org.briarproject.bramble.api.identity.Author.Status.UNVERIFIED;
-import static org.briarproject.bramble.api.identity.Author.Status.VERIFIED;
-import static org.briarproject.bramble.test.TestUtils.getAuthor;
 import static org.briarproject.bramble.test.TestUtils.getLocalAuthor;
-import static org.briarproject.bramble.util.StringUtils.getRandomString;
 import static org.junit.Assert.assertEquals;
 
 public class IdentityManagerImplTest extends BrambleMockTestCase {
@@ -108,60 +97,4 @@ public class IdentityManagerImplTest extends BrambleMockTestCase {
 		assertEquals(localAuthor, identityManager.getLocalAuthor());
 	}
 
-	@Test
-	public void testGetAuthorStatus() throws DbException {
-		Author author = getAuthor();
-		AuthorId authorId = author.getId();
-		Collection<Contact> contacts = new ArrayList<>();
-
-		context.checking(new Expectations() {{
-			oneOf(db).startTransaction(true);
-			will(returnValue(txn));
-			oneOf(db).getLocalAuthors(txn);
-			will(returnValue(localAuthors));
-			oneOf(db).getContactsByAuthorId(txn, authorId);
-			will(returnValue(contacts));
-			oneOf(db).endTransaction(txn);
-		}});
-		assertEquals(UNKNOWN, identityManager.getAuthorStatus(authorId));
-
-		// add one unverified contact
-		Contact contact = new Contact(new ContactId(1), author,
-				localAuthor.getId(), getRandomString(5), false, true);
-		contacts.add(contact);
-
-		checkAuthorStatusContext(authorId, contacts);
-		assertEquals(UNVERIFIED, identityManager.getAuthorStatus(authorId));
-
-		// add one verified contact
-		Contact contact2 = new Contact(new ContactId(1), author,
-				localAuthor.getId(), getRandomString(5), true, true);
-		contacts.add(contact2);
-
-		checkAuthorStatusContext(authorId, contacts);
-		assertEquals(VERIFIED, identityManager.getAuthorStatus(authorId));
-
-		context.checking(new Expectations() {{
-			oneOf(db).startTransaction(true);
-			will(returnValue(txn));
-			never(db).getLocalAuthors(txn);
-			never(db).getContactsByAuthorId(txn, authorId);
-			oneOf(db).endTransaction(txn);
-		}});
-		assertEquals(OURSELVES,
-				identityManager.getAuthorStatus(localAuthor.getId()));
-	}
-
-	private void checkAuthorStatusContext(AuthorId authorId,
-			Collection<Contact> contacts) throws DbException {
-		context.checking(new Expectations() {{
-			oneOf(db).startTransaction(true);
-			will(returnValue(txn));
-			never(db).getLocalAuthors(txn);
-			oneOf(db).getContactsByAuthorId(txn, authorId);
-			will(returnValue(contacts));
-			oneOf(db).endTransaction(txn);
-		}});
-	}
-
 }

bramble-core/src/test/java/org/briarproject/bramble/test/DbExpectations.java

@@ -1,5 +1,6 @@
 package org.briarproject.bramble.test;
 
+import org.briarproject.bramble.api.db.DbCallable;
 import org.briarproject.bramble.api.db.DbRunnable;
 import org.briarproject.bramble.api.db.Transaction;
 import org.jmock.Expectations;
@@ -13,4 +14,11 @@ public class DbExpectations extends Expectations {
 		return null;
 	}
 
+	protected <R, E extends Exception> DbCallable<R, E> withDbCallable(
+			Transaction txn) {
+		addParameterMatcher(any(DbCallable.class));
+		currentBuilder().setAction(new RunTransactionWithResultAction(txn));
+		return null;
+	}
+
 }

bramble-core/src/test/java/org/briarproject/bramble/test/RunTransactionWithResultAction.java

@@ -0,0 +1,27 @@
+package org.briarproject.bramble.test;
+
+import org.briarproject.bramble.api.db.DbCallable;
+import org.briarproject.bramble.api.db.Transaction;
+import org.hamcrest.Description;
+import org.jmock.api.Action;
+import org.jmock.api.Invocation;
+
+public class RunTransactionWithResultAction implements Action {
+
+	private final Transaction txn;
+
+	public RunTransactionWithResultAction(Transaction txn) {
+		this.txn = txn;
+	}
+
+	@Override
+	public Object invoke(Invocation invocation) throws Throwable {
+		DbCallable task = (DbCallable) invocation.getParameter(1);
+		return task.call(txn);
+	}
+
+	@Override
+	public void describeTo(Description description) {
+		description.appendText("runs a task inside a database transaction");
+	}
+}