1page.title=Option Handling 2@jd:body 3 4<!-- 5 Copyright 2015 The Android Open Source Project 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18--> 19<div id="qv-wrapper"> 20 <div id="qv"> 21 <h2>In this document</h2> 22 <ol id="auto-toc"> 23 </ol> 24 </div> 25</div> 26 27<p>Option handling lies at the heart of Trade Federation's modular approach. In particular, options 28are the mechanism by which the Developer, Integrator, and Test Runner can work together without 29having to duplicate each-other's work. Put simply, our implementation of option handling allows the 30Developer to mark a Java class member as being configurable, at which point the value of that member 31may be augmented or overridden by the Integrator, and may be subsequently augmented or overridden by 32the Test Runner. This mechanism works for all Java intrinsic types, as well as for any 33<code>Map</code>s or <code>Collection</code>s of intrinsic types.</p> 34 35<p class="note"><strong>Note:</strong> The option-handling mechanism only works for classes implementing one of the 36interfaces included in the <a href="lifecycle.html">Test Lifecycle</a>, and only when that class is 37<em>instantiated</em> by the lifecycle machinery.</p> 38 39<h2 id="developer">Developer</h2> 40<p>To start off, the developer marks a member with the 41<code><a href="https://android.googlesource.com/platform/tools/tradefederation/+/master/src/com/android/tradefed/config/Option.java" 42>@Option</a></code> annotation. <!-- note: javadoc for the Option class is broken --> 43They specify (at a minimum) the <code>name</code> and <code>description</code> values, which 44specify the argument name associated with that Option, and the description that will be displayed on 45the TF console when the command is run with <code>--help</code> or <code>--help-all</code>.</p> 46 47<p>As an example, let's say we want to build a functional phone test which will dial a variety of 48phone numbers, and will expect to receive a sequence of DTMF tones from each number after it 49connects.</p> 50<code><pre>public class PhoneCallFuncTest extends IRemoteTest { 51 @Option(name = "timeout", description = "How long to wait for connection, in millis") 52 private long mWaitTime = 30 * 1000; // 30 seconds 53 54 @Option(name = "call", description = "Key: Phone number to attempt. " + 55 "Value: DTMF to expect. May be repeated.") 56 private Map<String, String> mCalls = new HashMap<String, String>; 57 58 public PhoneCallFuncTest() { 59 mCalls.add("123-456-7890", "01134"); // default 60 }</pre></code> 61 62<p>That's all that's required for the Developer to set up two points of configuration for that 63test. They could then go off and use <code>mWaitTime</code> and <code>mCalls</code> as normal, 64without paying much attention to the fact that they're configurable. Because the 65<code>@Option</code> fields are set after the class is instantiated, but before the 66<code>run</code> method is called, that provides an easy way for implementors to set up defaults for 67or perform some kind of filtering on <code>Map</code> and <code>Collection</code> fields, which are 68otherwise append-only.</p> 69 70<h2 id="integrator">Integrator</h2> 71<p>The Integrator works in the world of Configurations, which are written in XML. The config format 72allows the Integrator to set (or append) a value for any <code>@Option</code> field. For instance, 73suppose the Integrator wanted to define a lower-latency test that calls the default number, as well 74as a long-running test that calls a variety of numbers. They could create a pair of configurations 75that might look like the following:</p> 76 77<code><pre><?xml version="1.0" encoding="utf-8"?> 78<configuration description="low-latency default test; low-latency.xml"> 79 <test class="com.example.PhoneCallFuncTest"> 80 <option name="timeout" value="5000" /> 81 </test> 82</configuration></pre></code> 83 84<code><pre><?xml version="1.0" encoding="utf-8"?> 85<configuration description="call a bunch of numbers; many-numbers.xml"> 86 <test class="com.example.PhoneCallFuncTest"> 87 <option name="call" key="111-111-1111" value="#*#*TEST1*#*#" /> 88 <option name="call" key="222-222-2222" value="#*#*TEST2*#*#" /> 89 <!-- ... --> 90 </test> 91</configuration></pre></code> 92 93<h2 id="testrunner">Test Runner</h2> 94<p>The Test Runner also has access to these configuration points via the Trade Federation console. 95First and foremost, they will run a Command (that is, a config and all of its arguments) with the 96<code>run command <name></code> instruction (or <code>run <name></code> for short). 97Beyond that, they can specify any list of arguments are part of the command, which may replace or 98append to fields specified by Lifecycle Objects within each config.</p> 99 100<p>To run the low-latency test with the <code>many-numbers</code> phone numbers, the Test Runner 101could execute:</p> 102<code><pre>tf >run low-latency.xml --call 111-111-1111 #*#*TEST1*#*# --call 222-222-2222 #*#*TEST2*#*#</pre></code> 103 104<p>Or, to get a similar effect from the opposite direction, the Test Runner could reduce the wait time 105for the <code>many-numbers</code> test:</p> 106<code><pre>tf >run many-numbers.xml --timeout 5000</code></pre> 107