src/test/java/net/pterodactylus/sone/core/FreenetInterfaceTest.java

   1 package net.pterodactylus.sone.core;
   2
   3 import static freenet.keys.InsertableClientSSK.createRandom;
   4 import static freenet.node.RequestStarter.INTERACTIVE_PRIORITY_CLASS;
   5 import static freenet.node.RequestStarter.PREFETCH_PRIORITY_CLASS;
   6 import static net.pterodactylus.sone.Matchers.delivers;
   7 import static net.pterodactylus.sone.TestUtil.setFinalField;
   8 import static org.hamcrest.MatcherAssert.assertThat;
   9 import static org.hamcrest.Matchers.is;
  10 import static org.hamcrest.Matchers.notNullValue;
  11 import static org.hamcrest.Matchers.nullValue;
  12 import static org.mockito.ArgumentCaptor.forClass;
  13 import static org.mockito.Matchers.any;
  14 import static org.mockito.Matchers.anyBoolean;
  15 import static org.mockito.Matchers.anyShort;
  16 import static org.mockito.Matchers.eq;
  17 import static org.mockito.Mockito.doNothing;
  18 import static org.mockito.Mockito.mock;
  19 import static org.mockito.Mockito.never;
  20 import static org.mockito.Mockito.times;
  21 import static org.mockito.Mockito.verify;
  22 import static org.mockito.Mockito.when;
  23 import static org.mockito.Mockito.withSettings;
  24
  25 import java.io.IOException;
  26 import java.net.MalformedURLException;
  27 import java.util.HashMap;
  28
  29 import net.pterodactylus.sone.TestUtil;
  30 import net.pterodactylus.sone.core.FreenetInterface.Callback;
  31 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
  32 import net.pterodactylus.sone.core.FreenetInterface.InsertToken;
  33 import net.pterodactylus.sone.core.FreenetInterface.InsertTokenSupplier;
  34 import net.pterodactylus.sone.core.event.ImageInsertAbortedEvent;
  35 import net.pterodactylus.sone.core.event.ImageInsertFailedEvent;
  36 import net.pterodactylus.sone.core.event.ImageInsertFinishedEvent;
  37 import net.pterodactylus.sone.core.event.ImageInsertStartedEvent;
  38 import net.pterodactylus.sone.data.Image;
  39 import net.pterodactylus.sone.data.impl.ImageImpl;
  40 import net.pterodactylus.sone.data.Sone;
  41 import net.pterodactylus.sone.data.TemporaryImage;
  42
  43 import freenet.client.ClientMetadata;
  44 import freenet.client.FetchException;
  45 import freenet.client.FetchException.FetchExceptionMode;
  46 import freenet.client.FetchResult;
  47 import freenet.client.HighLevelSimpleClient;
  48 import freenet.client.InsertBlock;
  49 import freenet.client.InsertContext;
  50 import freenet.client.InsertException;
  51 import freenet.client.InsertException.InsertExceptionMode;
  52 import freenet.client.async.ClientPutter;
  53 import freenet.client.async.USKCallback;
  54 import freenet.client.async.USKManager;
  55 import freenet.crypt.DummyRandomSource;
  56 import freenet.crypt.RandomSource;
  57 import freenet.keys.FreenetURI;
  58 import freenet.keys.InsertableClientSSK;
  59 import freenet.keys.USK;
  60 import freenet.node.Node;
  61 import freenet.node.NodeClientCore;
  62 import freenet.node.RequestClient;
  63 import freenet.support.Base64;
  64 import freenet.support.api.Bucket;
  65 import freenet.support.io.ArrayBucket;
  66 import freenet.support.io.ResumeFailedException;
  67
  68 import com.google.common.eventbus.EventBus;
  69 import org.junit.Before;
  70 import org.junit.Test;
  71 import org.mockito.ArgumentCaptor;
  72
  73 /**
  74  * Unit test for {@link FreenetInterface}.
  75  *
  76  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  77  */
  78 public class FreenetInterfaceTest {
  79
  80         private final EventBus eventBus = mock(EventBus.class);
  81         private final Node node = mock(Node.class);
  82         private final NodeClientCore nodeClientCore = mock(NodeClientCore.class);
  83         private final HighLevelSimpleClient highLevelSimpleClient = mock(HighLevelSimpleClient.class, withSettings().extraInterfaces(RequestClient.class));
  84         private final RandomSource randomSource = new DummyRandomSource();
  85         private final USKManager uskManager = mock(USKManager.class);
  86         private FreenetInterface freenetInterface;
  87         private final Sone sone = mock(Sone.class);
  88         private final ArgumentCaptor<USKCallback> callbackCaptor = forClass(USKCallback.class);
  89         private final Image image = mock(Image.class);
  90         private InsertToken insertToken;
  91         private final Bucket bucket = mock(Bucket.class);
  92
  93         @Before
  94         public void setupFreenetInterface() {
  95                 when(nodeClientCore.makeClient(anyShort(), anyBoolean(), anyBoolean())).thenReturn(highLevelSimpleClient);
  96                 setFinalField(node, "clientCore", nodeClientCore);
  97                 setFinalField(node, "random", randomSource);
  98                 setFinalField(nodeClientCore, "uskManager", uskManager);
  99                 freenetInterface = new FreenetInterface(eventBus, node);
 100                 insertToken = freenetInterface.new InsertToken(image);
 101                 insertToken.setBucket(bucket);
 102         }
 103
 104         @Before
 105         public void setupSone() {
 106                 InsertableClientSSK insertSsk = createRandom(randomSource, "test-0");
 107                 when(sone.getId()).thenReturn(Base64.encode(insertSsk.getURI().getRoutingKey()));
 108                 when(sone.getRequestUri()).thenReturn(insertSsk.getURI().uskForSSK());
 109         }
 110
 111         @Before
 112         public void setupCallbackCaptorAndUskManager() {
 113                 doNothing().when(uskManager).subscribe(any(USK.class), callbackCaptor.capture(), anyBoolean(), any(RequestClient.class));
 114         }
 115
 116         @Test
 117         public void canFetchUri() throws MalformedURLException, FetchException {
 118                 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
 119                 FetchResult fetchResult = createFetchResult();
 120                 when(highLevelSimpleClient.fetch(freenetUri)).thenReturn(fetchResult);
 121                 Fetched fetched = freenetInterface.fetchUri(freenetUri);
 122                 assertThat(fetched, notNullValue());
 123                 assertThat(fetched.getFetchResult(), is(fetchResult));
 124                 assertThat(fetched.getFreenetUri(), is(freenetUri));
 125         }
 126
 127         @Test
 128         public void fetchFollowsRedirect() throws MalformedURLException, FetchException {
 129                 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
 130                 FreenetURI newFreenetUri = new FreenetURI("KSK@GPLv3.txt");
 131                 FetchResult fetchResult = createFetchResult();
 132                 FetchException fetchException = new FetchException(FetchExceptionMode.PERMANENT_REDIRECT, newFreenetUri);
 133                 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
 134                 when(highLevelSimpleClient.fetch(newFreenetUri)).thenReturn(fetchResult);
 135                 Fetched fetched = freenetInterface.fetchUri(freenetUri);
 136                 assertThat(fetched.getFetchResult(), is(fetchResult));
 137                 assertThat(fetched.getFreenetUri(), is(newFreenetUri));
 138         }
 139
 140         @Test
 141         public void fetchReturnsNullOnFetchExceptions() throws MalformedURLException, FetchException {
 142                 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
 143                 FetchException fetchException = new FetchException(FetchExceptionMode.ALL_DATA_NOT_FOUND);
 144                 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
 145                 Fetched fetched = freenetInterface.fetchUri(freenetUri);
 146                 assertThat(fetched, nullValue());
 147         }
 148
 149         private FetchResult createFetchResult() {
 150                 ClientMetadata clientMetadata = new ClientMetadata("text/plain");
 151                 Bucket bucket = new ArrayBucket("Some Data.".getBytes());
 152                 return new FetchResult(clientMetadata, bucket);
 153         }
 154
 155         @Test
 156         public void insertingAnImage() throws SoneException, InsertException, IOException {
 157                 TemporaryImage temporaryImage = new TemporaryImage("image-id");
 158                 temporaryImage.setMimeType("image/png");
 159                 byte[] imageData = new byte[] { 1, 2, 3, 4 };
 160                 temporaryImage.setImageData(imageData);
 161                 Image image = new ImageImpl("image-id");
 162                 image.modify().setSone(sone).update();
 163                 InsertToken insertToken = freenetInterface.new InsertToken(image);
 164                 InsertContext insertContext = mock(InsertContext.class);
 165                 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
 166                 ClientPutter clientPutter = mock(ClientPutter.class);
 167                 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
 168                 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenReturn(clientPutter);
 169                 freenetInterface.insertImage(temporaryImage, image, insertToken);
 170                 assertThat(insertBlockCaptor.getValue().getData().getInputStream(), delivers(new byte[] { 1, 2, 3, 4 }));
 171                 assertThat(TestUtil.<ClientPutter>getPrivateField(insertToken, "clientPutter"), is(clientPutter));
 172                 verify(eventBus).post(any(ImageInsertStartedEvent.class));
 173         }
 174
 175         @Test(expected = SoneInsertException.class)
 176         public void insertExceptionCausesASoneException() throws InsertException, SoneException, IOException {
 177                 TemporaryImage temporaryImage = new TemporaryImage("image-id");
 178                 temporaryImage.setMimeType("image/png");
 179                 byte[] imageData = new byte[] { 1, 2, 3, 4 };
 180                 temporaryImage.setImageData(imageData);
 181                 Image image = new ImageImpl("image-id");
 182                 image.modify().setSone(sone).update();
 183                 InsertToken insertToken = freenetInterface.new InsertToken(image);
 184                 InsertContext insertContext = mock(InsertContext.class);
 185                 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
 186                 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
 187                 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenThrow(InsertException.class);
 188                 freenetInterface.insertImage(temporaryImage, image, insertToken);
 189         }
 190
 191         @Test
 192         public void insertingADirectory() throws InsertException, SoneException {
 193                 FreenetURI freenetUri = mock(FreenetURI.class);
 194                 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
 195                 String defaultFile = "index.html";
 196                 FreenetURI resultingUri = mock(FreenetURI.class);
 197                 when(highLevelSimpleClient.insertManifest(eq(freenetUri), eq(manifestEntries), eq(defaultFile))).thenReturn(resultingUri);
 198                 assertThat(freenetInterface.insertDirectory(freenetUri, manifestEntries, defaultFile), is(resultingUri));
 199         }
 200
 201         @Test(expected = SoneException.class)
 202         public void insertExceptionIsForwardedAsSoneException() throws InsertException, SoneException {
 203                 when(highLevelSimpleClient.insertManifest(any(FreenetURI.class), any(HashMap.class), any(String.class))).thenThrow(InsertException.class);
 204                 freenetInterface.insertDirectory(null, null, null);
 205         }
 206
 207         @Test
 208         public void soneWithWrongRequestUriWillNotBeSubscribed() throws MalformedURLException {
 209                 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
 210                 freenetInterface.registerUsk(new FreenetURI("KSK@GPLv3.txt"), null);
 211                 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), any(RequestClient.class));
 212         }
 213
 214         @Test
 215         public void registeringAUsk() {
 216                 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
 217                 Callback callback = mock(Callback.class);
 218                 freenetInterface.registerUsk(freenetUri, callback);
 219                 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
 220         }
 221
 222         @Test
 223         public void registeringANonUskKeyWillNotBeSubscribed() throws MalformedURLException {
 224                 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
 225                 Callback callback = mock(Callback.class);
 226                 freenetInterface.registerUsk(freenetUri, callback);
 227                 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
 228         }
 229
 230         @Test
 231         public void registeringAnActiveUskWillSubscribeToItCorrectly() {
 232                 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
 233                 final USKCallback uskCallback = mock(USKCallback.class);
 234                 freenetInterface.registerActiveUsk(freenetUri, uskCallback);
 235                 verify(uskManager).subscribe(any(USK.class), eq(uskCallback), eq(true), any(RequestClient.class));
 236         }
 237
 238         @Test
 239         public void registeringAnInactiveUskWillSubscribeToItCorrectly() {
 240                 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
 241                 final USKCallback uskCallback = mock(USKCallback.class);
 242                 freenetInterface.registerPassiveUsk(freenetUri, uskCallback);
 243                 verify(uskManager).subscribe(any(USK.class), eq(uskCallback), eq(false), any(RequestClient.class));
 244         }
 245
 246         @Test
 247         public void registeringAnActiveNonUskWillNotSubscribeToAUsk()
 248         throws MalformedURLException {
 249                 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI();
 250             freenetInterface.registerActiveUsk(freenetUri, null);
 251                 verify(uskManager, never()).subscribe(any(USK.class),
 252                                 any(USKCallback.class), anyBoolean(),
 253                                 eq((RequestClient) highLevelSimpleClient));
 254         }
 255
 256         @Test
 257         public void registeringAnInactiveNonUskWillNotSubscribeToAUsk()
 258         throws MalformedURLException {
 259                 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI();
 260             freenetInterface.registerPassiveUsk(freenetUri, null);
 261                 verify(uskManager, never()).subscribe(any(USK.class),
 262                                 any(USKCallback.class), anyBoolean(),
 263                                 eq((RequestClient) highLevelSimpleClient));
 264         }
 265
 266         @Test
 267         public void unregisteringANotRegisteredUskDoesNothing() {
 268                 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
 269                 freenetInterface.unregisterUsk(freenetURI);
 270                 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
 271         }
 272
 273         @Test
 274         public void unregisteringARegisteredUsk() {
 275                 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
 276                 Callback callback = mock(Callback.class);
 277                 freenetInterface.registerUsk(freenetURI, callback);
 278                 freenetInterface.unregisterUsk(freenetURI);
 279                 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
 280         }
 281
 282         @Test
 283         public void unregisteringANotRegisteredSoneDoesNothing() {
 284                 freenetInterface.unregisterUsk(sone);
 285                 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
 286         }
 287
 288         @Test
 289         public void unregisteringARegisteredSoneUnregistersTheSone()
 290         throws MalformedURLException {
 291                 freenetInterface.registerActiveUsk(sone.getRequestUri(), mock(USKCallback.class));
 292                 freenetInterface.unregisterUsk(sone);
 293                 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
 294         }
 295
 296         @Test
 297         public void unregisteringASoneWithAWrongRequestKeyWillNotUnsubscribe() throws MalformedURLException {
 298                 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
 299                 freenetInterface.registerUsk(sone.getRequestUri(), null);
 300                 freenetInterface.unregisterUsk(sone);
 301                 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
 302         }
 303
 304         @Test
 305         public void callbackForNormalUskUsesDifferentPriorities() {
 306                 Callback callback = mock(Callback.class);
 307                 FreenetURI soneUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
 308                 freenetInterface.registerUsk(soneUri, callback);
 309                 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(PREFETCH_PRIORITY_CLASS));
 310                 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
 311         }
 312
 313         @Test
 314         public void callbackForNormalUskForwardsImportantParameters() throws MalformedURLException {
 315                 Callback callback = mock(Callback.class);
 316                 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
 317                 freenetInterface.registerUsk(uri, callback);
 318                 USK key = mock(USK.class);
 319                 when(key.getURI()).thenReturn(uri);
 320                 callbackCaptor.getValue().onFoundEdition(3, key, null, false, (short) 0, null, true, true);
 321                 verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true));
 322         }
 323
 324         @Test
 325         public void fetchedRetainsUriAndFetchResult() {
 326                 FreenetURI freenetUri = mock(FreenetURI.class);
 327                 FetchResult fetchResult = mock(FetchResult.class);
 328                 Fetched fetched = new Fetched(freenetUri, fetchResult);
 329                 assertThat(fetched.getFreenetUri(), is(freenetUri));
 330                 assertThat(fetched.getFetchResult(), is(fetchResult));
 331         }
 332
 333         @Test
 334         public void cancellingAnInsertWillFireImageInsertAbortedEvent() {
 335                 ClientPutter clientPutter = mock(ClientPutter.class);
 336                 insertToken.setClientPutter(clientPutter);
 337                 ArgumentCaptor<ImageInsertStartedEvent> imageInsertStartedEvent = forClass(ImageInsertStartedEvent.class);
 338                 verify(eventBus).post(imageInsertStartedEvent.capture());
 339                 assertThat(imageInsertStartedEvent.getValue().image(), is(image));
 340                 insertToken.cancel();
 341                 ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
 342                 verify(eventBus, times(2)).post(imageInsertAbortedEvent.capture());
 343                 verify(bucket).free();
 344                 assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
 345         }
 346
 347         @Test
 348         public void failureWithoutExceptionSendsFailedEvent() {
 349                 insertToken.onFailure(null, null);
 350                 ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
 351                 verify(eventBus).post(imageInsertFailedEvent.capture());
 352                 verify(bucket).free();
 353                 assertThat(imageInsertFailedEvent.getValue().image(), is(image));
 354                 assertThat(imageInsertFailedEvent.getValue().cause(), nullValue());
 355         }
 356
 357         @Test
 358         public void failureSendsFailedEventWithException() {
 359                 InsertException insertException = new InsertException(InsertExceptionMode.INTERNAL_ERROR, "Internal error", null);
 360                 insertToken.onFailure(insertException, null);
 361                 ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
 362                 verify(eventBus).post(imageInsertFailedEvent.capture());
 363                 verify(bucket).free();
 364                 assertThat(imageInsertFailedEvent.getValue().image(), is(image));
 365                 assertThat(imageInsertFailedEvent.getValue().cause(), is((Throwable) insertException));
 366         }
 367
 368         @Test
 369         public void failureBecauseCancelledByUserSendsAbortedEvent() {
 370                 InsertException insertException = new InsertException(InsertExceptionMode.CANCELLED, null);
 371                 insertToken.onFailure(insertException, null);
 372                 ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
 373                 verify(eventBus).post(imageInsertAbortedEvent.capture());
 374                 verify(bucket).free();
 375                 assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
 376         }
 377
 378         @Test
 379         public void ignoredMethodsDoNotThrowExceptions() throws ResumeFailedException {
 380                 insertToken.onResume(null);
 381                 insertToken.onFetchable(null);
 382                 insertToken.onGeneratedMetadata(null, null);
 383         }
 384
 385         @Test
 386         public void generatedUriIsPostedOnSuccess() {
 387                 FreenetURI generatedUri = mock(FreenetURI.class);
 388                 insertToken.onGeneratedURI(generatedUri, null);
 389                 insertToken.onSuccess(null);
 390                 ArgumentCaptor<ImageInsertFinishedEvent> imageInsertFinishedEvent = forClass(ImageInsertFinishedEvent.class);
 391                 verify(eventBus).post(imageInsertFinishedEvent.capture());
 392                 verify(bucket).free();
 393                 assertThat(imageInsertFinishedEvent.getValue().image(), is(image));
 394                 assertThat(imageInsertFinishedEvent.getValue().resultingUri(), is(generatedUri));
 395         }
 396
 397         @Test
 398         public void insertTokenSupplierSuppliesInsertTokens() {
 399                 InsertTokenSupplier insertTokenSupplier = freenetInterface.new InsertTokenSupplier();
 400                 assertThat(insertTokenSupplier.apply(image), notNullValue());
 401         }
 402
 403 }