1CATBOX Trade Federation
2------------------------
3
4CATBOX Trade Federation, catbox-tradefed for short, is the next
5generation test harness for CAT (Complete Automotive Testing).
6
7catbox-tradefed is built on top of the Android Trade Federation test harness.
8
9Configuring catbox-tradefed
10----------------------------
11
121. Ensure 'adb' is in your current PATH. adb can be found in the
13Android SDK available from http://developer.android.com
14
15Example:
16  PATH=$PATH:/home/myuser/android-sdk-linux_x86/platform-tools
17
182. Follow the 'ADB and AAPT' setup steps documented in the
19User Manual. The User Manual can be found at
20https://source.android.com/compatibility/cts/setup#adb
21
223. Connect the device to the host machine.
23
244. Ensure device is visible via 'adb devices'
25
26Using catbox-tradefed
27----------------------
28
29To run a test plan on a single device:
30
311. Make sure you have at least one device connected
322. Launch the catbox-tradefed console by running the 'catbox-tradefed'. If you've
33downloaded and extracted the CATBOX zip, the script can be found at
34  android-catbox/tools/catbox-tradefed
35Or else if you are working from the Android source tree and have run make catbox,
36the script can be found at
37  out/host/linux-x86/catbox/android-catbox/tools/catbox-tradefed
383. Type:
39'run catbox' to run the default CATBOX plan
40
41Some other useful commands are
42
43To run a test module:
44'run catbox --module <module_name>'
45
46To run a specific test:
47'run catbox --test <test_name>'
48
49To shard a plan test run on multiple devices
50'run catbox --shards <number of shards>
51note: all connected devices must be running the same build
52
53For more options:
54'run catbox --help'
55
56CATBOX Tradefed Development
57----------------------------
58See http://source.android.com for instructions on obtaining the Android
59platform source code and setting up a build environment.
60
61The source for the tradefed framework can be found on the 'tradefed' branch.
62
63Perform these steps to build and run catbox-tradefed from the development
64environment:
65cd <path to android source root>
66make catbox
67catbox-tradefed
68
69More documentation and details on using and extending trade federation will
70be forthcoming in the near future.
71
72