Refactor: less confusing name for SUT factory methods in tests

Author: Whathecode

carp.deployments.core/src/commonTest/kotlin/dk/cachet/carp/deployments/application/DeploymentServiceHostTest.kt

@@ -15,7 +15,7 @@ class DeploymentServiceHostTest : DeploymentServiceTest
 {
     companion object
     {
-        fun createService(): DeploymentServiceTest.DependentServices
+        fun createSUT(): DeploymentServiceTest.SUT
         {
             val eventBus: EventBus = SingleThreadedEventBus()
 
@@ -26,9 +26,9 @@ class DeploymentServiceHostTest : DeploymentServiceTest
                 TestClock
             )
 
-            return DeploymentServiceTest.DependentServices( deploymentService, eventBus )
+            return DeploymentServiceTest.SUT( deploymentService, eventBus )
         }
     }
 
-    override fun createService(): DeploymentServiceTest.DependentServices = DeploymentServiceHostTest.createService()
+    override fun createSUT(): DeploymentServiceTest.SUT = DeploymentServiceHostTest.createSUT()
 }

carp.deployments.core/src/commonTest/kotlin/dk/cachet/carp/deployments/application/DeploymentServiceTest.kt

@@ -21,20 +21,20 @@ private val unknownId: UUID = UUID.randomUUID()
  */
 interface DeploymentServiceTest
 {
-    data class DependentServices(
-        val deploymentService: DeploymentService,
-        val eventBus: EventBus
-    )
+    /**
+     * System under test: the [deploymentService] and all dependencies to be used in tests.
+     */
+    data class SUT( val deploymentService: DeploymentService, val eventBus: EventBus )
 
     /**
-     * Create a deployment service and dependent services to be used in tests.
+     * Create the system under test (SUT): the [DeploymentService] and all dependencies to be used in tests.
      */
-    fun createService(): DependentServices
+    fun createSUT(): SUT
 
 
     @Test
     fun createStudyDeployment_registers_preregistered_devices() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val (protocol, primaryDevice, connectedDevice) = createSinglePrimaryWithConnectedDeviceProtocol()
 
         val deploymentId = UUID.randomUUID()
@@ -53,7 +53,7 @@ interface DeploymentServiceTest
 
     @Test
     fun createStudyDeployment_fails_for_existing_id() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val studyDeploymentId = addTestDeployment( service, "Primary" )
 
         val deviceRole = "Test device"
@@ -71,7 +71,7 @@ interface DeploymentServiceTest
 
     @Test
     fun removeStudyDeployments_succeeds() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val deploymentId1 = addTestDeployment( service, "Test device" )
         val deploymentId2 = addTestDeployment( service, "Test device" )
         val deploymentIds = setOf( deploymentId1, deploymentId2 )
@@ -84,7 +84,7 @@ interface DeploymentServiceTest
 
     @Test
     fun removeStudyDeployments_ignores_unknown_ids() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val deploymentId = addTestDeployment( service, "Test device" )
         val unknownId = UUID.randomUUID()
         val deploymentIds = setOf( deploymentId, unknownId )
@@ -95,7 +95,7 @@ interface DeploymentServiceTest
 
     @Test
     fun getStudyDeploymentStatus_succeeds() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val studyDeploymentId = addTestDeployment( service, "Test device" )
 
         // Actual testing of the status responses should already be covered adequately in StudyDeployment tests.
@@ -104,14 +104,14 @@ interface DeploymentServiceTest
 
     @Test
     fun getStudyDeploymentStatus_fails_for_unknown_studyDeploymentId() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
 
         assertFailsWith<IllegalArgumentException> { service.getStudyDeploymentStatus( unknownId ) }
     }
 
     @Test
     fun getStudyDeploymentStatusList_succeeds() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val deviceRoleName = "Primary"
         val (protocol, _, _) = createSinglePrimaryWithConnectedDeviceProtocol( deviceRoleName )
         val protocolSnapshot = protocol.getSnapshot()
@@ -129,7 +129,7 @@ interface DeploymentServiceTest
 
     @Test
     fun getStudyDeploymentStatusList_fails_when_containing_an_unknown_studyDeploymentId() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val studyDeploymentId = addTestDeployment( service, "Test device" )
 
         val deploymentIds = setOf( studyDeploymentId, unknownId )
