This document describes how to run the Node.js tests for testing the nodejs-mobile runtime on iOS and Android. Currently, the tests can only be run on physical devices, not simulators.
The Node.js tests expect to run the Node.js runtime as if it was a standalone executable running on the same machine. To get around this, iOS and Android applications were developed to use the nodejs-mobile library and behave like a desktop standalone application, paired with "proxy" scripts that are called by tools/test.py as if they were the actual desktop node application and start the iOS or Android applications to run the selected tests and return the results.
Some tests depend on the ability of node to spawn new processes / fork the current process, which is not supported in nodejs-mobile, so those tests are skipped, alongside tests for other functionalities not currently supported. Tests that are expected to fail are also currently skipped so we can use the current tests as a regression baseline.
You'll need a macOS development machine, an iOS arm64 physical device running iOS 11.0 or greater and a valid iOS Development certificate installed.
iOS tests depend on the ios-deploy tool for installing and running the test app. You can install it by using npm:
npm install -g ios-deploy@1.10.0You'll need to build nodejs-mobile, so its prerequisites should also be installed on your system.
Build nodejs-mobile for iOS:
./tools/ios_framework_prepare.shConnect the iOS device on which you intend to run tests, and make sure its screen stays unlocked.
Sign the tools/mobile-test/ios/testnode/testnode.xcodeproj in Xcode to be able to run on your target device. In the project settings (click on the project main node), in the Signing portion of the General tab, select a valid Team and handle the provisioning profile creation/update. If you get an error that the bundle identifier cannot be used, you can simply change the bundle identifier to a unique string by appending a few characters to it.
Run the helper script to build and install the iOS test application. It will also run the application on the device to copy the tests to the iOS application's documents path:
./tools/mobile-test/ios/prepare-ios-tests.shThis should be done the first time you run the tests and be repeated any time you change any of the tests or rebuild nodejs-mobile.
If you have more than one device connected to the development machine you can use the environment variable DEVICE_ID to select the device you want to run the tests on. Start by listing the devices:
ios-deploy --detectand then run the helper script setting DEVICE_ID to the device id you intend on using:
DEVICE_ID=1234567890abcdef123456789abcdef987654321 ./tools/mobile-test/ios/prepare-ios-tests.shConnect the iOS device on which you intend to run tests, and make sure its screen stays unlocked.
You can run the Node.js test scripts in iOS by calling ./tools/test.py with --arch ios. Here's an example to run the parallel, sequential and message test suites:
JOBS=0 ./tools/test.py --report -j 0 --flaky-tests=skip --arch ios parallel sequential messageWhile the tests are running, you will see the test application being repeatedly restarted on your test device.
If you have more than one device connected to the development machine you can use the environment variable DEVICE_ID to select the device you want to run the tests on. Start by listing the devices:
ios-deploy --detectand then run the tests setting DEVICE_ID to the device id you intend on using:
DEVICE_ID=1234567890abcdef123456789abcdef987654321 JOBS=0 ./tools/test.py --report -j 0 --flaky-tests=skip --arch ios parallel sequential messageYou'll need a macOS or Linux development machine, and a physical Android device. This test suite unfortunately only supports devices with Android version up to 9.0 (maybe 10.0 too?), because our scripts need to be able to execute kill which seems restricted or removed in recent versions of Android.
You'll need Android Studio installed on your development Machine, alongside Java, Gradle, the Android 8.0 (Android SDK Platform 26), Android SDK Build Tools v29.0.2, Android SDK Tools, Android SDK Platform-Tools, NDK version >=24 and CMake 3.6.4111459.
You should set the Environment variables required to build Android Applications from the command line: the ANDROID_HOME variable pointing to your android-sdk path and the ANDROID_NDK_HOME variable pointing to the installed NDK path (it usually is $ANDROID_HOME/ndk-bundle) . You should also add $ANDROID_HOME/platform-tools, $ANDROID_HOME/tools and $ANDROID_HOME/tools/bin to the PATH environment variable.
You'll need to build nodejs-mobile, so its prerequisites should also be installed on your system.
Build nodejs-mobile for Android:
./tools/android_build.sh "$ANDROID_NDK_HOME"Connect the Android device on which you intend to run tests, and make sure its screen stays unlocked.
Run the helper script to build and install the Android test application. It will also run the application on the device to copy the tests to the Android application's FilesDir path:
./tools/mobile-test/android/prepare-android-test.shThis should be done the first time you run the tests and be repeated any time you change any of the tests or rebuild nodejs-mobile.
If you have more than one device connected to the development machine you can use the environment variable DEVICE_ID to select the device you want to run the tests on. Start by listing the devices:
adb devicesand then run the helper script setting DEVICE_ID to the device id you intend on using:
DEVICE_ID=ENU7N123456789A ./tools/mobile-test/android/prepare-android-test.shConnect the Android device on which you intend to run tests, and make sure its screen stays unlocked.
You can run the Node.js test scripts in Android by calling ./tools/test.py with --arch android. Here's an example to run the parallel, sequential and message test suites:
JOBS=0 ./tools/test.py --report -j 0 --flaky-tests=skip --arch android parallel sequential messageWhile the tests are running, you will see the test application being repeatedly restarted on your test device.
If you have more than one device connected to the development machine you can use the environment variable DEVICE_ID to select the device you want to run the tests on. Start by listing the devices:
adb devicesand then run the tests setting DEVICE_ID to the device id you intend on using:
DEVICE_ID=ENU7N123456789A JOBS=0 ./tools/test.py --report -j 0 --flaky-tests=skip --arch android parallel sequential message