1 package net.pterodactylus.sone.core
3 import com.google.common.eventbus.*
4 import freenet.client.*
5 import freenet.client.FetchException.FetchExceptionMode.*
6 import freenet.client.InsertException.*
7 import freenet.client.async.*
10 import freenet.keys.InsertableClientSSK.*
12 import freenet.node.RequestStarter.*
13 import freenet.support.Base64
14 import freenet.support.api.*
15 import freenet.support.io.*
16 import net.pterodactylus.sone.core.FreenetInterface.*
17 import net.pterodactylus.sone.core.event.*
18 import net.pterodactylus.sone.data.*
19 import net.pterodactylus.sone.data.impl.*
20 import net.pterodactylus.sone.test.*
21 import net.pterodactylus.sone.test.Matchers.*
22 import net.pterodactylus.sone.test.TestUtil.*
23 import org.hamcrest.MatcherAssert.*
24 import org.hamcrest.Matchers.equalTo
25 import org.hamcrest.Matchers.notNullValue
26 import org.hamcrest.Matchers.nullValue
28 import org.junit.rules.*
30 import org.mockito.ArgumentCaptor.*
31 import org.mockito.ArgumentMatchers.eq
32 import org.mockito.Mockito.*
35 import kotlin.test.Test
38 * Unit test for [FreenetInterface].
40 class FreenetInterfaceTest {
44 val expectionException: ExpectedException = ExpectedException.none()
46 @Suppress("UnstableApiUsage")
47 private val eventBus = mock<EventBus>()
48 private val node = mock<Node>()
49 private val nodeClientCore = mock<NodeClientCore>()
50 private val highLevelSimpleClient: HighLevelSimpleClient = mock(HighLevelSimpleClient::class.java, withSettings().extraInterfaces(RequestClient::class.java))
51 private val randomSource = DummyRandomSource()
52 private val uskManager = mock<USKManager>()
53 private val sone = mock<Sone>()
54 private val callbackCaptor: ArgumentCaptor<USKCallback> = forClass(USKCallback::class.java)
55 private val image = mock<Image>()
56 private val insertToken: InsertToken
57 private val bucket = mock<Bucket>()
58 private val clientGetCallback: ArgumentCaptor<ClientGetCallback> = forClass(ClientGetCallback::class.java)
59 private val uri = FreenetURI("KSK@pgl.png")
60 private val fetchResult = mock<FetchResult>()
61 private val backgroundFetchCallback = mock<BackgroundFetchCallback>()
62 private val clientGetter = mock<ClientGetter>()
63 private val freenetInterface: FreenetInterface
66 whenever(nodeClientCore.makeClient(anyShort(), anyBoolean(), anyBoolean())).thenReturn(highLevelSimpleClient)
67 setField(node, "clientCore", nodeClientCore)
68 setField(node, "random", randomSource)
69 setField(nodeClientCore, "uskManager", uskManager)
70 setField(nodeClientCore, "clientContext", mock<ClientContext>())
71 freenetInterface = FreenetInterface(eventBus, node)
72 insertToken = freenetInterface.InsertToken(image)
73 insertToken.setBucket(bucket)
77 fun setupHighLevelSimpleClient() {
78 whenever(highLevelSimpleClient.fetchContext).thenReturn(mock())
79 whenever(highLevelSimpleClient.fetch(eq(uri), anyLong(), any(ClientGetCallback::class.java), any(FetchContext::class.java), anyShort())).thenReturn(clientGetter)
84 val insertSsk = createRandom(randomSource, "test-0")
85 whenever(sone.id).thenReturn(Base64.encode(insertSsk.uri.routingKey))
86 whenever(sone.requestUri).thenReturn(insertSsk.uri.uskForSSK())
90 fun setupCallbackCaptorAndUskManager() {
91 doNothing().whenever(uskManager).subscribe(any(USK::class.java), callbackCaptor.capture(), anyBoolean(), any(RequestClient::class.java))
95 fun `can fetch uri`() {
96 val freenetUri = FreenetURI("KSK@GPLv3.txt")
97 val fetchResult = createFetchResult()
98 whenever(highLevelSimpleClient.fetch(freenetUri)).thenReturn(fetchResult)
99 val fetched = freenetInterface.fetchUri(freenetUri)
100 assertThat(fetched, notNullValue())
101 assertThat(fetched!!.fetchResult, equalTo(fetchResult))
102 assertThat(fetched.freenetUri, equalTo(freenetUri))
106 fun `fetch follows redirect`() {
107 val freenetUri = FreenetURI("KSK@GPLv2.txt")
108 val newFreenetUri = FreenetURI("KSK@GPLv3.txt")
109 val fetchResult = createFetchResult()
110 val fetchException = FetchException(PERMANENT_REDIRECT, newFreenetUri)
111 whenever(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException)
112 whenever(highLevelSimpleClient.fetch(newFreenetUri)).thenReturn(fetchResult)
113 val fetched = freenetInterface.fetchUri(freenetUri)
114 assertThat(fetched!!.fetchResult, equalTo(fetchResult))
115 assertThat(fetched.freenetUri, equalTo(newFreenetUri))
119 fun `fetch returns null on fetch exceptions`() {
120 val freenetUri = FreenetURI("KSK@GPLv2.txt")
121 val fetchException = FetchException(ALL_DATA_NOT_FOUND)
122 whenever(highLevelSimpleClient.fetch(freenetUri)).thenThrow(fetchException)
123 val fetched = freenetInterface.fetchUri(freenetUri)
124 assertThat(fetched, nullValue())
127 private fun createFetchResult(): FetchResult {
128 val clientMetadata = ClientMetadata("text/plain")
129 val bucket = ArrayBucket("Some Data.".toByteArray())
130 return FetchResult(clientMetadata, bucket)
134 fun `inserting an image`() {
135 val temporaryImage = TemporaryImage("image-id")
136 temporaryImage.mimeType = "image/png"
137 val imageData = byteArrayOf(1, 2, 3, 4)
138 temporaryImage.imageData = imageData
139 val image = ImageImpl("image-id")
140 val insertToken = freenetInterface.InsertToken(image)
141 val insertContext = mock<InsertContext>()
142 whenever(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext)
143 val clientPutter = mock<ClientPutter>()
144 val insertBlockCaptor = forClass(InsertBlock::class.java)
145 whenever(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(null as String?), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenReturn(clientPutter)
146 freenetInterface.insertImage(temporaryImage, image, insertToken)
147 assertThat(insertBlockCaptor.value.data.inputStream, delivers(byteArrayOf(1, 2, 3, 4)))
148 assertThat(getPrivateField(insertToken, "clientPutter"), equalTo(clientPutter))
149 verify(eventBus).post(any(ImageInsertStartedEvent::class.java))
153 fun `insert exception causes a sone exception`() {
154 val temporaryImage = TemporaryImage("image-id")
155 temporaryImage.mimeType = "image/png"
156 val imageData = byteArrayOf(1, 2, 3, 4)
157 temporaryImage.imageData = imageData
158 val image = ImageImpl("image-id")
159 val insertToken = freenetInterface.InsertToken(image)
160 val insertContext = mock<InsertContext>()
161 whenever(highLevelSimpleClient.getInsertContext(anyBoolean())).thenReturn(insertContext)
162 val insertBlockCaptor = forClass(InsertBlock::class.java)
163 whenever(highLevelSimpleClient.insert(insertBlockCaptor.capture(), eq(null as String?), eq(false), eq(insertContext), eq(insertToken), anyShort())).thenThrow(InsertException::class.java)
164 expectionException.expect(SoneInsertException::class.java)
165 freenetInterface.insertImage(temporaryImage, image, insertToken)
169 fun `inserting a directory`() {
170 val freenetUri = mock<FreenetURI>()
171 val manifestEntries = HashMap<String, Any>()
172 val defaultFile = "index.html"
173 val resultingUri = mock<FreenetURI>()
174 whenever(highLevelSimpleClient.insertManifest(eq(freenetUri), eq(manifestEntries), eq(defaultFile))).thenReturn(resultingUri)
175 assertThat(freenetInterface.insertDirectory(freenetUri, manifestEntries, defaultFile), equalTo(resultingUri))
179 fun `insert exception is forwarded as sone exception`() {
180 whenever(highLevelSimpleClient.insertManifest(any(), any(), any())).thenThrow(InsertException::class.java)
181 expectionException.expect(SoneException::class.java)
182 freenetInterface.insertDirectory(null, null, null)
186 fun `sone with wrong request uri will not be subscribed`() {
187 whenever(sone.requestUri).thenReturn(FreenetURI("KSK@GPLv3.txt"))
188 freenetInterface.registerUsk(FreenetURI("KSK@GPLv3.txt"), null)
189 verify(uskManager, never()).subscribe(any(USK::class.java), any(USKCallback::class.java), anyBoolean(), any(RequestClient::class.java))
193 fun `registering a usk`() {
194 val freenetUri = createRandom(randomSource, "test-0").uri.uskForSSK()
195 val callback = mock<Callback>()
196 freenetInterface.registerUsk(freenetUri, callback)
197 verify(uskManager).subscribe(any(USK::class.java), any(USKCallback::class.java), anyBoolean(), any(RequestClient::class.java))
201 fun `registering a non-usk key will not be subscribed`() {
202 val freenetUri = FreenetURI("KSK@GPLv3.txt")
203 val callback = mock<Callback>()
204 freenetInterface.registerUsk(freenetUri, callback)
205 verify(uskManager, never()).subscribe(any(USK::class.java), any(USKCallback::class.java), anyBoolean(), any(RequestClient::class.java))
209 fun `registering an active usk will subscribe to it correctly`() {
210 val freenetUri = createRandom(randomSource, "test-0").uri.uskForSSK()
211 val uskCallback = mock<USKCallback>()
212 freenetInterface.registerActiveUsk(freenetUri, uskCallback)
213 verify(uskManager).subscribe(any(USK::class.java), eq(uskCallback), eq(true), any(RequestClient::class.java))
217 fun `registering an inactive usk will subscribe to it correctly`() {
218 val freenetUri = createRandom(randomSource, "test-0").uri.uskForSSK()
219 val uskCallback = mock<USKCallback>()
220 freenetInterface.registerPassiveUsk(freenetUri, uskCallback)
221 verify(uskManager).subscribe(any(USK::class.java), eq(uskCallback), eq(false), any(RequestClient::class.java))
225 fun `registering an active non-usk will not subscribe to a usk`() {
226 val freenetUri = createRandom(randomSource, "test-0").uri
227 freenetInterface.registerActiveUsk(freenetUri, null)
228 verify(uskManager, never()).subscribe(any(USK::class.java), any(USKCallback::class.java), anyBoolean(), any(RequestClient::class.java))
232 fun `registering an inactive non-usk will not subscribe to a usk`() {
233 val freenetUri = createRandom(randomSource, "test-0").uri
234 freenetInterface.registerPassiveUsk(freenetUri, null)
235 verify(uskManager, never()).subscribe(any(USK::class.java), any(USKCallback::class.java), anyBoolean(), any(RequestClient::class.java))
239 fun `unregistering a not registered usk does nothing`() {
240 val freenetURI = createRandom(randomSource, "test-0").uri.uskForSSK()
241 freenetInterface.unregisterUsk(freenetURI)
242 verify(uskManager, never()).unsubscribe(any(USK::class.java), any(USKCallback::class.java))
246 fun `unregistering a registered usk`() {
247 val freenetURI = createRandom(randomSource, "test-0").uri.uskForSSK()
248 val callback = mock<Callback>()
249 freenetInterface.registerUsk(freenetURI, callback)
250 freenetInterface.unregisterUsk(freenetURI)
251 verify(uskManager).unsubscribe(any(USK::class.java), any(USKCallback::class.java))
255 fun `unregistering a not registered sone does nothing`() {
256 freenetInterface.unregisterUsk(sone)
257 verify(uskManager, never()).unsubscribe(any(USK::class.java), any(USKCallback::class.java))
261 fun `unregistering aregistered sone unregisters the sone`() {
262 freenetInterface.registerActiveUsk(sone.requestUri, mock())
263 freenetInterface.unregisterUsk(sone)
264 verify(uskManager).unsubscribe(any(USK::class.java), any(USKCallback::class.java))
268 fun `unregistering asone with awrong request key will not unsubscribe`() {
269 whenever(sone.requestUri).thenReturn(FreenetURI("KSK@GPLv3.txt"))
270 freenetInterface.registerUsk(sone.requestUri, null)
271 freenetInterface.unregisterUsk(sone)
272 verify(uskManager, never()).unsubscribe(any(USK::class.java), any(USKCallback::class.java))
276 fun `callback for normal usk uses different priorities`() {
277 val callback = mock<Callback>()
278 val soneUri = createRandom(randomSource, "test-0").uri.uskForSSK()
279 freenetInterface.registerUsk(soneUri, callback)
280 assertThat(callbackCaptor.value.pollingPriorityNormal, equalTo(PREFETCH_PRIORITY_CLASS))
281 assertThat(callbackCaptor.value.pollingPriorityProgress, equalTo(INTERACTIVE_PRIORITY_CLASS))
285 fun `callback for normal usk forwards important parameters`() {
286 val callback = mock<Callback>()
287 val uri = createRandom(randomSource, "test-0").uri.uskForSSK()
288 freenetInterface.registerUsk(uri, callback)
289 val key = mock<USK>()
290 whenever(key.uri).thenReturn(uri)
291 callbackCaptor.value.onFoundEdition(3, key, null, false, 0.toShort(), null, true, true)
292 verify(callback).editionFound(eq(uri), eq(3L), eq(true), eq(true))
296 fun `fetched retains uri and fetch result`() {
297 val freenetUri = mock<FreenetURI>()
298 val fetchResult = mock<FetchResult>()
299 val (freenetUri1, fetchResult1) = Fetched(freenetUri, fetchResult)
300 assertThat(freenetUri1, equalTo(freenetUri))
301 assertThat(fetchResult1, equalTo(fetchResult))
305 fun `cancelling an insert will fire image insert aborted event`() {
306 val clientPutter = mock<ClientPutter>()
307 insertToken.setClientPutter(clientPutter)
308 val imageInsertStartedEvent = forClass(ImageInsertStartedEvent::class.java)
309 verify(eventBus).post(imageInsertStartedEvent.capture())
310 assertThat(imageInsertStartedEvent.value.image, equalTo(image))
312 val imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent::class.java)
313 verify(eventBus, times(2)).post(imageInsertAbortedEvent.capture())
314 verify(bucket).free()
315 assertThat(imageInsertAbortedEvent.value.image, equalTo(image))
319 fun `failure without exception sends failed event`() {
320 val insertException = InsertException(mock<InsertException>())
321 insertToken.onFailure(insertException, null)
322 val imageInsertFailedEvent = forClass(ImageInsertFailedEvent::class.java)
323 verify(eventBus).post(imageInsertFailedEvent.capture())
324 verify(bucket).free()
325 assertThat(imageInsertFailedEvent.value.image, equalTo(image))
326 assertThat(imageInsertFailedEvent.value.cause, equalTo<Throwable>(insertException))
330 fun `failure sends failed event with exception`() {
331 val insertException = InsertException(InsertExceptionMode.INTERNAL_ERROR, "Internal error", null)
332 insertToken.onFailure(insertException, null)
333 val imageInsertFailedEvent = forClass(ImageInsertFailedEvent::class.java)
334 verify(eventBus).post(imageInsertFailedEvent.capture())
335 verify(bucket).free()
336 assertThat(imageInsertFailedEvent.value.image, equalTo(image))
337 assertThat(imageInsertFailedEvent.value.cause, equalTo(insertException as Throwable))
341 fun `failure because cancelled by user sends aborted event`() {
342 val insertException = InsertException(InsertExceptionMode.CANCELLED, null)
343 insertToken.onFailure(insertException, null)
344 val imageInsertAbortedEvent = forClass(ImageInsertAbortedEvent::class.java)
345 verify(eventBus).post(imageInsertAbortedEvent.capture())
346 verify(bucket).free()
347 assertThat(imageInsertAbortedEvent.value.image, equalTo(image))
351 fun `ignored methods do not throw exceptions`() {
352 insertToken.onResume(null)
353 insertToken.onFetchable(null)
354 insertToken.onGeneratedMetadata(null, null)
358 fun `generated uri is posted on success`() {
359 val generatedUri = mock<FreenetURI>()
360 insertToken.onGeneratedURI(generatedUri, null)
361 insertToken.onSuccess(null)
362 val imageInsertFinishedEvent = forClass(ImageInsertFinishedEvent::class.java)
363 verify(eventBus).post(imageInsertFinishedEvent.capture())
364 verify(bucket).free()
365 assertThat(imageInsertFinishedEvent.value.image, equalTo(image))
366 assertThat(imageInsertFinishedEvent.value.resultingUri, equalTo(generatedUri))
370 fun `insert token supplier supplies insert tokens`() {
371 val insertTokenSupplier = InsertTokenSupplier(freenetInterface)
372 assertThat(insertTokenSupplier.apply(image), notNullValue())
376 fun `background fetch can be started`() {
377 freenetInterface.startFetch(uri, backgroundFetchCallback)
378 verify(highLevelSimpleClient).fetch(eq(uri), anyLong(), any(ClientGetCallback::class.java), any(FetchContext::class.java), anyShort())
382 fun `background fetch registers snoop and restarts the request`() {
383 freenetInterface.startFetch(uri, backgroundFetchCallback)
384 verify(clientGetter).metaSnoop = any(SnoopMetadata::class.java)
385 verify(clientGetter).restart(eq(uri), anyBoolean(), any(ClientContext::class.java))
389 fun `request is not cancelled for image mime type`() {
390 verifySnoopCancelsRequestForMimeType("image/png", false)
391 verify(backgroundFetchCallback, never()).failed(uri)
395 fun `request is cancelled for null mime type`() {
396 verifySnoopCancelsRequestForMimeType(null, true)
397 verify(backgroundFetchCallback, never()).shouldCancel(eq(uri), any(), anyLong())
398 verify(backgroundFetchCallback).failed(uri)
402 fun `request is cancelled for video mime type`() {
403 verifySnoopCancelsRequestForMimeType("video/mkv", true)
404 verify(backgroundFetchCallback).failed(uri)
408 fun `request is cancelled for audio mime type`() {
409 verifySnoopCancelsRequestForMimeType("audio/mpeg", true)
410 verify(backgroundFetchCallback).failed(uri)
414 fun `request is cancelled for text mime type`() {
415 verifySnoopCancelsRequestForMimeType("text/plain", true)
416 verify(backgroundFetchCallback).failed(uri)
419 private fun verifySnoopCancelsRequestForMimeType(mimeType: String?, cancel: Boolean) {
420 whenever(backgroundFetchCallback.shouldCancel(eq(uri), if (mimeType != null) eq(mimeType) else isNull(), anyLong())).thenReturn(cancel)
421 freenetInterface.startFetch(uri, backgroundFetchCallback)
422 val snoopMetadata = forClass(SnoopMetadata::class.java)
423 verify(clientGetter).metaSnoop = snoopMetadata.capture()
424 val metadata = mock<Metadata>()
425 whenever(metadata.mimeType).thenReturn(mimeType)
426 assertThat(snoopMetadata.value.snoopMetadata(metadata, mock()), equalTo(cancel))
430 fun `callback of background fetch is notified on success`() {
431 freenetInterface.startFetch(uri, backgroundFetchCallback)
432 verify(highLevelSimpleClient).fetch(eq(uri), anyLong(), clientGetCallback.capture(), any(FetchContext::class.java), anyShort())
433 whenever(fetchResult.mimeType).thenReturn("image/png")
434 whenever(fetchResult.asByteArray()).thenReturn(byteArrayOf(1, 2, 3, 4, 5))
435 clientGetCallback.value.onSuccess(fetchResult, mock())
436 verify(backgroundFetchCallback).loaded(uri, "image/png", byteArrayOf(1, 2, 3, 4, 5))
437 verifyNoMoreInteractions(backgroundFetchCallback)
441 fun `callback of background fetch is notified on failure`() {
442 freenetInterface.startFetch(uri, backgroundFetchCallback)
443 verify(highLevelSimpleClient).fetch(eq(uri), anyLong(), clientGetCallback.capture(), any(FetchContext::class.java), anyShort())
444 whenever(fetchResult.mimeType).thenReturn("image/png")
445 whenever(fetchResult.asByteArray()).thenReturn(byteArrayOf(1, 2, 3, 4, 5))
446 clientGetCallback.value.onFailure(FetchException(ALL_DATA_NOT_FOUND), mock())
447 verify(backgroundFetchCallback).failed(uri)
448 verifyNoMoreInteractions(backgroundFetchCallback)
452 fun `callback of background fetch is notified as failure if bucket can not be loaded`() {
453 freenetInterface.startFetch(uri, backgroundFetchCallback)
454 verify(highLevelSimpleClient).fetch(eq(uri), anyLong(), clientGetCallback.capture(), any(FetchContext::class.java), anyShort())
455 whenever(fetchResult.mimeType).thenReturn("image/png")
456 whenever(fetchResult.asByteArray()).thenThrow(IOException::class.java)
457 clientGetCallback.value.onSuccess(fetchResult, mock())
458 verify(backgroundFetchCallback).failed(uri)
459 verifyNoMoreInteractions(backgroundFetchCallback)
463 fun `unregistering a registered USK with different edition unregisters USK`() {
464 val callback = mock<Callback>()
465 val uri = createRandom(randomSource, "test-123").uri.uskForSSK()
466 freenetInterface.registerUsk(uri, callback)
467 freenetInterface.unregisterUsk(uri.setSuggestedEdition(234))
468 verify(uskManager).unsubscribe(any<USK>(), any<USKCallback>())