@@ -138,7 +138,7 @@ interface DeploymentServiceTest
 
     @Test
     fun registerDevice_can_be_called_multiple_times() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val studyDeploymentId = addTestDeployment( service, "Primary" )
         val status = service.getStudyDeploymentStatus( studyDeploymentId )
         val primary = status.getRemainingDevicesToRegister().first { it.roleName == "Primary" }
@@ -151,7 +151,7 @@ interface DeploymentServiceTest
 
     @Test
     fun registerDevice_cannot_be_called_with_same_registration_when_stopped() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val studyDeploymentId = addTestDeployment( service, "Primary" )
         val status = service.getStudyDeploymentStatus( studyDeploymentId )
         val primary = status.getRemainingDevicesToRegister().first { it.roleName == "Primary" }
@@ -167,7 +167,7 @@ interface DeploymentServiceTest
 
     @Test
     fun unregisterDevice_succeeds() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val deviceRolename = "Test device"
         val studyDeploymentId = addTestDeployment( service, deviceRolename )
         var status = service.getStudyDeploymentStatus( studyDeploymentId )
@@ -180,7 +180,7 @@ interface DeploymentServiceTest
 
     @Test
     fun getDeviceDeploymentFor_during_device_reregistrations() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val protocol = createSinglePrimaryDeviceProtocol( "Test device" )
         val device = protocol.primaryDevices.first()
         val deploymentId = UUID.randomUUID()
@@ -202,7 +202,7 @@ interface DeploymentServiceTest
 
     @Test
     fun stop_succeeds() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val studyDeploymentId = addTestDeployment( service, "Test device" )
 
         val status = service.stop( studyDeploymentId )
