1 package net.pterodactylus.sone.core;
3 import static freenet.client.FetchException.FetchExceptionMode.ALL_DATA_NOT_FOUND;
4 import static freenet.keys.InsertableClientSSK.createRandom;
5 import static freenet.node.RequestStarter.INTERACTIVE_PRIORITY_CLASS;
6 import static freenet.node.RequestStarter.PREFETCH_PRIORITY_CLASS;
7 import static net.pterodactylus.sone.Matchers.delivers;
8 import static net.pterodactylus.sone.TestUtil.setFinalField;
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.ArgumentMatchers.any;
15 import static org.mockito.ArgumentMatchers.anyBoolean;
16 import static org.mockito.ArgumentMatchers.anyLong;
17 import static org.mockito.ArgumentMatchers.anyShort;
18 import static org.mockito.ArgumentMatchers.eq;
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.times;
23 import static org.mockito.Mockito.verify;
24 import static org.mockito.Mockito.verifyNoMoreInteractions;
25 import static org.mockito.Mockito.when;
26 import static org.mockito.Mockito.withSettings;
28 import java.io.IOException;
29 import java.net.MalformedURLException;
30 import java.util.HashMap;
32 import net.pterodactylus.sone.TestUtil;
33 import net.pterodactylus.sone.core.FreenetInterface.BackgroundFetchCallback;
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.FreenetInterface.InsertTokenSupplier;
38 import net.pterodactylus.sone.core.event.ImageInsertAbortedEvent;
39 import net.pterodactylus.sone.core.event.ImageInsertFailedEvent;
40 import net.pterodactylus.sone.core.event.ImageInsertFinishedEvent;
41 import net.pterodactylus.sone.core.event.ImageInsertStartedEvent;
42 import net.pterodactylus.sone.data.Image;
43 import net.pterodactylus.sone.data.Sone;
44 import net.pterodactylus.sone.data.TemporaryImage;
45 import net.pterodactylus.sone.data.impl.ImageImpl;
47 import freenet.client.ClientMetadata;
48 import freenet.client.FetchContext;
49 import freenet.client.FetchException;
50 import freenet.client.FetchException.FetchExceptionMode;
51 import freenet.client.FetchResult;
52 import freenet.client.HighLevelSimpleClient;
53 import freenet.client.InsertBlock;
54 import freenet.client.InsertContext;
55 import freenet.client.InsertException;
56 import freenet.client.InsertException.InsertExceptionMode;
57 import freenet.client.async.ClientGetCallback;
58 import freenet.client.async.ClientGetter;
59 import freenet.client.async.ClientPutter;
60 import freenet.client.async.USKCallback;
61 import freenet.client.async.USKManager;
62 import freenet.crypt.DummyRandomSource;
63 import freenet.crypt.RandomSource;
64 import freenet.keys.FreenetURI;
65 import freenet.keys.InsertableClientSSK;
66 import freenet.keys.USK;
67 import freenet.node.Node;
68 import freenet.node.NodeClientCore;
69 import freenet.node.RequestClient;
70 import freenet.support.Base64;
71 import freenet.support.api.Bucket;
72 import freenet.support.io.ArrayBucket;
73 import freenet.support.io.ResumeFailedException;
75 import com.google.common.eventbus.EventBus;
76 import org.junit.Before;
77 import org.junit.Test;
78 import org.mockito.ArgumentCaptor;
79 import org.mockito.ArgumentMatchers;
82 * Unit test for {@link FreenetInterface}.
84 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
86 public class FreenetInterfaceTest {
88 private final EventBus eventBus = mock(EventBus.class);
89 private final Node node = mock(Node.class);
90 private final NodeClientCore nodeClientCore = mock(NodeClientCore.class);
91 private final HighLevelSimpleClient highLevelSimpleClient = mock(HighLevelSimpleClient.class, withSettings().extraInterfaces(RequestClient.class));
92 private final RandomSource randomSource = new DummyRandomSource();
93 private final USKManager uskManager = mock(USKManager.class);
94 private FreenetInterface freenetInterface;
95 private final Sone sone = mock(Sone.class);
96 private final ArgumentCaptor<USKCallback> callbackCaptor = forClass(USKCallback.class);
97 private final Image image = mock(Image.class);
98 private InsertToken insertToken;
99 private final Bucket bucket = mock(Bucket.class);
100 private final ArgumentCaptor<ClientGetCallback> clientGetCallback = forClass(ClientGetCallback.class);
101 private final FreenetURI uri = new FreenetURI("KSK@pgl.png");
102 private final FetchResult fetchResult = mock(FetchResult.class);
103 private final BackgroundFetchCallback backgroundFetchCallback = mock(BackgroundFetchCallback.class);
105 public FreenetInterfaceTest() throws MalformedURLException {
109 public void setupHighLevelSimpleClient() {
110 when(highLevelSimpleClient.getFetchContext()).thenReturn(mock(FetchContext.class));
114 public void setupFreenetInterface() {
115 when(nodeClientCore.makeClient(anyShort(), anyBoolean(), anyBoolean())).thenReturn(highLevelSimpleClient);
116 setFinalField(node, "clientCore", nodeClientCore);
117 setFinalField(node, "random", randomSource);
118 setFinalField(nodeClientCore, "uskManager", uskManager);
119 freenetInterface = new FreenetInterface(eventBus, node);
120 insertToken = freenetInterface.new InsertToken(image);
121 insertToken.setBucket(bucket);
125 public void setupSone() {
126 InsertableClientSSK insertSsk = createRandom(randomSource, "test-0");
127 when(sone.getId()).thenReturn(Base64.encode(insertSsk.getURI().getRoutingKey()));
128 when(sone.getRequestUri()).thenReturn(insertSsk.getURI().uskForSSK());
132 public void setupCallbackCaptorAndUskManager() {
133 doNothing().when(uskManager).subscribe(any(USK.class), callbackCaptor.capture(), anyBoolean(), any(RequestClient.class));
137 public void canFetchUri() throws MalformedURLException, FetchException {
138 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
139 FetchResult fetchResult = createFetchResult();
140 when(highLevelSimpleClient.fetch(freenetUri)).thenReturn(fetchResult);
141 Fetched fetched = freenetInterface.fetchUri(freenetUri);
142 assertThat(fetched, notNullValue());
143 assertThat(fetched.getFetchResult(), is(fetchResult));
144 assertThat(fetched.getFreenetUri(), is(freenetUri));
148 public void fetchFollowsRedirect() throws MalformedURLException, FetchException {
149 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
150 FreenetURI newFreenetUri = new FreenetURI("KSK@GPLv3.txt");
151 FetchResult fetchResult = createFetchResult();
152 FetchException fetchException = new FetchException(FetchExceptionMode.PERMANENT_REDIRECT, newFreenetUri);
153 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
154 when(highLevelSimpleClient.fetch(newFreenetUri)).thenReturn(fetchResult);
155 Fetched fetched = freenetInterface.fetchUri(freenetUri);
156 assertThat(fetched.getFetchResult(), is(fetchResult));
157 assertThat(fetched.getFreenetUri(), is(newFreenetUri));
161 public void fetchReturnsNullOnFetchExceptions() throws MalformedURLException, FetchException {
162 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
163 FetchException fetchException = new FetchException(ALL_DATA_NOT_FOUND);
164 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
165 Fetched fetched = freenetInterface.fetchUri(freenetUri);
166 assertThat(fetched, nullValue());
169 private FetchResult createFetchResult() {
170 ClientMetadata clientMetadata = new ClientMetadata("text/plain");
171 Bucket bucket = new ArrayBucket("Some Data.".getBytes());
172 return new FetchResult(clientMetadata, bucket);
176 public void insertingAnImage() throws SoneException, InsertException, 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 InsertToken insertToken = freenetInterface.new InsertToken(image);
183 InsertContext insertContext = mock(InsertContext.class);
184 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
185 ClientPutter clientPutter = mock(ClientPutter.class);
186 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
187 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenReturn(clientPutter);
188 freenetInterface.insertImage(temporaryImage, image, insertToken);
189 assertThat(insertBlockCaptor.getValue().getData().getInputStream(), delivers(new byte[] { 1, 2, 3, 4 }));
190 assertThat(TestUtil.<ClientPutter>getPrivateField(insertToken, "clientPutter"), is(clientPutter));
191 verify(eventBus).post(any(ImageInsertStartedEvent.class));
194 @Test(expected = SoneInsertException.class)
195 public void insertExceptionCausesASoneException() throws InsertException, SoneException, IOException {
196 TemporaryImage temporaryImage = new TemporaryImage("image-id");
197 temporaryImage.setMimeType("image/png");
198 byte[] imageData = new byte[] { 1, 2, 3, 4 };
199 temporaryImage.setImageData(imageData);
200 Image image = new ImageImpl("image-id");
201 InsertToken insertToken = freenetInterface.new InsertToken(image);
202 InsertContext insertContext = mock(InsertContext.class);
203 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
204 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
205 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenThrow(InsertException.class);
206 freenetInterface.insertImage(temporaryImage, image, insertToken);
210 public void insertingADirectory() throws InsertException, SoneException {
211 FreenetURI freenetUri = mock(FreenetURI.class);
212 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
213 String defaultFile = "index.html";
214 FreenetURI resultingUri = mock(FreenetURI.class);
215 when(highLevelSimpleClient.insertManifest(eq(freenetUri), eq(manifestEntries), eq(defaultFile))).thenReturn(resultingUri);
216 assertThat(freenetInterface.insertDirectory(freenetUri, manifestEntries, defaultFile), is(resultingUri));
219 @Test(expected = SoneException.class)
220 public void insertExceptionIsForwardedAsSoneException() throws InsertException, SoneException {
221 when(highLevelSimpleClient.insertManifest(ArgumentMatchers.<FreenetURI>any(), ArgumentMatchers.<HashMap<String, Object>>any(), ArgumentMatchers.<String>any())).thenThrow(InsertException.class);
222 freenetInterface.insertDirectory(null, null, null);
226 public void soneWithWrongRequestUriWillNotBeSubscribed() throws MalformedURLException {
227 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
228 freenetInterface.registerUsk(new FreenetURI("KSK@GPLv3.txt"), null);
229 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), any(RequestClient.class));
233 public void registeringAUsk() {
234 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
235 Callback callback = mock(Callback.class);
236 freenetInterface.registerUsk(freenetUri, callback);
237 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
241 public void registeringANonUskKeyWillNotBeSubscribed() throws MalformedURLException {
242 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
243 Callback callback = mock(Callback.class);
244 freenetInterface.registerUsk(freenetUri, callback);
245 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
249 public void registeringAnActiveUskWillSubscribeToItCorrectly() {
250 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
251 final USKCallback uskCallback = mock(USKCallback.class);
252 freenetInterface.registerActiveUsk(freenetUri, uskCallback);
253 verify(uskManager).subscribe(any(USK.class), eq(uskCallback), eq(true), any(RequestClient.class));
257 public void registeringAnInactiveUskWillSubscribeToItCorrectly() {
258 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
259 final USKCallback uskCallback = mock(USKCallback.class);
260 freenetInterface.registerPassiveUsk(freenetUri, uskCallback);
261 verify(uskManager).subscribe(any(USK.class), eq(uskCallback), eq(false), any(RequestClient.class));
265 public void registeringAnActiveNonUskWillNotSubscribeToAUsk()
266 throws MalformedURLException {
267 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI();
268 freenetInterface.registerActiveUsk(freenetUri, null);
269 verify(uskManager, never()).subscribe(any(USK.class),
270 any(USKCallback.class), anyBoolean(),
271 eq((RequestClient) highLevelSimpleClient));
275 public void registeringAnInactiveNonUskWillNotSubscribeToAUsk()
276 throws MalformedURLException {
277 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI();
278 freenetInterface.registerPassiveUsk(freenetUri, null);
279 verify(uskManager, never()).subscribe(any(USK.class),
280 any(USKCallback.class), anyBoolean(),
281 eq((RequestClient) highLevelSimpleClient));
285 public void unregisteringANotRegisteredUskDoesNothing() {
286 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
287 freenetInterface.unregisterUsk(freenetURI);
288 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
292 public void unregisteringARegisteredUsk() {
293 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
294 Callback callback = mock(Callback.class);
295 freenetInterface.registerUsk(freenetURI, callback);
296 freenetInterface.unregisterUsk(freenetURI);
297 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
301 public void unregisteringANotRegisteredSoneDoesNothing() {
302 freenetInterface.unregisterUsk(sone);
303 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
307 public void unregisteringARegisteredSoneUnregistersTheSone()
308 throws MalformedURLException {
309 freenetInterface.registerActiveUsk(sone.getRequestUri(), mock(USKCallback.class));
310 freenetInterface.unregisterUsk(sone);
311 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
315 public void unregisteringASoneWithAWrongRequestKeyWillNotUnsubscribe() throws MalformedURLException {
316 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
317 freenetInterface.registerUsk(sone.getRequestUri(), null);
318 freenetInterface.unregisterUsk(sone);
319 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
323 public void callbackForNormalUskUsesDifferentPriorities() {
324 Callback callback = mock(Callback.class);
325 FreenetURI soneUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
326 freenetInterface.registerUsk(soneUri, callback);
327 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(PREFETCH_PRIORITY_CLASS));
328 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
332 public void callbackForNormalUskForwardsImportantParameters() throws MalformedURLException {
333 Callback callback = mock(Callback.class);
334 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
335 freenetInterface.registerUsk(uri, callback);
336 USK key = mock(USK.class);
337 when(key.getURI()).thenReturn(uri);
338 callbackCaptor.getValue().onFoundEdition(3, key, null, false, (short) 0, null, true, true);
339 verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true));
343 public void fetchedRetainsUriAndFetchResult() {
344 FreenetURI freenetUri = mock(FreenetURI.class);
345 FetchResult fetchResult = mock(FetchResult.class);
346 Fetched fetched = new Fetched(freenetUri, fetchResult);
347 assertThat(fetched.getFreenetUri(), is(freenetUri));
348 assertThat(fetched.getFetchResult(), is(fetchResult));
352 public void cancellingAnInsertWillFireImageInsertAbortedEvent() {
353 ClientPutter clientPutter = mock(ClientPutter.class);
354 insertToken.setClientPutter(clientPutter);
355 ArgumentCaptor<ImageInsertStartedEvent> imageInsertStartedEvent = forClass(ImageInsertStartedEvent.class);
356 verify(eventBus).post(imageInsertStartedEvent.capture());
357 assertThat(imageInsertStartedEvent.getValue().image(), is(image));
358 insertToken.cancel();
359 ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
360 verify(eventBus, times(2)).post(imageInsertAbortedEvent.capture());
361 verify(bucket).free();
362 assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
366 public void failureWithoutExceptionSendsFailedEvent() {
367 insertToken.onFailure(null, null);
368 ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
369 verify(eventBus).post(imageInsertFailedEvent.capture());
370 verify(bucket).free();
371 assertThat(imageInsertFailedEvent.getValue().image(), is(image));
372 assertThat(imageInsertFailedEvent.getValue().cause(), nullValue());
376 public void failureSendsFailedEventWithException() {
377 InsertException insertException = new InsertException(InsertExceptionMode.INTERNAL_ERROR, "Internal error", null);
378 insertToken.onFailure(insertException, null);
379 ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
380 verify(eventBus).post(imageInsertFailedEvent.capture());
381 verify(bucket).free();
382 assertThat(imageInsertFailedEvent.getValue().image(), is(image));
383 assertThat(imageInsertFailedEvent.getValue().cause(), is((Throwable) insertException));
387 public void failureBecauseCancelledByUserSendsAbortedEvent() {
388 InsertException insertException = new InsertException(InsertExceptionMode.CANCELLED, null);
389 insertToken.onFailure(insertException, null);
390 ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
391 verify(eventBus).post(imageInsertAbortedEvent.capture());
392 verify(bucket).free();
393 assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
397 public void ignoredMethodsDoNotThrowExceptions() throws ResumeFailedException {
398 insertToken.onResume(null);
399 insertToken.onFetchable(null);
400 insertToken.onGeneratedMetadata(null, null);
404 public void generatedUriIsPostedOnSuccess() {
405 FreenetURI generatedUri = mock(FreenetURI.class);
406 insertToken.onGeneratedURI(generatedUri, null);
407 insertToken.onSuccess(null);
408 ArgumentCaptor<ImageInsertFinishedEvent> imageInsertFinishedEvent = forClass(ImageInsertFinishedEvent.class);
409 verify(eventBus).post(imageInsertFinishedEvent.capture());
410 verify(bucket).free();
411 assertThat(imageInsertFinishedEvent.getValue().image(), is(image));
412 assertThat(imageInsertFinishedEvent.getValue().resultingUri(), is(generatedUri));
416 public void insertTokenSupplierSuppliesInsertTokens() {
417 InsertTokenSupplier insertTokenSupplier = freenetInterface.new InsertTokenSupplier();
418 assertThat(insertTokenSupplier.apply(image), notNullValue());
422 public void backgroundFetchCanBeStarted() throws Exception {
423 freenetInterface.startFetch(uri, backgroundFetchCallback);
424 verify(highLevelSimpleClient).fetch(eq(uri), anyLong(), any(ClientGetCallback.class), any(FetchContext.class), anyShort());
428 public void callbackOfBackgroundFetchIsNotifiedOnSuccess() throws Exception {
429 freenetInterface.startFetch(uri, backgroundFetchCallback);
430 verify(highLevelSimpleClient).fetch(eq(uri), anyLong(), clientGetCallback.capture(), any(FetchContext.class), anyShort());
431 when(fetchResult.getMimeType()).thenReturn("image/png");
432 when(fetchResult.asByteArray()).thenReturn(new byte[] { 1, 2, 3, 4, 5 });
433 clientGetCallback.getValue().onSuccess(fetchResult, mock(ClientGetter.class));
434 verify(backgroundFetchCallback).loaded(uri, "image/png", new byte[] { 1, 2, 3, 4, 5 });
435 verifyNoMoreInteractions(backgroundFetchCallback);
439 public void callbackOfBackgroundFetchIsNotifiedOnFailure() throws Exception {
440 freenetInterface.startFetch(uri, backgroundFetchCallback);
441 verify(highLevelSimpleClient).fetch(eq(uri), anyLong(), clientGetCallback.capture(), any(FetchContext.class), anyShort());
442 when(fetchResult.getMimeType()).thenReturn("image/png");
443 when(fetchResult.asByteArray()).thenReturn(new byte[] { 1, 2, 3, 4, 5 });
444 clientGetCallback.getValue().onFailure(new FetchException(ALL_DATA_NOT_FOUND), mock(ClientGetter.class));
445 verify(backgroundFetchCallback).failed(uri);
446 verifyNoMoreInteractions(backgroundFetchCallback);
450 public void callbackOfBackgroundFetchIsNotifiedAsFailureIfBucketCanNotBeLoaded() throws Exception {
451 freenetInterface.startFetch(uri, backgroundFetchCallback);
452 verify(highLevelSimpleClient).fetch(eq(uri), anyLong(), clientGetCallback.capture(), any(FetchContext.class), anyShort());
453 when(fetchResult.getMimeType()).thenReturn("image/png");
454 when(fetchResult.asByteArray()).thenThrow(IOException.class);
455 clientGetCallback.getValue().onSuccess(fetchResult, mock(ClientGetter.class));
456 verify(backgroundFetchCallback).failed(uri);
457 verifyNoMoreInteractions(backgroundFetchCallback);