Add support for GraalVM Native Image

.gitignore

@@ -5,5 +5,7 @@ out/
 
 **/build/*
 !**/build/generated/
+**/build/generated/**/test
+.teamcity/target/
 # re-exclude BuildConfigGenerated.kt
 common/build/generated/source/buildConfig/main/main/dev/kord/common/BuildConfigGenerated.kt

.teamcity/DebuggableGradle.kt

@@ -0,0 +1,27 @@
+import jetbrains.buildServer.configs.kotlin.BuildSteps
+import jetbrains.buildServer.configs.kotlin.buildSteps.GradleBuildStep
+import jetbrains.buildServer.configs.kotlin.buildSteps.gradle
+
+const val debugParamName = "debug"
+
+/**
+ * Adds a new [Gradle build step][GradleBuildStep] that supports the debug parameter.
+ */
+fun BuildSteps.debuggableGradle(name: String, configure: GradleBuildStep.() -> Unit) {
+    gradle {
+        this.name = "$name (Debug)"
+        conditions {
+            equals(debugParamName, true.toString())
+        }
+        configure()
+        gradleParams = (gradleParams?.plus(' ') ?: "") + "-d"
+    }
+
+    gradle {
+        this.name = name
+        conditions {
+            equals(debugParamName, false.toString())
+        }
+        configure()
+    }
+}

.teamcity/DocsCI.kt

@@ -0,0 +1,18 @@
+import jetbrains.buildServer.configs.kotlin.RelativeId
+import jetbrains.buildServer.configs.kotlin.triggers.vcs
+
+val DocsCI = KordBuild("Deploy documentation") {
+    id = RelativeId("Deploy_docs")
+
+    triggers {
+        vcs {
+            branchFilter = "+:0.8.x"
+        }
+    }
+
+    steps {
+        debuggableGradle("Deploy documentation") {
+            tasks = "gitPublishPush"
+        }
+    }
+}

.teamcity/GitHub.kt

@@ -0,0 +1,50 @@
+import jetbrains.buildServer.configs.kotlin.BuildFeatures
+import jetbrains.buildServer.configs.kotlin.DslContext
+import jetbrains.buildServer.configs.kotlin.ProjectFeatures
+import jetbrains.buildServer.configs.kotlin.buildFeatures.commitStatusPublisher
+import jetbrains.buildServer.configs.kotlin.buildFeatures.pullRequests
+import jetbrains.buildServer.configs.kotlin.projectFeatures.githubIssues
+import jetbrains.buildServer.configs.kotlin.vcs.GitVcsRoot
+
+object GitHub : GitVcsRoot({
+    name = "https://github.com/kordlib/kord#refs/heads/0.8.x"
+    url = "https://github.com/kordlib/kord"
+    branch = "refs/heads/0.8.x"
+    branchSpec = """
+        +:refs/heads/*
+        -:refs/heads/gh-pages
+    """.trimIndent()
+    authMethod = password {
+        userName = "DRSchlaubi"
+        password = "credentialsJSON:6c4cf2b5-741b-420a-bd80-587c4746b827"
+    }
+    param("oauthProviderId", "tc-cloud-github-connection")
+})
+
+fun BuildFeatures.installGitHubPublisher() = commitStatusPublisher {
+    vcsRootExtId = "${DslContext.settingsRoot.id}"
+    publisher = github {
+        githubUrl = "https://api.github.com"
+        authType = personalToken {
+            token = "credentialsJSON:6c4cf2b5-741b-420a-bd80-587c4746b827"
+        }
+    }
+    param("github_oauth_user", "DRSchlaubi")
+}
+
+fun BuildFeatures.installGitHubPullRequest() = pullRequests {
+    provider = github {
+        authType = token {
+            token = "credentialsJSON:8a0ab174-fa52-45d4-950a-05a3c36d0e63"
+        }
+    }
+}
+
+fun ProjectFeatures.installGitHubIssueTracker() = githubIssues {
+    id = "PROJECT_EXT_2"
+    displayName = "GitHub"
+    repositoryURL = "https://github.com/kordlib/kord"
+    authType = accessToken {
+        accessToken = "credentialsJSON:8a0ab174-fa52-45d4-950a-05a3c36d0e63"
+    }
+}

.teamcity/GraalVMNativeImageCI.kt

@@ -0,0 +1,9 @@
+import jetbrains.buildServer.configs.kotlin.RelativeId
+
+val GraalVMNativeImageCI = MultiOSKordBuild("Run GraalVM Native image Tests", RelativeId("Run_Native_Image_tests")) {
+    steps {
+        debuggableGradle("Run Native Image Tests") {
+            tasks = "nativeTest"
+        }
+    }
+}

.teamcity/OSMatrix.kt

@@ -0,0 +1,32 @@
+import jetbrains.buildServer.configs.kotlin.AbsoluteId
+import jetbrains.buildServer.configs.kotlin.BuildType
+import jetbrains.buildServer.configs.kotlin.Id
+
+/**
+ * Creates a matrix for [operatingSystems] and runs the build everywhere.
+ *
+ * @param name a base name for all [types][BuildType]
+ *              (Is converted to `$name ($operatingSystem)`
+ * @param id a base [Id] for all [types][BuildType]
+ *              (Is converted to `$name_$operatingSystem)
+ * @param operatingSystems [List] of operating systems
+ * @param configure configuration for all types
+ */
+@Suppress("FunctionName")
+fun MultiOSKordBuild(
+    name: String,
+    id: Id,
+    operatingSystems: List<String> = listOf("Linux", "Windows", "Mac OS"),
+    configure: BuildType.() -> Unit
+): List<BuildType> {
+    return operatingSystems.map { operatingSystem ->
+        KordBuild("$name ($operatingSystem)") {
+            this.id = AbsoluteId("${id.value}_${operatingSystem.replace(' ', '_').lowercase()}")
+            requirements {
+                matches("teamcity.agent.jvm.os.family", "Linux")
+            }
+
+            configure()
+        }
+    }
+}

