src/test/kotlin/net/pterodactylus/sone/web/pages/WebPageTest.kt

   1 package net.pterodactylus.sone.web.pages
   2
   3 import com.google.common.eventbus.*
   4 import freenet.clients.http.*
   5 import freenet.support.*
   6 import freenet.support.api.*
   7 import net.pterodactylus.sone.core.*
   8 import net.pterodactylus.sone.data.*
   9 import net.pterodactylus.sone.freenet.*
  10 import net.pterodactylus.sone.freenet.wot.*
  11 import net.pterodactylus.sone.main.*
  12 import net.pterodactylus.sone.test.deepMock
  13 import net.pterodactylus.sone.test.get
  14 import net.pterodactylus.sone.test.mock
  15 import net.pterodactylus.sone.test.whenever
  16 import net.pterodactylus.sone.utils.*
  17 import net.pterodactylus.sone.web.*
  18 import net.pterodactylus.sone.web.page.*
  19 import net.pterodactylus.sone.web.page.FreenetTemplatePage.RedirectException
  20 import net.pterodactylus.util.notify.*
  21 import net.pterodactylus.util.template.*
  22 import net.pterodactylus.util.web.*
  23 import net.pterodactylus.util.web.Method.*
  24 import org.junit.Assert.*
  25 import org.mockito.ArgumentMatchers.*
  26 import org.mockito.ArgumentMatchers.eq
  27 import java.io.*
  28 import java.net.*
  29 import java.nio.charset.*
  30 import java.util.*
  31 import kotlin.text.Charsets.UTF_8
  32
  33 /**
  34  * Base class for web page tests.
  35  */
  36 open class WebPageTest(pageSupplier: (WebInterface, Loaders, TemplateRenderer) -> SoneTemplatePage = { _, _, _ -> mock() }) {
  37
  38         val currentSone = mock<Sone>()
  39         val loaders = mock<Loaders>()
  40         val templateRenderer = mock<TemplateRenderer>()
  41         val webInterface = deepMock<WebInterface>()
  42         val core = webInterface.core
  43         val eventBus = mock<EventBus>()
  44         val preferences = Preferences(eventBus)
  45
  46         open val page by lazy { pageSupplier(webInterface, loaders, templateRenderer) }
  47
  48         val httpRequest = mock<HTTPRequest>()
  49         val freenetRequest = mock<FreenetRequest>()
  50
  51         init {
  52                 whenever(freenetRequest.uri).thenReturn(mock())
  53         }
  54
  55         val soneRequest by lazy { freenetRequest.toSoneRequest(core, webInterface) }
  56         val templateContext = TemplateContext()
  57         val toadletContext = deepMock<ToadletContext>()
  58         val responseContent = ByteArrayOutputStream()
  59         val response = Response(responseContent)
  60
  61         private val requestHeaders = mutableMapOf<String, String>()
  62         private val getRequestParameters = mutableMapOf<String, MutableList<String>>()
  63         private val postRequestParameters = mutableMapOf<String, ByteArray>()
  64         private val uploadedFileNames = mutableMapOf<String, String>()
  65         private val uploadedFileContentTypes = mutableMapOf<String, String>()
  66         private val uploadedFileResources = mutableMapOf<String, String>()
  67         private val ownIdentities = mutableSetOf<OwnIdentity>()
  68         private val allSones = mutableMapOf<String, Sone>()
  69         private val localSones = mutableMapOf<String, Sone>()
  70         private val allPosts = mutableMapOf<String, Post>()
  71         private val allPostReplies = mutableMapOf<String, PostReply>()
  72         private val perPostReplies = mutableMapOf<String, PostReply>()
  73         private val allAlbums = mutableMapOf<String, Album>()
  74         private val allImages = mutableMapOf<String, Image>()
  75         private val notifications = mutableMapOf<String, Notification>()
  76         private val translations = mutableMapOf<String, String>()
  77
  78         private val translation = object : Translation {
  79                 override val currentLocale = Locale.ENGLISH
  80                 override fun translate(key: String) = translations[key] ?: key
  81         }
  82
  83         init {
  84                 setupCore()
  85                 setupWebInterface()
  86                 setupHttpRequest()
  87                 setupFreenetRequest()
  88         }
  89
  90         private fun setupCore() {
  91                 whenever(core.preferences).thenReturn(preferences)
  92                 whenever(core.identityManager.allOwnIdentities).then { ownIdentities }
  93                 whenever(core.sones).then { allSones.values }
  94                 whenever(core.getSone(anyString())).then { allSones[it[0]] }
  95                 whenever(core.localSones).then { localSones.values }
  96                 whenever(core.getLocalSone(anyString())).then { localSones[it[0]] }
  97                 whenever(core.getPost(anyString())).then { allPosts[it[0]] }
  98                 whenever(core.getPostReply(anyString())).then { allPostReplies[it[0]] }
  99                 whenever(core.getReplies(anyString())).then { perPostReplies[it[0]].asList() }
 100                 whenever(core.getAlbum(anyString())).then { allAlbums[it[0]] }
 101                 whenever(core.getImage(anyString())).then { allImages[it[0]] }
 102                 whenever(core.getImage(anyString(), anyBoolean())).then { allImages[it[0]] }
 103                 whenever(core.getTemporaryImage(anyString())).thenReturn(null)
 104         }
 105
 106         private fun setupWebInterface() {
 107                 whenever(webInterface.getCurrentSoneCreatingSession(eq(toadletContext))).thenReturn(currentSone)
 108                 whenever(webInterface.getCurrentSone(eq(toadletContext), anyBoolean())).thenReturn(currentSone)
 109                 whenever(webInterface.getCurrentSoneWithoutCreatingSession(eq(toadletContext))).thenReturn(currentSone)
 110                 whenever(webInterface.getNotifications(currentSone)).then { notifications.values }
 111                 whenever(webInterface.getNotification(anyString())).then { notifications[it[0]].asOptional() }
 112                 whenever(webInterface.translation).thenReturn(translation)
 113         }
 114
 115         private fun setupHttpRequest() {
 116                 whenever(httpRequest.method).thenReturn("GET")
 117                 whenever(httpRequest.getHeader(anyString())).then { requestHeaders[it.get<String>(0).toLowerCase()] }
 118                 whenever(httpRequest.hasParameters()).then { getRequestParameters.isNotEmpty() }
 119                 whenever(httpRequest.parameterNames).then { getRequestParameters.keys }
 120                 whenever(httpRequest.isParameterSet(anyString())).then { it[0] in getRequestParameters }
 121                 whenever(httpRequest.getParam(anyString())).then { getRequestParameters[it[0]]?.firstOrNull() ?: "" }
 122                 whenever(httpRequest.getParam(anyString(), anyString())).then { getRequestParameters[it[0]]?.firstOrNull() ?: it[1] }
 123                 whenever(httpRequest.getIntParam(anyString())).then { getRequestParameters[it[0]]?.first()?.toIntOrNull() ?: 0 }
 124                 whenever(httpRequest.getIntParam(anyString(), anyInt())).then { getRequestParameters[it[0]]?.first()?.toIntOrNull() ?: it[1] }
 125                 whenever(httpRequest.getLongParam(anyString(), anyLong())).then { getRequestParameters[it[0]]?.first()?.toLongOrNull() ?: it[1] }
 126                 whenever(httpRequest.getMultipleParam(anyString())).then { getRequestParameters[it[0]]?.toTypedArray() ?: emptyArray<String>() }
 127                 whenever(httpRequest.getMultipleIntParam(anyString())).then { getRequestParameters[it[0]]?.map { it.toIntOrNull() ?: 0 } ?: emptyArray<Int>() }
 128                 whenever(httpRequest.isPartSet(anyString())).then { it[0] in postRequestParameters }
 129                 whenever(httpRequest.getPartAsStringFailsafe(anyString(), anyInt())).then { postRequestParameters[it[0]]?.decode()?.take(it[1]) ?: "" }
 130                 whenever(httpRequest.getUploadedFile(anyString())).then {
 131                         it.get<String>(0).takeIf { it in uploadedFileNames }
 132                                         ?.let { name ->
 133                                                 UploadedFile(uploadedFileNames[name]!!, uploadedFileContentTypes[name]!!, uploadedFileResources[name]!!)
 134                                         }
 135                 }
 136         }
 137
 138         private class UploadedFile(private val filename: String, private val contentType: String, private val resourceName: String) : HTTPUploadedFile {
 139                 override fun getFilename() = filename
 140                 override fun getContentType() = contentType
 141                 override fun getData() = javaClass.getResourceAsStream(resourceName).readBytes().let(::SimpleReadOnlyArrayBucket)
 142         }
 143
 144         private fun ByteArray.decode(charset: Charset = UTF_8) = String(this, charset)
 145
 146         private fun setupFreenetRequest() {
 147                 whenever(freenetRequest.method).thenReturn(GET)
 148                 whenever(freenetRequest.httpRequest).thenReturn(httpRequest)
 149                 whenever(freenetRequest.toadletContext).thenReturn(toadletContext)
 150         }
 151
 152         fun setMethod(method: Method) {
 153                 whenever(httpRequest.method).thenReturn(method.name)
 154                 whenever(freenetRequest.method).thenReturn(method)
 155         }
 156
 157         fun request(uri: String) {
 158                 whenever(httpRequest.path).thenReturn(uri)
 159                 whenever(freenetRequest.uri).thenReturn(URI(uri))
 160         }
 161
 162         fun addHttpRequestHeader(name: String, value: String) {
 163                 requestHeaders[name.toLowerCase()] = value
 164         }
 165
 166         fun addHttpRequestParameter(name: String, value: String) {
 167                 getRequestParameters[name] = getRequestParameters.getOrElse(name) { mutableListOf() }.apply { add(value) }
 168         }
 169
 170         fun addHttpRequestPart(name: String, value: String) {
 171                 postRequestParameters[name] = value.toByteArray(UTF_8)
 172         }
 173
 174         fun unsetCurrentSone() {
 175                 whenever(webInterface.getCurrentSoneCreatingSession(eq(toadletContext))).thenReturn(null)
 176                 whenever(webInterface.getCurrentSone(eq(toadletContext), anyBoolean())).thenReturn(null)
 177                 whenever(webInterface.getCurrentSoneWithoutCreatingSession(eq(toadletContext))).thenReturn(null)
 178         }
 179
 180         fun addOwnIdentity(ownIdentity: OwnIdentity) {
 181                 ownIdentities += ownIdentity
 182         }
 183
 184         fun addSone(id: String, sone: Sone) {
 185                 allSones[id] = sone
 186         }
 187
 188         fun addLocalSone(id: String, localSone: Sone) {
 189                 localSones[id] = localSone
 190         }
 191
 192         fun addPost(id: String, post: Post) {
 193                 allPosts[id] = post
 194         }
 195
 196         fun addPostReply(id: String, postReply: PostReply) {
 197                 allPostReplies[id] = postReply
 198                 postReply.postId?.also { perPostReplies[it] = postReply }
 199         }
 200
 201         fun addAlbum(id: String, album: Album) {
 202                 allAlbums[id] = album
 203         }
 204
 205         fun addImage(id: String, image: Image) {
 206                 allImages[id] = image
 207         }
 208
 209         fun addTranslation(key: String, value: String) {
 210                 translations[key] = value
 211         }
 212
 213         fun addNotification(id: String, notification: Notification) {
 214                 notifications[id] = notification
 215         }
 216
 217         fun addTemporaryImage(id: String, temporaryImage: TemporaryImage) {
 218                 whenever(core.getTemporaryImage(id)).thenReturn(temporaryImage)
 219         }
 220
 221         fun addUploadedFile(name: String, filename: String, contentType: String, resource: String) {
 222                 uploadedFileNames[name] = filename
 223                 uploadedFileContentTypes[name] = contentType
 224                 uploadedFileResources[name] = resource
 225         }
 226
 227         fun verifyNoRedirect(assertions: () -> Unit) {
 228                 var caughtException: Exception? = null
 229                 try {
 230                         page.handleRequest(freenetRequest, templateContext)
 231                 } catch (e: Exception) {
 232                         caughtException = e
 233                 }
 234                 caughtException?.run { throw this } ?: assertions()
 235         }
 236
 237         fun verifyRedirect(target: String, assertions: () -> Unit = {}) {
 238                 try {
 239                         page.handleRequest(freenetRequest, templateContext)
 240                         fail()
 241                 } catch (re: RedirectException) {
 242                         if (re.target != target) {
 243                                 throw re
 244                         }
 245                         assertions()
 246                 } catch (e: Exception) {
 247                         throw e
 248                 }
 249         }
 250
 251 }