Google is committed to advancing racial equity for Black communities. See how.

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 mDirectoryKeys

Public constructors

FilePullerDeviceMetricCollector()

Public methods

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)

Callback when a test case is ended.

void onTestRunEnd(DeviceMetricData runData, currentRunMetrics)

Callback when a test run is ended.

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

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 data)

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

Protected methods

void addKeys(String... keys)

Adds additional pattern keys to the pull from the device.

File retrieveFile(ITestDevice device, String remoteFilePath)

Pull the file from the specified path in the device.

Fields

mDirectoryKeys

protected  mDirectoryKeys

Public constructors

FilePullerDeviceMetricCollector

public FilePullerDeviceMetricCollector ()

Public methods

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 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(com.android.tradefed.device.metric.DeviceMetricData).

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

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 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(com.android.tradefed.device.metric.DeviceMetricData).

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

processMetricDirectory

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

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 ERROR(/File) pulled from the device matching the option key.

data DeviceMetricData: the DeviceMetricData where metrics can be stored.

processMetricFile

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

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 ERROR(/File) pulled from the device matching the option key.

data DeviceMetricData: the DeviceMetricData where metrics can be stored.

Protected methods

addKeys

protected void addKeys (String... keys)

Adds additional pattern keys to the pull from the device.

Parameters
keys String

retrieveFile

protected File retrieveFile (ITestDevice device, 
                String remoteFilePath)

Pull the file from the specified path in the device.

Parameters
device ITestDevice: which has the file.

remoteFilePath String: location in the device.

Returns
File File retrieved from the given path in the device.

Throws
DeviceNotAvailableException