1 package net.pterodactylus.sone.core;
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.ArgumentMatchers.any;
14 import static org.mockito.ArgumentMatchers.anyBoolean;
15 import static org.mockito.ArgumentMatchers.anyShort;
16 import static org.mockito.ArgumentMatchers.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;
25 import java.io.IOException;
26 import java.net.MalformedURLException;
27 import java.util.HashMap;
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;
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;
68 import com.google.common.eventbus.EventBus;
69 import org.junit.Before;
70 import org.junit.Test;
71 import org.mockito.ArgumentCaptor;
72 import org.mockito.ArgumentMatchers;
75 * Unit test for {@link FreenetInterface}.
77 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
79 public class FreenetInterfaceTest {
81 private final EventBus eventBus = mock(EventBus.class);
82 private final Node node = mock(Node.class);
83 private final NodeClientCore nodeClientCore = mock(NodeClientCore.class);
84 private final HighLevelSimpleClient highLevelSimpleClient = mock(HighLevelSimpleClient.class, withSettings().extraInterfaces(RequestClient.class));
85 private final RandomSource randomSource = new DummyRandomSource();
86 private final USKManager uskManager = mock(USKManager.class);
87 private FreenetInterface freenetInterface;
88 private final Sone sone = mock(Sone.class);
89 private final ArgumentCaptor<USKCallback> callbackCaptor = forClass(USKCallback.class);
90 private final Image image = mock(Image.class);
91 private InsertToken insertToken;
92 private final Bucket bucket = mock(Bucket.class);
95 public void setupFreenetInterface() {
96 when(nodeClientCore.makeClient(anyShort(), anyBoolean(), anyBoolean())).thenReturn(highLevelSimpleClient);
97 setFinalField(node, "clientCore", nodeClientCore);
98 setFinalField(node, "random", randomSource);
99 setFinalField(nodeClientCore, "uskManager", uskManager);
100 freenetInterface = new FreenetInterface(eventBus, node);
101 insertToken = freenetInterface.new InsertToken(image);
102 insertToken.setBucket(bucket);
106 public void setupSone() {
107 InsertableClientSSK insertSsk = createRandom(randomSource, "test-0");
108 when(sone.getId()).thenReturn(Base64.encode(insertSsk.getURI().getRoutingKey()));
109 when(sone.getRequestUri()).thenReturn(insertSsk.getURI().uskForSSK());
113 public void setupCallbackCaptorAndUskManager() {
114 doNothing().when(uskManager).subscribe(any(USK.class), callbackCaptor.capture(), anyBoolean(), any(RequestClient.class));
118 public void canFetchUri() throws MalformedURLException, FetchException {
119 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
120 FetchResult fetchResult = createFetchResult();
121 when(highLevelSimpleClient.fetch(freenetUri)).thenReturn(fetchResult);
122 Fetched fetched = freenetInterface.fetchUri(freenetUri);
123 assertThat(fetched, notNullValue());
124 assertThat(fetched.getFetchResult(), is(fetchResult));
125 assertThat(fetched.getFreenetUri(), is(freenetUri));
129 public void fetchFollowsRedirect() throws MalformedURLException, FetchException {
130 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
131 FreenetURI newFreenetUri = new FreenetURI("KSK@GPLv3.txt");
132 FetchResult fetchResult = createFetchResult();
133 FetchException fetchException = new FetchException(FetchExceptionMode.PERMANENT_REDIRECT, newFreenetUri);
134 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
135 when(highLevelSimpleClient.fetch(newFreenetUri)).thenReturn(fetchResult);
136 Fetched fetched = freenetInterface.fetchUri(freenetUri);
137 assertThat(fetched.getFetchResult(), is(fetchResult));
138 assertThat(fetched.getFreenetUri(), is(newFreenetUri));
142 public void fetchReturnsNullOnFetchExceptions() throws MalformedURLException, FetchException {
143 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
144 FetchException fetchException = new FetchException(FetchExceptionMode.ALL_DATA_NOT_FOUND);
145 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
146 Fetched fetched = freenetInterface.fetchUri(freenetUri);
147 assertThat(fetched, nullValue());
150 private FetchResult createFetchResult() {
151 ClientMetadata clientMetadata = new ClientMetadata("text/plain");
152 Bucket bucket = new ArrayBucket("Some Data.".getBytes());
153 return new FetchResult(clientMetadata, bucket);
157 public void insertingAnImage() throws SoneException, InsertException, IOException {
158 TemporaryImage temporaryImage = new TemporaryImage("image-id");
159 temporaryImage.setMimeType("image/png");
160 byte[] imageData = new byte[] { 1, 2, 3, 4 };
161 temporaryImage.setImageData(imageData);
162 Image image = new ImageImpl("image-id");
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));
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 InsertToken insertToken = freenetInterface.new InsertToken(image);
183 InsertContext insertContext = mock(InsertContext.class);
184 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
185 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
186 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenThrow(InsertException.class);
187 freenetInterface.insertImage(temporaryImage, image, insertToken);
191 public void insertingADirectory() throws InsertException, SoneException {
192 FreenetURI freenetUri = mock(FreenetURI.class);
193 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
194 String defaultFile = "index.html";
195 FreenetURI resultingUri = mock(FreenetURI.class);
196 when(highLevelSimpleClient.insertManifest(eq(freenetUri), eq(manifestEntries), eq(defaultFile))).thenReturn(resultingUri);
197 assertThat(freenetInterface.insertDirectory(freenetUri, manifestEntries, defaultFile), is(resultingUri));
200 @Test(expected = SoneException.class)
201 public void insertExceptionIsForwardedAsSoneException() throws InsertException, SoneException {
202 when(highLevelSimpleClient.insertManifest(ArgumentMatchers.<FreenetURI>any(), ArgumentMatchers.<HashMap<String, Object>>any(), ArgumentMatchers.<String>any())).thenThrow(InsertException.class);
203 freenetInterface.insertDirectory(null, null, null);
207 public void soneWithWrongRequestUriWillNotBeSubscribed() throws MalformedURLException {
208 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
209 freenetInterface.registerUsk(new FreenetURI("KSK@GPLv3.txt"), null);
210 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), any(RequestClient.class));
214 public void registeringAUsk() {
215 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
216 Callback callback = mock(Callback.class);
217 freenetInterface.registerUsk(freenetUri, callback);
218 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
222 public void registeringANonUskKeyWillNotBeSubscribed() throws MalformedURLException {
223 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
224 Callback callback = mock(Callback.class);
225 freenetInterface.registerUsk(freenetUri, callback);
226 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
230 public void registeringAnActiveUskWillSubscribeToItCorrectly() {
231 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
232 final USKCallback uskCallback = mock(USKCallback.class);
233 freenetInterface.registerActiveUsk(freenetUri, uskCallback);
234 verify(uskManager).subscribe(any(USK.class), eq(uskCallback), eq(true), any(RequestClient.class));
238 public void registeringAnInactiveUskWillSubscribeToItCorrectly() {
239 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
240 final USKCallback uskCallback = mock(USKCallback.class);
241 freenetInterface.registerPassiveUsk(freenetUri, uskCallback);
242 verify(uskManager).subscribe(any(USK.class), eq(uskCallback), eq(false), any(RequestClient.class));
246 public void registeringAnActiveNonUskWillNotSubscribeToAUsk()
247 throws MalformedURLException {
248 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI();
249 freenetInterface.registerActiveUsk(freenetUri, null);
250 verify(uskManager, never()).subscribe(any(USK.class),
251 any(USKCallback.class), anyBoolean(),
252 eq((RequestClient) highLevelSimpleClient));
256 public void registeringAnInactiveNonUskWillNotSubscribeToAUsk()
257 throws MalformedURLException {
258 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI();
259 freenetInterface.registerPassiveUsk(freenetUri, null);
260 verify(uskManager, never()).subscribe(any(USK.class),
261 any(USKCallback.class), anyBoolean(),
262 eq((RequestClient) highLevelSimpleClient));
266 public void unregisteringANotRegisteredUskDoesNothing() {
267 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
268 freenetInterface.unregisterUsk(freenetURI);
269 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
273 public void unregisteringARegisteredUsk() {
274 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
275 Callback callback = mock(Callback.class);
276 freenetInterface.registerUsk(freenetURI, callback);
277 freenetInterface.unregisterUsk(freenetURI);
278 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
282 public void unregisteringANotRegisteredSoneDoesNothing() {
283 freenetInterface.unregisterUsk(sone);
284 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
288 public void unregisteringARegisteredSoneUnregistersTheSone()
289 throws MalformedURLException {
290 freenetInterface.registerActiveUsk(sone.getRequestUri(), mock(USKCallback.class));
291 freenetInterface.unregisterUsk(sone);
292 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
296 public void unregisteringASoneWithAWrongRequestKeyWillNotUnsubscribe() throws MalformedURLException {
297 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
298 freenetInterface.registerUsk(sone.getRequestUri(), null);
299 freenetInterface.unregisterUsk(sone);
300 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
304 public void callbackForNormalUskUsesDifferentPriorities() {
305 Callback callback = mock(Callback.class);
306 FreenetURI soneUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
307 freenetInterface.registerUsk(soneUri, callback);
308 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(PREFETCH_PRIORITY_CLASS));
309 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
313 public void callbackForNormalUskForwardsImportantParameters() throws MalformedURLException {
314 Callback callback = mock(Callback.class);
315 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
316 freenetInterface.registerUsk(uri, callback);
317 USK key = mock(USK.class);
318 when(key.getURI()).thenReturn(uri);
319 callbackCaptor.getValue().onFoundEdition(3, key, null, false, (short) 0, null, true, true);
320 verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true));
324 public void fetchedRetainsUriAndFetchResult() {
325 FreenetURI freenetUri = mock(FreenetURI.class);
326 FetchResult fetchResult = mock(FetchResult.class);
327 Fetched fetched = new Fetched(freenetUri, fetchResult);
328 assertThat(fetched.getFreenetUri(), is(freenetUri));
329 assertThat(fetched.getFetchResult(), is(fetchResult));
333 public void cancellingAnInsertWillFireImageInsertAbortedEvent() {
334 ClientPutter clientPutter = mock(ClientPutter.class);
335 insertToken.setClientPutter(clientPutter);
336 ArgumentCaptor<ImageInsertStartedEvent> imageInsertStartedEvent = forClass(ImageInsertStartedEvent.class);
337 verify(eventBus).post(imageInsertStartedEvent.capture());
338 assertThat(imageInsertStartedEvent.getValue().image(), is(image));
339 insertToken.cancel();
340 ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
341 verify(eventBus, times(2)).post(imageInsertAbortedEvent.capture());
342 verify(bucket).free();
343 assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
347 public void failureWithoutExceptionSendsFailedEvent() {
348 insertToken.onFailure(null, null);
349 ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
350 verify(eventBus).post(imageInsertFailedEvent.capture());
351 verify(bucket).free();
352 assertThat(imageInsertFailedEvent.getValue().image(), is(image));
353 assertThat(imageInsertFailedEvent.getValue().cause(), nullValue());
357 public void failureSendsFailedEventWithException() {
358 InsertException insertException = new InsertException(InsertExceptionMode.INTERNAL_ERROR, "Internal error", null);
359 insertToken.onFailure(insertException, null);
360 ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
361 verify(eventBus).post(imageInsertFailedEvent.capture());
362 verify(bucket).free();
363 assertThat(imageInsertFailedEvent.getValue().image(), is(image));
364 assertThat(imageInsertFailedEvent.getValue().cause(), is((Throwable) insertException));
368 public void failureBecauseCancelledByUserSendsAbortedEvent() {
369 InsertException insertException = new InsertException(InsertExceptionMode.CANCELLED, null);
370 insertToken.onFailure(insertException, null);
371 ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
372 verify(eventBus).post(imageInsertAbortedEvent.capture());
373 verify(bucket).free();
374 assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
378 public void ignoredMethodsDoNotThrowExceptions() throws ResumeFailedException {
379 insertToken.onResume(null);
380 insertToken.onFetchable(null);
381 insertToken.onGeneratedMetadata(null, null);
385 public void generatedUriIsPostedOnSuccess() {
386 FreenetURI generatedUri = mock(FreenetURI.class);
387 insertToken.onGeneratedURI(generatedUri, null);
388 insertToken.onSuccess(null);
389 ArgumentCaptor<ImageInsertFinishedEvent> imageInsertFinishedEvent = forClass(ImageInsertFinishedEvent.class);
390 verify(eventBus).post(imageInsertFinishedEvent.capture());
391 verify(bucket).free();
392 assertThat(imageInsertFinishedEvent.getValue().image(), is(image));
393 assertThat(imageInsertFinishedEvent.getValue().resultingUri(), is(generatedUri));
397 public void insertTokenSupplierSuppliesInsertTokens() {
398 InsertTokenSupplier insertTokenSupplier = freenetInterface.new InsertTokenSupplier();
399 assertThat(insertTokenSupplier.apply(image), notNullValue());