xref: /aosp_15_r20/test/cts-root/tools/cts-root-tradefed/README (revision fc9e02cc466b32ca348fe8172a44255464d9ce4e)
1*fc9e02ccSAndroid Build Coastguard WorkerCTS-Root Trade Federation
2*fc9e02ccSAndroid Build Coastguard Worker-------------------------
3*fc9e02ccSAndroid Build Coastguard Worker
4*fc9e02ccSAndroid Build Coastguard WorkerCTS-Root Trade Federation, cts-root-tradefed for short, is built on
5*fc9e02ccSAndroid Build Coastguard Workertop of the Android Trade Federation test harness for general compatibility tests
6*fc9e02ccSAndroid Build Coastguard Workerthat require root privileges or a debuggable device to run.
7*fc9e02ccSAndroid Build Coastguard Worker
8*fc9e02ccSAndroid Build Coastguard WorkerConfiguring cts-root-tradefed
9*fc9e02ccSAndroid Build Coastguard Worker-----------------------------
10*fc9e02ccSAndroid Build Coastguard Worker
11*fc9e02ccSAndroid Build Coastguard WorkerEnsure 'adb' is in your current PATH. adb can be found in the
12*fc9e02ccSAndroid Build Coastguard WorkerAndroid SDK available from http://developer.android.com
13*fc9e02ccSAndroid Build Coastguard Worker
14*fc9e02ccSAndroid Build Coastguard WorkerExample:
15*fc9e02ccSAndroid Build Coastguard Worker  PATH=$PATH:/home/myuser/android-sdk-linux_x86/platform-tools
16*fc9e02ccSAndroid Build Coastguard Worker
17*fc9e02ccSAndroid Build Coastguard WorkerAnd ensure device is visible via 'adb devices'
18*fc9e02ccSAndroid Build Coastguard Worker
19*fc9e02ccSAndroid Build Coastguard WorkerUsing cts-root-tradefed
20*fc9e02ccSAndroid Build Coastguard Worker-----------------------
21*fc9e02ccSAndroid Build Coastguard Worker
22*fc9e02ccSAndroid Build Coastguard WorkerTo run a test plan on a single device:
23*fc9e02ccSAndroid Build Coastguard Worker
24*fc9e02ccSAndroid Build Coastguard Worker1. Make sure you have at least one device connected
25*fc9e02ccSAndroid Build Coastguard Worker2. Launch the cts-root-tradefed console by running 'cts-root-tradefed'. If you
26*fc9e02ccSAndroid Build Coastguard Workerare working from the Android source tree and have run 'm cts_root',
27*fc9e02ccSAndroid Build Coastguard Workerthe script can be found at
28*fc9e02ccSAndroid Build Coastguard Worker  out/host/linux-x86/ats/android-cts_root/tools/cts-root-tradefed
29*fc9e02ccSAndroid Build Coastguard Worker3. Type:
30*fc9e02ccSAndroid Build Coastguard Worker'run cts-root' to run the default MTS plan
31*fc9e02ccSAndroid Build Coastguard Worker
32*fc9e02ccSAndroid Build Coastguard WorkerSome other useful commands are
33*fc9e02ccSAndroid Build Coastguard Worker
34*fc9e02ccSAndroid Build Coastguard WorkerTo run a test module:
35*fc9e02ccSAndroid Build Coastguard Worker'run cts-root --module <module_name>'
36*fc9e02ccSAndroid Build Coastguard Worker
37*fc9e02ccSAndroid Build Coastguard WorkerTo run a specific test:
38*fc9e02ccSAndroid Build Coastguard Worker'run cts-root --test <test_name>'
39*fc9e02ccSAndroid Build Coastguard Worker
40*fc9e02ccSAndroid Build Coastguard WorkerTo shard a plan test run on multiple devices
41*fc9e02ccSAndroid Build Coastguard Worker'run cts-root --shards <number of shards>
42*fc9e02ccSAndroid Build Coastguard Workernote: all connected devices must be running the same build
43*fc9e02ccSAndroid Build Coastguard Worker
44*fc9e02ccSAndroid Build Coastguard WorkerFor more options:
45*fc9e02ccSAndroid Build Coastguard Worker'run cts-root --help'
46*fc9e02ccSAndroid Build Coastguard Worker
47*fc9e02ccSAndroid Build Coastguard WorkerCTS-Root Tradefed Development
48*fc9e02ccSAndroid Build Coastguard Worker-----------------------------
49*fc9e02ccSAndroid Build Coastguard WorkerSee http://source.android.com for instructions on obtaining the Android
50*fc9e02ccSAndroid Build Coastguard Workerplatform source code and setting up a build environment.
51*fc9e02ccSAndroid Build Coastguard Worker
52*fc9e02ccSAndroid Build Coastguard WorkerThe source for the tradefed framework can be found on the 'tradefed' branch.
53*fc9e02ccSAndroid Build Coastguard Worker
54*fc9e02ccSAndroid Build Coastguard WorkerPerform these steps to build and run cts-root-tradefed from the development
55*fc9e02ccSAndroid Build Coastguard Workerenvironment:
56*fc9e02ccSAndroid Build Coastguard Workercd <path to android source root>
57*fc9e02ccSAndroid Build Coastguard Workerm cts_root
58*fc9e02ccSAndroid Build Coastguard Workercts-root-tradefed
59*fc9e02ccSAndroid Build Coastguard Worker
60