From 42eb3faa504eab3cdc49a320521c9b545b20cb64 Mon Sep 17 00:00:00 2001
From: Torsten Grote <t@grobox.de>
Date: Tue, 19 Oct 2021 15:36:37 -0300
Subject: [PATCH] Add a JavaDoc for TestUtils#everyTransactionWithResult

---
 .../src/test/java/org/briarproject/mailbox/core/TestUtils.kt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/mailbox-core/src/test/java/org/briarproject/mailbox/core/TestUtils.kt b/mailbox-core/src/test/java/org/briarproject/mailbox/core/TestUtils.kt
index 23a0b6c7..9ec2c1b1 100644
--- a/mailbox-core/src/test/java/org/briarproject/mailbox/core/TestUtils.kt
+++ b/mailbox-core/src/test/java/org/briarproject/mailbox/core/TestUtils.kt
@@ -27,6 +27,11 @@ object TestUtils {
         outboxId = getNewRandomId(),
     )
 
+    /**
+     * Allows you to mock [Database] access happening within a [Transaction] more comfortably.
+     * Calls to [Database.transactionWithResult] will be mocked.
+     * The given lambda [block] will get captured and invoked.
+     */
     fun <T> everyTransactionWithResult(db: Database, readOnly: Boolean, block: (Transaction) -> T) {
         val txn = Transaction(mockk(), readOnly)
         every { db.transactionWithResult<T>(true, captureLambda()) } answers {
-- 
GitLab