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