| /* |
| * Copyright (C) 2016 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; |
| |
| import com.android.tradefed.build.IBuildInfo; |
| import com.android.tradefed.config.Option; |
| import com.android.tradefed.device.ITestDevice; |
| import com.android.tradefed.invoker.IInvocationContext; |
| import com.android.tradefed.metrics.proto.MetricMeasurement.Metric; |
| import com.android.tradefed.result.InputStreamSource; |
| import com.android.tradefed.result.LogDataType; |
| import com.android.tradefed.testtype.MetricTestCase.LogHolder; |
| import com.android.tradefed.util.proto.TfMetricProtoUtil; |
| |
| import org.junit.rules.ExternalResource; |
| import org.junit.rules.TestRule; |
| import org.junit.runner.Description; |
| import org.junit.runners.BlockJUnit4ClassRunner; |
| import org.junit.runners.model.InitializationError; |
| import org.junit.runners.model.Statement; |
| |
| import java.lang.annotation.Annotation; |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| |
| /** |
| * JUnit4 test runner that also accommodate {@link IDeviceTest}. Should be specify above JUnit4 Test |
| * with the RunWith annotation. |
| */ |
| public class DeviceJUnit4ClassRunner extends BlockJUnit4ClassRunner |
| implements IDeviceTest, |
| IBuildReceiver, |
| IAbiReceiver, |
| ISetOptionReceiver, |
| IMultiDeviceTest, |
| IInvocationContextReceiver { |
| private ITestDevice mDevice; |
| private IBuildInfo mBuildInfo; |
| private IAbi mAbi; |
| private IInvocationContext mContext; |
| private Map<ITestDevice, IBuildInfo> mDeviceInfos; |
| |
| @Option(name = HostTest.SET_OPTION_NAME, description = HostTest.SET_OPTION_DESC) |
| private List<String> mKeyValueOptions = new ArrayList<>(); |
| |
| public DeviceJUnit4ClassRunner(Class<?> klass) throws InitializationError { |
| super(klass); |
| } |
| |
| /** |
| * We override createTest in order to set the device. |
| */ |
| @Override |
| protected Object createTest() throws Exception { |
| Object testObj = super.createTest(); |
| if (testObj instanceof IDeviceTest) { |
| if (mDevice == null) { |
| throw new IllegalArgumentException("Missing device"); |
| } |
| ((IDeviceTest) testObj).setDevice(mDevice); |
| } |
| if (testObj instanceof IBuildReceiver) { |
| if (mBuildInfo == null) { |
| throw new IllegalArgumentException("Missing build information"); |
| } |
| ((IBuildReceiver) testObj).setBuild(mBuildInfo); |
| } |
| // We are more flexible about abi information since not always available. |
| if (testObj instanceof IAbiReceiver) { |
| ((IAbiReceiver) testObj).setAbi(mAbi); |
| } |
| if (testObj instanceof IMultiDeviceTest) { |
| ((IMultiDeviceTest) testObj).setDeviceInfos(mDeviceInfos); |
| } |
| if (testObj instanceof IInvocationContextReceiver) { |
| ((IInvocationContextReceiver) testObj).setInvocationContext(mContext); |
| } |
| // Set options of test object |
| HostTest.setOptionToLoadedObject(testObj, mKeyValueOptions); |
| return testObj; |
| } |
| |
| @Override |
| public void setDevice(ITestDevice device) { |
| mDevice = device; |
| } |
| |
| @Override |
| public ITestDevice getDevice() { |
| return mDevice; |
| } |
| |
| @Override |
| public void setAbi(IAbi abi) { |
| mAbi = abi; |
| } |
| |
| @Override |
| public IAbi getAbi() { |
| return mAbi; |
| } |
| |
| @Override |
| public void setBuild(IBuildInfo buildInfo) { |
| mBuildInfo = buildInfo; |
| } |
| |
| @Override |
| public void setInvocationContext(IInvocationContext invocationContext) { |
| mContext = invocationContext; |
| } |
| |
| @Override |
| public void setDeviceInfos(Map<ITestDevice, IBuildInfo> deviceInfos) { |
| mDeviceInfos = deviceInfos; |
| } |
| |
| /** |
| * Implementation of {@link ExternalResource} and {@link TestRule}. This rule allows to log |
| * metrics during a test case (inside @Test). It guarantees that the metrics map is cleaned |
| * between tests, so the same rule object can be re-used. |
| * |
| * <pre>Example: |
| * @Rule |
| * public TestMetrics metrics = new TestMetrics(); |
| * |
| * @Test |
| * public void testFoo() { |
| * metrics.put("key", "value"); |
| * metrics.put("key2", "value2"); |
| * } |
| * |
| * @Test |
| * public void testFoo2() { |
| * metrics.put("key3", "value3"); |
| * } |
| * </pre> |
| */ |
| public static class TestMetrics extends ExternalResource { |
| |
| Description mDescription; |
| private Map<String, String> mMetrics = new HashMap<>(); |
| private HashMap<String, Metric> mProtoMetrics = new HashMap<>(); |
| |
| @Override |
| public Statement apply(Statement base, Description description) { |
| mDescription = description; |
| return super.apply(base, description); |
| } |
| |
| /** |
| * Log a metric entry for the test case. Each key within a test case must be unique |
| * otherwise it will override the previous value. |
| * |
| * @param key The key of the metric. |
| * @param value The value associated to the key. |
| */ |
| public void addTestMetric(String key, String value) { |
| mMetrics.put(key, value); |
| } |
| |
| /** |
| * Log a metric entry in proto format for the test case. Each key within a test case must be |
| * unique otherwise it will override the previous value. |
| * |
| * @param key The key of the metric. |
| * @param metric The value associated to the key. |
| */ |
| public void addTestMetric(String key, Metric metric) { |
| mProtoMetrics.put(key, metric); |
| } |
| |
| @Override |
| protected void before() throws Throwable { |
| mMetrics = new HashMap<>(); |
| mProtoMetrics = new HashMap<>(); |
| } |
| |
| @Override |
| protected void after() { |
| // we inject a Description with an annotation carrying metrics. |
| // We have to go around, since Description cannot be extended and RunNotifier |
| // does not give us a lot of flexibility to find our metrics back. |
| mProtoMetrics.putAll(TfMetricProtoUtil.upgradeConvert(mMetrics)); |
| mDescription.addChild( |
| Description.createTestDescription( |
| "METRICS", "METRICS", new MetricAnnotation(mProtoMetrics))); |
| } |
| } |
| |
| /** Fake annotation meant to carry metrics to the reporters. */ |
| public static class MetricAnnotation implements Annotation { |
| |
| public HashMap<String, Metric> mMetrics = new HashMap<>(); |
| |
| public MetricAnnotation(HashMap<String, Metric> metrics) { |
| mMetrics.putAll(metrics); |
| } |
| |
| @Override |
| public Class<? extends Annotation> annotationType() { |
| return null; |
| } |
| } |
| |
| /** |
| * Implementation of {@link ExternalResource} and {@link TestRule}. This rule allows to log logs |
| * during a test case (inside @Test). It guarantees that the log list is cleaned between tests, |
| * so the same rule object can be re-used. |
| * |
| * <pre>Example: |
| * @Rule |
| * public TestLogData logs = new TestLogData(); |
| * |
| * @Test |
| * public void testFoo() { |
| * logs.addTestLog("logcat", LogDataType.LOGCAT, new FileInputStreamSource(logcatFile)); |
| * } |
| * |
| * @Test |
| * public void testFoo2() { |
| * logs.addTestLog("logcat2", LogDataType.LOGCAT, new FileInputStreamSource(logcatFile2)); |
| * } |
| * </pre> |
| */ |
| public static class TestLogData extends ExternalResource { |
| private Description mDescription; |
| private List<LogHolder> mLogs = new ArrayList<>(); |
| |
| @Override |
| public Statement apply(Statement base, Description description) { |
| mDescription = description; |
| return super.apply(base, description); |
| } |
| |
| public final void addTestLog( |
| String dataName, LogDataType dataType, InputStreamSource dataStream) { |
| mLogs.add(new LogHolder(dataName, dataType, dataStream)); |
| } |
| |
| @Override |
| protected void after() { |
| // we inject a Description with an annotation carrying metrics. |
| // We have to go around, since Description cannot be extended and RunNotifier |
| // does not give us a lot of flexibility to find our metrics back. |
| mDescription.addChild( |
| Description.createTestDescription("LOGS", "LOGS", new LogAnnotation(mLogs))); |
| } |
| } |
| |
| /** Fake annotation meant to carry logs to the reporters. */ |
| public static class LogAnnotation implements Annotation { |
| |
| public List<LogHolder> mLogs = new ArrayList<>(); |
| |
| public LogAnnotation(List<LogHolder> logs) { |
| mLogs.addAll(logs); |
| } |
| |
| @Override |
| public Class<? extends Annotation> annotationType() { |
| return null; |
| } |
| } |
| } |