Merge pull request #964 from Vacxe/ci-integrations

feat(core): basic ci integration

configuration/src/main/kotlin/com/malinskiy/marathon/config/CIConfiguration.kt

@@ -0,0 +1,20 @@
+package com.malinskiy.marathon.config
+
+import com.fasterxml.jackson.annotation.JsonSubTypes
+import com.fasterxml.jackson.annotation.JsonTypeInfo
+
+@JsonTypeInfo(
+    use = JsonTypeInfo.Id.NAME,
+    include = JsonTypeInfo.As.PROPERTY,
+    property = "type"
+)
+@JsonSubTypes(
+    JsonSubTypes.Type(value = CIConfiguration.Auto::class, name = "auto"),
+    JsonSubTypes.Type(value = CIConfiguration.None::class, name = "none"),
+    JsonSubTypes.Type(value = CIConfiguration.Teamcity::class, name = "teamcity"),
+)
+sealed class CIConfiguration {
+    object Auto : CIConfiguration()
+    object None : CIConfiguration()
+    object Teamcity : CIConfiguration()
+}

configuration/src/main/kotlin/com/malinskiy/marathon/config/Configuration.kt

@@ -50,6 +50,7 @@ data class Configuration private constructor(
     val analyticsTracking: Boolean,
     val bugsnagReporting: Boolean,
     val deviceInitializationTimeoutMillis: Long,
+    val ciConfiguration: CIConfiguration,
 ) {
     fun toMap() =
         mapOf<String, String>(
@@ -74,7 +75,8 @@ data class Configuration private constructor(
             "debug" to debug.toString(),
             "screenRecordingPolicy" to screenRecordingPolicy.toString(),
             "vendorConfiguration" to vendorConfiguration.toString(),
-            "deviceInitializationTimeoutMillis" to deviceInitializationTimeoutMillis.toString()
+            "deviceInitializationTimeoutMillis" to deviceInitializationTimeoutMillis.toString(),
+            "ciConfiguration" to ciConfiguration.toString(),
         )
 
     override fun equals(other: Any?): Boolean {
@@ -108,6 +110,7 @@ data class Configuration private constructor(
         if (analyticsTracking != other.analyticsTracking) return false
         if (bugsnagReporting != other.bugsnagReporting) return false
         if (deviceInitializationTimeoutMillis != other.deviceInitializationTimeoutMillis) return false
+        if (ciConfiguration != other.ciConfiguration) return false
 
         return true
     }
@@ -138,6 +141,7 @@ data class Configuration private constructor(
         result = 31 * result + analyticsTracking.hashCode()
         result = 31 * result + bugsnagReporting.hashCode()
         result = 31 * result + deviceInitializationTimeoutMillis.hashCode()
+        result = 31 * result + ciConfiguration.hashCode()
         return result
     }
 
@@ -173,6 +177,7 @@ data class Configuration private constructor(
 
          var outputConfiguration: OutputConfiguration = OutputConfiguration(),
          var vendorConfiguration: VendorConfiguration = VendorConfiguration.EmptyVendorConfiguration(),
+         var ciConfiguration: CIConfiguration = CIConfiguration.None,
     ) {
         fun build(): Configuration {
             return Configuration(
@@ -200,7 +205,8 @@ data class Configuration private constructor(
                 vendorConfiguration = vendorConfiguration,
                 analyticsTracking = analyticsTracking,
                 bugsnagReporting = bugsnagReporting,
-                deviceInitializationTimeoutMillis = deviceInitializationTimeoutMillis
+                deviceInitializationTimeoutMillis = deviceInitializationTimeoutMillis,
+                ciConfiguration = ciConfiguration,
             )
         }
     }

core/src/main/kotlin/com/malinskiy/marathon/execution/progress/PoolProgressAccumulator.kt

@@ -12,6 +12,7 @@ import com.malinskiy.marathon.execution.TestStatus
 import com.malinskiy.marathon.execution.queue.TestAction
 import com.malinskiy.marathon.execution.queue.TestEvent
 import com.malinskiy.marathon.execution.queue.TestState
+import com.malinskiy.marathon.integrations.ci.CIIntegrationFactory
 import com.malinskiy.marathon.log.MarathonLogging
 import com.malinskiy.marathon.test.Test
 import com.malinskiy.marathon.test.toTestName
@@ -26,6 +27,7 @@ class PoolProgressAccumulator(
     private val tests: HashMap<String, TestExecutionData> = HashMap()
     private val logger = MarathonLogging.logger {}
     private val executionStrategy = configuration.executionStrategy
+    private val ci = CIIntegrationFactory.get(configuration)
 
     private fun createState(initialCount: Int) = StateMachine.create<TestState, TestEvent, TestAction> {
         initialState(TestState.Added(initialCount))
@@ -265,6 +267,7 @@ class PoolProgressAccumulator(
 
     fun testStarted(device: DeviceInfo, test: Test) {
         transition(test, TestEvent.Started)
+        ci.setBuildProgress(progress().toInt())
         println("${toPercent(progress())} | [${poolId.name}]-[${device.serialNumber}] ${test.toTestName()} started")
     }
 

core/src/main/kotlin/com/malinskiy/marathon/integrations/ci/CI.kt

@@ -0,0 +1,5 @@
+package com.malinskiy.marathon.integrations.ci
+
+interface CI {
+    fun setBuildProgress(int: Int)
+}

core/src/main/kotlin/com/malinskiy/marathon/integrations/ci/CIIntegrationFactory.kt

@@ -0,0 +1,18 @@
+package com.malinskiy.marathon.integrations.ci
+
+import com.malinskiy.marathon.config.CIConfiguration
+import com.malinskiy.marathon.config.Configuration
+
+object CIIntegrationFactory {
+    fun get(configuration: Configuration) = when (configuration.ciConfiguration) {
+        CIConfiguration.Auto -> auto()
+        CIConfiguration.None -> None
+        CIConfiguration.Teamcity -> Teamcity
+    }
+
+    private fun auto() = when {
+        // Teamcity predefined variables: https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html#84e0b866
+        System.getenv().containsValue("TEAMCITY_VERSION") -> Teamcity
+        else -> None
+    }
+}

core/src/main/kotlin/com/malinskiy/marathon/integrations/ci/None.kt

@@ -0,0 +1,5 @@
+package com.malinskiy.marathon.integrations.ci
+
+object None: CI {
+    override fun setBuildProgress(int: Int) = Unit
+}

core/src/main/kotlin/com/malinskiy/marathon/integrations/ci/Teamcity.kt

@@ -0,0 +1,9 @@
+package com.malinskiy.marathon.integrations.ci
+
+object Teamcity: CI {
+    private fun setBuildMessage(message: String) = println("##teamcity[buildStatus text='$message']")
+
+    private fun setKeyValue(key: String, value: String) = println("##teamcity[buildStatisticValue key='$key' value='$value']")
+
+    override fun setBuildProgress(int: Int) = setBuildMessage("Marathon run: $int %")
+}