Google tests framework for UnitTests

.github/jobs/android_tests.yml

@@ -0,0 +1,58 @@
+parameters:
+  name: ''
+  vmImage: ''
+  JSEngine: ''
+  macOSCodename: ''
+
+jobs:
+  - job: ${{ parameters.name }}
+    timeoutInMinutes: 45
+    pool:
+      vmImage: ${{ parameters.vmImage }}
+
+    steps:
+    - script: |
+        git submodule update --init --recursive
+      displayName: 'Checkout dependencies'
+    - template: cmake.yml
+      parameters:
+        vmImage: ${{ parameters.vmImage }}
+
+    - script: |
+        echo Install Android image
+        echo 'y' | $ANDROID_HOME/tools/bin/sdkmanager --install 'system-images;android-27;default;x86_64'
+        echo 'y' | $ANDROID_HOME/tools/bin/sdkmanager --licenses
+        echo Create AVD
+        $ANDROID_HOME/tools/bin/avdmanager create avd -n Pixel_API_27 -d pixel -k 'system-images;android-27;default;x86_64'
+      displayName: 'Install Android Emulator'
+    - script: |
+        echo Start emulator
+        nohup $ANDROID_HOME/emulator/emulator -avd Pixel_API_27 -gpu host -no-window 2>&1 &
+        echo Wait for emulator
+        $ANDROID_HOME/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed) ]]; do echo '.'; sleep 1; done'
+        $ANDROID_HOME/platform-tools/adb devices
+      displayName: 'Start Android Emulator'
+
+    - task: Gradle@3
+      inputs:
+        gradleWrapperFile: 'Apps/UnitTests/Android/gradlew'
+        workingDirectory: 'Apps/UnitTests/Android'
+        options: '-PabiFilters=x86_64 -PjsEngine=${{parameters.jsEngine}}'
+        tasks: 'connectedAndroidTest'
+        jdkVersionOption: 1.11
+      displayName: 'Run Connected Android Test'
+
+    - script: |
+        export results=$(find ./app/build/outputs/androidTest-results -name "*.txt")
+        echo cat "$results"
+        cat "$results"
+      workingDirectory: 'Apps/UnitTests/Android'
+      condition: succeededOrFailed()
+      displayName: 'Dump logcat from Test Results'
+
+    - task: PublishBuildArtifacts@1
+      inputs:
+        pathToPublish: 'Apps/UnitTests/Android/app/build/outputs/androidTest-results/connected'
+        artifactName: 'AndroidTestResults_${{parameters.jsEngine}}'
+      condition: succeededOrFailed()
+      displayName: 'Publish Test Results'

Apps/UnitTests/Android/.gitignore

@@ -0,0 +1,10 @@
+*.iml
+.gradle/
+.idea/
+local.properties
+
+app/.cxx/
+app/build/
+app/src/main/assets
+
+build/

Apps/UnitTests/Android/app/build.gradle

