Allow the use of the new Android ndk paths

orion78fr · orion78fr · commit 9962c5864379 · 2022-01-17T21:52:20.000+01:00
Looks for the ndk under the `ndk` folder (which allows for multiple parallel
ndk versions installed), then in the obsolete `ndk-bundle` folder if not found.

If multiple ndk versions are found, the most recent is automatically chosen
and a compilation warning is issued.

A specific NDK version can be chosen with the `ANDROID_NDK_VERSION` env var.

The `JAVA_HOME` env var has been removed because it's not used.
diff --git a/.github/workflows/full-ci.yml b/.github/workflows/full-ci.yml
@@ -195,35 +195,18 @@ jobs:
         #  rust: ${{ matrix.rust.toolchain }}
       - name: "Install Java + NDK"
         run: |
-          export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64;
-          export ANDROID_SDK_ROOT=/opt/ndk/android-ndk-r21d;
           # aarch64 and armv7 cover most Android phones & tablets.;
           rustup target add aarch64-linux-android armv7-linux-androideabi;
           sudo apt-get update;
-          sudo apt-get install openjdk-8-jdk;
           sudo apt-get install llvm-dev libclang-dev clang g++-multilib gcc-multilib libc6-dev libc6-dev-arm64-cross;
-          # Downloading NDK. This file is huge (1Gb) maybe extract only what's needed and repackage.;
-          # See https://developer.android.com/ndk/downloads for updates.;
-          # The Android SDK which comes with Android Studio is not required. Only Java + NDK are.;
-          mkdir /opt/ndk
-          install -d /opt/ndk;
-          cd /opt/ndk && wget -nc -nv https://dl.google.com/android/repository/android-ndk-r21d-linux-x86_64.zip && cd $GITHUB_WORKSPACE;
-          echo "bcf4023eb8cb6976a4c7cff0a8a8f145f162bf4d  /opt/ndk/android-ndk-r21d-linux-x86_64.zip" >> /opt/ndk/SHA1SUM.txt;
-          sha1sum --check /opt/ndk/SHA1SUM.txt;
-          cd /opt/ndk && unzip -q android-ndk-r21d-linux-x86_64.zip && cd $GITHUB_WORKSPACE;
-          # Using clang linker from NDK when building Android programs.;
-          install -d $HOME/.cargo;
-          echo >> $HOME/.cargo/config;
-          echo "[target.aarch64-linux-android]" >> $HOME/.cargo/config;
-          find /opt/ndk -name aarch64-linux-android21-clang++ -printf 'linker = "%p"\n' >> $HOME/.cargo/config;
-          echo >> $HOME/.cargo/config;
-          echo "[target.armv7-linux-androideabi]" >> $HOME/.cargo/config;
-          find /opt/ndk -name armv7a-linux-androideabi21-clang++ -printf 'linker = "%p"\n' >> $HOME/.cargo/config;
-          echo >> $HOME/.cargo/config;
       - name: "Build Rust for targets: aarch64-linux-android, armv7-linux-androideabi"
         run: |
+          export CARGO_TARGET_AARCH64_LINUX_ANDROID_LINKER=$ANDROID_SDK_ROOT/ndk/$ANDROID_NDK_VERSION/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android21-clang++
+          export CARGO_TARGET_ARMV7_LINUX_ANDROIDEABI_LINKER=$ANDROID_SDK_ROOT/ndk/$ANDROID_NDK_VERSION/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi21-clang++
           cargo build --target aarch64-linux-android --release;
           cargo build --target armv7-linux-androideabi --release;
+        env:
+          ANDROID_NDK_VERSION: 21.4.7075529
 
   integration-test-godot:
     name: itest-godot-${{ matrix.godot }}${{ matrix.postfix }}
