kumi/Android-Password-Store
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactor(pgpainless): rework runTest invocation

Browse source
This commit is contained in:
Harsh Shandilya 2023-05-06 01:59:35 +05:30
parent ff0b489dd9
commit cb6a92e1d3
No known key found for this signature in database
1 changed files with 22 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

81
crypto-pgpainless/src/test/kotlin/app/passwordstore/crypto/PGPKeyManagerTest.kt
View file

@ -11,25 +11,18 @@ import com.github.michaelbull.result.Ok
import com.github.michaelbull.result.unwrap import com.github.michaelbull.result.unwrap
import com.github.michaelbull.result.unwrapError import com.github.michaelbull.result.unwrapError
import java.io.File import java.io.File
import kotlin.test.AfterTest
import kotlin.test.BeforeTest
import kotlin.test.Test import kotlin.test.Test
import kotlin.test.assertContentEquals import kotlin.test.assertContentEquals
import kotlin.test.assertEquals import kotlin.test.assertEquals
import kotlin.test.assertIs import kotlin.test.assertIs
import kotlin.test.assertNotEquals import kotlin.test.assertNotEquals
import kotlin.test.assertNotNull import kotlin.test.assertNotNull
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.test.StandardTestDispatcher import kotlinx.coroutines.test.StandardTestDispatcher
import kotlinx.coroutines.test.TestScope import kotlinx.coroutines.test.TestScope
import kotlinx.coroutines.test.resetMain
import kotlinx.coroutines.test.runTest import kotlinx.coroutines.test.runTest
import kotlinx.coroutines.test.setMain
import org.junit.Rule import org.junit.Rule
import org.junit.rules.TemporaryFolder import org.junit.rules.TemporaryFolder
@OptIn(ExperimentalCoroutinesApi::class)
class PGPKeyManagerTest { class PGPKeyManagerTest {
@get:Rule val temporaryFolder: TemporaryFolder = TemporaryFolder() @get:Rule val temporaryFolder: TemporaryFolder = TemporaryFolder()
@ -44,26 +37,14 @@ class PGPKeyManagerTest {
private fun <T> unsafeLazy(initializer: () -> T) = private fun <T> unsafeLazy(initializer: () -> T) =
lazy(LazyThreadSafetyMode.NONE) { initializer.invoke() } lazy(LazyThreadSafetyMode.NONE) { initializer.invoke() }
@BeforeTest
fun setUp() {
Dispatchers.setMain(dispatcher)
}
@AfterTest
fun tearDown() {
Dispatchers.resetMain()
}
@Test @Test
fun addKey() = fun addKey() =
scope.runTest { runTest(dispatcher) {
// Check if the key id returned is correct // Check if the key id returned is correct
val keyId = keyManager.getKeyId(keyManager.addKey(secretKey).unwrap()) val keyId = keyManager.getKeyId(keyManager.addKey(secretKey).unwrap())
assertEquals(KeyId(CryptoConstants.KEY_ID), keyId) assertEquals(KeyId(CryptoConstants.KEY_ID), keyId)
// Check if the keys directory have one file // Check if the keys directory have one file
assertEquals(1, filesDir.list()?.size) assertEquals(1, filesDir.list()?.size)
// Check if the file name is correct // Check if the file name is correct
val keyFile = keysDir.listFiles()?.first() val keyFile = keysDir.listFiles()?.first()
assertEquals(keyFile?.name, "$keyId.${PGPKeyManager.KEY_EXTENSION}") assertEquals(keyFile?.name, "$keyId.${PGPKeyManager.KEY_EXTENSION}")
@ -71,7 +52,7 @@ class PGPKeyManagerTest {
@Test @Test
fun addKeyWithoutReplaceFlag() = fun addKeyWithoutReplaceFlag() =
scope.runTest { runTest(dispatcher) {
// Check adding the keys twice // Check adding the keys twice
keyManager.addKey(secretKey, false).unwrap() keyManager.addKey(secretKey, false).unwrap()
val error = keyManager.addKey(secretKey, false).unwrapError() val error = keyManager.addKey(secretKey, false).unwrapError()
@ -81,7 +62,7 @@ class PGPKeyManagerTest {
@Test @Test
fun addKeyWithReplaceFlag() = fun addKeyWithReplaceFlag() =
scope.runTest { runTest(dispatcher) {
// Check adding the keys twice // Check adding the keys twice
keyManager.addKey(secretKey, true).unwrap() keyManager.addKey(secretKey, true).unwrap()
val keyId = keyManager.getKeyId(keyManager.addKey(secretKey, true).unwrap()) val keyId = keyManager.getKeyId(keyManager.addKey(secretKey, true).unwrap())
@ -91,13 +72,11 @@ class PGPKeyManagerTest {
@Test @Test
fun removeKey() = fun removeKey() =
scope.runTest { runTest(dispatcher) {
// Add key using KeyManager // Add key using KeyManager
keyManager.addKey(secretKey).unwrap() keyManager.addKey(secretKey).unwrap()
// Remove key // Remove key
keyManager.removeKey(tryGetId(secretKey)!!).unwrap() keyManager.removeKey(tryGetId(secretKey)!!).unwrap()
// Check that no keys remain // Check that no keys remain
val keys = keyManager.getAllKeys().unwrap() val keys = keyManager.getAllKeys().unwrap()
assertEquals(0, keys.size) assertEquals(0, keys.size)
@ -105,14 +84,12 @@ class PGPKeyManagerTest {
@Test @Test
fun getKeyById() = fun getKeyById() =
scope.runTest { runTest(dispatcher) {
// Add key using KeyManager // Add key using KeyManager
keyManager.addKey(secretKey).unwrap() keyManager.addKey(secretKey).unwrap()
val keyId = keyManager.getKeyId(secretKey) val keyId = keyManager.getKeyId(secretKey)
assertNotNull(keyId) assertNotNull(keyId)
assertEquals(KeyId(CryptoConstants.KEY_ID), keyManager.getKeyId(secretKey)) assertEquals(KeyId(CryptoConstants.KEY_ID), keyManager.getKeyId(secretKey))
// Check returned key id matches the expected id and the created key id // Check returned key id matches the expected id and the created key id
val returnedKey = keyManager.getKeyById(keyId).unwrap() val returnedKey = keyManager.getKeyById(keyId).unwrap()
assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey)) assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey))
@ -120,9 +97,8 @@ class PGPKeyManagerTest {
@Test @Test
fun getKeyByFullUserId() = fun getKeyByFullUserId() =
scope.runTest { runTest(dispatcher) {
keyManager.addKey(secretKey).unwrap() keyManager.addKey(secretKey).unwrap()
val keyId = "${CryptoConstants.KEY_NAME} <${CryptoConstants.KEY_EMAIL}>" val keyId = "${CryptoConstants.KEY_NAME} <${CryptoConstants.KEY_EMAIL}>"
val returnedKey = keyManager.getKeyById(UserId(keyId)).unwrap() val returnedKey = keyManager.getKeyById(UserId(keyId)).unwrap()
assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey)) assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey))
@ -130,9 +106,8 @@ class PGPKeyManagerTest {
@Test @Test
fun getKeyByEmailUserId() = fun getKeyByEmailUserId() =
scope.runTest { runTest(dispatcher) {
keyManager.addKey(secretKey).unwrap() keyManager.addKey(secretKey).unwrap()
val keyId = CryptoConstants.KEY_EMAIL val keyId = CryptoConstants.KEY_EMAIL
val returnedKey = keyManager.getKeyById(UserId(keyId)).unwrap() val returnedKey = keyManager.getKeyById(UserId(keyId)).unwrap()
assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey)) assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey))
@ -140,12 +115,10 @@ class PGPKeyManagerTest {
@Test @Test
fun getNonExistentKey() = fun getNonExistentKey() =
scope.runTest { runTest(dispatcher) {
// Add key using KeyManager // Add key using KeyManager
keyManager.addKey(secretKey).unwrap() keyManager.addKey(secretKey).unwrap()
val keyId = KeyId(0x08edf7567183ce44) val keyId = KeyId(0x08edf7567183ce44)
// Check returned key // Check returned key
val error = keyManager.getKeyById(keyId).unwrapError() val error = keyManager.getKeyById(keyId).unwrapError()
assertIs<KeyNotFoundException>(error) assertIs<KeyNotFoundException>(error)
@ -154,7 +127,7 @@ class PGPKeyManagerTest {
@Test @Test
fun findNonExistentKey() = fun findNonExistentKey() =
scope.runTest { runTest(dispatcher) {
// Check returned key // Check returned key
val error = keyManager.getKeyById(KeyId(0x08edf7567183ce44)).unwrapError() val error = keyManager.getKeyById(KeyId(0x08edf7567183ce44)).unwrapError()
assertIs<NoKeysAvailableException>(error) assertIs<NoKeysAvailableException>(error)
@ -163,52 +136,46 @@ class PGPKeyManagerTest {
@Test @Test
fun getAllKeys() = fun getAllKeys() =
scope.runTest { runTest(dispatcher) {
// Check if KeyManager returns no key // Check if KeyManager returns no key
val noKeyList = keyManager.getAllKeys().unwrap() val noKeyList = keyManager.getAllKeys().unwrap()
assertEquals(0, noKeyList.size) assertEquals(0, noKeyList.size)
// Add key using KeyManager // Add key using KeyManager
keyManager.addKey(secretKey).unwrap() keyManager.addKey(secretKey).unwrap()
keyManager.addKey(PGPKey(TestUtils.getArmoredSecretKeyWithMultipleIdentities())).unwrap() keyManager.addKey(PGPKey(TestUtils.getArmoredSecretKeyWithMultipleIdentities())).unwrap()
// Check if KeyManager returns one key // Check if KeyManager returns one key
val singleKeyList = keyManager.getAllKeys().unwrap() val singleKeyList = keyManager.getAllKeys().unwrap()
assertEquals(2, singleKeyList.size) assertEquals(2, singleKeyList.size)
} }
@Test @Test
fun getMultipleIdentityKeyWithAllIdentities() { fun getMultipleIdentityKeyWithAllIdentities() =
scope.runTest { runTest(dispatcher) {
val key = PGPKey(TestUtils.getArmoredSecretKeyWithMultipleIdentities()) val key = PGPKey(TestUtils.getArmoredSecretKeyWithMultipleIdentities())
keyManager.addKey(key).unwrap() keyManager.addKey(key).unwrap()
val johnKey = keyManager.getKeyById(UserId("john@doe.org")).unwrap() val johnKey = keyManager.getKeyById(UserId("john@doe.org")).unwrap()
val janeKey = keyManager.getKeyById(UserId("jane@doe.org")).unwrap() val janeKey = keyManager.getKeyById(UserId("jane@doe.org")).unwrap()
assertContentEquals(johnKey.contents, janeKey.contents) assertContentEquals(johnKey.contents, janeKey.contents)
} }
}
@Test @Test
fun replaceSecretKeyWithPublicKey() { fun replaceSecretKeyWithPublicKey() =
scope.runTest { runTest(dispatcher) {
assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey))
assertIs<Err<KeyAlreadyExistsException>>(keyManager.addKey(publicKey)) assertIs<Err<KeyAlreadyExistsException>>(keyManager.addKey(publicKey))
} }
}
@Test @Test
fun replacePublicKeyWithSecretKey() { fun replacePublicKeyWithSecretKey() =
scope.runTest { runTest(dispatcher) {
assertIs<Ok<PGPKey>>(keyManager.addKey(publicKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(publicKey))
assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey))
} }
}
@Test @Test
fun replacePublicKeyWithPublicKey() { fun replacePublicKeyWithPublicKey() =
scope.runTest { runTest(dispatcher) {
assertIs<Ok<PGPKey>>(keyManager.addKey(publicKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(publicKey))
assertIs<Ok<PGPKey>>(keyManager.addKey(publicKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(publicKey))
val allKeys = keyManager.getAllKeys() val allKeys = keyManager.getAllKeys()
@ -217,19 +184,17 @@ class PGPKeyManagerTest {
val key = allKeys.value[0] val key = allKeys.value[0]
assertContentEquals(publicKey.contents, key.contents) assertContentEquals(publicKey.contents, key.contents)
} }
}
@Test @Test
fun replaceSecretKeyWithSecretKey() { fun replaceSecretKeyWithSecretKey() =
scope.runTest { runTest(dispatcher) {
assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey))
assertIs<Err<KeyAlreadyExistsException>>(keyManager.addKey(secretKey)) assertIs<Err<KeyAlreadyExistsException>>(keyManager.addKey(secretKey))
} }
}
@Test @Test
fun addMultipleKeysWithSameEmail() { fun addMultipleKeysWithSameEmail() =
scope.runTest { runTest(dispatcher) {
val alice = val alice =
PGPKey(this::class.java.classLoader.getResource("alice_owner@example_com")!!.readBytes()) PGPKey(this::class.java.classLoader.getResource("alice_owner@example_com")!!.readBytes())
val bobby = val bobby =
@ -241,7 +206,6 @@ class PGPKeyManagerTest {
assertIs<Ok<List<PGPKey>>>(this) assertIs<Ok<List<PGPKey>>>(this)
assertEquals(2, this.value.size) assertEquals(2, this.value.size)
} }
val longKeyIds = val longKeyIds =
arrayOf( arrayOf(
KeyId(-7087927403306410599), // Alice KeyId(-7087927403306410599), // Alice
@ -262,4 +226,3 @@ class PGPKeyManagerTest {
} }
} }
} }
}