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.event.ImageInsertStartedEvent;
38 import net.pterodactylus.sone.data.Image;
39 import net.pterodactylus.sone.data.ImageImpl;
40 import net.pterodactylus.sone.data.Sone;
41 import net.pterodactylus.sone.data.TemporaryImage;
42 import net.pterodactylus.sone.freenet.StringBucket;
44 import freenet.client.ClientMetadata;
45 import freenet.client.FetchException;
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.async.ClientPutter;
52 import freenet.client.async.USKCallback;
53 import freenet.client.async.USKManager;
54 import freenet.crypt.DummyRandomSource;
55 import freenet.crypt.RandomSource;
56 import freenet.keys.FreenetURI;
57 import freenet.keys.InsertableClientSSK;
58 import freenet.keys.USK;
59 import freenet.node.Node;
60 import freenet.node.NodeClientCore;
61 import freenet.node.RequestClient;
62 import freenet.support.Base64;
63 import freenet.support.api.Bucket;
65 import com.google.common.eventbus.EventBus;
66 import org.junit.Before;
67 import org.junit.Test;
68 import org.mockito.ArgumentCaptor;
69 import org.mockito.invocation.InvocationOnMock;
70 import org.mockito.stubbing.Answer;
73 * Unit test for {@link FreenetInterface}.
75 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
77 public class FreenetInterfaceTest {
79 private final EventBus eventBus = mock(EventBus.class);
80 private final Node node = mock(Node.class);
81 private final NodeClientCore nodeClientCore = mock(NodeClientCore.class);
82 private final HighLevelSimpleClient highLevelSimpleClient = mock(HighLevelSimpleClient.class, withSettings().extraInterfaces(RequestClient.class));
83 private final RandomSource randomSource = new DummyRandomSource();
84 private final USKManager uskManager = mock(USKManager.class);
85 private FreenetInterface freenetInterface;
86 private final Sone sone = mock(Sone.class);
87 private final ArgumentCaptor<USKCallback> callbackCaptor = forClass(USKCallback.class);
88 private final SoneDownloader soneDownloader = mock(SoneDownloader.class);
91 public void setupFreenetInterface() {
92 when(nodeClientCore.makeClient(anyShort(), anyBoolean(), anyBoolean())).thenReturn(highLevelSimpleClient);
93 setFinalField(node, "clientCore", nodeClientCore);
94 setFinalField(node, "random", randomSource);
95 setFinalField(nodeClientCore, "uskManager", uskManager);
96 freenetInterface = new FreenetInterface(eventBus, node);
100 public void setupSone() {
101 InsertableClientSSK insertSsk = createRandom(randomSource, "test-0");
102 when(sone.getId()).thenReturn(Base64.encode(insertSsk.getURI().getRoutingKey()));
103 when(sone.getRequestUri()).thenReturn(insertSsk.getURI().uskForSSK());
107 public void setupCallbackCaptorAndUskManager() {
108 doNothing().when(uskManager).subscribe(any(USK.class), callbackCaptor.capture(), anyBoolean(), any(RequestClient.class));
112 public void canFetchUri() throws MalformedURLException, FetchException {
113 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
114 FetchResult fetchResult = createFetchResult();
115 when(highLevelSimpleClient.fetch(freenetUri)).thenReturn(fetchResult);
116 Fetched fetched = freenetInterface.fetchUri(freenetUri);
117 assertThat(fetched, notNullValue());
118 assertThat(fetched.getFetchResult(), is(fetchResult));
119 assertThat(fetched.getFreenetUri(), is(freenetUri));
123 public void fetchFollowsRedirect() throws MalformedURLException, FetchException {
124 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
125 FreenetURI newFreenetUri = new FreenetURI("KSK@GPLv3.txt");
126 FetchResult fetchResult = createFetchResult();
127 FetchException fetchException = new FetchException(FetchException.PERMANENT_REDIRECT, newFreenetUri);
128 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
129 when(highLevelSimpleClient.fetch(newFreenetUri)).thenReturn(fetchResult);
130 Fetched fetched = freenetInterface.fetchUri(freenetUri);
131 assertThat(fetched.getFetchResult(), is(fetchResult));
132 assertThat(fetched.getFreenetUri(), is(newFreenetUri));
136 public void fetchReturnsNullOnFetchExceptions() throws MalformedURLException, FetchException {
137 FreenetURI freenetUri = new FreenetURI("KSK@GPLv2.txt");
138 FetchException fetchException = new FetchException(FetchException.ALL_DATA_NOT_FOUND);
139 when(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException);
140 Fetched fetched = freenetInterface.fetchUri(freenetUri);
141 assertThat(fetched, nullValue());
144 private FetchResult createFetchResult() {
145 ClientMetadata clientMetadata = new ClientMetadata("text/plain");
146 Bucket bucket = new StringBucket("Some Data.");
147 return new FetchResult(clientMetadata, bucket);
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(TestUtil.<ClientPutter>getPrivateField(insertToken, "clientPutter"), is(clientPutter));
166 verify(eventBus).post(any(ImageInsertStartedEvent.class));
169 @Test(expected = SoneInsertException.class)
170 public void insertExceptionCausesASoneException() throws InsertException, SoneException, IOException {
171 TemporaryImage temporaryImage = new TemporaryImage("image-id");
172 temporaryImage.setMimeType("image/png");
173 byte[] imageData = new byte[] { 1, 2, 3, 4 };
174 temporaryImage.setImageData(imageData);
175 Image image = new ImageImpl("image-id");
176 InsertToken insertToken = freenetInterface.new InsertToken(image);
177 InsertContext insertContext = mock(InsertContext.class);
178 when(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext);
179 ArgumentCaptor<InsertBlock> insertBlockCaptor = forClass(InsertBlock.class);
180 when(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(false), eq((String) null), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenThrow(InsertException.class);
181 freenetInterface.insertImage(temporaryImage, image, insertToken);
185 public void insertingADirectory() throws InsertException, SoneException {
186 FreenetURI freenetUri = mock(FreenetURI.class);
187 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
188 String defaultFile = "index.html";
189 FreenetURI resultingUri = mock(FreenetURI.class);
190 when(highLevelSimpleClient.insertManifest(eq(freenetUri), eq(manifestEntries), eq(defaultFile))).thenReturn(resultingUri);
191 assertThat(freenetInterface.insertDirectory(freenetUri, manifestEntries, defaultFile), is(resultingUri));
194 @Test(expected = SoneException.class)
195 public void insertExceptionIsForwardedAsSoneException() throws InsertException, SoneException {
196 when(highLevelSimpleClient.insertManifest(any(FreenetURI.class), any(HashMap.class), any(String.class))).thenThrow(InsertException.class);
197 freenetInterface.insertDirectory(null, null, null);
201 public void soneWithWrongRequestUriWillNotBeSubscribed() throws MalformedURLException {
202 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
203 freenetInterface.registerUsk(sone, null);
204 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), any(RequestClient.class));
208 public void registeringAUskForARecentlyModifiedSone() throws MalformedURLException {
209 when(sone.getTime()).thenReturn(currentTimeMillis() - DAYS.toMillis(1));
210 freenetInterface.registerUsk(sone, null);
211 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), eq(true), eq((RequestClient) highLevelSimpleClient));
215 public void registeringAUskForAnOldSone() throws MalformedURLException {
216 when(sone.getTime()).thenReturn(currentTimeMillis() - DAYS.toMillis(365));
217 freenetInterface.registerUsk(sone, null);
218 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), eq(false), eq((RequestClient) highLevelSimpleClient));
222 public void registeringAUsk() {
223 FreenetURI freenetUri = createRandom(randomSource, "test-0").getURI().uskForSSK();
224 Callback callback = mock(Callback.class);
225 freenetInterface.registerUsk(freenetUri, callback);
226 verify(uskManager).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
230 public void registeringANonUskKeyWillNotBeSubscribed() throws MalformedURLException {
231 FreenetURI freenetUri = new FreenetURI("KSK@GPLv3.txt");
232 Callback callback = mock(Callback.class);
233 freenetInterface.registerUsk(freenetUri, callback);
234 verify(uskManager, never()).subscribe(any(USK.class), any(USKCallback.class), anyBoolean(), eq((RequestClient) highLevelSimpleClient));
238 public void unregisteringANotRegisteredUskDoesNothing() {
239 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
240 freenetInterface.unregisterUsk(freenetURI);
241 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
245 public void unregisteringARegisteredUsk() {
246 FreenetURI freenetURI = createRandom(randomSource, "test-0").getURI().uskForSSK();
247 Callback callback = mock(Callback.class);
248 freenetInterface.registerUsk(freenetURI, callback);
249 freenetInterface.unregisterUsk(freenetURI);
250 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
254 public void unregisteringANotRegisteredSoneDoesNothing() {
255 freenetInterface.unregisterUsk(sone);
256 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
260 public void unregisteringARegisteredSoneUnregistersTheSone() {
261 freenetInterface.registerUsk(sone, null);
262 freenetInterface.unregisterUsk(sone);
263 verify(uskManager).unsubscribe(any(USK.class), any(USKCallback.class));
267 public void unregisteringASoneWithAWrongRequestKeyWillNotUnsubscribe() throws MalformedURLException {
268 freenetInterface.registerUsk(sone, null);
269 when(sone.getRequestUri()).thenReturn(new FreenetURI("KSK@GPLv3.txt"));
270 freenetInterface.unregisterUsk(sone);
271 verify(uskManager, never()).unsubscribe(any(USK.class), any(USKCallback.class));
275 public void callbackPrioritiesAreInteractive() {
276 freenetInterface.registerUsk(sone, null);
277 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(INTERACTIVE_PRIORITY_CLASS));
278 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
282 public void callbackForRegisteredSoneWithHigherEditionTriggersDownload() throws InterruptedException {
283 freenetInterface.registerUsk(sone, soneDownloader);
284 final CountDownLatch downloadTriggered = new CountDownLatch(1);
285 doAnswer(new Answer<Void>() {
287 public Void answer(InvocationOnMock invocation) throws Throwable {
288 downloadTriggered.countDown();
291 }).when(soneDownloader).fetchSone(sone);
292 callbackCaptor.getValue().onFoundEdition(1, null, null, null, false, (short) 0, null, false, false);
293 assertThat(downloadTriggered.await(1, SECONDS), is(true));
297 public void callbackForRegisteredSoneWithTheSameEditionDoesNotTriggerDownload() throws InterruptedException {
298 freenetInterface.registerUsk(sone, soneDownloader);
299 final CountDownLatch downloadTriggered = new CountDownLatch(1);
300 doAnswer(new Answer<Void>() {
302 public Void answer(InvocationOnMock invocation) throws Throwable {
303 downloadTriggered.countDown();
306 }).when(soneDownloader).fetchSone(sone);
307 callbackCaptor.getValue().onFoundEdition(0, null, null, null, false, (short) 0, null, false, false);
308 assertThat(downloadTriggered.await(1, SECONDS), is(false));
312 public void callbackForNormalUskUsesDifferentPriorities() {
313 Callback callback = mock(Callback.class);
314 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
315 freenetInterface.registerUsk(uri, callback);
316 assertThat(callbackCaptor.getValue().getPollingPriorityNormal(), is(PREFETCH_PRIORITY_CLASS));
317 assertThat(callbackCaptor.getValue().getPollingPriorityProgress(), is(INTERACTIVE_PRIORITY_CLASS));
321 public void callbackForNormalUskForwardsImportantParameters() throws MalformedURLException {
322 Callback callback = mock(Callback.class);
323 FreenetURI uri = createRandom(randomSource, "test-0").getURI().uskForSSK();
324 freenetInterface.registerUsk(uri, callback);
325 USK key = mock(USK.class);
326 when(key.getURI()).thenReturn(uri);
327 callbackCaptor.getValue().onFoundEdition(3, key, null, null, false, (short) 0, null, true, true);
328 verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true));
332 public void fetchedRetainsUriAndFetchResult() {
333 FreenetURI freenetUri = mock(FreenetURI.class);
334 FetchResult fetchResult = mock(FetchResult.class);
335 Fetched fetched = new Fetched(freenetUri, fetchResult);
336 assertThat(fetched.getFreenetUri(), is(freenetUri));
337 assertThat(fetched.getFetchResult(), is(fetchResult));