Add test for insert token.
[Sone.git] / src / test / java / net / pterodactylus / sone / core / FreenetInterfaceTest.java
index 5abf2c1..f4217eb 100644 (file)
@@ -1,9 +1,15 @@
 package net.pterodactylus.sone.core;
 
+import static freenet.client.InsertException.CANCELLED;
+import static freenet.client.InsertException.INTERNAL_ERROR;
 import static freenet.keys.InsertableClientSSK.createRandom;
+import static freenet.node.RequestStarter.INTERACTIVE_PRIORITY_CLASS;
+import static freenet.node.RequestStarter.PREFETCH_PRIORITY_CLASS;
 import static java.lang.System.currentTimeMillis;
 import static java.util.concurrent.TimeUnit.DAYS;
+import static java.util.concurrent.TimeUnit.SECONDS;
 import static net.pterodactylus.sone.Matchers.delivers;
+import static net.pterodactylus.sone.TestUtil.setFinalField;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
@@ -13,21 +19,28 @@ import static org.mockito.Matchers.any;
 import static org.mockito.Matchers.anyBoolean;
 import static org.mockito.Matchers.anyShort;
 import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 import static org.mockito.Mockito.withSettings;
 
 import java.io.IOException;
-import java.lang.reflect.Field;
-import java.lang.reflect.Modifier;
 import java.net.MalformedURLException;
 import java.util.HashMap;
+import java.util.concurrent.CountDownLatch;
 
+import net.pterodactylus.sone.TestUtil;
 import net.pterodactylus.sone.core.FreenetInterface.Callback;
 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
 import net.pterodactylus.sone.core.FreenetInterface.InsertToken;
+import net.pterodactylus.sone.core.FreenetInterface.InsertTokenSupplier;
+import net.pterodactylus.sone.core.event.ImageInsertAbortedEvent;
+import net.pterodactylus.sone.core.event.ImageInsertFailedEvent;
+import net.pterodactylus.sone.core.event.ImageInsertFinishedEvent;
 import net.pterodactylus.sone.core.event.ImageInsertStartedEvent;
 import net.pterodactylus.sone.data.Image;
 import net.pterodactylus.sone.data.ImageImpl;
