Docs: Add list of plans and command ref for CTS v2.
Bug: 27150781
Change-Id: Id1daa1e69a0da48ed30bbf7b5df153f2f770cf8a
diff --git a/src/compatibility/cts/run.jd b/src/compatibility/cts/run.jd
index 68f7da2..660589c 100644
--- a/src/compatibility/cts/run.jd
+++ b/src/compatibility/cts/run.jd
@@ -24,7 +24,7 @@
</div>
</div>
-<h2 id=cts_tradefed>Using the CTS tradefed</h2>
+<h2 id=cts_tradefed>Getting started with CTS tradefed</h2>
<p>See the <a
href="{@docRoot}devices/tech/test_infra/tradefed/index.html">Trade Federation
Overview</a> for an explanation of the Trade Federation (tradefed or TF for
@@ -44,7 +44,8 @@
the folder where the CTS package has been unzipped, e.g.
<code>$ ./android-cts/tools/cts-tradefed</code>
<li>You may start the default test plan (containing all of the test packages) by
- appending: <code>run cts --plan CTS</code> This will kick off all the CTS tests required for compatibility.
+ appending: <code>run cts --plan CTS</code> (or just <code>run cts</code> for v2).
+ This kicks off all the CTS tests required for compatibility.
Enter <code>list plans</code> to see a list of test plans in the repository.
Enter <code>list packages</code> to see a list of test packages in the repository.
See the CTS command
@@ -57,7 +58,11 @@
<li>If your device is Android 5.0 or later and declares support for an ARM and a
x86 ABI, you should run both the ARM and x86 CTS packages.
</ol>
-<h2 id=selecting_cts_plans>Selecting CTS plans</h2>
+
+<h2 id=using-cts-v1>Using the CTS v1 console</h2>
+
+<p>For Android 6.0 or earlier, you'll use CTS v1.</p>
+<h3 id=selecting_cts_plans>Selecting plans</h3>
<p>The following test plans are available:</p>
<ul>
<li><em>CTS</em>—all tests required for compatibility. </li>
@@ -68,10 +73,10 @@
<li><em>Performance</em>—performance tests for your implementation </li>
</ul>
<p>These can be executed with the <code>run cts</code> command.</p>
-<h2 id=cts_reference>CTS console command reference</h2>
+<h3 id=cts_reference>CTS v1 console command reference</h3>
<p class="table-caption" id="console-commands">
- <strong>Table 1.</strong> This table summarizes the CTS console commands for
+ <strong>Table 1.</strong> This table summarizes the CTS v1 console commands for
various uses.</p>
<table>
<tbody>
@@ -183,3 +188,168 @@
</tr>
</tbody>
</table>
+
+<h2 id=using-cts-v2>Using the CTS v2 console</h2>
+
+<p>For Android 7.0 or later, you'll use CTS v2.</p>
+<h3 id=selecting_ctsv2_plans>Selecting plans</h3>
+<p>Available test plans include the following:</p>
+<ul>
+ <li><em>cts</em>—Runs CTS from an pre-existing CTS installation.</li>
+ <li><em>cts-camera</em>— Runs CTS-camera from a pre-existing CTS installation.</li>
+ <li><em>cts-java</em>— Runs Core Java Tests from a pre-existing CTS installation.</li>
+ <li><em>cts-pdk</em>— Runs Tests useful on validating a PDK fusion build.</li>
+ <li><em>everything</em>— Common config for Compatibility suites.</li>
+</ul>
+<p>Other available configurations include the following:</p>
+<ul>
+ <li><em>basic-reporters</em>— Configuration with basic CTS reporters.</li>
+ <li><em>collect-tests-only</em>—Runs CTS from a pre-existing CTS installation.</li>
+ <li><em>common-compatibility-config</em>— Common config for Compatibility suites.</li>
+ <li><em>cts-filtered-sample</em>— Common config for Compatibility suites.</li>
+ <li><em>cts-known-failures</em>— Configuration with CTS known failures.</li>
+ <li><em>cts-preconditions</em>— CTS precondition configs.</li>
+ <li><em>host</em>— Runs a single host-based test on an existing device.</li>
+ <li><em>instrument</em>— Runs a single Android instrumentation test on an existing device.</li>
+ <li><em>native-benchmark</em>— Runs a native stress test on an existing device.</li>
+ <li><em>native-stress</em>— Runs a native stress test on an existing device.</li>
+ <li><em>recharge</em>— A fake test that waits for nearly-discharged devices and holds them for charging.</li>
+ <li><em>testdef</em>— Runs tests contained in test_def.xml files on an existing device.</li>
+ <li><em>util/wifi</em>— Utility config to configure Wi-Fi on device.</li>
+ <li><em>util/wipe</em>— Wipes user data on device.</li>
+</ul>
+<p>All of these plans and configs can be executed with the <code>run cts</code> command.</p>
+
+<h3 id=ctsv2_reference>CTS v2 console command reference</h3>
+
+<p class="table-caption" id="console-commands">
+ <strong>Table 1.</strong> This table summarizes the CTS V2 console commands for
+various uses.</p>
+<table>
+ <tbody>
+ <tr>
+ <th>Host</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>help</code></td>
+ <td>Display a summary of the most commonly used commands</td>
+ </tr>
+ <tr>
+ <td><code>help all</code></td>
+ <td>Display the complete list of available commands</td>
+ </tr>
+ <tr>
+ <td><code>version</code></td>
+ <td>Show the version.</td>
+ </tr>
+ <tr>
+ <td><code>exit</code></td>
+ <td>Gracefully exit the CTS console. Console will close when all currently running tests are finished.</td>
+ </tr>
+ <tr>
+ <th>Run</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>run cts</code></td>
+ <td><p>Run the default CTS plan (that is, the full CTS invocation).</p>
+ <p>The CTS console can accept other commands while tests are in progress.</p>
+ <p>If no devices are connected, the CTS desktop machine (or host) will wait
+ for a device to be connected before starting tests.</p>
+ <p>If more than one device is connected, the CTS host will choose a device automatically.</p></td>
+ </tr>
+ <tr>
+ <td><code>--plan <test_plan_name></code></td>
+ <td>Run the specified test plan.</td>
+ </tr>
+ <tr>
+ <td><code>-- module/-m <test_module_name> [--module/-m <test_module2>...]</code></td>
+ <td>Run the specified test module or modules. For example, <code>run cts --module CtsGestureTestCases</code>
+ executes the gesture test module (this can be shortened to <code>run cts -m Gesture</code>).</br>
+ <code>run cts -m Gesture --test android.gesture.cts.GestureTest#testGetStrokes</code> runs the specific
+ package, class, or test.</td>
+ </tr>
+ <tr>
+ <td><code>-- module/-m <test_module_name> -- test <test_name> </code></td>
+ <td>Run the specified module and test. For example,
+ <code>run cts -m Gesture --test android.gesture.cts.GestureTest#testGetStrokes</code> runs the specific
+ package, class, or test.</td>
+ </tr>
+ <tr>
+ <td><code>--retry</code></td>
+ <td>Retry all tests that failed or were not executed from the previous sessions.
+ Use <code>list results</code> to get the session id.</td>
+ </tr>
+ <tr>
+ <td><code>--shards <number_of_shards></code></td>
+ <td>Shard a CTS run into given number of independent chunks, to run on multiple devices in parallel.</td>
+ </tr>
+ <tr>
+ <td><code>--serial/-s <deviceID></code></td>
+ <td>Run CTS on the specific device.</td>
+ </tr>
+ <tr>
+ <td><code>--abi 32|64</code></td>
+ <td>Forces the test to run on the given ABI. By default CTS runs a test once for each ABI the device supports.</td>
+ </tr>
+ <tr>
+ <td><code>--logcat</code>, <code>--bugreport</code>, and <code>--screenshoot-on-failure</code></td>
+ <td>Give more visibility into failures and can help with diagnostics.</td>
+ </tr>
+ <tr>
+ <td><code>--device-token</code></td>
+ <td>Specifies a given device has the given token eg. <code>--device-token 1a2b3c4d:sim-card.</code>.</td>
+ </tr>
+ <tr>
+ <td><code>--skip-device-info</code></td>
+ <td>Skips collection of information about the device. Note: do not use this option when running CTS for approval.</td>
+ </tr>
+ <tr>
+ <td><code>--skip-preconditions</code></td>
+ <td>Bypasses verification and setup of the device's configuration, such as pushing media files or checking for Wi-Fi connection.</td>
+ </tr>
+ <tr>
+ <th>List</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>list modules</code></td>
+ <td>List all available test modules in the repository.</td.>
+ </tr>
+ <tr>
+ <td><code>list plans</code> or <code>list configs</code></td>
+ <td>List all available test plans (configs) in the repository.</td>
+ </tr>
+ <tr>
+ <td><code>list invocations</code></td>
+ <td>List 'run' commands currently being executed on devices.</td>
+ </tr>
+ <tr>
+ <td><code>list commands</code></td>
+ <td>List all 'run' commands currently in the queue waiting to be assigned to devices.</td>
+ </tr>
+ <tr>
+ <td><code>list results</code></td>
+ <td>List CTS results currently stored in repository.</td>
+ </tr>
+ <tr>
+ <td><code>list devices</code></td>
+ <td>List currently connected devices and their state.
+ <p> </p>
+ <p>'Available' devices are functioning, idle devices, available for running tests.</p>
+ <p> </p>
+ <p>'Unavailable' devices are devices visible via adb, but are not responding to adb commands and won't be allocated for tests.</p>
+ <p> </p>
+ <p>'Allocated' devices are devices currently running tests.</td>
+ </tr>
+ <tr>
+ <th>Dump</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>dump logs</code></td>
+ <td>Dump the tradefed logs for all running invocations.</td>
+ </tr>
+ </tbody>
+</table>