@@ -211,14 +211,14 @@ interface DeploymentServiceTest
 
     @Test
     fun stop_fails_for_unknown_studyDeploymentId() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
 
         assertFailsWith<IllegalArgumentException> { service.stop( unknownId ) }
     }
 
     @Test
     fun modifications_after_stop_not_allowed() = runTest {
-        val (service, _) = createService()
+        val (service, _) = createSUT()
         val studyDeploymentId = addTestDeployment( service, "Primary", "Connected" )
         val status = service.getStudyDeploymentStatus( studyDeploymentId )
         val primary = status.getRemainingDevicesToRegister().first { it.roleName == "Primary" }

carp.deployments.core/src/commonTest/kotlin/dk/cachet/carp/deployments/application/ParticipationServiceHostTest.kt

@@ -19,7 +19,7 @@ class ParticipationServiceHostTest : ParticipationServiceTest
 {
     companion object
     {
-        fun createService(): ParticipationServiceTest.DependentServices
+        fun createSUT(): ParticipationServiceTest.SUT
         {
             val eventBus: EventBus = SingleThreadedEventBus()
 
@@ -38,7 +38,7 @@ class ParticipationServiceHostTest : ParticipationServiceTest
                 eventBus.createApplicationServiceAdapter( ParticipationService::class )
             )
 
-            return ParticipationServiceTest.DependentServices(
+            return ParticipationServiceTest.SUT(
                 participationService,
                 deploymentService,
                 accountService,
@@ -47,6 +47,5 @@ class ParticipationServiceHostTest : ParticipationServiceTest
         }
     }
 
-    override fun createService(): ParticipationServiceTest.DependentServices =
-        ParticipationServiceHostTest.createService()
+    override fun createSUT(): ParticipationServiceTest.SUT = ParticipationServiceHostTest.createSUT()
 }

carp.deployments.core/src/commonTest/kotlin/dk/cachet/carp/deployments/application/ParticipationServiceTest.kt

@@ -35,22 +35,25 @@ interface ParticipationServiceTest
     }
 
 
-    data class DependentServices(
+    /**
+     * System under test: the [participationService] and all dependencies to be used in tests.
+     */
+    data class SUT(
         val participationService: ParticipationService,
         val deploymentService: DeploymentService,
         val accountService: AccountService,
         val eventBus: EventBus
     )
 
     /**
-     * Create a deployment service and account service it depends on to be used in the tests.
+     * Create the system under test (SUT): the [ParticipationService] and all dependencies to be used in tests.
      */
-    fun createService(): DependentServices
+    fun createSUT(): SUT
 
 
     @Test
     fun getActiveParticipationInvitations_succeeds() = runTest {
-        val (participationService, deploymentService, accountService) = createService()
+        val (participationService, deploymentService, accountService) = createSUT()
         val protocol = createSinglePrimaryDeviceProtocol()
         val identity = AccountIdentity.fromEmailAddress( "[email protected]" )
         val invitation = StudyInvitation( "Test study", "description", "Custom data" )
@@ -75,7 +78,7 @@ interface ParticipationServiceTest
 
     @Test
     fun getParticipantData_initially_returns_null_for_all_expected_data() = runTest {
-        val (participationService, deploymentService, _) = createService()
+        val (participationService, deploymentService, _) = createSUT()
 
         // Create protocol with one common custom attribute and 'sex' assigned to two participant roles.
         val protocol = createSinglePrimaryDeviceProtocol( deviceRoleName )
@@ -109,14 +112,14 @@ interface ParticipationServiceTest
 
     @Test
     fun getParticipantData_fails_for_unknown_deploymentId() = runTest {
-        val (participationService, _, _) = createService()
+        val (participationService, _, _) = createSUT()
 
         assertFailsWith<IllegalArgumentException> { participationService.getParticipantData( unknownId ) }
     }
 
     @Test
     fun getParticipantDataList_succeeds() = runTest {
-        val (participationService, deploymentService, _) = createService()
+        val (participationService, deploymentService, _) = createSUT()
         val protocol = createSinglePrimaryDeviceProtocol( deviceRoleName )
         val protocolSnapshot = protocol.getSnapshot()
         val invitation1 = createParticipantInvitation()
@@ -133,15 +136,15 @@ interface ParticipationServiceTest
 
     @Test
     fun getParticipantDataList_fails_for_unknown_deploymentId() = runTest {
-        val (participationService, _, _) = createService()
+        val (participationService, _, _) = createSUT()
 
         val deploymentIds = setOf( unknownId )
         assertFailsWith<IllegalArgumentException> { participationService.getParticipantDataList( deploymentIds ) }
     }
 
     @Test
     fun setParticipantData_assigned_to_all_roles_succeeds() = runTest {
-        val (participationService, deploymentService, _) = createService()
+        val (participationService, deploymentService, _) = createSUT()
 
         // Create protocol without roles with expected 'sex' participant data.
         val protocol = createSinglePrimaryDeviceProtocol( deviceRoleName )
@@ -163,7 +166,7 @@ interface ParticipationServiceTest
 
     @Test
     fun setParticipantData_assigned_to_role_succeeds() = runTest {
-        val (participationService, deploymentService, _) = createService()
+        val (participationService, deploymentService, _) = createSUT()
 
         // Create protocol with expected 'sex' participant data for a single participant role.
         val protocol = createSinglePrimaryDeviceProtocol( deviceRoleName )
@@ -191,7 +194,7 @@ interface ParticipationServiceTest
 
     @Test
     fun setParticipantData_fails_for_unknown_deploymentId() = runTest {
-        val (participationService, _, _) = createService()
+        val (participationService, _, _) = createSUT()
 
         val toSet = mapOf( CarpInputDataTypes.SEX to Sex.Male )
         assertFailsWith<IllegalArgumentException>
@@ -202,7 +205,7 @@ interface ParticipationServiceTest
 
     @Test
     fun setParticipantData_fails_for_unexpected_input_for_protocol() = runTest {
-        val (participationService, deploymentService, _) = createService()
+        val (participationService, deploymentService, _) = createSUT()
         val studyDeploymentId = addTestDeployment( deploymentService )
 
         val toSet = mapOf( CarpInputDataTypes.SEX to Sex.Male )
@@ -214,7 +217,7 @@ interface ParticipationServiceTest
 
     @Test
     fun setParticipantData_fails_for_invalid_data() = runTest {
-        val (participationService, deploymentService, _) = createService()
+        val (participationService, deploymentService, _) = createSUT()
 
         // Create protocol with expected 'sex' participant data.
         val protocol = createSinglePrimaryDeviceProtocol( deviceRoleName )

carp.deployments.core/src/commonTest/kotlin/dk/cachet/carp/deployments/infrastructure/DeploymentServiceRequestsTest.kt

@@ -36,6 +36,6 @@ class DeploymentServiceRequestsTest : ApplicationServiceRequestsTest<DeploymentS
 
     override fun createServiceLoggingProxy(): ApplicationServiceLoggingProxy<DeploymentService, DeploymentService.Event> =
         DeploymentServiceHostTest
-            .createService()
+            .createSUT()
             .let { DeploymentServiceLoggingProxy( it.deploymentService, it.eventBus ) }
 }

carp.deployments.core/src/commonTest/kotlin/dk/cachet/carp/deployments/infrastructure/ParticipationServiceRequestsTest.kt

@@ -33,6 +33,6 @@ class ParticipationServiceRequestsTest : ApplicationServiceRequestsTest<Particip
 
     override fun createServiceLoggingProxy(): ApplicationServiceLoggingProxy<ParticipationService, ParticipationService.Event> =
         ParticipationServiceHostTest
-            .createService()
+            .createSUT()
             .let { ParticipationServiceLoggingProxy( it.participationService, it.eventBus ) }
 }

carp.deployments.core/src/jvmTest/kotlin/dk/cachet/carp/deployments/infrastructure/versioning/BackwardsCompatibilityTest.kt

@@ -12,7 +12,7 @@ import kotlinx.serialization.ExperimentalSerializationApi
 class DeploymentServiceBackwardsCompatibilityTest :
     BackwardsCompatibilityTest<DeploymentService>( DeploymentService::class )
 {
-    override fun createService() = DeploymentServiceHostTest.createService()
+    override fun createService() = DeploymentServiceHostTest.createSUT()
         .let { Pair( it.deploymentService, it.eventBus ) }
 }
 
@@ -21,6 +21,6 @@ class DeploymentServiceBackwardsCompatibilityTest :
 class ParticipationServiceBackwardsCompatibilityTest :
     BackwardsCompatibilityTest<ParticipationService>( ParticipationService::class )
 {
-    override fun createService() = ParticipationServiceHostTest.createService()
+    override fun createService() = ParticipationServiceHostTest.createSUT()
         .let { Pair( it.participationService, it.eventBus ) }
 }

carp.deployments.core/src/jvmTest/kotlin/dk/cachet/carp/deployments/infrastructure/versioning/OutputDeploymentServiceTestRequests.kt

@@ -11,12 +11,12 @@ class OutputDeploymentServiceTestRequests :
     OutputTestRequests<DeploymentService>( DeploymentService::class ),
     DeploymentServiceTest
 {
-    override fun createService(): DeploymentServiceTest.DependentServices
+    override fun createSUT(): DeploymentServiceTest.SUT
     {
-        val services = DeploymentServiceHostTest.createService()
+        val services = DeploymentServiceHostTest.createSUT()
         val service = DeploymentServiceLoggingProxy( services.deploymentService, services.eventBus )
         loggedService = service
 
-        return DeploymentServiceTest.DependentServices( service, services.eventBus )
+        return DeploymentServiceTest.SUT( service, services.eventBus )
     }
 }

carp.deployments.core/src/jvmTest/kotlin/dk/cachet/carp/deployments/infrastructure/versioning/OutputParticipationServiceTestRequests.kt

@@ -11,13 +11,13 @@ class OutputParticipationServiceTestRequests :
     OutputTestRequests<ParticipationService>( ParticipationService::class ),
     ParticipationServiceTest
 {
-    override fun createService(): ParticipationServiceTest.DependentServices
+    override fun createSUT(): ParticipationServiceTest.SUT
     {
-        val services = ParticipationServiceHostTest.createService()
+        val services = ParticipationServiceHostTest.createSUT()
         val service = ParticipationServiceLoggingProxy( services.participationService, services.eventBus )
         loggedService = service
 
-        return ParticipationServiceTest.DependentServices(
+        return ParticipationServiceTest.SUT(
             service,
             services.deploymentService,
             services.accountService,

carp.studies.core/src/commonTest/kotlin/dk/cachet/carp/studies/application/RecruitmentServiceHostTest.kt

@@ -19,7 +19,7 @@ class RecruitmentServiceHostTest : RecruitmentServiceTest
 {
     companion object
     {
-        fun createService(): RecruitmentServiceTest.DependentServices
+        fun createSUT(): RecruitmentServiceTest.SUT
         {
             val eventBus = SingleThreadedEventBus()
 
@@ -48,9 +48,9 @@ class RecruitmentServiceHostTest : RecruitmentServiceTest
                 TestClock
             )
 
-            return RecruitmentServiceTest.DependentServices( recruitmentService, studyService, eventBus )
+            return RecruitmentServiceTest.SUT( recruitmentService, studyService, eventBus )
         }
     }
 
-    override fun createService(): RecruitmentServiceTest.DependentServices = RecruitmentServiceHostTest.createService()
+    override fun createSUT(): RecruitmentServiceTest.SUT = RecruitmentServiceHostTest.createSUT()
 }