CORDA-716 Retire withTestSerialization (#2240)

core/src/test/kotlin/net/corda/core/utilities/NonEmptySetTest.kt

@@ -7,9 +7,10 @@ import com.google.common.collect.testing.features.CollectionSize
 import junit.framework.TestSuite
 import net.corda.core.serialization.deserialize
 import net.corda.core.serialization.serialize
-import net.corda.testing.withTestSerialization
+import net.corda.testing.SerializationEnvironmentRule
 import org.assertj.core.api.Assertions.assertThat
 import org.assertj.core.api.Assertions.assertThatThrownBy
+import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.Suite
@@ -36,6 +37,10 @@ class NonEmptySetTest {
     }
 
     class General {
+        @Rule
+        @JvmField
+        val testSerialization = SerializationEnvironmentRule()
+
         @Test
         fun `copyOf - empty source`() {
             assertThatThrownBy { NonEmptySet.copyOf(HashSet<Int>()) }.isInstanceOf(IllegalArgumentException::class.java)
@@ -48,13 +53,11 @@ class NonEmptySetTest {
 
         @Test
         fun `serialize deserialize`() {
-            withTestSerialization {
             val original = NonEmptySet.of(-17, 22, 17)
             val copy = original.serialize().deserialize()
             assertThat(copy).isEqualTo(original).isNotSameAs(original)
         }
     }
-    }
 
     private object NonEmptySetGenerator : TestIntegerSetGenerator() {
         override fun create(elements: Array<out Int?>): NonEmptySet<Int?> = NonEmptySet.copyOf(elements.asList())

node-api/src/test/kotlin/net/corda/nodeapi/internal/serialization/amqp/SerializationOutputTests.kt

@@ -29,6 +29,7 @@ import org.apache.qpid.proton.codec.EncoderImpl
 import org.assertj.core.api.Assertions.*
 import org.junit.Assert.*
 import org.junit.Ignore
+import org.junit.Rule
 import org.junit.Test
 import java.io.ByteArrayInputStream
 import java.io.IOException
@@ -54,6 +55,10 @@ class SerializationOutputTests {
         val MINI_CORP_PUBKEY get() = miniCorp.publicKey
     }
 
+    @Rule
+    @JvmField
+    val testSerialization = SerializationEnvironmentRule()
+
     data class Foo(val bar: String, val pub: Int)
 
     data class testFloat(val f: Float)
@@ -473,9 +478,9 @@ class SerializationOutputTests {
         assertSerializedThrowableEquivalent(t, desThrowable)
     }
 
-    private fun serdesThrowableWithInternalInfo(t: Throwable, factory: SerializerFactory, factory2: SerializerFactory, expectedEqual: Boolean = true): Throwable = withTestSerialization {
+    private fun serdesThrowableWithInternalInfo(t: Throwable, factory: SerializerFactory, factory2: SerializerFactory, expectedEqual: Boolean = true): Throwable {
         val newContext = SerializationFactory.defaultFactory.defaultContext.withProperty(CommonPropertyNames.IncludeInternalInfo, true)
-        SerializationFactory.defaultFactory.asCurrent { withCurrentContext(newContext) { serdes(t, factory, factory2, expectedEqual) } }
+        return SerializationFactory.defaultFactory.asCurrent { withCurrentContext(newContext) { serdes(t, factory, factory2, expectedEqual) } }
     }
 
     @Test

node/src/integration-test/kotlin/net/corda/node/services/AttachmentLoadingTests.kt

@@ -24,16 +24,20 @@ import net.corda.testing.*
 import net.corda.testing.driver.DriverDSL
 import net.corda.testing.driver.NodeHandle
 import net.corda.testing.driver.driver
+import net.corda.testing.internal.withoutTestSerialization
 import net.corda.testing.services.MockAttachmentStorage
 import net.corda.testing.rigorousMock
-import net.corda.testing.withTestSerialization
 import org.junit.Assert.assertEquals
+import org.junit.Rule
 import org.junit.Test
 import java.net.URLClassLoader
 import java.nio.file.Files
 import kotlin.test.assertFailsWith
 
 class AttachmentLoadingTests {
+    @Rule
+    @JvmField
+    val testSerialization = SerializationEnvironmentRule()
     private val attachments = MockAttachmentStorage()
     private val provider = CordappProviderImpl(CordappLoader.createDevMode(listOf(isolatedJAR)), attachments)
     private val cordapp get() = provider.cordapps.first()
@@ -80,7 +84,7 @@ class AttachmentLoadingTests {
     }
 
     @Test
-    fun `test a wire transaction has loaded the correct attachment`() = withTestSerialization {
+    fun `test a wire transaction has loaded the correct attachment`() {
         val appClassLoader = appContext.classLoader
         val contractClass = appClassLoader.loadClass(ISOLATED_CONTRACT_ID).asSubclass(Contract::class.java)
         val generateInitialMethod = contractClass.getDeclaredMethod("generateInitial", PartyAndReference::class.java, Integer.TYPE, Party::class.java)
@@ -96,7 +100,7 @@ class AttachmentLoadingTests {
     }
 
     @Test
-    fun `test that attachments retrieved over the network are not used for code`() {
+    fun `test that attachments retrieved over the network are not used for code`() = withoutTestSerialization {
         driver {
             installIsolatedCordappTo(bankAName)
             val (bankA, bankB) = createTwoNodes()
@@ -104,15 +108,17 @@ class AttachmentLoadingTests {
                 bankA.rpc.startFlowDynamic(flowInitiatorClass, bankB.nodeInfo.legalIdentities.first()).returnValue.getOrThrow()
             }
         }
+        Unit
     }
 
     @Test
-    fun `tests that if the attachment is loaded on both sides already that a flow can run`() {
+    fun `tests that if the attachment is loaded on both sides already that a flow can run`() = withoutTestSerialization {
         driver {
             installIsolatedCordappTo(bankAName)
             installIsolatedCordappTo(bankBName)
             val (bankA, bankB) = createTwoNodes()
             bankA.rpc.startFlowDynamic(flowInitiatorClass, bankB.nodeInfo.legalIdentities.first()).returnValue.getOrThrow()
         }
+        Unit
     }
 }

node/src/test/kotlin/net/corda/node/services/identity/InMemoryIdentityServiceTests.kt

@@ -13,6 +13,7 @@ import net.corda.nodeapi.internal.crypto.CertificateType
 import net.corda.nodeapi.internal.crypto.X509CertificateFactory
 import net.corda.nodeapi.internal.crypto.X509Utilities
 import net.corda.testing.*
+import org.junit.Rule
 import org.junit.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
@@ -34,6 +35,10 @@ class InMemoryIdentityServiceTests {
         fun createService(vararg identities: PartyAndCertificate) = InMemoryIdentityService(identities.toSet(), DEV_TRUST_ROOT)
     }
 
+    @Rule
+    @JvmField
+    val testSerialization = SerializationEnvironmentRule()
+
     @Test
     fun `get all identities`() {
         val service = createService()
@@ -94,7 +99,6 @@ class InMemoryIdentityServiceTests {
      */
     @Test
     fun `assert unknown anonymous key is unrecognised`() {
-        withTestSerialization {
         val rootKey = Crypto.generateKeyPair(X509Utilities.DEFAULT_TLS_SIGNATURE_SCHEME)
         val rootCert = X509Utilities.createSelfSignedCACertificate(ALICE.name, rootKey)
         val txKey = Crypto.generateKeyPair(X509Utilities.DEFAULT_TLS_SIGNATURE_SCHEME)
@@ -107,7 +111,6 @@ class InMemoryIdentityServiceTests {
             service.assertOwnership(identity, txIdentity)
         }
     }
-    }
 
     /**
      * Generate a pair of certificate paths from a root CA, down to a transaction key, store and verify the associations.
@@ -137,7 +140,6 @@ class InMemoryIdentityServiceTests {
      */
     @Test
     fun `assert ownership`() {
-        withTestSerialization {
         val (alice, anonymousAlice) = createConfidentialIdentity(ALICE.name)
         val (bob, anonymousBob) = createConfidentialIdentity(BOB.name)
 
@@ -162,7 +164,6 @@ class InMemoryIdentityServiceTests {
             service.assertOwnership(Party(subject, owningKey), anonymousAlice.party.anonymise())
         }
     }
-    }
 
     private fun createConfidentialIdentity(x500Name: CordaX500Name): Pair<PartyAndCertificate, PartyAndCertificate> {
         val issuerKeyPair = generateKeyPair()

node/src/test/kotlin/net/corda/node/services/identity/PersistentIdentityServiceTests.kt

@@ -21,6 +21,7 @@ import net.corda.testing.node.MockServices.Companion.makeTestDataSourcePropertie
 import net.corda.testing.node.makeTestIdentityService
 import org.junit.After
 import org.junit.Before
+import org.junit.Rule
 import org.junit.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
@@ -41,6 +42,9 @@ class PersistentIdentityServiceTests {
         val BOB_PUBKEY get() = bob.publicKey
     }
 
+    @Rule
+    @JvmField
+    val testSerialization = SerializationEnvironmentRule()
     private lateinit var database: CordaPersistence
     private lateinit var identityService: IdentityService
 
@@ -138,7 +142,6 @@ class PersistentIdentityServiceTests {
      */
     @Test
     fun `assert unknown anonymous key is unrecognised`() {
-        withTestSerialization {
         val rootKey = Crypto.generateKeyPair(X509Utilities.DEFAULT_TLS_SIGNATURE_SCHEME)
         val rootCert = X509Utilities.createSelfSignedCACertificate(ALICE.name, rootKey)
         val txKey = Crypto.generateKeyPair(X509Utilities.DEFAULT_IDENTITY_SIGNATURE_SCHEME)
@@ -151,7 +154,6 @@ class PersistentIdentityServiceTests {
             }
         }
     }
-    }
 
     /**
      * Generate a pair of certificate paths from a root CA, down to a transaction key, store and verify the associations.
@@ -191,7 +193,6 @@ class PersistentIdentityServiceTests {
      */
     @Test
     fun `assert ownership`() {
-        withTestSerialization {
         val (alice, anonymousAlice) = createConfidentialIdentity(ALICE.name)
         val (bob, anonymousBob) = createConfidentialIdentity(BOB.name)
 
@@ -225,7 +226,6 @@ class PersistentIdentityServiceTests {
             }
         }
     }
-    }
 
     @Test
     fun `Test Persistence`() {

samples/irs-demo/cordapp/src/test/kotlin/net/corda/irs/api/NodeInterestRatesTest.kt

@@ -19,6 +19,7 @@ import net.corda.node.internal.configureDatabase
 import net.corda.nodeapi.internal.persistence.CordaPersistence
 import net.corda.nodeapi.internal.persistence.DatabaseConfig
 import net.corda.testing.*
+import net.corda.testing.internal.withoutTestSerialization
 import net.corda.testing.node.*
 import net.corda.testing.node.MockServices.Companion.makeTestDataSourceProperties
 import org.junit.After

testing/test-utils/src/main/kotlin/net/corda/testing/SerializationTestHelpers.kt

@@ -55,25 +55,6 @@ interface GlobalSerializationEnvironment : SerializationEnvironment {
     fun unset()
 }
 
-/** @param inheritable whether new threads inherit the environment, use sparingly. */
-fun <T> withTestSerialization(inheritable: Boolean = false, callable: (SerializationEnvironment) -> T): T {
-    return createTestSerializationEnv("<context>").asContextEnv(inheritable, callable)
-}
-
-/**
- * For example your test class uses [SerializationEnvironmentRule] but you want to turn it off for one method.
- * Use sparingly, ideally a test class shouldn't mix serializers init mechanisms.
- */
-fun <T> withoutTestSerialization(callable: () -> T): T {
-    val (property, env) = listOf(_contextSerializationEnv, _inheritableContextSerializationEnv).map { Pair(it, it.get()) }.single { it.second != null }
-    property.set(null)
-    try {
-        return callable()
-    } finally {
-        property.set(env)
-    }
-}
-
 /**
  * Should only be used by Driver and MockNode.
  * @param armed true to install, false to do nothing and return a dummy env.

testing/test-utils/src/main/kotlin/net/corda/testing/internal/InternalSerializationTestHelpers.kt

@@ -0,0 +1,19 @@
+package net.corda.testing.internal
+
+import net.corda.core.serialization.internal._contextSerializationEnv
+import net.corda.core.serialization.internal._inheritableContextSerializationEnv
+import net.corda.testing.SerializationEnvironmentRule
+
+/**
+ * For example your test class uses [SerializationEnvironmentRule] but you want to turn it off for one method.
+ * Use sparingly, ideally a test class shouldn't mix serializers init mechanisms.
+ */
+fun <T> withoutTestSerialization(callable: () -> T): T { // TODO: Delete this, see CORDA-858.
+    val (property, env) = listOf(_contextSerializationEnv, _inheritableContextSerializationEnv).map { Pair(it, it.get()) }.single { it.second != null }
+    property.set(null)
+    try {
+        return callable()
+    } finally {
+        property.set(env)
+    }
+}