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 java.lang.System.currentTimeMillis;
   7 import static java.util.concurrent.TimeUnit.DAYS;
   8 import static java.util.concurrent.TimeUnit.SECONDS;
   9 import static net.pterodactylus.sone.Matchers.delivers;
  10 import static org.hamcrest.MatcherAssert.assertThat;
  11 import static org.hamcrest.Matchers.is;
  12 import static org.hamcrest.Matchers.notNullValue;
  13 import static org.hamcrest.Matchers.nullValue;
  14 import static org.mockito.ArgumentCaptor.forClass;
  15 import static org.mockito.Matchers.any;
  16 import static org.mockito.Matchers.anyBoolean;
  17 import static org.mockito.Matchers.anyShort;
  18 import static org.mockito.Matchers.eq;
  19 import static org.mockito.Mockito.doAnswer;
  20 import static org.mockito.Mockito.doNothing;
  21 import static org.mockito.Mockito.mock;
  22 import static org.mockito.Mockito.never;
  23 import static org.mockito.Mockito.verify;
  24 import static org.mockito.Mockito.when;
  25 import static org.mockito.Mockito.withSettings;
  26
  27 import java.io.IOException;
  28 import java.lang.reflect.Field;
  29 import java.lang.reflect.Modifier;
  30 import java.net.MalformedURLException;
  31 import java.util.HashMap;
  32 import java.util.concurrent.CountDownLatch;
  33
  34 import net.pterodactylus.sone.core.FreenetInterface.Callback;
  35 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
  36 import net.pterodactylus.sone.core.FreenetInterface.InsertToken;
  37 import net.pterodactylus.sone.core.event.ImageInsertStartedEvent;
  38 import net.pterodactylus.sone.data.Image;
  39 import net.pterodactylus.sone.data.ImageImpl;
  40 import net.pterodactylus.sone.data.Sone;
  41 import net.pterodactylus.sone.data.TemporaryImage;
  42 import net.pterodactylus.sone.freenet.StringBucket;
  43
  44 import freenet.client.ClientMetadata;
  45 import freenet.client.FetchException;
  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.async.ClientPutter;
  52 import freenet.client.async.USKCallback;
  53 import freenet.client.async.USKManager;
  54 import freenet.crypt.DummyRandomSource;
  55 import freenet.crypt.RandomSource;
  56 import freenet.keys.FreenetURI;
  57 import freenet.keys.InsertableClientSSK;
  58 import freenet.keys.USK;
  59 import freenet.node.Node;
  60 import freenet.node.NodeClientCore;
  61 import freenet.node.RequestClient;
  62 import freenet.support.Base64;
  63 import freenet.support.api.Bucket;
  64
  65 import com.google.common.eventbus.EventBus;
  66 import org.junit.Before;
  67 import org.junit.Test;
  68 import org.mockito.ArgumentCaptor;
  69 import org.mockito.invocation.InvocationOnMock;
  70 import org.mockito.stubbing.Answer;
  71
  72 /**
  73  * Unit test for {@link FreenetInterface}.
  74  *
  75  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  76  */
  77 public class FreenetInterfaceTest {
  78
  79         private final EventBus eventBus = mock(EventBus.class);
  80         private final Node node = mock(Node.class);
  81         private final NodeClientCore nodeClientCore = mock(NodeClientCore.class);
  82         private final HighLevelSimpleClient highLevelSimpleClient = mock(HighLevelSimpleClient.class, withSettings().extraInterfaces(RequestClient.class));
  83         private final RandomSource randomSource = new DummyRandomSource();
  84         private final USKManager uskManager = mock(USKManager.class);
  85         private FreenetInterface freenetInterface;
  86         private final Sone sone = mock(Sone.class);
  87         private final ArgumentCaptor<USKCallback> callbackCaptor = forClass(USKCallback.class);
  88         private final SoneDownloader soneDownloader = mock(SoneDownloader.class);
  89
  90         @Before
  91         public void setupFreenetInterface() {
  92                 when(nodeClientCore.makeClient(anyShort(), anyBoolean(), anyBoolean())).thenReturn(highLevelSimpleClient);
  93                 setFinalField(node, "clientCore", nodeClientCore);
  94                 setFinalField(node, "random", randomSource);
  95                 setFinalField(nodeClientCore, "uskManager", uskManager);
  96                 freenetInterface = new FreenetInterface(eventBus, node);
  97         }
  98
  99         @Before
 100         public void setupSone() {
 101                 InsertableClientSSK insertSsk = createRandom(randomSource, "test-0");
 102                 when(sone.getId()).thenReturn(Base64.encode(insertSsk.getURI().getRoutingKey()));
 103                 when(sone.getRequestUri()).thenReturn(insertSsk.getURI().uskForSSK());
 104         }
 105
 106         @Before
 107         public void setupCallbackCaptorAndUskManager() {
 108                 doNothing().when(uskManager).subscribe(any(USK.class), callbackCaptor.capture(), anyBoolean(), any(RequestClient.class));
 109         }
 110
 111         @Test
 112         public void canFetchUri() throws MalformedURLException, FetchException {
 113                 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
 114                 FetchResult fetchResult = createFetchResult();
 115                 when(highLevelSimpleClient.fetch(freenetUri)).thenReturn(fetchResult);
 116                 Fetched fetched = freenetInterface.fetchUri(freenetUri);
 117                 assertThat(fetched, notNullValue());
 118                 assertThat(fetched.getFetchResult(), is(fetchResult));
 119                 assertThat(fetched.getFreenetUri(), is(freenetUri));
 120         }
 121
 122         @Test
 123         public void fetchFollowsRedirect() throws MalformedURLException, FetchException {
 124                 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
 125                 FreenetURI newFreenetUri = new FreenetURI("KSK@GPLv3.txt");
 126                 FetchResult fetchResult = createFetchResult();
 127                 FetchException fetchException = new FetchException(FetchException.PERMANENT_REDIRECT, newFreenetUri);
 128                 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
 129                 when(highLevelSimpleClient.fetch(newFreenetUri)).thenReturn(fetchResult);
 130                 Fetched fetched = freenetInterface.fetchUri(freenetUri);
 131                 assertThat(fetched.getFetchResult(), is(fetchResult));
 132                 assertThat(fetched.getFreenetUri(), is(newFreenetUri));
 133         }
 134
 135         @Test
 136         public void fetchReturnsNullOnFetchExceptions() throws MalformedURLException, FetchException {
 137                 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
 138                 FetchException fetchException = new FetchException(FetchException.ALL_DATA_NOT_FOUND);
 139                 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
 140                 Fetched fetched = freenetInterface.fetchUri(freenetUri);
 141                 assertThat(fetched, nullValue());
 142         }
 143
 144         private FetchResult createFetchResult() {
 145                 ClientMetadata clientMetadata = new ClientMetadata("text/plain");
 146                 Bucket bucket = new StringBucket("Some Data.");
 147                 return new FetchResult(clientMetadata, bucket);
 148         }
 149
 150         private void setFinalField(Object object, String fieldName, Object value) {
 151                 try {
 152                         Field clientCoreField = object.getClass().getField(fieldName);
 153                         clientCoreField.setAccessible(true);
 154                         Field modifiersField = Field.class.getDeclaredField("modifiers");
 155                         modifiersField.setAccessible(true);
 156                         modifiersField.setInt(clientCoreField, clientCoreField.getModifiers() & ~Modifier.FINAL);
 157                         clientCoreField.set(object, value);
 158                 } catch (NoSuchFieldException e) {
 159                         throw new RuntimeException(e);
 160                 } catch (IllegalAccessException e) {
 161                         throw new RuntimeException(e);
 162                 }
 163         }
 164
 165         @Test
 166         public void insertingAnImage() throws SoneException, InsertException, IOException {
 167                 TemporaryImage temporaryImage = new TemporaryImage("image-id");
 168                 temporaryImage.setMimeType("image/png");
 169                 byte[] imageData = new byte[] { 1, 2, 3, 4 };
 170                 temporaryImage.setImageData(imageData);
 171                 Image image = new ImageImpl("image-id");
 172                 InsertToken insertToken = freenetInterface.new InsertToken(image);
 173                 InsertContext insertContext = mock(InsertContext.class);
 174                 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
 175                 ClientPutter clientPutter = mock(ClientPutter.class);
 176                 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
 177                 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(false), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenReturn(clientPutter);
 178                 freenetInterface.insertImage(temporaryImage, image, insertToken);
 179                 assertThat(insertBlockCaptor.getValue().getData().getInputStream(), delivers(new byte[] { 1, 2, 3, 4 }));
 180                 assertThat(this.<ClientPutter>getPrivateField(insertToken, "clientPutter"), is(clientPutter));
 181                 verify(eventBus).post(any(ImageInsertStartedEvent.class));
 182         }
 183
 184         private <T> T getPrivateField(Object object, String fieldName) {
 185                 try {
 186                         Field field = object.getClass().getDeclaredField(fieldName);
 187                         field.setAccessible(true);
 188                         return (T) field.get(object);
 189                 } catch (NoSuchFieldException e) {
 190                         throw new RuntimeException(e);
 191                 } catch (IllegalAccessException e) {
 192                         throw new RuntimeException(e);
 193                 }
 194         }
 195
 196         @Test(expected = SoneInsertException.class)
 197         public void insertExceptionCausesASoneException() throws InsertException, SoneException, IOException {
 198                 TemporaryImage temporaryImage = new TemporaryImage("image-id");
 199                 temporaryImage.setMimeType("image/png");
 200                 byte[] imageData = new byte[] { 1, 2, 3, 4 };
 201                 temporaryImage.setImageData(imageData);
 202                 Image image = new ImageImpl("image-id");
 203                 InsertToken insertToken = freenetInterface.new InsertToken(image);
 204                 InsertContext insertContext = mock(InsertContext.class);
 205                 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
 206                 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
 207                 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(false), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenThrow(InsertException.class);
 208                 freenetInterface.insertImage(temporaryImage, image, insertToken);
 209         }
 210
 211         @Test
 212         public void insertingADirectory() throws InsertException, SoneException {
 213                 FreenetURI freenetUri = mock(FreenetURI.class);
 214                 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
 215                 String defaultFile = "index.html";
 216                 FreenetURI resultingUri = mock(FreenetURI.class);
 217                 when(highLevelSimpleClient.insertManifest(eq(freenetUri), eq(manifestEntries), eq(defaultFile))).thenReturn(resultingUri);
 218                 assertThat(freenetInterface.insertDirectory(freenetUri, manifestEntries, defaultFile), is(resultingUri));
 219         }
 220
 221         @Test(expected = SoneException.class)
 222         public void insertExceptionIsForwardedAsSoneException() throws InsertException, SoneException {
 223                 when(highLevelSimpleClient.insertManifest(any(FreenetURI.class), any(HashMap.class), any(String.class))).thenThrow(InsertException.class);
 224                 freenetInterface.insertDirectory(null, null, null);
 225         }
 226
 227         @Test
 228         public void soneWithWrongRequestUriWillNotBeSubscribed() throws MalformedURLException {
 229                 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
 230                 freenetInterface.registerUsk(sone, null);
 231                 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), any(RequestClient.class));
 232         }
 233
 234         @Test
 235         public void registeringAUskForARecentlyModifiedSone() throws MalformedURLException {
 236                 when(sone.getTime()).thenReturn(currentTimeMillis() - DAYS.toMillis(1));
 237                 freenetInterface.registerUsk(sone, null);
 238                 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), eq(true), eq((RequestClient) highLevelSimpleClient));
 239         }
 240
 241         @Test
 242         public void registeringAUskForAnOldSone() throws MalformedURLException {
 243                 when(sone.getTime()).thenReturn(currentTimeMillis() - DAYS.toMillis(365));
 244                 freenetInterface.registerUsk(sone, null);
 245                 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), eq(false), eq((RequestClient) highLevelSimpleClient));
 246         }
 247
 248         @Test
 249         public void registeringAUsk() {
 250                 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
 251                 Callback callback = mock(Callback.class);
 252                 freenetInterface.registerUsk(freenetUri, callback);
 253                 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
 254         }
 255
 256         @Test
 257         public void registeringANonUskKeyWillNotBeSubscribed() throws MalformedURLException {
 258                 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
 259                 Callback callback = mock(Callback.class);
 260                 freenetInterface.registerUsk(freenetUri, callback);
 261                 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
 262         }
 263
 264         @Test
 265         public void unregisteringANotRegisteredUskDoesNothing() {
 266                 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
 267                 freenetInterface.unregisterUsk(freenetURI);
 268                 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
 269         }
 270
 271         @Test
 272         public void unregisteringARegisteredUsk() {
 273                 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
 274                 Callback callback = mock(Callback.class);
 275                 freenetInterface.registerUsk(freenetURI, callback);
 276                 freenetInterface.unregisterUsk(freenetURI);
 277                 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
 278         }
 279
 280         @Test
 281         public void unregisteringANotRegisteredSoneDoesNothing() {
 282                 freenetInterface.unregisterUsk(sone);
 283                 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
 284         }
 285
 286         @Test
 287         public void unregisteringARegisteredSoneUnregistersTheSone() {
 288                 freenetInterface.registerUsk(sone, null);
 289                 freenetInterface.unregisterUsk(sone);
 290                 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
 291         }
 292
 293         @Test
 294         public void unregisteringASoneWithAWrongRequestKeyWillNotUnsubscribe() throws MalformedURLException {
 295                 freenetInterface.registerUsk(sone, null);
 296                 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
 297                 freenetInterface.unregisterUsk(sone);
 298                 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
 299         }
 300
 301         @Test
 302         public void callbackPrioritiesAreInteractive() {
 303                 freenetInterface.registerUsk(sone, null);
 304                 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(INTERACTIVE_PRIORITY_CLASS));
 305                 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
 306         }
 307
 308         @Test
 309         public void callbackForRegisteredSoneWithHigherEditionTriggersDownload() throws InterruptedException {
 310                 freenetInterface.registerUsk(sone, soneDownloader);
 311                 final CountDownLatch downloadTriggered = new CountDownLatch(1);
 312                 doAnswer(new Answer<Void>() {
 313                         @Override
 314                         public Void answer(InvocationOnMock invocation) throws Throwable {
 315                                 downloadTriggered.countDown();
 316                                 return null;
 317                         }
 318                 }).when(soneDownloader).fetchSone(sone);
 319                 callbackCaptor.getValue().onFoundEdition(1, null, null, null, false, (short) 0, null, false, false);
 320                 assertThat(downloadTriggered.await(1, SECONDS), is(true));
 321         }
 322
 323         @Test
 324         public void callbackForRegisteredSoneWithTheSameEditionDoesNotTriggerDownload() throws InterruptedException {
 325                 freenetInterface.registerUsk(sone, soneDownloader);
 326                 final CountDownLatch downloadTriggered = new CountDownLatch(1);
 327                 doAnswer(new Answer<Void>() {
 328                         @Override
 329                         public Void answer(InvocationOnMock invocation) throws Throwable {
 330                                 downloadTriggered.countDown();
 331                                 return null;
 332                         }
 333                 }).when(soneDownloader).fetchSone(sone);
 334                 callbackCaptor.getValue().onFoundEdition(0, null, null, null, false, (short) 0, null, false, false);
 335                 assertThat(downloadTriggered.await(1, SECONDS), is(false));
 336         }
 337
 338         @Test
 339         public void callbackForNormalUskUsesDifferentPriorities() {
 340                 Callback callback = mock(Callback.class);
 341                 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
 342                 freenetInterface.registerUsk(uri, callback);
 343                 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(PREFETCH_PRIORITY_CLASS));
 344                 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
 345         }
 346
 347         @Test
 348         public void callbackForNormalUskForwardsImportantParameters() throws MalformedURLException {
 349                 Callback callback = mock(Callback.class);
 350                 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
 351                 freenetInterface.registerUsk(uri, callback);
 352                 USK key = mock(USK.class);
 353                 when(key.getURI()).thenReturn(uri);
 354                 callbackCaptor.getValue().onFoundEdition(3, key, null, null, false, (short) 0, null, true, true);
 355                 verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true));
 356         }
 357
 358         @Test
 359         public void fetchedRetainsUriAndFetchResult() {
 360                 FreenetURI freenetUri = mock(FreenetURI.class);
 361                 FetchResult fetchResult = mock(FetchResult.class);
 362                 Fetched fetched = new Fetched(freenetUri, fetchResult);
 363                 assertThat(fetched.getFreenetUri(), is(freenetUri));
 364                 assertThat(fetched.getFetchResult(), is(fetchResult));
 365         }
 366
 367 }