@@ -0,0 +1,116 @@
+plugins {
+    id 'com.android.application'
+}
+
+def jsEngine = "V8"
+if (project.hasProperty("jsEngine")) {
+    jsEngine = project.property("jsEngine")
+}
+
+configurations { natives }
+
+android {
+    namespace 'com.babylonnative.unittests'
+    compileSdk 33
+    ndkVersion = "21.4.7075529"
+
+    defaultConfig {
+        applicationId "com.babylonnative.unittests"
+        minSdk 21
+        targetSdk 33
+        versionCode 1
+        versionName "1.0"
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+
+        externalNativeBuild {
+            cmake {
+                arguments (
+                    "-DANDROID_STL=c++_shared",
+                    "-DNAPI_JAVASCRIPT_ENGINE=${jsEngine}",
+                    "-DJSRUNTIMEHOST_CORE_APPRUNTIME_V8_INSPECTOR=ON",
+                )
+            }
+        }
+
+        if (project.hasProperty("abiFilters")) {
+            ndk {
+                abiFilters project.getProperty("abiFilters")
+            }
+        }
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+    externalNativeBuild {
+        cmake {
+            path file('src/main/cpp/CMakeLists.txt')
+            buildStagingDirectory '../../../../Build/Android'
+            version '3.22.1+'
+        }
+    }
+    buildFeatures {
+        viewBinding true
+    }
+}
+
+dependencies {
+    implementation 'com.google.ar:core:1.16.0'
+    natives 'com.google.ar:core:1.16.0'
+    implementation 'androidx.appcompat:appcompat:1.6.0'
+    implementation 'com.google.android.material:material:1.7.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
+    implementation group: 'org.java-websocket', name: 'Java-WebSocket', version: '1.5.3'
+    testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
+}
+
+task copyScripts {
+    doLast {
+        // run copy at execution phase because npm command is not done at configuration phase
+        copy
+        {
+            from "../../../node_modules/chai"
+            include "chai.js"
+            into 'src/main/assets/Scripts'
+        }
+        copy
+        {
+            from "../../../node_modules/mocha"
+            include "mocha.js"
+            into 'src/main/assets/Scripts'
+        }
+        copy
+        {
+            from "../../../node_modules/babylonjs"
+            include "babylon.max.js"
+            into 'src/main/assets/Scripts'
+        }
+        copy
+        {
+            from "../../../node_modules/babylonjs-materials"
+            include "babylonjs.materials.js"
+            into 'src/main/assets/Scripts'
+        }
+    }
+}
+
+// Run copyScripts task after CMake external build
+// And make sure merging assets into output is performed after the scripts copy
+tasks.whenTaskAdded { task ->
+    if (task.name == 'mergeDebugNativeLibs') {
+        task.finalizedBy(copyScripts)
+    }
+    if (task.name == 'mergeDebugAssets') {
+        task.dependsOn(copyScripts)
+    }
+}

Apps/UnitTests/Android/app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

Apps/UnitTests/Android/app/src/androidTest/java/com/babylonnative/unittests/Main.java

@@ -0,0 +1,28 @@
+package com.babylonnative.unittests;
+
+import android.content.Context;
+
+import androidx.test.platform.app.InstrumentationRegistry;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static org.junit.Assert.*;
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
+ */
+@RunWith(AndroidJUnit4.class)
+public class Main {
+    @Test
+    public void javaScriptTests() {
+        // Context of the app under test.
+        Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext();
+        assertEquals("com.babylonnative.unittests", appContext.getPackageName());
+
+        assertEquals(0, Native.javaScriptTests(appContext));
+    }
+}

Apps/UnitTests/Android/app/src/androidTest/java/com/babylonnative/unittests/Native.java

@@ -0,0 +1,12 @@
+package com.babylonnative.unittests;
+
+import android.content.Context;
+
+public class Native {
+    // JNI interface
+    static {
+        System.loadLibrary("UnitTestsJNI");
+    }
+
+    public static native int javaScriptTests(Context context);
+}

Apps/UnitTests/Android/app/src/main/AndroidManifest.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <application android:label="@string/app_name" />
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+</manifest>

Apps/UnitTests/Android/app/src/main/cpp/CMakeLists.txt

@@ -0,0 +1,43 @@
+cmake_minimum_required(VERSION 3.18)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+project(UnitTestsJNI)
+
+get_filename_component(UNIT_TESTS_DIR "${CMAKE_CURRENT_LIST_DIR}/../../../../.." ABSOLUTE)
+get_filename_component(REPO_ROOT_DIR "${UNIT_TESTS_DIR}/../.." ABSOLUTE)
+
+set(JSRUNTIMEHOST_TESTS OFF) # Turn off the tests folder for Android Studio path
+add_subdirectory(${REPO_ROOT_DIR} "${CMAKE_CURRENT_BINARY_DIR}/BabylonNative")
+
+get_filename_component(APPS_DIR "${UNIT_TESTS_DIR}/.." ABSOLUTE)
+npm(install "${APPS_DIR}" "Apps" "--silent")
+
+add_library(UnitTestsJNI SHARED
+    JNI.cpp
+    ${UNIT_TESTS_DIR}/Shared/Tests.h)
+target_compile_definitions(UnitTestsJNI PRIVATE JSRUNTIMEHOST_PLATFORM="${JSRUNTIMEHOST_PLATFORM}")
+
+target_include_directories(UnitTestsJNI
+    PRIVATE ${UNIT_TESTS_DIR})
+
+target_link_libraries(UnitTestsJNI
+    PRIVATE GLESv3
+    PRIVATE android
+    PRIVATE EGL
+    PRIVATE log
+    PRIVATE -lz
+    PRIVATE AndroidExtensions
+    PRIVATE AppRuntime
+    PRIVATE Canvas
+    PRIVATE Console
+    PRIVATE GraphicsDevice
+    PRIVATE NativeCamera
+    PRIVATE NativeEngine
+    PRIVATE NativeInput
+    PRIVATE NativeOptimizations
+    PRIVATE ScriptLoader
+    PRIVATE XMLHttpRequest
+    PRIVATE gtest_main
+    PRIVATE Window)

Apps/UnitTests/Android/app/src/main/cpp/JNI.cpp

@@ -0,0 +1,72 @@
+#include "gtest/gtest.h"
+#include <jni.h>
+#include <Android/log.h>
+#include <AndroidExtensions/Globals.h>
+#include <AndroidExtensions/JavaWrappers.h>
+#include <atomic>
+#include <Shared/Tests.h>
+
+namespace
+{
+    int pfd[2];
+    int fd_saved[2];
+}
+void* thread_func(void*)
+{
+    ssize_t rdsz;
+    char buf[128];
+    while ((rdsz = read(pfd[0], buf, sizeof buf - 1)) > 0)
+    {
+        if (buf[rdsz - 1] == '\n') --rdsz;
+        buf[rdsz] = 0;
+        __android_log_write(ANDROID_LOG_DEBUG, "UnitTests", buf);
+    }
+    __android_log_write(ANDROID_LOG_DEBUG, "UnitTests", "Logger shutdown");
+    return 0;
+}
+
+void start_logger()
+{
+    pthread_t thr;
+
+    // make stdout line-buffered and stderr unbuffered
+    fd_saved[0] = setvbuf(stdout, 0, _IOLBF, 0);
+    fd_saved[1] = setvbuf(stderr, 0, _IONBF, 0);
+
+    // create the pipe and redirect stdout and stderr
+    pipe(pfd);
+    dup2(pfd[1], 1);
+    dup2(pfd[1], 2);
+
+    // spawn the logging thread
+    if (pthread_create(&thr, 0, thread_func, 0) == -1)
+    {
+        return;
+    }
+    pthread_detach(thr);
+}
+
+void stop_logger()
+{
+    close(pfd[1]);
+    close(pfd[0]);
+    setvbuf(stdout, NULL, fd_saved[0], 0);
+    setvbuf(stderr, NULL, fd_saved[1], 0);
+}
+
+extern "C" JNIEXPORT jint JNICALL
+Java_com_babylonnative_unittests_Native_javaScriptTests(JNIEnv* env, jclass clazz, jobject context) {
+    JavaVM* javaVM{};
+    if (env->GetJavaVM(&javaVM) != JNI_OK)
+    {
+        throw std::runtime_error{"Failed to get Java VM"};
+    }
+
+    start_logger();
+
+    android::global::Initialize(javaVM, context);
+    auto testResult = Run();
+
+    stop_logger();
+    return testResult;
+}

Apps/UnitTests/Android/app/src/main/res/values/strings.xml

@@ -0,0 +1,3 @@
+<resources>
+    <string name="app_name">BabylonNative UnitTests</string>
+</resources>

Apps/UnitTests/Android/build.gradle

@@ -0,0 +1,5 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+plugins {
+    id 'com.android.application' version '7.3.1' apply false
+    id 'com.android.library' version '7.3.1' apply false
+}