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