Lab 4 In class Hands-on Android Debugging Tutorial

Transcription

1 Lab 4 In class Hands-on Android Debugging Tutorial Submit lab 4 as PDF with your feedback and list each major step in this tutorial with screen shots documenting your work, i.e., document each listed step. Submit to Blackboard. Java Debugging Java TM Debug Wire Protocol (JDWP) is the protocol used for communication between a debugger and the Java Virtual Machine (VM). Used by Eclipse, IntelliJ, and AndroidStudio. JDWP allows you to step through code, view variable values, and pause execution of an application while executing (on your AVD or device). You can attach a debugger to a special port so it can communicate with the application VMs on your devices. Android Debugging adb (Android Debug Bridge) Generally means to communicate with connected emulators (AVD) and devices. Device management, moving and syncing files to the emulator (or device), running a UNIX shell on the device or emulator, interacting with SQLite database for an application. Dalvik Debug Monitor Server (DDMS) Graphical program that communicates with your devices through the adb. Capture screenshots, gather thread and stack information, monitor heap, spoof incoming calls and SMS messages, etc. Device or Android Virtual Device (AVD) Your App must run on a device, or in an AVD so that it can be debugged. An adb device daemon runs on an actual device or a virtual device (AVD), and provides a means for the adb host daemon to communicate with the device or emulator. 1

2 JDWP debugger The Dalvik VM supports the JDWP protocol. Each application runs in a VM and exposes a unique port (8700) that you can attach a debugger to via DDMS. DDMS provides a port-forwarding feature that can forward a specific VM's debugging port to port 8700 for debugging multiple ports. You can switch between Apps in the Devices tab of DDMS. Most modern Java IDEs include a JDWP debugger, or you can use a command line debugger such as jdb. Debugging Environment 2

3 ADB Tutorial Start AndroidStudio and run an App on an Android device through a USB port, or start up an AVD (emulator). Open the Android SDK Manager: Select Android SDK; copy the location of the Android SDK. Mobile Applications - Jay Urbain, Ph.D. 3

4 Step 1) Open a command window (or terminal on Mac/Linux) in your Android SKD platform-tools subdirectory: You can find the adb application in <sdk location>/platform- tools/. For example: Windows: C:\Program Files\Android\android-sdk\platform-tools OSX: /Users/jayurbain/Library/Android/sdk/platform-tools Note: You can navigate to <sdk location>/platform- tools/ using Windows Explorer: select the platform-tools subdirectory, and select Shift+Menu and type w to open a command window here. If you have a Mac, you can use a normal Unix terminal and just paste your actual <sdk location>/platform- tools/ path into the terminal. Type adb or adb help to get a listing of available adb commands (Note:./adb on Mac): 4

5 Step 2) General adb command format is as follows: adb [-d -e -s <serialnumber>] <command> To get a list of attached devices and their serial numbers type the following: Mac OSX: Windows: General form of command to attach to a specific device: adb -s <serialnumber> <command> Note: If there is only one device, you do not need the serial number. If you are having trouble with the state of a debugging session with an AVD or an Android device, a good first step is to kill the adb.exe host server and restart it. Try the following: Mac: Windows: 5

6 Step 3 You can install an App with the adb install command as shown below. You should be able to find your project *.apk file under your Android project s bin directory. If the App is already installed you will need to remove it. An easy way to remove an App, is to remove it from the device Application Manager (on the device): Settings -> Application Manager. Download and install the SpinningCubeShader.apk from the course outline. Mac: Windows: 6

7 Step 4 adb allows you to run a command shell. The command shell allows you to run a variety of commands on an emulator or device. The command binaries are stored in the file system of the emulator or device, in this location: /system/bin/... General format of shell command: adb [-d -e -s {<serialnumber>}] shell Example: shell command, directory listing. Mac: Note: If you have only one device or AVD attached you do not need to include the serial number. 7

8 Windows: To list the installed App directories within a shell: ls /system/app The name of each listed directory is the name of an App, each directory contains the app *.apk file. Exit the remote shell by entering CTRL+D or exit. To issue a single command without entering a remote shell, use the shell command as follows: adb [-d -e -s {<serialnumber>}] shell <shellcommand> Example on Mac: 8

9 Step 5 You can use the adb commands pull and push to copy files to and from an emulator/device instance's data file. Unlike the install command, which only copies a *.apk file to a specific location, the pull and push commands let you copy arbitrary directories and files to/from any location on an emulator/device instance. To copy a file or directory (recursively) from the emulator or device: adb pull <remote> <local> To copy a file or directory (recursively) to the emulator or device, use adb push <local> <remote> <local> and <remote> refer to the paths to the target files/directory on your development machine (local) and on the emulator/device instance (remote). Here's example usage:./adb push /Users/jayurbain/Dropbox/Jay/stocks.txt /sdcard/stocks.txt./adb pull /sdcard/stocks.txt stocks.txt 9

