1VTS Trade Federation
2---------------------
3
4VTS Trade Federation, vts-tradefed for short, is the next generation test
5harness for VTS.
6
7vts-tradefed is built on top of the Android Trade Federation test harness.
8
9It works in a similar manner to the prior VTS harness, but with much
10simplicity.
11
12  - tests all run through Trade Federation without python wrapper, thus no
13virtualenv is needed.
14  - supports sharding a VTS test run across multiple devices in parallel
15  - supports Trade Federation suite features including auto-retry.
16
17Configuring vts-tradefed
18------------------------
19
201. Ensure 'adb' is in your current PATH. adb can be found in the
21Android SDK available from http://developer.android.com
22
23Example:
24  PATH=$PATH:/home/myuser/android-sdk-linux_x86/platform-tools
25
262. Follow the 'Setting up your device' steps documented in the VTS User Manual.
27# TODO: add link for documentation.
28
293. Connect the device to the host machine.
30
314. Ensure device is visible via 'adb devices'
32
33Using vts-tradefed
34-------------------
35
36To run a test plan on a single device:
37
381. Make sure you have at least one device connected
392. Launch the vts-tradefed console by running the 'vts-tradefed'. If you've
40downloaded and extracted the VTS zip, the script can be found at
41android-vts/tools/vts-tradefed
42Or else if you are working from the Android source tree and have run `make
43vts`, the script can be found at
44  out/host/linux-x86/vts/android-vts/tools/vts-tradefed
453. Type:
46'run vts' to run the default VTS plan
47
48Some other useful commands are
49
50To run a test module:
51'run vts --module <module_name>'
52
53To run a specific test:
54'run vts --module <module_name> --test <test_name>'
55
56To shard a plan test run on multiple devices
57'run vts --shard-count <number of shards>
58note: all connected devices must be running the same build
59
60For more options:
61'run vts --help'
62
63VTS Tradefed Development
64------------------------
65See http://source.android.com for instructions on obtaining the Android
66platform source code and setting up a build environment.
67
68The source for the VTS extensions for tradefed can be found at
69<android source root>/test/vts/tools/vts-tradefed
70
71The source for the tradefed framework can be found on the 'tradefed' branch.
72
73Perform these steps to build and run vts-tradefed from the development
74environment:
75cd <path to android source root>
76make vts
77vts-tradefed
78
79More documentation and details on using and extending trade federation will
80be forthcoming in the near future.
81
82