Skip to content

fix: add Gradle 9 compatibility #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
klochowicz wants to merge 1 commit into
base: master
Choose a base branch
from
+53 −31
Open

fix: add Gradle 9 compatibility #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ buildscript {
Properties versionProperties = new Properties()
versionProperties.load(new FileInputStream("$project.rootDir/version.properties"))

ext.kotlin_version = '1.3.50'
ext.agp_version = '4.0.1'
// Kotlin 1.9.22: Required for Gradle 8.5+ (old Kotlin Gradle plugin uses removed APIs)
ext.kotlin_version = '1.9.22'
// AGP 8.2.0: Required for Gradle 8.5+ compatibility
ext.agp_version = '8.2.0'
ext.plugin_version = versionProperties.getProperty("version")

repositories {
Expand Down
2 changes: 1 addition & 1 deletion gradle/wrapper/gradle-wrapper.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.1.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
46 changes: 27 additions & 19 deletions plugin/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ import groovy.json.JsonBuilder
import org.gradle.util.VersionNumber

plugins {
id 'com.gradle.plugin-publish' version '0.14.0'
id "org.gradle.test-retry" version "1.2.0"
// plugin-publish 1.2.1: Required for Gradle 8.5+ (old version uses removed pluginBundle API)
id 'com.gradle.plugin-publish' version '1.2.1'
id "org.gradle.test-retry" version "1.5.8"
}

apply plugin: "java-gradle-plugin"
Expand All @@ -12,12 +13,16 @@ apply plugin: "groovy"
apply plugin: "kotlin"

gradlePlugin {
// website/vcsUrl/tags moved here from pluginBundle (removed in plugin-publish 1.0+)
website = 'https://github.com/mozilla/rust-android-gradle'
vcsUrl = 'https://github.com/mozilla/rust-android-gradle.git'
plugins {
rustAndroidGradlePlugin {
id = 'org.mozilla.rust-android-gradle.rust-android'
implementationClass = 'com.nishtahir.RustAndroidPlugin'
displayName = 'Plugin for building Rust with Cargo in Android projects'
description = 'A plugin that helps build Rust JNI libraries with Cargo for use in Android projects.'
tags.set(['rust', 'cargo', 'android'])
}
}
}
Expand All @@ -28,14 +33,13 @@ version "$plugin_version"
def isCI = (System.getenv('CI') ?: 'false').toBoolean()

// Maps supported Android plugin versions to the versions of Gradle that support it
// Updated for Gradle 8.5+ compatibility (required for Gradle 9 support)
def supportedVersions = [
"7.0.0": ["7.1.1"],
"4.2.2": ["6.8.3", "7.1.1"],
"4.1.3": ["6.5.1", "6.8.3"],
"4.0.2": ["6.1.1", "6.8.3"],
"3.6.4": ["5.6.4", "6.8.3"],
"3.5.4": ["5.4.1", "5.6.4", "6.8.3"],
"3.1.2": ["4.10.2"]
"8.2.0": ["8.5"],
"8.3.0": ["8.5"],
"8.4.0": ["8.6"],
"8.5.0": ["8.7"],
"8.6.0": ["8.7"],
Comment on lines -32 to +42
Copy link
Author

@klochowicz klochowicz Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what to keep here to avoid breaking code - I tested it with 8.5.0 locally.

perhaps it would require a minor version bump to avoid breaking old code?

]

// A local repo we publish our library to for testing in order to workaround limitations
Expand All @@ -51,6 +55,8 @@ publishing {

dependencies {
implementation gradleApi()
// Guava: Required for Versions.groovy (was transitively provided by old AGP)
implementation "com.google.guava:guava:32.1.3-jre"
compileOnly "com.android.tools.build:gradle:${agp_version}"

testImplementation gradleTestKit()
Expand All @@ -61,17 +67,17 @@ dependencies {
testImplementation "org.junit.jupiter:junit-jupiter-api"
}

// Java 17: Required for Gradle 8.5+ and AGP 8.x
java {
sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17
}

compileKotlin {
kotlinOptions.jvmTarget = "1.8"
kotlinOptions.jvmTarget = "17"
}
compileTestKotlin {
kotlinOptions.jvmTarget = "1.8"
}

pluginBundle {
website = 'https://github.com/mozilla/rust-android-gradle'
vcsUrl = 'https://github.com/mozilla/rust-android-gradle.git'
tags = ['rust', 'cargo', 'android']
kotlinOptions.jvmTarget = "17"
}


Expand Down Expand Up @@ -152,7 +158,9 @@ static def normalizeVersion(String version) {
}

static def jdkVersionFor(String version) {
def jdkVersion = VersionNumber.parse(version) > VersionNumber.parse("7.0.0-alpha01") ? 11 : 8

// AGP 8.x requires Java 17
def jdkVersion = VersionNumber.parse(version) >= VersionNumber.parse("8.0.0") ? 17 :
VersionNumber.parse(version) > VersionNumber.parse("7.0.0-alpha01") ? 11 : 8

return JavaLanguageVersion.of(jdkVersion)
}
18 changes: 12 additions & 6 deletions plugin/src/main/kotlin/com/nishtahir/CargoBuildTask.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ import org.gradle.api.Project
import org.gradle.api.logging.LogLevel
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.TaskAction
import org.gradle.process.ExecOperations
import java.io.ByteArrayOutputStream
import java.io.File
import javax.inject.Inject

open class CargoBuildTask : DefaultTask() {
abstract class CargoBuildTask : DefaultTask() {
@get:Inject
abstract val execOperations: ExecOperations
@Input
var toolchain: Toolchain? = null

Expand Down Expand Up @@ -48,7 +52,7 @@ open class CargoBuildTask : DefaultTask() {
?: targetDirectory
?: "${module!!}/target"

val defaultTargetTriple = getDefaultTargetTriple(project, rustcCommand)
val defaultTargetTriple = getDefaultTargetTriple(execOperations, project, rustcCommand)

var cargoOutputDir = File(if (toolchain.target == defaultTargetTriple) {
"${target}/${profile}"
Expand Down Expand Up @@ -84,9 +88,9 @@ open class CargoBuildTask : DefaultTask() {

inline fun <reified T : BaseExtension> buildProjectForTarget(project: Project, toolchain: Toolchain, ndk: Ndk, cargoExtension: CargoExtension) {
val apiLevel = cargoExtension.apiLevels[toolchain.platform]!!
val defaultTargetTriple = getDefaultTargetTriple(project, cargoExtension.rustcCommand)
val defaultTargetTriple = getDefaultTargetTriple(execOperations, project, cargoExtension.rustcCommand)

project.exec { spec ->
execOperations.exec { spec ->
with(spec) {
standardOutput = System.out
val module = File(cargoExtension.module!!)
Expand Down Expand Up @@ -120,6 +124,7 @@ open class CargoBuildTask : DefaultTask() {
// there's a way to specify them in the cargo command line -- rustc accepts
// them if passed in directly with `--cfg`, and cargo will pass them to rustc
// if you use them as default featureSpec.
// Kotlin 1.9+ requires exhaustive when for sealed classes with nullable types
Copy link
Author

@klochowicz klochowicz Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

happy to remove all the comments in the review process, but figured it would be easier to understand how this small file permissions change (the actual removed API) triggered cascading change in other dependencies.

when (features) {
is Features.All -> {
theCommandLine.add("--all-features")
Expand All @@ -137,6 +142,7 @@ open class CargoBuildTask : DefaultTask() {
theCommandLine.add(features.featureSet.joinToString(" "))
}
}
null -> { /* Use default features */ }
}

if (cargoExtension.profile != "debug") {
Expand Down Expand Up @@ -249,9 +255,9 @@ open class CargoBuildTask : DefaultTask() {
}

// This can't be private/internal as it's called from `buildProjectForTarget`.
fun getDefaultTargetTriple(project: Project, rustc: String): String? {
fun getDefaultTargetTriple(execOperations: ExecOperations, project: Project, rustc: String): String? {
val stdout = ByteArrayOutputStream()
val result = project.exec { spec ->
val result = execOperations.exec { spec ->
spec.standardOutput = stdout
spec.commandLine = listOf(rustc, "--version", "--verbose")
}
Expand Down
8 changes: 6 additions & 2 deletions plugin/src/main/kotlin/com/nishtahir/GenerateToolchainsTask.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,12 @@ import org.gradle.api.DefaultTask
import org.gradle.api.GradleException
import org.gradle.api.Project
import org.gradle.api.tasks.TaskAction
import org.gradle.process.ExecOperations
import javax.inject.Inject

open class GenerateToolchainsTask : DefaultTask() {
abstract class GenerateToolchainsTask : DefaultTask() {
@get:Inject
abstract val execOperations: ExecOperations

@TaskAction
@Suppress("unused")
Expand Down Expand Up @@ -44,7 +48,7 @@ open class GenerateToolchainsTask : DefaultTask() {
// already. It is fast to do so and fixes any issues
// with partially reclaimed temporary files.
val dir = File(cargoExtension.toolchainDirectory, arch + "-" + apiLevel)
project.exec { spec ->
execOperations.exec { spec ->
spec.standardOutput = System.out
spec.errorOutput = System.out
spec.commandLine(cargoExtension.pythonCommand)
Expand Down
4 changes: 3 additions & 1 deletion plugin/src/main/kotlin/com/nishtahir/RustAndroidPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,9 @@ open class RustAndroidPlugin : Plugin<Project> {
eachFile {
it.path = it.path.replaceFirst("com/nishtahir", "")
}
fileMode = 493 // 0755 in decimal; Kotlin doesn't have octal literals (!).
filePermissions { permissions ->
permissions.unix("rwxr-xr-x") // 0755
}
includeEmptyDirs = false
duplicatesStrategy = DuplicatesStrategy.EXCLUDE
}
Expand Down