diff --git a/gdnative-sys/Cargo.toml b/gdnative-sys/Cargo.toml
@@ -19,3 +19,4 @@ bindgen = { version = "0.59.1", default-features = false, features = ["runtime"]
 proc-macro2 = "1.0.30"
 quote = "1.0.10"
 miniserde = "0.1.15"
+semver = "1.0.4"
diff --git a/gdnative-sys/build.rs b/gdnative-sys/build.rs
@@ -52,11 +52,8 @@ mod header_binding {
 
         assert_eq!("android", &target_os);
 
-        let java_home =
-            std::env::var("JAVA_HOME").expect("JAVA_HOME and ANDROID_SDK_ROOT must be set");
-        let java_home = Path::new(&java_home).to_path_buf();
         let android_sdk_root =
-            std::env::var("ANDROID_SDK_ROOT").expect("JAVA_HOME and ANDROID_SDK_ROOT must be set");
+            std::env::var("ANDROID_SDK_ROOT").expect("ANDROID_SDK_ROOT must be set");
         let android_sdk_root = Path::new(&android_sdk_root).to_path_buf();
 
         // Note: cfg!(target_os) and cfg!(target_arch) refer to the target of the build script:
@@ -69,51 +66,83 @@ mod header_binding {
             "unsupported host architecture: build from x86_64 instead"
         );
 
-        builder = builder
-            .clang_arg("-I")
-            .clang_arg(Path::join(&java_home, "include/").to_string_lossy());
-
-        builder = builder.clang_arg("-I").clang_arg(
-            Path::join(
-                &java_home,
-                format!("include/{}/", {
-                    if cfg!(target_os = "windows") {
-                        "win32"
-                    } else if cfg!(target_os = "macos") {
-                        "darwin"
-                    } else if cfg!(target_os = "linux") {
-                        "linux"
+        let mut android_ndk_root: Option<PathBuf> = None;
+
+        let android_ndk_folder = Path::join(&android_sdk_root, "ndk");
+        if android_ndk_folder.exists() {
+            // New NDK
+            let available_ndk_versions: Vec<_> = std::fs::read_dir(android_ndk_folder.clone())
+                .unwrap()
+                .into_iter()
+                .map(|dir| dir.unwrap().path())
+                .collect();
+
+            if !available_ndk_versions.is_empty() {
+                let ndk_version = std::env::var("ANDROID_NDK_VERSION");
+
+                if let Ok(ndk_version) = ndk_version {
+                    if available_ndk_versions
+                        .iter()
+                        .map(|p| p.file_name())
+                        .any(|p| {
+                            p.is_some() && p.unwrap().to_string_lossy().eq(ndk_version.as_str())
+                        })
+                    {
+                        // Asked version is available
+                        android_ndk_root = Some(Path::join(&android_ndk_folder, ndk_version))
                     } else {
-                        panic!("unsupported host OS: build from Windows, MacOS, or Linux instead");
+                        panic!(
+                            "no available android ndk versions matches {}. Available versions: {:?}",
+                            ndk_version, available_ndk_versions
+                        )
                     }
-                }),
-            )
-            .to_string_lossy(),
-        );
+                } else {
+                    // No NDK version chosen, chose the most recent one and issue a warning
+                    println!("cargo:warning=Multiple android ndk versions have been detected.");
+                    println!("cargo:warning=You should chose one using ANDROID_NDK_VERSION environment variable to have reproducible builds.");
+                    println!(
+                        "cargo:warning=Available versions: {:?}",
+                        available_ndk_versions
+                    );
+
+                    let ndk_version = available_ndk_versions
+                        .iter()
+                        .filter_map(|p| p.file_name())
+                        .filter_map(|v| semver::Version::parse(v.to_string_lossy().as_ref()).ok())
+                        .max()
+                        .unwrap();
+
+                    println!(
+                        "cargo:warning=Automatically chosen version: {} (latest)",
+                        ndk_version
+                    );
+
+                    android_ndk_root =
+                        Some(Path::join(&android_ndk_folder, ndk_version.to_string()));
+                }
+            }
+        }
 
+        let android_ndk_bundle_folder = Path::join(&android_sdk_root, "ndk-bundle");
+        if android_ndk_root.is_none() && android_ndk_bundle_folder.exists() {
+            // Old NDK
+            android_ndk_root = Some(android_ndk_bundle_folder);
+        }
+
+        let android_ndk_root = android_ndk_root.expect("Android ndk needs to be installed");
+
+        builder = builder
+            .clang_arg("-I")
+            .clang_arg(Path::join(&android_ndk_root, "sysroot/usr/include").to_string_lossy());
         builder = builder.clang_arg("-I").clang_arg(
-            Path::join(&android_sdk_root, "ndk-bundle/sysroot/usr/include").to_string_lossy(),
-        );
-        builder = builder.clang_arg("-I").clang_arg(
-            Path::join(
-                &android_sdk_root,
-                "ndk-bundle/sources/cxx-stl/llvm-libc++/include",
-            )
-            .to_string_lossy(),
+            Path::join(&android_ndk_root, "sources/cxx-stl/llvm-libc++/include").to_string_lossy(),
         );
         builder = builder.clang_arg("-I").clang_arg(
-            Path::join(
-                &android_sdk_root,
-                "ndk-bundle/sources/cxx-stl/llvm-libc++abi/include",
-            )
-            .to_string_lossy(),
+            Path::join(&android_ndk_root, "sources/cxx-stl/llvm-libc++abi/include")
+                .to_string_lossy(),
         );
         builder = builder.clang_arg("-I").clang_arg(
-            Path::join(
-                &android_sdk_root,
-                "ndk-bundle/sources/android/support/include",
-            )
-            .to_string_lossy(),
+            Path::join(&android_ndk_root, "sources/android/support/include").to_string_lossy(),
         );
 
         let host_tag = {
@@ -130,23 +159,20 @@ mod header_binding {
 
         builder = builder.clang_arg("-I").clang_arg(
             Path::join(
-                &android_sdk_root,
-                format!(
-                    "ndk-bundle/toolchains/llvm/prebuilt/{}/sysroot/usr/include",
-                    &host_tag
-                ),
+                &android_ndk_root,
+                format!("toolchains/llvm/prebuilt/{}/sysroot/usr/include", &host_tag),
             )
             .to_string_lossy(),
         );
 
         builder = builder.clang_arg("-I").clang_arg(
             Path::join(
-                &android_sdk_root,
+                &android_ndk_root,
                 format!(
-            "ndk-bundle/toolchains/llvm/prebuilt/{host}/sysroot/usr/include/{target_triple}",
-            host = &host_tag,
-            target_triple = &target_triple,
-        ),
+                    "toolchains/llvm/prebuilt/{host}/sysroot/usr/include/{target_triple}",
+                    host = &host_tag,
+                    target_triple = &target_triple,
+                ),
             )
             .to_string_lossy(),
         );
