Add Tests

This commit is contained in:
2021-06-26 01:51:33 +02:00
parent 181176ed21
commit ce55c58430
7 changed files with 236 additions and 25 deletions

View File

@@ -1,4 +1,4 @@
package fr.dcproject.common.security
package io.github.flecomte
/** Responses of AccessControl */
enum class AccessDecision {
@@ -25,19 +25,17 @@ abstract class AccessControl {
*/
protected fun denied(message: String, code: String): DeniedResponse = DeniedResponse(this, message, code)
/**
* Check all responses and return DENIED if one is DENIED
*
* If the list of responses is empty, return GRANTED
*/
private fun AccessResponses.getOneResponse(): AccessResponse = this.firstOrNull { it.decision == AccessDecision.DENIED } ?: granted()
/**
* A helper to convert a list of subject into one response
*/
protected fun <S : List<T>, T> canAll(items: S, action: (T) -> AccessResponse): AccessResponse = items
.map { action(it) }
.getOneResponse()
protected fun <S : List<T>, T> canAll(items: S, action: (T) -> AccessResponse): AccessResponses = items
.map { action(it) }.let { responses ->
if (responses.any { it is DeniedResponse }) {
DeniedResponses(responses)
} else {
GrantedResponses(responses)
}
}
}
/**
@@ -47,49 +45,65 @@ fun <T : AccessControl> T.assert(action: T.() -> AccessResponse) {
action().assert()
}
typealias AccessResponses = List<AccessResponse>
/**
* Check all responses and return DENIED if one is DENIED
*
* If the list of responses is empty, return GRANTED
*/
fun AccessResponses.getOneResponse(): AccessResponse = this.firstOrNull { it.decision == AccessDecision.DENIED } ?: GrantedResponse(first().accessControl)
fun AccessResponses.getFirstDecisionResponse(): AccessResponse = this.firstOrNull { it.decision == AccessDecision.DENIED } ?: this.first { it.decision == AccessDecision.GRANTED }
/**
* Throw an Exception if one response is DENIED
*/
fun AccessResponses.assert() = this.getOneResponse().assert()
fun AccessResponses.assert() {
if (!toBoolean()) {
throw AccessDeniedException(this)
}
}
val AccessResponses.grantedResponses get(): AccessResponses = this.filterIsInstance<GrantedResponse>()
val AccessResponses.deniedResponses get(): AccessResponses = this.filterIsInstance<DeniedResponse>()
class AccessDeniedException(private val accessResponses: AccessResponses) : Throwable(accessResponses.first().message) {
/**
* Convert responses as boolean
*/
fun AccessResponses.toBoolean(): Boolean = deniedResponses.isEmpty()
class AccessDeniedException(val accessResponses: AccessResponses) : Throwable(accessResponses.deniedResponses.first().message) {
constructor(accessResponse: AccessResponse) : this(listOf(accessResponse))
/**
* Get first response
*/
fun first(): AccessResponse = accessResponses.first()
fun first(): AccessResponse = accessResponses.deniedResponses.first()
/**
* Check if the error code is present into the responses
*/
fun hasErrorCode(code: String): Boolean = accessResponses
.filter { it.decision == AccessDecision.DENIED }
.deniedResponses
.any { it.code == code }
/**
* Find and return the response than match with the error code
*/
fun getErrorCode(code: String): AccessResponse? = accessResponses
.firstOrNull { it.decision == AccessDecision.DENIED && it.code == code }
.deniedResponses
.firstOrNull { it.code == code }
/**
* Get a list of messages of all responses
*/
fun getMessages(): List<String> = accessResponses
.mapNotNull { it.message }
.deniedResponses
.map { it.message!! }
/**
* Get the first message
*/
fun getFirstMessage(): String? = accessResponses
.deniedResponses
.first()
.message
}
@@ -120,16 +134,32 @@ sealed class AccessResponse(
}
}
class GrantedResponse(
open class GrantedResponse(
accessControl: AccessControl,
message: String? = null,
code: String? = null
) : AccessResponse(AccessDecision.GRANTED, accessControl, message, code)
class DeniedResponse(
open class DeniedResponse(
accessControl: AccessControl,
message: String,
code: String
) : AccessResponse(AccessDecision.DENIED, accessControl, message, code)
typealias AccessResponses = List<AccessResponse>
class GrantedResponses(
accessResponses: List<AccessResponse>
) : AccessResponses by accessResponses,
GrantedResponse(
accessResponses.grantedResponses.first().accessControl,
accessResponses.grantedResponses.first().message,
accessResponses.grantedResponses.first().code
)
class DeniedResponses(
accessResponses: List<AccessResponse>
) : AccessResponses by accessResponses,
DeniedResponse(
accessResponses.deniedResponses.first().accessControl,
accessResponses.deniedResponses.firstOrNull()?.message ?: error("DeniedResponses cannot be empty"),
accessResponses.deniedResponses.firstOrNull()?.code ?: error("DeniedResponses cannot be empty")
)

View File

@@ -0,0 +1,144 @@
package io.github.flecomte
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertFalse
import org.junit.jupiter.api.Assertions.assertThrows
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Test
data class User(
val name: String
)
data class MyObject(
val title: String
)
class AccessControlSample : AccessControl() {
fun canView(myObject: MyObject, user: User?): AccessResponse {
return if (myObject.title == "granted" && user != null) {
granted("ok")
} else if (myObject.title == "wrong2") {
denied("KO2", "ko2")
} else {
denied("KO", "ko")
}
}
fun canView(myObjects: List<MyObject>, user: User?): AccessResponses {
return canAll(myObjects) { canView(it, user) }
}
}
class AccessControlTest {
@Test
fun `test granted`() {
AccessControlSample().run {
assertTrue(canView(MyObject("granted"), User("")).toBoolean())
}
}
@Test
fun `test denied`() {
AccessControlSample().run {
assertFalse(canView(MyObject("wrong"), User("")).toBoolean())
}
}
@Test
fun `test canAllGranted`() {
AccessControlSample().run {
assertTrue(
canView(
listOf(
MyObject("granted"),
MyObject("granted")
),
User("")
).first().toBoolean()
)
}
}
@Test
fun `test CanAllDenied`() {
AccessControlSample().run {
assertFalse(
canView(
listOf(
MyObject("granted"),
MyObject("wrong")
),
User("")
).toBoolean()
)
}
}
@Test
fun `test Assert on fail`() {
assertThrows(AccessDeniedException::class.java) {
AccessControlSample().canView(MyObject("denied"), User("")).assert()
}
}
@Test
fun `test Assert on success`() {
AccessControlSample().assert { canView(MyObject("granted"), User("")) }
}
@Test
fun `Exception tests`() {
assertThrows(AccessDeniedException::class.java) {
AccessControlSample().canView(listOf(MyObject("wrong"), MyObject("granted"), MyObject("wrong2")), User("")).assert()
}.run {
assertEquals("ko", first().code)
assertTrue(hasErrorCode("ko"))
assertFalse(hasErrorCode("notExists"))
assertEquals("ko", getErrorCode("ko")?.code)
assertEquals(null, getErrorCode("notExists")?.code)
assertEquals("KO2", getMessages().last())
assertEquals("KO", getFirstMessage())
}
}
@Test
fun `Assert success`() {
AccessControlSample()
.canView(listOf(MyObject("granted"), MyObject("granted")), User(""))
.assert()
}
@Test
fun `test getFirstDecisionResponse`() {
AccessControlSample()
.canView(listOf(MyObject("granted"), MyObject("granted")), User(""))
.getFirstDecisionResponse()
.run {
assertTrue(decision.toBoolean())
}
}
@Test
fun `test getFirstDecisionResponse on denied`() {
AccessControlSample()
.canView(listOf(MyObject("granted"), MyObject("denied")), User(""))
.getFirstDecisionResponse()
.run {
assertFalse(decision.toBoolean())
}
}
@Test
fun `GrantedResponse instantiation test`() {
assertEquals(AccessDecision.GRANTED, GrantedResponse(AccessControlSample()).decision)
}
@Test
fun `DeniedResponses must be throw exception if have no denied responses`() {
assertThrows(Exception::class.java) {
DeniedResponses(
listOf(GrantedResponse(AccessControlSample())),
)
}
}
}