@@ -60,6 +73,8 @@ import com.google.common.eventbus.EventBus;
 import org.junit.Before;
 import org.junit.Test;
 import org.mockito.ArgumentCaptor;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
 
 /**
  * Unit test for {@link FreenetInterface}.
@@ -76,6 +91,10 @@ public class FreenetInterfaceTest {
        private final USKManager uskManager = mock(USKManager.class);
        private FreenetInterface freenetInterface;
        private final Sone sone = mock(Sone.class);
+       private final ArgumentCaptor<USKCallback> callbackCaptor = forClass(USKCallback.class);
+       private final SoneDownloader soneDownloader = mock(SoneDownloader.class);
+       private final Image image = mock(Image.class);
+       private InsertToken insertToken;
 
        @Before
        public void setupFreenetInterface() {
@@ -84,6 +103,7 @@ public class FreenetInterfaceTest {
                setFinalField(node, "random", randomSource);
                setFinalField(nodeClientCore, "uskManager", uskManager);
                freenetInterface = new FreenetInterface(eventBus, node);
+               insertToken = freenetInterface.new InsertToken(image);
        }
 
        @Before
@@ -93,6 +113,11 @@ public class FreenetInterfaceTest {
                when(sone.getRequestUri()).thenReturn(insertSsk.getURI().uskForSSK());
        }
 
+       @Before
+       public void setupCallbackCaptorAndUskManager() {
+               doNothing().when(uskManager).subscribe(any(USK.class), callbackCaptor.capture(), anyBoolean(), any(RequestClient.class));
+       }
+
        @Test
        public void canFetchUri() throws MalformedURLException, FetchException {
                FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
@@ -132,21 +157,6 @@ public class FreenetInterfaceTest {
                return new FetchResult(clientMetadata, bucket);
        }
 
-       private void setFinalField(Object object, String fieldName, Object value) {
-               try {
-                       Field clientCoreField = object.getClass().getField(fieldName);
-                       clientCoreField.setAccessible(true);
-                       Field modifiersField = Field.class.getDeclaredField("modifiers");
-                       modifiersField.setAccessible(true);
-                       modifiersField.setInt(clientCoreField, clientCoreField.getModifiers() & ~Modifier.FINAL);
-                       clientCoreField.set(object, value);
-               } catch (NoSuchFieldException e) {
-                       throw new RuntimeException(e);
-               } catch (IllegalAccessException e) {
-                       throw new RuntimeException(e);
-               }
-       }
-
        @Test
        public void insertingAnImage() throws SoneException, InsertException, IOException {
                TemporaryImage temporaryImage = new TemporaryImage("image-id");
@@ -162,22 +172,10 @@ public class FreenetInterfaceTest {
                when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(false), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenReturn(clientPutter);
                freenetInterface.insertImage(temporaryImage, image, insertToken);
                assertThat(insertBlockCaptor.getValue().getData().getInputStream(), delivers(new byte[] { 1, 2, 3, 4 }));
-               assertThat(this.<ClientPutter>getPrivateField(insertToken, "clientPutter"), is(clientPutter));
+               assertThat(TestUtil.<ClientPutter>getPrivateField(insertToken, "clientPutter"), is(clientPutter));
                verify(eventBus).post(any(ImageInsertStartedEvent.class));
        }
 
-       private <T> T getPrivateField(Object object, String fieldName) {
-               try {
-                       Field field = object.getClass().getDeclaredField(fieldName);
-                       field.setAccessible(true);
-                       return (T) field.get(object);
-               } catch (NoSuchFieldException e) {
-                       throw new RuntimeException(e);
-               } catch (IllegalAccessException e) {
-                       throw new RuntimeException(e);
-               }
-       }
-
        @Test(expected = SoneInsertException.class)
        public void insertExceptionCausesASoneException() throws InsertException, SoneException, IOException {
                TemporaryImage temporaryImage = new TemporaryImage("image-id");
@@ -284,6 +282,63 @@ public class FreenetInterfaceTest {
        }
 
        @Test
+       public void callbackPrioritiesAreInteractive() {
+               freenetInterface.registerUsk(sone, null);
+               assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(INTERACTIVE_PRIORITY_CLASS));
+               assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
+       }
+
+       @Test
+       public void callbackForRegisteredSoneWithHigherEditionTriggersDownload() throws InterruptedException {
+               freenetInterface.registerUsk(sone, soneDownloader);
+               final CountDownLatch downloadTriggered = new CountDownLatch(1);
+               doAnswer(new Answer<Void>() {
+                       @Override
+                       public Void answer(InvocationOnMock invocation) throws Throwable {
+                               downloadTriggered.countDown();
+                               return null;
+                       }
+               }).when(soneDownloader).fetchSone(sone);
+               callbackCaptor.getValue().onFoundEdition(1, null, null, null, false, (short) 0, null, false, false);
+               assertThat(downloadTriggered.await(1, SECONDS), is(true));
+       }
+
+       @Test
+       public void callbackForRegisteredSoneWithTheSameEditionDoesNotTriggerDownload() throws InterruptedException {
+               freenetInterface.registerUsk(sone, soneDownloader);
+               final CountDownLatch downloadTriggered = new CountDownLatch(1);
+               doAnswer(new Answer<Void>() {
+                       @Override
+                       public Void answer(InvocationOnMock invocation) throws Throwable {
+                               downloadTriggered.countDown();
+                               return null;
+                       }
+               }).when(soneDownloader).fetchSone(sone);
+               callbackCaptor.getValue().onFoundEdition(0, null, null, null, false, (short) 0, null, false, false);
+               assertThat(downloadTriggered.await(1, SECONDS), is(false));
+       }
+
+       @Test
+       public void callbackForNormalUskUsesDifferentPriorities() {
+               Callback callback = mock(Callback.class);
+               FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
+               freenetInterface.registerUsk(uri, callback);
+               assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(PREFETCH_PRIORITY_CLASS));
+               assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
+       }
+
+       @Test
+       public void callbackForNormalUskForwardsImportantParameters() throws MalformedURLException {
+               Callback callback = mock(Callback.class);
+               FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
+               freenetInterface.registerUsk(uri, callback);
+               USK key = mock(USK.class);
+               when(key.getURI()).thenReturn(uri);
+               callbackCaptor.getValue().onFoundEdition(3, key, null, null, false, (short) 0, null, true, true);
+               verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true));
+       }
+
+       @Test
        public void fetchedRetainsUriAndFetchResult() {
                FreenetURI freenetUri = mock(FreenetURI.class);
                FetchResult fetchResult = mock(FetchResult.class);
@@ -292,4 +347,69 @@ public class FreenetInterfaceTest {
                assertThat(fetched.getFetchResult(), is(fetchResult));
        }
 
+       @Test
+       public void cancellingAnInsertWillFireImageInsertAbortedEvent() {
+               ClientPutter clientPutter = mock(ClientPutter.class);
+               insertToken.setClientPutter(clientPutter);
+               ArgumentCaptor<ImageInsertStartedEvent> imageInsertStartedEvent = forClass(ImageInsertStartedEvent.class);
+               verify(eventBus).post(imageInsertStartedEvent.capture());
+               assertThat(imageInsertStartedEvent.getValue().image(), is(image));
+               insertToken.cancel();
+               ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
+               verify(eventBus, times(2)).post(imageInsertAbortedEvent.capture());
+               assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
+       }
+
+       @Test
+       public void failureWithoutExceptionSendsFailedEvent() {
+               insertToken.onFailure(null, null, null);
+               ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
+               verify(eventBus).post(imageInsertFailedEvent.capture());
+               assertThat(imageInsertFailedEvent.getValue().image(), is(image));
+               assertThat(imageInsertFailedEvent.getValue().cause(), nullValue());
+       }
+
+       @Test
+       public void failureSendsFailedEventWithException() {
+               InsertException insertException = new InsertException(INTERNAL_ERROR, "Internal error", null);
+               insertToken.onFailure(insertException, null, null);
+               ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
+               verify(eventBus).post(imageInsertFailedEvent.capture());
+               assertThat(imageInsertFailedEvent.getValue().image(), is(image));
+               assertThat(imageInsertFailedEvent.getValue().cause(), is((Throwable) insertException));
+       }
+
+       @Test
+       public void failureBecauseCancelledByUserSendsAbortedEvent() {
+               InsertException insertException = new InsertException(CANCELLED, null);
+               insertToken.onFailure(insertException, null, null);
+               ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
+               verify(eventBus).post(imageInsertAbortedEvent.capture());
+               assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
+       }
+
+       @Test
+       public void ignoredMethodsDoNotThrowExceptions() {
+               insertToken.onMajorProgress(null);
+               insertToken.onFetchable(null, null);
+               insertToken.onGeneratedMetadata(null, null, null);
+       }
+
+       @Test
+       public void generatedUriIsPostedOnSuccess() {
+               FreenetURI generatedUri = mock(FreenetURI.class);
+               insertToken.onGeneratedURI(generatedUri, null, null);
+               insertToken.onSuccess(null, null);
+               ArgumentCaptor<ImageInsertFinishedEvent> imageInsertFinishedEvent = forClass(ImageInsertFinishedEvent.class);
+               verify(eventBus).post(imageInsertFinishedEvent.capture());
+               assertThat(imageInsertFinishedEvent.getValue().image(), is(image));
+               assertThat(imageInsertFinishedEvent.getValue().resultingUri(), is(generatedUri));
+       }
+
+       @Test
+       public void insertTokenSupplierSuppliesInsertTokens() {
+               InsertTokenSupplier insertTokenSupplier = freenetInterface.new InsertTokenSupplier();
+               assertThat(insertTokenSupplier.apply(image), notNullValue());
+       }
+
 }