android-runner
Run gradle and android related stuff
Android Studio craves more gigabytes of RAM that I am willing to buy so this plugin was created to alleviate some of the problems of Android related development.
Usage
The plugin needs to know where your gradlew is and it assumes it's at the root of the entire android project.
Use :GradleSetup /path/to/android/project for bootstrapping.
It will set the following:
" <arg> denotes the /path/to/android/project argument
g:android_project_root = <arg>
g:gradle_project_root = <arg>
g:gradle_bin = <arg> .. '/gradlew'The default adb binary is searched for in:
$ANDROID_SDK/platform-tools/adb$(which adb)
An error message will pop up if it fails.
If you wish to use some other adb binary, set g:adb_bin to it.
Commands
Most of the commands take optional arguments, which is most likely apk_name.
If not specified, g:android_target_app and g:target_device are used.
GradleRun - runs `gradle` commands with `g:gradle_project_root` as current working dir, and `g:gradle_flags` as the flags
AdbSetPort - set port (default: `5037`)
AdbSelectDevice - select one of the detected devices as your target
AdbShell - spawn shell on the target device
AdbRun - run a command on the target device
AdbInputText - inputs given text on the device
AdbDevices - list all devices
AdbInstall - install given apk on target device
AdbStart - start given app on target device
AdbLogcat - start logcat (or pidcat)
AdbLogcatClear - clear logcat
AdbSelectBuildType - select apk build type
AdbPush - push given apk to target device
AdbShazam - push, install, start
AdbDebugger - push, install, start in debug modeDefault LLDB server port is 54321.
Using the debugger
0. Pre-setup
Be sure to set the following variables so that the correct lldb-server can be pushed to the device:
g:android_lldb_armv8_server_bin
g:android_lldb_armv7_server_binIf you're using the portable version of AS, downloaded straight from its site, the servers should be in these directories:
$> ls android-studio/plugins/android-ndk/resources/lldb/android/
arm64-v8a armeabi x86 x86_64
1. Setup
Run :GradleSetup /path/to/android/project.
Run :GradleRun :app:assembleDebug or any other gradle command you need.
Set g:android_target_app to the final app name, e.g. CoreUtilsTest.
If you have only one android device connected, it'll be used for running the adb commands.
But if you have more than one, please set the ID through :AdbSelectDevice.
Run :AdbShazam to install and launch the application.
Run :AdbDebugger to launch the application in debug mode. (the app needs to be installed first)
Note: if you want to preset the GradleSetup so you don't have to invoke it, this is GradleSetup in a nutshell:
def Setup( dir: string )
g:android_project_root = dir
g:gradle_project_root = dir
g:gradle_bin = dir .. '/gradlew'2. Launch Vimspector
Here's the config:
{
"configurations": {
"Remote android debugging": {
"remote-request": "launch",
"adapter": {
"extends": "CodeLLDB",
"command": [
"${gadgetDir}/CodeLLDB/adapter/codelldb",
"--liblldb", "/usr/local/lib/liblldb.so",
"--port", "${unusedLocalPort}"
],
"variables": {
"ANDROID_APP" : "com.package.application", // edit this
"ANDROID_SERIAL" : "<device-serial-id>", // edit this
"ANDROID_ADB_SERVER_PORT" : "5037", // edit this if needed
"ANDROID_PLATFORM_LISTEN_PORT" : "6666",
"ANDROID_PLATFORM_LOCAL_PORT" : "6666",
"ANDROID_PLATFORM_LOCAL_GDB_PORT" : "8888"
},
"launch": {
"delay": "3000m",
"remote": {
"runCommands": [
[ "jdb", "-attach", "localhost:54321" ], // this port is hardcoded
[
"adb",
"-P", "${ANDROID_ADB_SERVER_PORT}",
"-s", "${ANDROID_SERIAL}",
"shell", "run-as", "${ANDROID_APP}",
"./lldb-server", "platform",
"--listen", "\"*:${ANDROID_PLATFORM_LISTEN_PORT}\""
]
]
}
}
},
"breakpoints": {
"exception": {
"cpp_catch": "N",
"cpp_throw": "N"
}
},
"variables": {
"pid": {
"shell": [
"adb",
"-P", "${ANDROID_ADB_SERVER_PORT}",
"-s", "${ANDROID_SERIAL}",
"shell", "ps",
"| grep \"${ANDROID_APP}\"",
"| tr -s ' '",
"| cut -d' ' -f2"
]
}
},
"configuration": {
"initCommands": [
"script os.environ['ANDROID_PLATFORM_LOCAL_PORT' ] = '${ANDROID_PLATFORM_LOCAL_PORT}'",
"script os.environ['ANDROID_PLATFORM_LOCAL_GDB_PORT'] = '${ANDROID_PLATFORM_LOCAL_GDB_PORT}'",
"script os.environ['ANDROID_ADB_SERVER_PORT' ] = '${ANDROID_ADB_SERVER_PORT}'",
"platform select remote-android",
"platform connect connect://localhost:${ANDROID_PLATFORM_LISTEN_PORT}"
],
"pid": "${pid}",
"request": "attach"
}
}
}
}Notes
If you get the "failed to get reply to handshake packet", you likely need a longer delay.
If the lldb-server says that the address is already used, you can kill the server by either relaunching the app via :AdbDebugger or invoking :call adb#StopLLDB() directly.
Configuration
Variables:
g:android_target_device - ID of the target device
g:android_target_app - name of the target app
g:android_project_root - path to the android project root
g:android_lldb_armv8_server_bin - path to the armv8 version of lldb-server
g:android_lldb_armv7_server_bin - path to the armv7 version of lldb-server
g:gradle_bin - path to gradlew
g:gradle_project_root - dirname of g:gradle_bin
g:adb_bin - path to adb, defaults to `$ANDROID_SDK/platform-tools/adb` or `which adb`
g:adb_port - port for adb to use, defaults to 5037
g:gradle_flags - flags that are injected into gradle invocations, default to `-p`Bonus
To stop a job press <C-c> in the job's buffer.
WIP
To clear the logcat press <leader>c in the job's buffer.