FilePullerDeviceMetricCollector

public abstract class FilePullerDeviceMetricCollector
extends BaseDeviceMetricCollector

java.lang.Object
   ↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector
     ↳ com.android.tradefed.device.metric.FilePullerDeviceMetricCollector


A BaseDeviceMetricCollector that listen for metrics key coming from the device and pull them as a file from the device. Can be extended for extra-processing of the file.

Summary

Fields

protected List<String> mDirectoryKeys

Public constructors

FilePullerDeviceMetricCollector()

Public methods

void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

Callback when a test case is ended.

void onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)

Callback when a test run is ended.

abstract void processMetricDirectory(String key, File metricDirectory, DeviceMetricData runData)

Implementation of the method should allow to log the directory, parse it for metrics to be put in DeviceMetricData.

abstract void processMetricFile(String key, File metricFile, DeviceMetricData runData)

Implementation of the method should allow to log the file, parse it for metrics to be put in DeviceMetricData.

Fields

mDirectoryKeys

protected List<String> mDirectoryKeys

Public constructors

FilePullerDeviceMetricCollector

public FilePullerDeviceMetricCollector ()

Public methods

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

Callback when a test case is ended. This should be the time for clean up.

Parameters
testData DeviceMetricData: the DeviceMetricData holding the data for the test case. Will be the same object as during BaseDeviceMetricCollector.onTestStart(DeviceMetricData).

currentTestCaseMetrics Map: the current map of metrics passed to ITestLifeCycleReceiver.testEnded(TestDescription, Map).

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                Map<String, MetricMeasurement.Metric> currentRunMetrics)

Callback when a test run is ended. This should be the time for clean up.

Parameters
runData DeviceMetricData: the DeviceMetricData holding the data for the run. Will be the same object as during BaseDeviceMetricCollector.onTestRunStart(DeviceMetricData).

currentRunMetrics Map: the current map of metrics passed to ITestLifeCycleReceiver.testRunEnded(long, Map).

processMetricDirectory

public abstract void processMetricDirectory (String key, 
                File metricDirectory, 
                DeviceMetricData runData)

Implementation of the method should allow to log the directory, parse it for metrics to be put in DeviceMetricData.

Parameters
key String: the option key associated to the directory that was pulled.

metricDirectory File: the File pulled from the device matching the option key.

runData DeviceMetricData: the run DeviceMetricData where metrics can be stored.

processMetricFile

public abstract void processMetricFile (String key, 
                File metricFile, 
                DeviceMetricData runData)

Implementation of the method should allow to log the file, parse it for metrics to be put in DeviceMetricData.

Parameters
key String: the option key associated to the file that was pulled.

metricFile File: the File pulled from the device matching the option key.

runData DeviceMetricData: the run DeviceMetricData where metrics can be stored.