README
1CTS Trade Federation
2---------------------
3
4CTS Trade Federation, cts-tradefed for short, is the next
5generation test harness for CTS.
6
7cts-tradefed is built on top of the Android Trade Federation test harness.
8
9It works in a similar manner to the prior CTS harness, but supports some
10advanced features such as:
11
12 - modular, flexible extensible design. cts-tradefed can be extended to
13support running CTS in a continuous test environment.
14 - supports sharding a CTS test run across multiple devices in parallel
15 - automatically continue a CTS test run on another device if connection
16is lost
17
18Configuring cts-tradefed
19------------------------
20
211. Ensure 'adb' is in your current PATH. adb can be found in the
22Android SDK available from http://developer.android.com
23
24Example:
25 PATH=$PATH:/home/myuser/android-sdk-linux_x86/platform-tools
26
272. Follow the 'Setting up your device' steps documented in the
28CTS User Manual. The CTS User Manual can be downloaded at
29http://source.android.com/compatibility/downloads.html
30
313. Connect the device to the host machine.
32
334. Ensure device is visible via 'adb devices'
34
35Using cts-tradefed
36-------------------
37
38To run a test plan on a single device:
39
401. Make sure you have at least one device connected
412. Launch the cts-tradefed console by running the 'cts-tradefed' script at
42android-cts/tools/cts-tradefed
433. Type:
44'run cts --plan CTS' to run the default CTS plan
45
46Some other useful commands are
47
48To run a test package:
49'run cts --package <packagename>'
50
51To run a test class:
52'run cts --class <full test class name>'
53
54To shard a plan test run on multiple devices
55'run cts --plan CTS --shards <number of shards>
56note: all connected devices must be running the same build
57
58For more options:
59'run cts --help'
60
61CTS Tradefed Development
62------------------------
63See http://source.android.com for instructions on obtaining the Android
64platform source code and setting up a build environment.
65
66The source for the CTS extensions for tradefed can be found at
67<android source root>/cts/tools/tradefed-host
68
69The source for the tradefed framework can be found on the 'tradefed' branch.
70
71Perform these steps to build and run cts-tradefed from the development
72environment:
73cd <path to android source root>
74make cts
75cts-tradefed
76
77More documentation and details on using and extending trade federation will
78be forthcoming in the near future.
79
80