Extract common utility functions to utils.kt

Author: Abduqodiri Qurbonzoda

main/resources/teamcity/settings.kts

@@ -25,15 +25,6 @@ To debug in IntelliJ Idea, open the 'Maven Projects' tool window (View
 */
 
 version = "2018.2"
-val versionSuffixParameter = "versionSuffix"
-val teamcitySuffixParameter = "teamcitySuffix"
-val releaseVersionParameter = "releaseVersion"
-
-val bintrayUserName = "<<BINTRAY_USER>>"
-val bintrayToken = "<<BINTRAY_TOKEN>>"
-
-val platforms = listOf("Windows", "Linux", "Mac OS X")
-val jdk = "<<JDK>>"
 
 project {
     // Disable editing of project and build settings from the UI to avoid issues with TeamCity
@@ -109,7 +100,7 @@ fun Project.buildAll(versionBuild: BuildType) = BuildType {
     commonConfigure()
 }.also { buildType(it) }
 
-fun Project.build(platform: String, versionBuild: BuildType) = platform(platform, "Build") {
+fun Project.build(platform: Platform, versionBuild: BuildType) = buildType("Build", platform) {
 
     dependsOnSnapshot(versionBuild)
 
@@ -120,7 +111,7 @@ fun Project.build(platform: String, versionBuild: BuildType) = platform(platform
 
     steps {
         gradle {
-            name = "Build and Test $platform Binaries"
+            name = "Build and Test ${platform.buildTypeName()} Binaries"
             jdkHome = "%env.$jdk%"
             jvmArgs = "-Xmx1g"
             tasks = "clean publishToBuildLocal check"
@@ -135,21 +126,6 @@ fun Project.build(platform: String, versionBuild: BuildType) = platform(platform
     artifactRules = "+:build/maven=>maven\n+:build/api=>api"
 }
 
-fun BuildType.dependsOn(build: BuildType, configure: Dependency.() -> Unit) =
-    apply {
-        dependencies.dependency(build, configure)
-    }
-
-fun BuildType.dependsOnSnapshot(build: BuildType, onFailure: FailureAction = FailureAction.FAIL_TO_START, configure: SnapshotDependency.() -> Unit = {}) = apply {
-    dependencies.dependency(build) {
-        snapshot {
-            configure()
-            onDependencyFailure = onFailure
-            onDependencyCancel = FailureAction.CANCEL
-        }
-    }
-}
-
 fun Project.deployConfigure() = BuildType {
     id("Deploy_Configure")
     this.name = "Deploy (Configure Version)"
@@ -194,7 +170,7 @@ fun Project.deployPublish(configureBuild: BuildType) = BuildType {
 }.also { buildType(it) }
 
 
-fun Project.deploy(platform: String, configureBuild: BuildType) = platform(platform, "Deploy") {
+fun Project.deploy(platform: Platform, configureBuild: BuildType) = buildType("Deploy", platform) {
     type = BuildTypeSettings.Type.DEPLOYMENT
     enablePersonalBuilds = false
     maxRunningBuilds = 1
@@ -211,7 +187,7 @@ fun Project.deploy(platform: String, configureBuild: BuildType) = platform(platf
 
     steps {
         gradle {
-            name = "Deploy $platform Binaries"
+            name = "Deploy ${platform.buildTypeName()} Binaries"
             jdkHome = "%env.$jdk%"
             jvmArgs = "-Xmx1g"
             gradleParams = "--info --stacktrace -P$versionSuffixParameter=%$versionSuffixParameter% -P$releaseVersionParameter=%$releaseVersionParameter% -PbintrayApiKey=%bintray-key% -PbintrayUser=%bintray-user%"
@@ -221,53 +197,3 @@ fun Project.deploy(platform: String, configureBuild: BuildType) = platform(platf
         }
     }
 }.dependsOnSnapshot(configureBuild)
-
-fun Project.platform(platform: String, name: String, configure: BuildType.() -> Unit) = BuildType {
-    // ID is prepended with Project ID, so don't repeat it here
-    // ID should conform to identifier rules, so just letters, numbers and underscore
-    id("${name}_${platform.substringBefore(" ")}")
-    // Display name of the build configuration
-    this.name = "$name ($platform)"
-
-    requirements {
-        contains("teamcity.agent.jvm.os.name", platform)
-    }
-
-    params {
-        // This parameter is needed for macOS agent to be compatible
-        if (platform.startsWith("Mac")) param("env.JDK_17", "")
-    }
-
-    commonConfigure()
-    configure()
-}.also { buildType(it) }
-
-
-fun BuildType.commonConfigure() {
-    requirements {
-        noLessThan("teamcity.agent.hardware.memorySizeMb", "6144")
-    }
-
-    // Allow to fetch build status through API for badges
-    allowExternalStatus = true
-
-    // Configure VCS, by default use the same and only VCS root from which this configuration is fetched
-    vcs {
-        root(DslContext.settingsRoot)
-        showDependenciesChanges = true
-        checkoutMode = CheckoutMode.ON_AGENT
-    }
-
-    failureConditions {
-        errorMessage = true
-        nonZeroExitCode = true
-        executionTimeoutMin = 120
-    }
-
-    features {
-        feature {
-            id = "perfmon"
-            type = "perfmon"
-        }
-    }
-}

main/resources/teamcity/utils.kt

@@ -0,0 +1,98 @@
+/*
+ * Copyright 2016-2020 JetBrains s.r.o.
+ * Use of this source code is governed by the Apache 2.0 License that can be found in the LICENSE.txt file.
+ */
+
+import jetbrains.buildServer.configs.kotlin.v2018_2.*
+
+const val versionSuffixParameter = "versionSuffix"
+const val teamcitySuffixParameter = "teamcitySuffix"
+const val releaseVersionParameter = "releaseVersion"
+
+const val bintrayUserName = "<<BINTRAY_USER>>"
+const val bintrayToken = "<<BINTRAY_TOKEN>>"
+
+val platforms = Platform.values()
+const val jdk = "<<JDK>>"
+
+enum class Platform {
+    Windows, Linux, MacOS;
+}
+
+fun Platform.nativeTaskPrefix(): String = when(this) {
+    Platform.Windows -> "mingwX64"
+    Platform.Linux -> "linuxX64"
+    Platform.MacOS -> "macosX64"
+}
+fun Platform.buildTypeName(): String = when (this) {
+    Platform.Windows, Platform.Linux -> name
+    Platform.MacOS -> "Mac OS X"
+}
+fun Platform.buildTypeId(): String = buildTypeName().substringBefore(" ")
+fun Platform.teamcityAgentName(): String = buildTypeName()
+
+
+fun Project.buildType(name: String, platform: Platform, configure: BuildType.() -> Unit) = BuildType {
+    // ID is prepended with Project ID, so don't repeat it here
+    // ID should conform to identifier rules, so just letters, numbers and underscore
+    id("${name}_${platform.buildTypeId()}")
+    // Display name of the build configuration
+    this.name = "$name (${platform.buildTypeName()})"
+
+    requirements {
+        contains("teamcity.agent.jvm.os.name", platform.teamcityAgentName())
+    }
+
+    params {
+        // This parameter is needed for macOS agent to be compatible
+        if (platform == Platform.MacOS) param("env.JDK_17", "")
+    }
+
+    commonConfigure()
+    configure()
+}.also { buildType(it) }
+
+
+fun BuildType.commonConfigure() {
+    requirements {
+        noLessThan("teamcity.agent.hardware.memorySizeMb", "6144")
+    }
+
+    // Allow to fetch build status through API for badges
+    allowExternalStatus = true
+
+    // Configure VCS, by default use the same and only VCS root from which this configuration is fetched
+    vcs {
+        root(DslContext.settingsRoot)
+        showDependenciesChanges = true
+        checkoutMode = CheckoutMode.ON_AGENT
+    }
+
+    failureConditions {
+        errorMessage = true
+        nonZeroExitCode = true
+        executionTimeoutMin = 120
+    }
+
+    features {
+        feature {
+            id = "perfmon"
+            type = "perfmon"
+        }
+    }
+}
+
+fun BuildType.dependsOn(build: BuildType, configure: Dependency.() -> Unit) =
+        apply {
+            dependencies.dependency(build, configure)
+        }
+
+fun BuildType.dependsOnSnapshot(build: BuildType, onFailure: FailureAction = FailureAction.FAIL_TO_START, configure: SnapshotDependency.() -> Unit = {}) = apply {
+    dependencies.dependency(build) {
+        snapshot {
+            configure()
+            onDependencyFailure = onFailure
+            onDependencyCancel = FailureAction.CANCEL
+        }
+    }
+}

main/src/kotlinx/team/infra/TeamCity.kt

@@ -34,7 +34,8 @@ fun Project.configureTeamCityConfigGenerator(teamcity: TeamCityConfiguration) {
                 it
                     .replace("<artifactId>resource</artifactId>", "<artifactId>teamcity</artifactId>")
             }
-            copyResource(teamcityDir, "settings.kts") { text ->
+            copyResource(teamcityDir, "settings.kts")
+            copyResource(teamcityDir, "utils.kt") { text ->
                 val bintrayUser = teamcity.bintrayUser
                     ?: throw KotlinInfrastructureException("TeamCity configuration should specify `bintrayUser` parameter")
                 val bintrayToken = teamcity.bintrayToken