.teamcity/README.md

@@ -0,0 +1,29 @@
+# .teamcity
+
+This folder houses the [TeamCity](https://jetbrains.com/teamcity) configurations for the Kord build process
+
+# Documentation
+
+Documentation can be
+found [here](https://www.jetbrains.com/help/teamcity/kotlin-dsl.html) ([KDoc](https://kord.teamcity.com/app/dsl-documentation/index.html))
+
+# Importing in IntelliJ
+
+File -> Project Structure -> Modules -> Add -> Import ->
+Select [pom.xml](pom.xml) -> Select Maven
+
+# Validating
+
+To Validate the config format run the following Maven goal
+
+```shell
+mvnDebug org.jetbrains.teamcity:teamcity-configs-maven-plugin:generate
+```
+
+# Builds
+
+| Name               | Description                                                          | Definition                                         |
+|--------------------|----------------------------------------------------------------------|----------------------------------------------------|
+| Validation         | Runs checks (Test, binary compatibility) and publish Maven artifacts | [ValidationCI.kt](ValidationCI.kt)                 |
+| Docs               | Deploys documentation to GitHub Pages                                | [DocsCI.kt](DocsCI.kt)                             |
+| GraalVM Validation | Runs GraalVM Native image Tests                                      | [GraalVMNativeImageCI.kt](GraalVMNativeImageCI.kt) |

.teamcity/Shared.kt

@@ -0,0 +1,23 @@
+import jetbrains.buildServer.configs.kotlin.*
+
+@Suppress("FunctionName")
+fun KordBuild(name: String, configure: BuildType.() -> Unit) = object : BuildType({
+    this.name = name
+    configure()
+
+    vcs {
+        root(DslContext.settingsRoot)
+    }
+
+    params {
+        checkbox(debugParamName, false.toString(), "Debug Mode", "Run build with debug logging enabled")
+
+        param("env.GITHUB_BRANCH", "%teamcity.build.branch%")
+
+        password("env.KORD_TEST_TOKEN", "credentialsJSON:cbd8be1d-4808-42ff-90cf-551e9f60e83d")
+    }
+
+    features {
+        installGitHubPublisher()
+    }
+}) {}

.teamcity/TeamCityExtensions.kt

@@ -0,0 +1,16 @@
+import jetbrains.buildServer.configs.kotlin.BuildType
+import jetbrains.buildServer.configs.kotlin.Project
+import jetbrains.buildServer.configs.kotlin.Triggers
+import jetbrains.buildServer.configs.kotlin.triggers.vcs
+
+/**
+ * Short-hand for only VCS triggers.
+ */
+fun Triggers.vcs() = vcs {  }
+
+/**
+ * Adds all [types] to this [Project].
+ *
+ * @see MultiOSKordBuild
+ */
+fun Project.buildType(types: Iterable<BuildType>) = types.forEach(::buildType)

.teamcity/ValidationCI.kt

@@ -0,0 +1,55 @@
+import jetbrains.buildServer.configs.kotlin.FailureConditions
+import jetbrains.buildServer.configs.kotlin.RelativeId
+import jetbrains.buildServer.configs.kotlin.failureConditions.BuildFailureOnMetric
+import jetbrains.buildServer.configs.kotlin.failureConditions.failOnMetricChange
+
+val ValidationCI = KordBuild("Validate Code") {
+    id = RelativeId("Validation")
+    triggers {
+        vcs()
+    }
+
+    steps {
+        debuggableGradle("Run checks") {
+            tasks = "check"
+        }
+
+        debuggableGradle("Publish Artifacts") {
+            // Secrets need to be specified
+            enabled = false
+            param("env.NEXUS_USER", "TODO")
+            param("env.NEXUS_PASSWORD", "TODO")
+            param("system.org.gradle.project.signingKey", "TODO")
+            param("system.org.gradle.project.signingPassword", "TODO")
+
+            conditions {
+                // Meaning: Do not run on Pull Requests
+                doesNotExist("teamcity.pullRequest.number")
+            }
+
+            tasks = "publish"
+            gradleParams = "-x test"
+        }
+    }
+
+    failureConditions {
+        failOnSignificantDecreaseOf(BuildFailureOnMetric.MetricType.TEST_COUNT)
+        failOnSignificantDecreaseOf(BuildFailureOnMetric.MetricType.TEST_IGNORED_COUNT)
+    }
+
+    features {
+        installGitHubPullRequest()
+    }
+}
+
+private fun FailureConditions.failOnSignificantDecreaseOf(metricType: BuildFailureOnMetric.MetricType) {
+    failOnMetricChange {
+        metric = metricType
+        threshold = 20
+        units = BuildFailureOnMetric.MetricUnit.PERCENTS
+        comparison = BuildFailureOnMetric.MetricComparison.LESS
+        compareTo = build {
+            buildRule = lastSuccessful()
+        }
+    }
+}