1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.tradefed.testtype.suite;
import com.android.tradefed.config.ConfigurationException;
import com.android.tradefed.config.IConfiguration;
import com.android.tradefed.config.OptionCopier;
import com.android.tradefed.targetprep.ITargetPreparer;
import com.android.tradefed.targetprep.multi.IMultiTargetPreparer;
import com.android.tradefed.testtype.IAbiReceiver;
import com.android.tradefed.testtype.IRemoteTest;
import com.android.tradefed.testtype.IShardableTest;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map.Entry;
/**
* Helper to split a list of modules represented by {@link IConfiguration} into a list of execution
* units represented by {@link ModuleDefinition}.
*
* <p>Each configuration may generate 1 or more {@link ModuleDefinition} depending on its options
* and test types:
*
* <ul>
* <li>A non-shardable {@link IConfiguration} will generate a single {@link ModuleDefinition}.
* <li>A shardable {@link IConfiguration} will generate a number of ModuleDefinition linked to the
* {@link IRemoteTest} properties:
* <ul>
* <li>A non - {@link IShardableTest} will generate a single ModuleDefinition.
* <li>A {@link IShardableTest} generates one ModuleDefinition per tests returned by {@link
* IShardableTest#split()}.
* </ul>
*
* </ul>
*/
public class ModuleSplitter {
/**
* Create a List of executable unit {@link ModuleDefinition}s based on the map of configuration
* that was loaded.
*
* @param runConfig {@link LinkedHashMap} loaded from {@link ITestSuite#loadTests()}.
* @param shardCount a shard count hint to help with sharding.
* @return List of {@link ModuleDefinition}
*/
public static List<ModuleDefinition> splitConfiguration(
LinkedHashMap<String, IConfiguration> runConfig,
int shardCount,
boolean dynamicModule) {
if (dynamicModule) {
// We maximize the sharding for dynamic to reduce time difference between first and
// last shard as much as possible. Overhead is low due to our test pooling.
shardCount *= 2;
}
List<ModuleDefinition> runModules = new ArrayList<>();
for (Entry<String, IConfiguration> configMap : runConfig.entrySet()) {
validateConfig(configMap.getValue());
createAndAddModule(
runModules,
configMap.getKey(),
configMap.getValue(),
shardCount,
dynamicModule);
}
return runModules;
}
private static void createAndAddModule(
List<ModuleDefinition> currentList,
String moduleName,
IConfiguration config,
int shardCount,
boolean dynamicModule) {
// If this particular configuration module is declared as 'not shardable' we take it whole
// but still split the individual IRemoteTest in a pool.
if (config.getConfigurationDescription().isNotShardable()
|| (!dynamicModule
&& config.getConfigurationDescription().isNotStrictShardable())) {
for (int i = 0; i < config.getTests().size(); i++) {
if (dynamicModule) {
ModuleDefinition module =
new ModuleDefinition(
moduleName,
config.getTests(),
clonePreparers(config.getTargetPreparers()),
clonePreparers(config.getMultiTargetPreparers()),
config.getConfigurationDescription());
currentList.add(module);
} else {
addModuleToListFromSingleTest(
currentList, config.getTests().get(i), moduleName, config);
}
}
return;
}
// If configuration is possibly shardable we attempt to shard it.
for (IRemoteTest test : config.getTests()) {
if (test instanceof IShardableTest) {
Collection<IRemoteTest> shardedTests = ((IShardableTest) test).split(shardCount);
if (shardedTests != null) {
// Test did shard we put the shard pool in ModuleDefinition which has a polling
// behavior on the pool.
if (dynamicModule) {
for (int i = 0; i < shardCount; i++) {
ModuleDefinition module =
new ModuleDefinition(
moduleName,
shardedTests,
clonePreparers(config.getTargetPreparers()),
clonePreparers(config.getMultiTargetPreparers()),
config.getConfigurationDescription());
currentList.add(module);
}
} else {
// We create independent modules with each sharded test.
for (IRemoteTest moduleTest : shardedTests) {
addModuleToListFromSingleTest(
currentList, moduleTest, moduleName, config);
}
}
continue;
}
}
// test is not shardable or did not shard
addModuleToListFromSingleTest(currentList, test, moduleName, config);
}
}
/**
* Helper to add a new {@link ModuleDefinition} to our list of Modules from a single {@link
* IRemoteTest}.
*/
private static void addModuleToListFromSingleTest(
List<ModuleDefinition> currentList,
IRemoteTest test,
String moduleName,
IConfiguration config) {
List<IRemoteTest> testList = new ArrayList<>();
testList.add(test);
ModuleDefinition module =
new ModuleDefinition(
moduleName,
testList,
clonePreparers(config.getTargetPreparers()),
clonePreparers(config.getMultiTargetPreparers()),
config.getConfigurationDescription());
currentList.add(module);
}
private static void validateConfig(IConfiguration config) {
if (!ValidateSuiteConfigHelper.validateConfig(config)) {
throw new RuntimeException(
new ConfigurationException(
String.format(
"Configuration %s cannot be run in a suite.",
config.getName())));
}
}
/**
* Deep clone a list of {@link ITargetPreparer} or {@link IMultiTargetPreparer}. We are ensured
* to find a default constructor with no arguments since that's the expectation from Tradefed
* when loading configuration. Cloning preparers is required since they may be stateful and we
* cannot share instance across devices.
*/
private static <T> List<T> clonePreparers(List<T> preparerList) {
List<T> clones = new ArrayList<>();
for (T prep : preparerList) {
try {
@SuppressWarnings("unchecked")
T clone = (T) prep.getClass().newInstance();
OptionCopier.copyOptions(prep, clone);
// Ensure we copy the Abi too.
if (clone instanceof IAbiReceiver) {
((IAbiReceiver) clone).setAbi(((IAbiReceiver) prep).getAbi());
}
clones.add(clone);
} catch (InstantiationException | IllegalAccessException | ConfigurationException e) {
throw new RuntimeException(e);
}
}
return clones;
}
}
|