10 Step 6 Accessing the sqlite3 database: The sqlite3 binary doesn't always get built for the Android OS builds targeting production devices (user build), only the development builds. If installed, sqlite3 is in /system/xbin. If not installed, I would recommend using an AVD emulator for this portion of the lab. Note: To install sqlite3 on your physical device, you would need to root your device. This basically amounts to installing super user su on your phone so you can install programs in /system/bin. See notes in following section on Installing sqlite3. From an adb remote shell, you can use the sqlite3 command-line program to manage SQLite databases created by different Android applications (similar to the MySql command-line interface). The sqlite3 tool includes many commands, such as.dump to print out the contents of a table and.schema to print the SQL CREATE statement for existing tables. Type.help for a list of commands. Enter.exit to quit. A separate *.db database file exists for each application under /data/data/ To use sqlite3, enter a remote shell on the emulator or device, and enter the sqlite3 command. $ adb -s emulator-5554 shell # sqlite3 /data/data/com.example.google.rss.rssexample/databases/rssitems.db SQLite version Enter ".help" for instructions... enter commands, then quit... # sqlite>.exit The tool also allows you to execute SQLite commands on the fly. You can also specify the full path to the database you want to explore. Emulator/device instances store SQLite3 databases in the folder /data/data/<package_name>/databases/. 10

11 You can also use a recursive directory listing ls R /data/data to find a database files from the shell command: Navigate to your database directory: > cd /data/data/com.jayurbain.databaseactivitydemo/databases > ls comments.db Connect to your database (in this case comments.db : > sqlite3 comments.db SQLite version :35:50 Enter ".help" for instructions Enter SQL statements terminated with a ";" List tables with.table: sqlite>.table android_metadata comments 11

12 Step 7 List db schema with.schema: sqlite>.schema CREATE TABLE android_metadata (locale TEXT); CREATE TABLE comments(_id integer primary key autoincrement, comment text not null); Query db (columns are separated by the pipe ): sqlite> select * from comments; 1 Awesome 2 Not! 3 Awesome 4 Hot! 5 Hot! 6 Hot! If you don t have any tables, you can just create one: sqlite> create table x(name TEXT); sqlite> insert into x values ('Jay'); sqlite> select * from x; Another option for reviewing your App s database files is to pull (copy) your *.db file onto your host machine and run sqlite on your host. Note: They need to be compatible versions, i.e., sqlite 3 since the file format changed significantly between sqlite 2 and 3. 12

13 Step 8 Other useful adb shell commands: dumpsys Dumps system data to the screen dumpstate Dumps state More adb information can be found here: 13

14 Step 9) Running DDMS DDMS is packaged with the Android SDK. It can be accessed from the SDK tools/ directory, or from within Eclipse or Android Studio. From Android Studio: Select Tools -> Android -> Android Device Monitor. There are also icons. When DDMS starts, it connects to the adb. Note: The screens vary based on your version of the SDK. 14

15 Select a process from the Devices tab, and select the update threads icon Mobile Applications - Jay Urbain, Ph.D. : 15

16 Select a process from the Devices tab, select the heap database can icon (along the top of the Devices tab), select the Heap tab in the main window, and initiate garbage collection by selecting the GC button. The display should now update automatically. 16

17 Select a Type to generate an allocation chart: Select your application in the Devices tab, the Threads icon in the Devices tab, then select the Treads tab in the main window to list App threads. Select the Profiling icon in the Devices Tab Mobile Applications - Jay Urbain, Ph.D. to profile your process> 17

18 Memory allocation tracker: File explorer: 18

19 Logcat (lower window) outputs the messages that you print out in your App using the Log class along with other system messages. You can filter messages with the following settings: Verbose Debug Info Warn Error Other DDMS features: The Emulator control tab lets you simulate a phone's voice and data network status. The Telephony Status section of the Emulator control tab lets you change different aspects of the phone's networks status, speed and latency. Spoofing calls or SMS text messages Note: This only works on a simulator not an actual device. On your device, go to Settings->Applications->Development and select "Allow mock locations". Add ACCESS_MOCK_LOCATION permission to AndroidManifest.xml: <?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android=" <uses-permission android:name="android.permission.access_mock_location"> More can be found here: 19

20 Miscellaneous (optional): Take a screenshot (easier within DDMS Icon) adb shell screencap -p perl -pe 's/\x0d\x0a/\x0a/g' > screen.png Power button This command sends the power button event to turn the device on or off. adb shell input keyevent 26 Unlock screen This command sends the event that unlocks the lockscreen on the device. It can be combine with the power button command above to turn on and unlock the device. adb shell input keyevent 82 Print all installed packages adb shell pm list packages -f Clear application data adb shell pm clear PACKAGE_NAME # example adb shell pm clear com.growingwiththeweb.example Logging To show the log stream on your command line. adb logcat Filter by tagname adb logcat -s TAG_NAME adb logcat -s TAG_NAME_1 TAG_NAME_2 #example adb logcat -s TEST adb logcat -s TEST MYAPP Filter by priority To show logs of a specific priority warning and above. adb logcat "*:PRIORITY" # example adb logcat "*:W" 20

21 Here are the priority levels: V - Verbose (lowest priority) D - Debug I - Info W - Warning E - Error F - Fatal S - Silent (highest priority, on which nothing is ever printed) Filter by tagname and priority adb logcat -s TAG_NAME:PRIORITY adb logcat -s TAG_NAME_1:PRIORITY TAG_NAME_2:PRIORITY #example adb logcat -s TEST: W Filter using grep Alternatively the output of logcat can be piped to grep on a system that supports it. adb logcat grep "SEARCH_TERM" adb logcat grep "SEARCH_TERM_1\ SEARCH_TERM_2" #example adb logcat grep "Exception" adb logcat grep "Exception\ Error" Clearing the logcat buffer Use this to clear the buffer to remove any old log data. adb logcat -c Acknowledgement: This lab was developed by Jay Urbain. 21