docs/html/tools/help/monkey.jd

page.title=UI/Application Exerciser Monkey
parent.title=Tools
parent.link=index.html
@jd:body

<p>The Monkey is a program that runs on your 
<a href="{@docRoot}tools/help/emulator.html">emulator</a> or device and generates pseudo-random
streams of user events such as clicks, touches, or gestures, as well as a number of system-level 
events.  You can use the Monkey to stress-test applications that you are developing, in a random 
yet repeatable manner.</p>

<a name="overview"></a>
<h2>Overview</h2>

<p>The Monkey is a command-line tool that you can run on any emulator
instance or on a device.  It sends a pseudo-random stream of 
user events into the system, which acts as a stress test on the application software you are 
developing.</p>

<p>The Monkey includes a number of options, but they break down into four primary
categories:</p>

<ul>
  <li>Basic configuration options, such as setting the number of events to attempt.</li>
  <li>Operational constraints, such as restricting the test to a single package.</li>
  <li>Event types and frequencies.</li>
  <li>Debugging options.</li>
</ul>

<p>When the Monkey runs, it generates events and sends them to the system.  It also <i>watches</i>
the system under test and looks for three conditions, which it treats specially:</p>

<ul>
  <li>If you have constrained the Monkey to run in one or more specific packages, it 
  watches for attempts to navigate to any other packages, and blocks them.</li>
  <li>If your application crashes or receives any sort of unhandled exception, the Monkey
  will stop and report the error.</li>
  <li>If your application generates an <i>application not responding</i> error, the Monkey
  will stop and report the error.</li>
</ul>

<p>Depending on the verbosity level you have selected, you will also see reports on the progress
of the Monkey and the events being generated.</p>

<a name="basics"></a>
<h2>Basic Use of the Monkey</h2>

<p>You can launch the Monkey using a command line on your development machine or from a script. 
Because the Monkey runs in the emulator/device environment, you must launch it from a shell in 
that environment.  You can do this by prefacing <code>adb shell</code> to each command, 
or by entering the shell and entering Monkey commands directly.</p>
<p>The basic syntax is: </p>

<pre>$ adb shell monkey [options] &lt;event-count&gt;</pre>
    
<p>With no options specified, the Monkey will launch in a quiet (non-verbose) mode, and will send 
events to any (and all) packages installed on your target.  Here is a more typical command line,
which will launch your application and send 500 pseudo-random events to it:</p>

<pre>$ adb shell monkey -p your.package.name -v 500</pre>

<a name="reference"></a>
<h2>Command Options Reference</h2>

<p>The table below lists all options you can include on the Monkey command line.</p>

<table>
<tr>
  <th>Category</th>
  <th>Option</th>
  <th>Description</th>
</tr>

<tr>
<td rowspan="2">General</td>
<td><code>--help</code></td>
<td>Prints a simple usage guide.</td>
</tr>

<tr>
<td><code>-v</code></td>
<td>Each -v on the command line will increment the verbosity level.  
Level 0 (the default) provides little information beyond startup notification, test completion, and
final results.  
Level 1 provides more details about the test as it runs, such as individual events being sent to 
your activities.  
Level 2 provides more detailed setup information such as activities selected or not selected for 
testing.</td>
</tr>

<tr>
<td rowspan="10">Events</td>
<td><code>-s &lt;seed&gt;</code></td>
<td>Seed value for pseudo-random number generator.  If you re-run the Monkey with the same seed 
value, it will generate the same sequence of events.</td>
</tr>

<tr>
<td><code>--throttle &lt;milliseconds&gt;</code></td>
<td>Inserts a fixed delay between events.  You can use this option to slow down the Monkey.  
If not specified, there is no delay and the events are generated as rapidly as possible.</td>
</tr>

<tr>
<td><code>--pct-touch &lt;percent&gt;</code></td>
<td>Adjust percentage of touch events.  
(Touch events are a down-up event in a single place on the screen.)</td>
</tr>

<tr>
<td><code>--pct-motion &lt;percent&gt;</code></td>
<td>Adjust percentage of motion events.
(Motion events consist of a down event somewhere on the screen, a series of pseudo-random
movements, and an up event.)</td>
</tr>

<tr>
<td><code>--pct-trackball &lt;percent&gt;</code></td>
<td>Adjust percentage of trackball events.
(Trackball events consist of one or more random movements, sometimes followed by a click.)</td>
</tr>

<tr>
<td><code>--pct-nav &lt;percent&gt;</code></td>
<td>Adjust percentage of "basic" navigation events.
(Navigation events consist of up/down/left/right, as input from a directional input device.)</td>
</tr>

