Merged in enforce-transaction-check-in-tests (pull request #160)

Enforce transaction check in tests

contracts/src/main/kotlin/com/r3corda/contracts/testing/TestUtils.kt

@@ -46,8 +46,6 @@ fun generateState(notary: Party = DUMMY_NOTARY) = DummyContract.State(Random().n
 //    contract.accepts() -> should pass
 //    contract `fails requirement` "some substring of the error message"
 // }
-//
-// TODO: Make it impossible to forget to test either a failure or an accept for each transaction{} block
 
 infix fun Cash.State.`owned by`(owner: PublicKey) = copy(owner = owner)
 infix fun Cash.State.`issued by`(party: Party) = copy(amount = Amount<Issued<Currency>>(amount.quantity, issuanceDef.copy(issuer = deposit.copy(party = party))))

contracts/src/test/kotlin/com/r3corda/contracts/IRSTests.kt

@@ -573,6 +573,7 @@ class IRSTests {
             output("irs post agreement") { singleIRS() }
             arg(MEGA_CORP_PUBKEY) { InterestRateSwap.Commands.Agree() }
             timestamp(TEST_TX_TIME)
+            this.accepts()
         }
 
         val oldIRS = singleIRS(1)

core/src/main/kotlin/com/r3corda/core/testing/TestUtils.kt

@@ -135,10 +135,19 @@ abstract class AbstractTransactionForTest {
 
     // Forbid patterns like:  transaction { ... transaction { ... } }
     @Deprecated("Cannot nest transactions, use tweak", level = DeprecationLevel.ERROR)
-    fun transaction(body: TransactionForTest.() -> Unit) {
+    fun transaction(body: TransactionForTest.() -> LastLineShouldTestForAcceptOrFailure) {
     }
 }
 
+/** If you jumped here from a compiler error make sure the last line of your test tests for a transaction accept or fail
+ *  This is a dummy type that can only be instantiated by functions in this module. This way we can ensure that all tests
+ *  will have as the last line either an accept or a failure test. The name is deliberately long to help make sense of
+ *  the triggered diagnostic
+ */
+sealed class LastLineShouldTestForAcceptOrFailure {
+    internal object Token: LastLineShouldTestForAcceptOrFailure()
+}
+
 // Corresponds to the args to Contract.verify
 open class TransactionForTest : AbstractTransactionForTest() {
     private val inStates = arrayListOf<ContractState>()
@@ -150,7 +159,10 @@ open class TransactionForTest : AbstractTransactionForTest() {
         tx.verify()
     }
 
-    fun accepts(time: Instant = TEST_TX_TIME) = runCommandsAndVerify(time)
+    fun accepts(time: Instant = TEST_TX_TIME): LastLineShouldTestForAcceptOrFailure {
+        runCommandsAndVerify(time)
+        return LastLineShouldTestForAcceptOrFailure.Token
+    }
     fun rejects(withMessage: String? = null, time: Instant = TEST_TX_TIME) {
         val r = try {
             runCommandsAndVerify(time)
@@ -169,13 +181,16 @@ open class TransactionForTest : AbstractTransactionForTest() {
     /**
      * Used to confirm that the test, when (implicitly) run against the .verify() method, fails with the text of the message
      */
-    infix fun `fails requirement`(msg: String) = rejects(msg)
+    infix fun `fails requirement`(msg: String): LastLineShouldTestForAcceptOrFailure {
+        rejects(msg)
+        return LastLineShouldTestForAcceptOrFailure.Token
+    }
 
     fun fails_requirement(msg: String) = this.`fails requirement`(msg)
 
     // Use this to create transactions where the output of this transaction is automatically used as an input of
     // the next.
-    fun chain(vararg outputLabels: String, body: TransactionForTest.() -> Unit): TransactionForTest {
+    fun chain(vararg outputLabels: String, body: TransactionForTest.() -> LastLineShouldTestForAcceptOrFailure): TransactionForTest {
         val states = outStates.mapNotNull {
             val l = it.label
             if (l != null && outputLabels.contains(l))
@@ -190,13 +205,12 @@ open class TransactionForTest : AbstractTransactionForTest() {
     }
 
     // Allow customisation of partial transactions.
-    fun tweak(body: TransactionForTest.() -> Unit): TransactionForTest {
+    fun tweak(body: TransactionForTest.() -> LastLineShouldTestForAcceptOrFailure): LastLineShouldTestForAcceptOrFailure {
         val tx = TransactionForTest()
         tx.inStates.addAll(inStates)
         tx.outStates.addAll(outStates)
         tx.commands.addAll(commands)
-        tx.body()
-        return tx
+        return tx.body()
     }
 
     override fun toString(): String {
@@ -217,7 +231,9 @@ open class TransactionForTest : AbstractTransactionForTest() {
     }
 }
 
-fun transaction(body: TransactionForTest.() -> Unit) = TransactionForTest().apply { body() }
+fun transaction(body: TransactionForTest.() -> LastLineShouldTestForAcceptOrFailure): LastLineShouldTestForAcceptOrFailure {
+    return body(TransactionForTest())
+}
 
 class TransactionGroupDSL<T : ContractState>(private val stateType: Class<T>) {
     open inner class WireTransactionDSL : AbstractTransactionForTest() {
@@ -271,10 +287,16 @@ class TransactionGroupDSL<T : ContractState>(private val stateType: Class<T>) {
             rootTxns.add(wtx)
         }
 
+        /**
+         * Note: Don't delete, this is intended to trigger compiler diagnostic when the DSL primitive is used in the wrong place
+         */
         @Deprecated("Does not nest ", level = DeprecationLevel.ERROR)
         fun roots(body: Roots.() -> Unit) {
         }
 
+        /**
+         * Note: Don't delete, this is intended to trigger compiler diagnostic when the DSL primitive is used in the wrong place
+         */
         @Deprecated("Use the vararg form of transaction inside roots", level = DeprecationLevel.ERROR)
         fun transaction(body: WireTransactionDSL.() -> Unit) {
         }
@@ -298,6 +320,9 @@ class TransactionGroupDSL<T : ContractState>(private val stateType: Class<T>) {
     fun labelForTransaction(tx: WireTransaction): String? = txnToLabelMap[tx.id]
     fun labelForTransaction(tx: LedgerTransaction): String? = txnToLabelMap[tx.id]
 
+    /**
+     * Note: Don't delete, this is intended to trigger compiler diagnostic when the DSL primitive is used in the wrong place
+     */
     @Deprecated("Does not nest ", level = DeprecationLevel.ERROR)
     fun transactionGroup(body: TransactionGroupDSL<T>.() -> Unit) {
     }