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 java.lang.System.currentTimeMillis;
7 import static java.util.concurrent.TimeUnit.DAYS;
8 import static java.util.concurrent.TimeUnit.SECONDS;
9 import static net.pterodactylus.sone.Matchers.delivers;
10 import static net.pterodactylus.sone.TestUtil.setFinalField;
11 import static org.hamcrest.MatcherAssert.assertThat;
12 import static org.hamcrest.Matchers.is;
13 import static org.hamcrest.Matchers.notNullValue;
14 import static org.hamcrest.Matchers.nullValue;
15 import static org.mockito.ArgumentCaptor.forClass;
16 import static org.mockito.Matchers.any;
17 import static org.mockito.Matchers.anyBoolean;
18 import static org.mockito.Matchers.anyShort;
19 import static org.mockito.Matchers.eq;
20 import static org.mockito.Mockito.doAnswer;
21 import static org.mockito.Mockito.doNothing;
22 import static org.mockito.Mockito.mock;
23 import static org.mockito.Mockito.never;
24 import static org.mockito.Mockito.verify;
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;
31 import java.util.concurrent.CountDownLatch;
33 import net.pterodactylus.sone.TestUtil;
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.ImageInsertStartedEvent;
39 import net.pterodactylus.sone.data.Image;
40 import net.pterodactylus.sone.data.ImageImpl;
41 import net.pterodactylus.sone.data.Sone;
42 import net.pterodactylus.sone.data.TemporaryImage;
43 import net.pterodactylus.sone.freenet.StringBucket;
45 import freenet.client.ClientMetadata;
46 import freenet.client.FetchException;
47 import freenet.client.FetchResult;
48 import freenet.client.HighLevelSimpleClient;
49 import freenet.client.InsertBlock;
50 import freenet.client.InsertContext;
51 import freenet.client.InsertException;
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;
66 import com.google.common.eventbus.EventBus;
67 import org.junit.Before;
68 import org.junit.Test;
69 import org.mockito.ArgumentCaptor;
70 import org.mockito.invocation.InvocationOnMock;
71 import org.mockito.stubbing.Answer;
74 * Unit test for {@link FreenetInterface}.
76 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
78 public class FreenetInterfaceTest {
80 private final EventBus eventBus = mock(EventBus.class);
81 private final Node node = mock(Node.class);
82 private final NodeClientCore nodeClientCore = mock(NodeClientCore.class);
83 private final HighLevelSimpleClient highLevelSimpleClient = mock(HighLevelSimpleClient.class, withSettings().extraInterfaces(RequestClient.class));
84 private final RandomSource randomSource = new DummyRandomSource();
85 private final USKManager uskManager = mock(USKManager.class);
86 private FreenetInterface freenetInterface;
87 private final Sone sone = mock(Sone.class);
88 private final ArgumentCaptor<USKCallback> callbackCaptor = forClass(USKCallback.class);
89 private final SoneDownloader soneDownloader = mock(SoneDownloader.class);
92 public void setupFreenetInterface() {
93 when(nodeClientCore.makeClient(anyShort(), anyBoolean(), anyBoolean())).thenReturn(highLevelSimpleClient);
94 setFinalField(node, "clientCore", nodeClientCore);
95 setFinalField(node, "random", randomSource);
96 setFinalField(nodeClientCore, "uskManager", uskManager);
97 freenetInterface = new FreenetInterface(eventBus, node);
101 public void setupSone() {
102 InsertableClientSSK insertSsk = createRandom(randomSource, "test-0");
103 when(sone.getId()).thenReturn(Base64.encode(insertSsk.getURI().getRoutingKey()));
104 when(sone.getRequestUri()).thenReturn(insertSsk.getURI().uskForSSK());
108 public void setupCallbackCaptorAndUskManager() {
109 doNothing().when(uskManager).subscribe(any(USK.class), callbackCaptor.capture(), anyBoolean(), any(RequestClient.class));
113 public void canFetchUri() throws MalformedURLException, FetchException {
114 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
115 FetchResult fetchResult = createFetchResult();
116 when(highLevelSimpleClient.fetch(freenetUri)).thenReturn(fetchResult);
117 Fetched fetched = freenetInterface.fetchUri(freenetUri);
118 assertThat(fetched, notNullValue());
119 assertThat(fetched.getFetchResult(), is(fetchResult));
120 assertThat(fetched.getFreenetUri(), is(freenetUri));
124 public void fetchFollowsRedirect() throws MalformedURLException, FetchException {
125 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
126 FreenetURI newFreenetUri = new FreenetURI("KSK@GPLv3.txt");
127 FetchResult fetchResult = createFetchResult();
128 FetchException fetchException = new FetchException(FetchException.PERMANENT_REDIRECT, newFreenetUri);
129 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
130 when(highLevelSimpleClient.fetch(newFreenetUri)).thenReturn(fetchResult);
131 Fetched fetched = freenetInterface.fetchUri(freenetUri);
132 assertThat(fetched.getFetchResult(), is(fetchResult));
133 assertThat(fetched.getFreenetUri(), is(newFreenetUri));
137 public void fetchReturnsNullOnFetchExceptions() throws MalformedURLException, FetchException {
138 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
139 FetchException fetchException = new FetchException(FetchException.ALL_DATA_NOT_FOUND);
140 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
141 Fetched fetched = freenetInterface.fetchUri(freenetUri);
142 assertThat(fetched, nullValue());
145 private FetchResult createFetchResult() {
146 ClientMetadata clientMetadata = new ClientMetadata("text/plain");
147 Bucket bucket = new StringBucket("Some Data.");
148 return new FetchResult(clientMetadata, bucket);
152 public void insertingAnImage() throws SoneException, InsertException, IOException {
153 TemporaryImage temporaryImage = new TemporaryImage("image-id");
154 temporaryImage.setMimeType("image/png");
155 byte[] imageData = new byte[] { 1, 2, 3, 4 };
156 temporaryImage.setImageData(imageData);
157 Image image = new ImageImpl("image-id");
158 InsertToken insertToken = freenetInterface.new InsertToken(image);
159 InsertContext insertContext = mock(InsertContext.class);
160 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
161 ClientPutter clientPutter = mock(ClientPutter.class);
162 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
163 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(false), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenReturn(clientPutter);
164 freenetInterface.insertImage(temporaryImage, image, insertToken);
165 assertThat(insertBlockCaptor.getValue().getData().getInputStream(), delivers(new byte[] { 1, 2, 3, 4 }));
166 assertThat(TestUtil.<ClientPutter>getPrivateField(insertToken, "clientPutter"), is(clientPutter));
167 verify(eventBus).post(any(ImageInsertStartedEvent.class));
170 @Test(expected = SoneInsertException.class)
171 public void insertExceptionCausesASoneException() throws InsertException, SoneException, IOException {
172 TemporaryImage temporaryImage = new TemporaryImage("image-id");
173 temporaryImage.setMimeType("image/png");
174 byte[] imageData = new byte[] { 1, 2, 3, 4 };
175 temporaryImage.setImageData(imageData);
176 Image image = new ImageImpl("image-id");
177 InsertToken insertToken = freenetInterface.new InsertToken(image);
178 InsertContext insertContext = mock(InsertContext.class);
179 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
180 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
181 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(false), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenThrow(InsertException.class);
182 freenetInterface.insertImage(temporaryImage, image, insertToken);
186 public void insertingADirectory() throws InsertException, SoneException {
187 FreenetURI freenetUri = mock(FreenetURI.class);
188 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
189 String defaultFile = "index.html";
190 FreenetURI resultingUri = mock(FreenetURI.class);
191 when(highLevelSimpleClient.insertManifest(eq(freenetUri), eq(manifestEntries), eq(defaultFile))).thenReturn(resultingUri);
192 assertThat(freenetInterface.insertDirectory(freenetUri, manifestEntries, defaultFile), is(resultingUri));
195 @Test(expected = SoneException.class)
196 public void insertExceptionIsForwardedAsSoneException() throws InsertException, SoneException {
197 when(highLevelSimpleClient.insertManifest(any(FreenetURI.class), any(HashMap.class), any(String.class))).thenThrow(InsertException.class);
198 freenetInterface.insertDirectory(null, null, null);
202 public void soneWithWrongRequestUriWillNotBeSubscribed() throws MalformedURLException {
203 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
204 freenetInterface.registerUsk(sone, null);
205 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), any(RequestClient.class));
209 public void registeringAUskForARecentlyModifiedSone() throws MalformedURLException {
210 when(sone.getTime()).thenReturn(currentTimeMillis() - DAYS.toMillis(1));
211 freenetInterface.registerUsk(sone, null);
212 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), eq(true), eq((RequestClient) highLevelSimpleClient));
216 public void registeringAUskForAnOldSone() throws MalformedURLException {
217 when(sone.getTime()).thenReturn(currentTimeMillis() - DAYS.toMillis(365));
218 freenetInterface.registerUsk(sone, null);
219 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), eq(false), eq((RequestClient) highLevelSimpleClient));
223 public void registeringAUsk() {
224 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
225 Callback callback = mock(Callback.class);
226 freenetInterface.registerUsk(freenetUri, callback);
227 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
231 public void registeringANonUskKeyWillNotBeSubscribed() throws MalformedURLException {
232 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
233 Callback callback = mock(Callback.class);
234 freenetInterface.registerUsk(freenetUri, callback);
235 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
239 public void unregisteringANotRegisteredUskDoesNothing() {
240 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
241 freenetInterface.unregisterUsk(freenetURI);
242 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
246 public void unregisteringARegisteredUsk() {
247 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
248 Callback callback = mock(Callback.class);
249 freenetInterface.registerUsk(freenetURI, callback);
250 freenetInterface.unregisterUsk(freenetURI);
251 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
255 public void unregisteringANotRegisteredSoneDoesNothing() {
256 freenetInterface.unregisterUsk(sone);
257 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
261 public void unregisteringARegisteredSoneUnregistersTheSone() {
262 freenetInterface.registerUsk(sone, null);
263 freenetInterface.unregisterUsk(sone);
264 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
268 public void unregisteringASoneWithAWrongRequestKeyWillNotUnsubscribe() throws MalformedURLException {
269 freenetInterface.registerUsk(sone, null);
270 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
271 freenetInterface.unregisterUsk(sone);
272 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
276 public void callbackPrioritiesAreInteractive() {
277 freenetInterface.registerUsk(sone, null);
278 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(INTERACTIVE_PRIORITY_CLASS));
279 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
283 public void callbackForRegisteredSoneWithHigherEditionTriggersDownload() throws InterruptedException {
284 freenetInterface.registerUsk(sone, soneDownloader);
285 final CountDownLatch downloadTriggered = new CountDownLatch(1);
286 doAnswer(new Answer<Void>() {
288 public Void answer(InvocationOnMock invocation) throws Throwable {
289 downloadTriggered.countDown();
292 }).when(soneDownloader).fetchSone(sone);
293 callbackCaptor.getValue().onFoundEdition(1, null, null, null, false, (short) 0, null, false, false);
294 assertThat(downloadTriggered.await(1, SECONDS), is(true));
298 public void callbackForRegisteredSoneWithTheSameEditionDoesNotTriggerDownload() throws InterruptedException {
299 freenetInterface.registerUsk(sone, soneDownloader);
300 final CountDownLatch downloadTriggered = new CountDownLatch(1);
301 doAnswer(new Answer<Void>() {
303 public Void answer(InvocationOnMock invocation) throws Throwable {
304 downloadTriggered.countDown();
307 }).when(soneDownloader).fetchSone(sone);
308 callbackCaptor.getValue().onFoundEdition(0, null, null, null, false, (short) 0, null, false, false);
309 assertThat(downloadTriggered.await(1, SECONDS), is(false));
313 public void callbackForNormalUskUsesDifferentPriorities() {
314 Callback callback = mock(Callback.class);
315 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
316 freenetInterface.registerUsk(uri, callback);
317 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(PREFETCH_PRIORITY_CLASS));
318 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
322 public void callbackForNormalUskForwardsImportantParameters() throws MalformedURLException {
323 Callback callback = mock(Callback.class);
324 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
325 freenetInterface.registerUsk(uri, callback);
326 USK key = mock(USK.class);
327 when(key.getURI()).thenReturn(uri);
328 callbackCaptor.getValue().onFoundEdition(3, key, null, null, false, (short) 0, null, true, true);
329 verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true));
333 public void fetchedRetainsUriAndFetchResult() {
334 FreenetURI freenetUri = mock(FreenetURI.class);
335 FetchResult fetchResult = mock(FetchResult.class);
336 Fetched fetched = new Fetched(freenetUri, fetchResult);
337 assertThat(fetched.getFreenetUri(), is(freenetUri));
338 assertThat(fetched.getFetchResult(), is(fetchResult));
342 public void insertTokenSupplierSuppliesInsertTokens() {
343 InsertTokenSupplier insertTokenSupplier = freenetInterface.new InsertTokenSupplier();
344 Image image = mock(Image.class);
345 assertThat(insertTokenSupplier.apply(image), notNullValue());