<tr>
<td><code>--pct-majornav &lt;percent&gt;</code></td>
<td>Adjust percentage of "major" navigation events.
(These are navigation events that will typically cause actions within your UI, such as
the center button in a 5-way pad, the back key, or the menu key.)</td>
</tr>

<tr>
<td><code>--pct-syskeys &lt;percent&gt;</code></td>
<td>Adjust percentage of "system" key events.
(These are keys that are generally reserved for use by the system, such as Home, Back, Start Call,
End Call, or Volume controls.)</td>
</tr>

<tr>
<td><code>--pct-appswitch &lt;percent&gt;</code></td>
<td>Adjust percentage of activity launches.  At random intervals, the Monkey will issue a startActivity() call, as a way of maximizing
coverage of all activities within your package.</td>
</tr>

<tr>
<td><code>--pct-anyevent &lt;percent&gt;</code></td>
<td>Adjust percentage of other types of events.  This is a catch-all for all other types of events such as keypresses, other less-used
buttons on the device, and so forth.</td>
</tr>

<tr>
<td rowspan="2">Constraints</td>
<td><code>-p &lt;allowed-package-name&gt;</code></td>
<td>If you specify one or more packages this way, the Monkey will <i>only</i> allow the system
to visit activities within those packages.  If your application requires access to activities in
other packages (e.g. to select a contact) you'll need to specify those packages as well.
If you don't specify any packages, the Monkey will allow the system to launch activities
in all packages.  To specify multiple packages, use the -p option multiple times &mdash; one -p 
option per package.</td>
</tr>

<tr>
<td><code>-c &lt;main-category&gt;</code></td>
<td>If you specify one or more categories this way, the Monkey will <i>only</i> allow the 
system to visit activities that are listed with one of the specified categories.  
If you don't specify any categories, the Monkey will select activities listed with the category
Intent.CATEGORY_LAUNCHER or Intent.CATEGORY_MONKEY.  To specify multiple categories, use the -c
option multiple times &mdash; one -c option per category.</td>
</tr>

<tr>
<td rowspan="8">Debugging</td>
<td><code>--dbg-no-events</code></td>
<td>When specified, the Monkey will perform the initial launch into a test activity, but
will not generate any further events.
For best results, combine with -v, one or more package constraints, and a non-zero throttle to keep the Monkey
running for 30 seconds or more.  This provides an environment in which you can monitor package
transitions invoked by your application.</td>
</tr>

<tr>
<td><code>--hprof</code></td>
<td>If set, this option will generate profiling reports immediately before and after
the Monkey event sequence.
This will generate large (~5Mb) files in data/misc, so use with care.  See 
<a href="{@docRoot}tools/debugging/debugging-tracing.html" title="traceview">Traceview</a> for more information
on trace files.</td>
</tr>

<tr>
<td><code>--ignore-crashes</code></td>
<td>Normally, the Monkey will stop when the application crashes or experiences any type of 
unhandled exception.  If you specify this option, the Monkey will continue to send events to
the system, until the count is completed.</td>
</tr>

<tr>
<td><code>--ignore-timeouts</code></td>
<td>Normally, the Monkey will stop when the application experiences any type of timeout error such
as a "Application Not Responding" dialog.  If you specify this option, the Monkey will continue to 
send events to the system, until the count is completed.</td>
</tr>

<tr>
<td><code>--ignore-security-exceptions</code></td>
<td>Normally, the Monkey will stop when the application experiences any type of permissions error,
for example if it attempts to launch an activity that requires certain permissions.  If you specify
this option, the Monkey will continue to send events to the system, until the count is 
completed.</td>
</tr>

<tr>
<td><code>--kill-process-after-error</code></td>
<td>Normally, when the Monkey stops due to an error, the application that failed will be left
running.  When this option is set, it will signal the system to stop the process in which the error
occurred.
Note, under a normal (successful) completion, the launched process(es) are not stopped, and
the device is simply left in the last state after the final event.</td>
</tr>

<tr>
<td><code>--monitor-native-crashes</code></td>
<td>Watches for and reports crashes occurring in the Android system native code. If --kill-process-after-error is set, the system will stop.</td>
</tr>

<tr>
<td><code>--wait-dbg</code></td>
<td>Stops the Monkey from executing until a debugger is attached to it.</td>
</tr>

</table>

<!-- TODO: add a section called "debugging" that covers ways to use it, 
need to clear data, use of the seed, etc. -->

<!-- TODO: add a section that lays down a contract for Monkey output so it can be
scripted safely. -->