1 package net.pterodactylus.sone.core;
3 import static freenet.client.InsertException.CANCELLED;
4 import static freenet.client.InsertException.INTERNAL_ERROR;
5 import static freenet.keys.InsertableClientSSK.createRandom;
6 import static freenet.node.RequestStarter.INTERACTIVE_PRIORITY_CLASS;
7 import static freenet.node.RequestStarter.PREFETCH_PRIORITY_CLASS;
8 import static java.lang.System.currentTimeMillis;
9 import static java.util.concurrent.TimeUnit.DAYS;
10 import static java.util.concurrent.TimeUnit.SECONDS;
11 import static net.pterodactylus.sone.Matchers.delivers;
12 import static net.pterodactylus.sone.TestUtil.setFinalField;
13 import static org.hamcrest.MatcherAssert.assertThat;
14 import static org.hamcrest.Matchers.is;
15 import static org.hamcrest.Matchers.notNullValue;
16 import static org.hamcrest.Matchers.nullValue;
17 import static org.mockito.ArgumentCaptor.forClass;
18 import static org.mockito.Matchers.any;
19 import static org.mockito.Matchers.anyBoolean;
20 import static org.mockito.Matchers.anyShort;
21 import static org.mockito.Matchers.eq;
22 import static org.mockito.Mockito.doAnswer;
23 import static org.mockito.Mockito.doNothing;
24 import static org.mockito.Mockito.mock;
25 import static org.mockito.Mockito.never;
26 import static org.mockito.Mockito.times;
27 import static org.mockito.Mockito.verify;
28 import static org.mockito.Mockito.when;
29 import static org.mockito.Mockito.withSettings;
31 import java.io.IOException;
32 import java.net.MalformedURLException;
33 import java.util.HashMap;
34 import java.util.concurrent.CountDownLatch;
36 import net.pterodactylus.sone.TestUtil;
37 import net.pterodactylus.sone.core.FreenetInterface.Callback;
38 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
39 import net.pterodactylus.sone.core.FreenetInterface.InsertToken;
40 import net.pterodactylus.sone.core.FreenetInterface.InsertTokenSupplier;
41 import net.pterodactylus.sone.core.event.ImageInsertAbortedEvent;
42 import net.pterodactylus.sone.core.event.ImageInsertFailedEvent;
43 import net.pterodactylus.sone.core.event.ImageInsertFinishedEvent;
44 import net.pterodactylus.sone.core.event.ImageInsertStartedEvent;
45 import net.pterodactylus.sone.data.Image;
46 import net.pterodactylus.sone.data.ImageImpl;
47 import net.pterodactylus.sone.data.Sone;
48 import net.pterodactylus.sone.data.TemporaryImage;
49 import net.pterodactylus.sone.freenet.StringBucket;
51 import freenet.client.ClientMetadata;
52 import freenet.client.FetchException;
53 import freenet.client.FetchResult;
54 import freenet.client.HighLevelSimpleClient;
55 import freenet.client.InsertBlock;
56 import freenet.client.InsertContext;
57 import freenet.client.InsertException;
58 import freenet.client.async.ClientPutter;
59 import freenet.client.async.USKCallback;
60 import freenet.client.async.USKManager;
61 import freenet.crypt.DummyRandomSource;
62 import freenet.crypt.RandomSource;
63 import freenet.keys.FreenetURI;
64 import freenet.keys.InsertableClientSSK;
65 import freenet.keys.USK;
66 import freenet.node.Node;
67 import freenet.node.NodeClientCore;
68 import freenet.node.RequestClient;
69 import freenet.support.Base64;
70 import freenet.support.api.Bucket;
72 import com.google.common.eventbus.EventBus;
73 import org.junit.Before;
74 import org.junit.Test;
75 import org.mockito.ArgumentCaptor;
76 import org.mockito.invocation.InvocationOnMock;
77 import org.mockito.stubbing.Answer;
80 * Unit test for {@link FreenetInterface}.
82 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
84 public class FreenetInterfaceTest {
86 private final EventBus eventBus = mock(EventBus.class);
87 private final Node node = mock(Node.class);
88 private final NodeClientCore nodeClientCore = mock(NodeClientCore.class);
89 private final HighLevelSimpleClient highLevelSimpleClient = mock(HighLevelSimpleClient.class, withSettings().extraInterfaces(RequestClient.class));
90 private final RandomSource randomSource = new DummyRandomSource();
91 private final USKManager uskManager = mock(USKManager.class);
92 private FreenetInterface freenetInterface;
93 private final Sone sone = mock(Sone.class);
94 private final ArgumentCaptor<USKCallback> callbackCaptor = forClass(USKCallback.class);
95 private final SoneDownloader soneDownloader = mock(SoneDownloader.class);
96 private final SoneUpdater soneUpdater = mock(SoneUpdater.class);
97 private final Image image = mock(Image.class);
98 private InsertToken insertToken;
101 public void setupFreenetInterface() {
102 when(nodeClientCore.makeClient(anyShort(), anyBoolean(), anyBoolean())).thenReturn(highLevelSimpleClient);
103 setFinalField(node, "clientCore", nodeClientCore);
104 setFinalField(node, "random", randomSource);
105 setFinalField(nodeClientCore, "uskManager", uskManager);
106 freenetInterface = new FreenetInterface(eventBus, node);
107 insertToken = freenetInterface.new InsertToken(image);
111 public void setupSone() {
112 InsertableClientSSK insertSsk = createRandom(randomSource, "test-0");
113 when(sone.getId()).thenReturn(Base64.encode(insertSsk.getURI().getRoutingKey()));
114 when(sone.getRequestUri()).thenReturn(insertSsk.getURI().uskForSSK());
118 public void setupCallbackCaptorAndUskManager() {
119 doNothing().when(uskManager).subscribe(any(USK.class), callbackCaptor.capture(), anyBoolean(), any(RequestClient.class));
123 public void canFetchUri() throws MalformedURLException, FetchException {
124 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
125 FetchResult fetchResult = createFetchResult();
126 when(highLevelSimpleClient.fetch(freenetUri)).thenReturn(fetchResult);
127 Fetched fetched = freenetInterface.fetchUri(freenetUri);
128 assertThat(fetched, notNullValue());
129 assertThat(fetched.getFetchResult(), is(fetchResult));
130 assertThat(fetched.getFreenetUri(), is(freenetUri));
134 public void fetchFollowsRedirect() throws MalformedURLException, FetchException {
135 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
136 FreenetURI newFreenetUri = new FreenetURI("KSK@GPLv3.txt");
137 FetchResult fetchResult = createFetchResult();
138 FetchException fetchException = new FetchException(FetchException.PERMANENT_REDIRECT, newFreenetUri);
139 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
140 when(highLevelSimpleClient.fetch(newFreenetUri)).thenReturn(fetchResult);
141 Fetched fetched = freenetInterface.fetchUri(freenetUri);
142 assertThat(fetched.getFetchResult(), is(fetchResult));
143 assertThat(fetched.getFreenetUri(), is(newFreenetUri));
147 public void fetchReturnsNullOnFetchExceptions() throws MalformedURLException, FetchException {
148 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
149 FetchException fetchException = new FetchException(FetchException.ALL_DATA_NOT_FOUND);
150 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
151 Fetched fetched = freenetInterface.fetchUri(freenetUri);
152 assertThat(fetched, nullValue());
155 private FetchResult createFetchResult() {
156 ClientMetadata clientMetadata = new ClientMetadata("text/plain");
157 Bucket bucket = new StringBucket("Some Data.");
158 return new FetchResult(clientMetadata, bucket);
162 public void insertingAnImage() throws SoneException, InsertException, IOException {
163 TemporaryImage temporaryImage = new TemporaryImage("image-id");
164 temporaryImage.setMimeType("image/png");
165 byte[] imageData = new byte[] { 1, 2, 3, 4 };
166 temporaryImage.setImageData(imageData);
167 Image image = new ImageImpl("image-id");
168 InsertToken insertToken = freenetInterface.new InsertToken(image);
169 InsertContext insertContext = mock(InsertContext.class);
170 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
171 ClientPutter clientPutter = mock(ClientPutter.class);
172 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
173 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(false), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenReturn(clientPutter);
174 freenetInterface.insertImage(temporaryImage, image, insertToken);
175 assertThat(insertBlockCaptor.getValue().getData().getInputStream(), delivers(new byte[] { 1, 2, 3, 4 }));
176 assertThat(TestUtil.<ClientPutter>getPrivateField(insertToken, "clientPutter"), is(clientPutter));
177 verify(eventBus).post(any(ImageInsertStartedEvent.class));
180 @Test(expected = SoneInsertException.class)
181 public void insertExceptionCausesASoneException() throws InsertException, SoneException, IOException {
182 TemporaryImage temporaryImage = new TemporaryImage("image-id");
183 temporaryImage.setMimeType("image/png");
184 byte[] imageData = new byte[] { 1, 2, 3, 4 };
185 temporaryImage.setImageData(imageData);
186 Image image = new ImageImpl("image-id");
187 InsertToken insertToken = freenetInterface.new InsertToken(image);
188 InsertContext insertContext = mock(InsertContext.class);
189 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
190 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
191 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(false), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenThrow(InsertException.class);
192 freenetInterface.insertImage(temporaryImage, image, insertToken);
196 public void insertingADirectory() throws InsertException, SoneException {
197 FreenetURI freenetUri = mock(FreenetURI.class);
198 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
199 String defaultFile = "index.html";
200 FreenetURI resultingUri = mock(FreenetURI.class);
201 when(highLevelSimpleClient.insertManifest(eq(freenetUri), eq(manifestEntries), eq(defaultFile))).thenReturn(resultingUri);
202 assertThat(freenetInterface.insertDirectory(freenetUri, manifestEntries, defaultFile), is(resultingUri));
205 @Test(expected = SoneException.class)
206 public void insertExceptionIsForwardedAsSoneException() throws InsertException, SoneException {
207 when(highLevelSimpleClient.insertManifest(any(FreenetURI.class), any(HashMap.class), any(String.class))).thenThrow(InsertException.class);
208 freenetInterface.insertDirectory(null, null, null);
212 public void soneWithWrongRequestUriWillNotBeSubscribed() throws MalformedURLException {
213 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
214 freenetInterface.registerUsk(sone, null);
215 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), any(RequestClient.class));
219 public void registeringAUskForARecentlyModifiedSone() throws MalformedURLException {
220 when(sone.getTime()).thenReturn(currentTimeMillis() - DAYS.toMillis(1));
221 freenetInterface.registerUsk(sone, null);
222 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), eq(true), eq((RequestClient) highLevelSimpleClient));
226 public void registeringAUskForAnOldSone() throws MalformedURLException {
227 when(sone.getTime()).thenReturn(currentTimeMillis() - DAYS.toMillis(365));
228 freenetInterface.registerUsk(sone, null);
229 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), eq(false), eq((RequestClient) highLevelSimpleClient));
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 unregisteringANotRegisteredUskDoesNothing() {
250 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
251 freenetInterface.unregisterUsk(freenetURI);
252 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
256 public void unregisteringARegisteredUsk() {
257 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
258 Callback callback = mock(Callback.class);
259 freenetInterface.registerUsk(freenetURI, callback);
260 freenetInterface.unregisterUsk(freenetURI);
261 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
265 public void unregisteringANotRegisteredSoneDoesNothing() {
266 freenetInterface.unregisterUsk(sone);
267 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
271 public void unregisteringARegisteredSoneUnregistersTheSone() {
272 freenetInterface.registerUsk(sone, null);
273 freenetInterface.unregisterUsk(sone);
274 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
278 public void unregisteringASoneWithAWrongRequestKeyWillNotUnsubscribe() throws MalformedURLException {
279 freenetInterface.registerUsk(sone, null);
280 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
281 freenetInterface.unregisterUsk(sone);
282 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
286 public void callbackPrioritiesAreInteractive() {
287 freenetInterface.registerUsk(sone, null);
288 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(INTERACTIVE_PRIORITY_CLASS));
289 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
293 public void callbackForRegisteredSoneWithHigherEditionTriggersDownload() throws InterruptedException {
294 freenetInterface.registerUsk(sone, soneUpdater);
295 callbackCaptor.getValue().onFoundEdition(1, null, null, null, false, (short) 0, null, false, false);
296 verify(soneUpdater).updateSone(1);
300 public void callbackForNormalUskUsesDifferentPriorities() {
301 Callback callback = mock(Callback.class);
302 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
303 freenetInterface.registerUsk(uri, callback);
304 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(PREFETCH_PRIORITY_CLASS));
305 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
309 public void callbackForNormalUskForwardsImportantParameters() throws MalformedURLException {
310 Callback callback = mock(Callback.class);
311 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
312 freenetInterface.registerUsk(uri, callback);
313 USK key = mock(USK.class);
314 when(key.getURI()).thenReturn(uri);
315 callbackCaptor.getValue().onFoundEdition(3, key, null, null, false, (short) 0, null, true, true);
316 verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true));
320 public void fetchedRetainsUriAndFetchResult() {
321 FreenetURI freenetUri = mock(FreenetURI.class);
322 FetchResult fetchResult = mock(FetchResult.class);
323 Fetched fetched = new Fetched(freenetUri, fetchResult);
324 assertThat(fetched.getFreenetUri(), is(freenetUri));
325 assertThat(fetched.getFetchResult(), is(fetchResult));
329 public void cancellingAnInsertWillFireImageInsertAbortedEvent() {
330 ClientPutter clientPutter = mock(ClientPutter.class);
331 insertToken.setClientPutter(clientPutter);
332 ArgumentCaptor<ImageInsertStartedEvent> imageInsertStartedEvent = forClass(ImageInsertStartedEvent.class);
333 verify(eventBus).post(imageInsertStartedEvent.capture());
334 assertThat(imageInsertStartedEvent.getValue().image(), is(image));
335 insertToken.cancel();
336 ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
337 verify(eventBus, times(2)).post(imageInsertAbortedEvent.capture());
338 assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
342 public void failureWithoutExceptionSendsFailedEvent() {
343 insertToken.onFailure(null, null, null);
344 ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
345 verify(eventBus).post(imageInsertFailedEvent.capture());
346 assertThat(imageInsertFailedEvent.getValue().image(), is(image));
347 assertThat(imageInsertFailedEvent.getValue().cause(), nullValue());
351 public void failureSendsFailedEventWithException() {
352 InsertException insertException = new InsertException(INTERNAL_ERROR, "Internal error", null);
353 insertToken.onFailure(insertException, null, null);
354 ArgumentCaptor<ImageInsertFailedEvent> imageInsertFailedEvent = forClass(ImageInsertFailedEvent.class);
355 verify(eventBus).post(imageInsertFailedEvent.capture());
356 assertThat(imageInsertFailedEvent.getValue().image(), is(image));
357 assertThat(imageInsertFailedEvent.getValue().cause(), is((Throwable) insertException));
361 public void failureBecauseCancelledByUserSendsAbortedEvent() {
362 InsertException insertException = new InsertException(CANCELLED, null);
363 insertToken.onFailure(insertException, null, null);
364 ArgumentCaptor<ImageInsertAbortedEvent> imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent.class);
365 verify(eventBus).post(imageInsertAbortedEvent.capture());
366 assertThat(imageInsertAbortedEvent.getValue().image(), is(image));
370 public void ignoredMethodsDoNotThrowExceptions() {
371 insertToken.onMajorProgress(null);
372 insertToken.onFetchable(null, null);
373 insertToken.onGeneratedMetadata(null, null, null);
377 public void generatedUriIsPostedOnSuccess() {
378 FreenetURI generatedUri = mock(FreenetURI.class);
379 insertToken.onGeneratedURI(generatedUri, null, null);
380 insertToken.onSuccess(null, null);
381 ArgumentCaptor<ImageInsertFinishedEvent> imageInsertFinishedEvent = forClass(ImageInsertFinishedEvent.class);
382 verify(eventBus).post(imageInsertFinishedEvent.capture());
383 assertThat(imageInsertFinishedEvent.getValue().image(), is(image));
384 assertThat(imageInsertFinishedEvent.getValue().resultingUri(), is(generatedUri));
388 public void insertTokenSupplierSuppliesInsertTokens() {
389 InsertTokenSupplier insertTokenSupplier = freenetInterface.new InsertTokenSupplier();
390 assertThat(insertTokenSupplier.apply(image), notNullValue());