BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Object
   ↳ com.android.tradefed.postprocessor.BasePostProcessor

القاعدة IPostProcessor التي يجب أن تمتد إليها كل عملية تنفيذ تأكَّد من استدعاء طرق المعالجة بعد قبل أدوات إعداد تقارير النتائج النهائية.

ملخّص

وظائف الإنشاء العامة

BasePostProcessor()

الطرق العامة

final ITestInvocationListener init(ITestInvocationListener listener)

خطوة الإعداد لمحرر الصور.

final void invocationEnded(long elapsedTime)

تُستخدَم لتسجيل انتهاء طلب الاستدعاء، سواءً بنجاح أو بسبب خطأ.

final void invocationFailed(FailureDescription failure)

الإبلاغ عن طلب غير مكتمل بسبب بعض حالات الخطأ

final void invocationFailed(Throwable cause)

الإبلاغ عن طلب غير مكتمل بسبب بعض حالات الخطأ

void invocationSkipped(SkipReason reason)

الإبلاغ عن طلب استدعاء كطلب تم تخطّيه

final void invocationStarted(IInvocationContext context)

أدوات مراقبة عمليات الاستدعاء لإعادة التوجيه

final boolean isDisabled()

تعرِض هذه الدالة القيمة True إذا كان العنصر بأكمله غير مفعَّل (يتم تخطّي كلّ من الإعداد والتفكيك).

final void logAssociation(String dataName, LogFile logFile)

في بعض الحالات، يجب أن يكون السجلّ مرتبطًا ارتباطًا وثيقًا بحالات الاختبار، ولكن لا يمكن إجراء ذلك في عملية callback المباشرة testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile).

تعديل عملية ربط السجلّ بالاختبار

processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

يمكنك تنفيذ هذه الطريقة لتجميع المقاييس والسجلّات في جميع الاختبارات.

abstract processRunMetricsAndLogs( rawMetrics, runLogs)

يمكنك تنفيذ هذه الطريقة لإنشاء مجموعة من المقاييس الجديدة من المقاييس الحالية وملفّات log.

processTestMetricsAndLogs(TestDescription testDescription, testMetrics, testLogs)

يمكنك تنفيذ هذه الطريقة لنشر المقاييس والسجلّات من كل اختبار.

final void setLogSaver(ILogSaver logSaver)

اضبط ILogSaver للسماح للمنفِّذ بحفظ الملفات.

void setUp()

يمكنك إلغاء هذه الطريقة في معالجات ما بعد المعالجة الفرعية لبدء التشغيل قبل تنفيذ الاختبار.

final void testAssumptionFailure(TestDescription test, String trace)

يتمّ استدعاؤه عندما يُبلغ اختبار ذري عن أنّه يفترض شرطًا غير صحيح.

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

يتمّ استدعاؤه عندما يُبلغ اختبار ذري عن أنّه يفترض شرطًا غير صحيح.

final void testEnded(TestDescription test, long endTime, testMetrics)

بديل ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) حيث يمكننا تحديد وقت الانتهاء مباشرةً.

final void testEnded(TestDescription test, testMetrics)

يُبلِغ عن نهاية تنفيذ نموذج اختبار فردي.

final void testFailed(TestDescription test, FailureDescription failure)

الإبلاغ عن تعذُّر حالة اختبار فردية

final void testFailed(TestDescription test, String trace)

الإبلاغ عن تعذُّر حالة اختبار فردية

final void testIgnored(TestDescription test)

يتمّ استدعاؤه عندما لا يتمّ تنفيذ اختبار، وذلك بشكل عام لأنّ طريقة اختبار تمّت إضافة تعليق توضيحي إليها باستخدام علامة ‎@org.junit.Ignore.

final void testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)

استخدِم هذه الطريقة لتسجيل ملف من عملية تنفيذ PostProcessor.

final void testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

يتمّ استدعاء هذه الدالة عند حفظ سجلّ الاختبار.

final void testModuleEnded()

الإبلاغ عن نهاية تشغيل وحدة

final void testModuleStarted(IInvocationContext moduleContext)

الإبلاغ عن بدء تشغيل وحدة

final void testRunEnded(long elapsedTime, runMetrics)

الإبلاغ عن نهاية عملية الاختبار

final void testRunFailed(FailureDescription failure)

تعذّر إكمال تشغيل اختبار التقارير بسبب خطأ وصفه FailureDescription.

final void testRunFailed(String errorMessage)

تعذّر إكمال تشغيل اختبار التقارير بسبب خطأ فادح.

final void testRunStarted(String runName, int testCount, int attemptNumber)

الإبلاغ عن بدء عملية تنفيذ اختبار

final void testRunStarted(String runName, int testCount)

طلبات معاودة الاتصال في اختبار التنفيذ

final void testRunStarted(String runName, int testCount, int attemptNumber, long startTime)

الإبلاغ عن بدء عملية تنفيذ اختبار

final void testRunStopped(long elapsedTime)

توقّف تشغيل اختبار التقارير قبل اكتماله بناءً على طلب أحد المستخدِمين.

final void testSkipped(TestDescription test, SkipReason reason)

يتمّ استدعاؤه عند تخطّي اختبار وعدم تنفيذه لسبب غير متوقّع عادةً.

final void testStarted(TestDescription test, long startTime)

بديل عن testStarted(com.android.tradefed.result.TestDescription) حيث نحدّد أيضًا وقت بدء الاختبار ، مع ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) لإجراء قياس دقيق.

final void testStarted(TestDescription test)

طلبات معاودة الاتصال لحالات الاختبار

الطرق المحمية

void cleanUp()
MetricMeasurement.DataType getMetricType()

يمكنك إلغاء هذه الطريقة لتغيير نوع المقياس إذا لزم الأمر.

String getRunName()

وظائف الإنشاء العامة

BasePostProcessor

public BasePostProcessor ()

الطرق العامة

init

public final ITestInvocationListener init (ITestInvocationListener listener)

خطوة الإعداد لمحرر الصور. يتم ضمان استدعائه قبل أي من اختبارات callbacks.

المعلمات
listener ITestInvocationListener

المرتجعات
ITestInvocationListener

invocationEnded

public final void invocationEnded (long elapsedTime)

تُستخدَم لتسجيل انتهاء طلب الاستدعاء، سواءً بنجاح أو بسبب خطأ.

سيتم استدعاؤه تلقائيًا من خلال إطار عمل TradeFederation.

المعلمات
elapsedTime ‫long: الوقت المنقضي منذ بدء الطلب بالملي ثانية

invocationFailed

public final void invocationFailed (FailureDescription failure)

الإبلاغ عن طلب غير مكتمل بسبب بعض حالات الخطأ

سيتم استدعاؤه تلقائيًا من خلال إطار عمل TradeFederation.

المعلمات
failure FailureDescription: FailureDescription الذي يصف سبب تعذُّر الإجراء

invocationFailed

public final void invocationFailed (Throwable cause)

الإبلاغ عن طلب غير مكتمل بسبب بعض حالات الخطأ

سيتم استدعاؤه تلقائيًا من خلال إطار عمل TradeFederation.

المعلمات
cause Throwable: Throwable سبب الخطأ

invocationSkipped

public void invocationSkipped (SkipReason reason)

الإبلاغ عن طلب استدعاء كطلب تم تخطّيه

المعلمات
reason SkipReason

invocationStarted

public final void invocationStarted (IInvocationContext context)

أدوات مراقبة عمليات الاستدعاء لإعادة التوجيه

المعلمات
context IInvocationContext: معلومات عن الاستدعاء

isDisabled

public final boolean isDisabled ()

تعرِض هذه الدالة القيمة True إذا كان العنصر بأكمله غير مفعَّل (يتم تخطّي كلّ من الإعداد والتفكيك). خطأ بخلاف ذلك.

المرتجعات
boolean

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

في بعض الحالات، يجب أن يكون السجلّ مرتبطًا ارتباطًا وثيقًا بحالات الاختبار، ولكن لا يمكن إجراء ذلك في عملية callback المباشرة testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile). وبالتالي، يسمح هذا المرجع العكسي بتوفير ارتباط قوي بشكل صريح.

تعديل عملية ربط السجلّ بالاختبار إذا تمّ استدعاء هذه الطريقة أثناء الاختبار، يعني ذلك أنّ السجلّ belongs to the test، وإلا سيكون سجلّ تشغيل.

المعلمات
dataName String: اسم البيانات
logFile LogFile: LogFile التي تم تسجيلها من قبل ويجب أن تكون مرتبطة بحالة الاختبار

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

يمكنك تنفيذ هذه الطريقة لتجميع المقاييس والسجلّات في جميع الاختبارات. سيتم تسجيل المقاييس الناتجة عن هذه الطريقة على أنّها مقاييس عمليات التنفيذ. يجب عدم عرض سوى المقاييس التي تم إنشاؤها حديثًا ، ويجب أن يكون لها اسم مفتاح فريد (لا يُسمح بحدوث تعارض مع المفاتيح الحالية).

المعلمات
allTestMetrics ‫ListMultimap: HashMultimap لتخزين المقاييس من كل اختبار مجمّعة حسب أسماء المقاييس

allTestLogs : خريطة تخزِّن خريطة كل اختبار لملفات السجلّات مفعَّلة حسب أسماء البيانات، باستخدام TestDescription لكل اختبار كمفاتيح.
المرتجعات
مجموعة المقاييس التي تم إنشاؤها حديثًا من جميع مقاييس الاختبار

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

يمكنك تنفيذ هذه الطريقة لإنشاء مجموعة من المقاييس الجديدة من المقاييس الحالية وملفّات log. يجب عرض المقاييس التي تم إنشاؤها حديثًا فقط، ويجب أن يكون لها اسم مفتاح فريد (لا يُسمح بحدوث تعارض مع المفاتيح الحالية).

المعلمات
rawMetrics : مجموعة المقاييس الأوّلية المتاحة للتنفيذ
runLogs : مجموعة ملفات السجلّ لتشغيل الاختبار
المرتجعات
مجموعة المقاييس التي تم إنشاؤها حديثًا من مقاييس الأداء

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

يمكنك تنفيذ هذه الطريقة لنشر المقاييس والسجلّات من كل اختبار. يجب عرض المقاييس التي تم إنشاؤها حديثًا فقط، ويجب أن يكون لها اسم مفتاح فريد (لا يُسمح بحدوث تعارض مع مفاتيح الحالية).

المعلمات
testDescription TestDescription: عنصر TestDescription الذي يصف الاختبار
testMetrics : مجموعة المقاييس من الاختبار
testLogs : مجموعة الملفات التي تم تسجيلها أثناء الاختبار
المرتجعات
مجموعة المقاييس التي تم إنشاؤها حديثًا من مقاييس الاختبار

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

اضبط ILogSaver للسماح للمنفِّذ بحفظ الملفات.

المعلمات
logSaver ILogSaver: ILogSaver

setUp

public void setUp ()

يمكنك إلغاء هذه الطريقة في معالجات ما بعد المعالجة الفرعية لبدء التشغيل قبل تنفيذ الاختبار.

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

يتمّ استدعاؤه عندما يُبلغ اختبار ذري عن أنّه يفترض شرطًا غير صحيح.

المعلمات
test TestDescription: لتحديد الاختبار
trace String: تتبُّع تسلسل استدعاء الدوال البرمجية للخطأ

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

يتمّ استدعاؤه عندما يُبلغ اختبار ذري عن أنّه يفترض شرطًا غير صحيح.

المعلمات
test TestDescription: لتحديد الاختبار
failure FailureDescription: FailureDescription لوصف الخطأ وسياقه

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

بديل ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) حيث يمكننا تحديد وقت الانتهاء مباشرةً. يمكنك الجمع بين السمتَين testStarted(com.android.tradefed.result.TestDescription, long) وtestStarted(com.android.tradefed.result.TestDescription, long) لقياس الأداء بدقة.

المعلمات
test TestDescription: لتحديد الاختبار
endTime long: وقت انتهاء الاختبار، يتم قياسه من خلال System.currentTimeMillis()
testMetrics : ERROR(/Map) من المقاييس التي تمّ قياسها

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

يُبلِغ عن نهاية تنفيذ نموذج اختبار فردي.

إذا لم يتمّ استدعاء testFailed(TestDescription, FailureDescription)، يعني ذلك أنّ هذا الاختبار قد اجتاز. تُرجِع أيضًا أي مقاييس مفتاح/قيمة قد تم إصدارها أثناء تنفيذ نموذج الاختبار.

المعلمات
test TestDescription: لتحديد الاختبار
testMetrics : ERROR(/Map) من المقاييس التي تمّ قياسها

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

الإبلاغ عن تعذُّر اختبار فردي

سيتمّ استدعاؤه بين testStarted وtestEnded.

المعلمات
test TestDescription: لتحديد الاختبار
failure FailureDescription: FailureDescription لوصف الخطأ وسياقه

testFailed

public final void testFailed (TestDescription test, 
                String trace)

الإبلاغ عن تعذُّر اختبار فردي

سيتمّ استدعاؤه بين testStarted وtestEnded.

المعلمات
test TestDescription: لتحديد الاختبار
trace String: تتبُّع تسلسل استدعاء الدوال البرمجية للخطأ

testIgnored

public final void testIgnored (TestDescription test)

يتمّ استدعاؤه عندما لا يتمّ تنفيذ اختبار، وذلك بشكل عام لأنّ طريقة اختبار تمّت إضافة تعليق توضيحي إليها باستخدام علامة ‎@org.junit.Ignore.

المعلمات
test TestDescription: لتحديد الاختبار

testLog

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

استخدِم هذه الطريقة لتسجيل ملف من عملية تنفيذ PostProcessor.

المعلمات
dataName String: اسم String وصفي للبيانات، مثل "device_logcat". ملاحظة: قد لا يكون dataName فريدًا لكلّ طلب. أي أنّه يجب أن يتمكّن مُنفّذو الإجراء من التعامل مع عدة طلبات باستخدام dataName نفسه.
dataType LogDataType: LogDataType البيانات
dataStream InputStreamSource: InputStreamSource البيانات على مُنفِّذي الإجراء استدعاء createInputStream لبدء قراءة البيانات، والتأكّد من إغلاق InputStream الناتج عند اكتمال العملية. على المُتصلين التأكّد من بقاء مصدر البيانات حاضرًا ويمكن الوصول إليه إلى أن تكتمل طريقة testLog.

testLogSaved

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

يتمّ استدعاء هذه الدالة عند حفظ سجلّ الاختبار.

يجب استخدامه بدلاً من ITestInvocationListener.testLog(String, LogDataType, InputStreamSource).

المعلمات
dataName String: اسم String وصفي للبيانات، مثل "device_logcat". ملاحظة: قد لا يكون dataName فريدًا لكلّ طلب. أي أنّه يجب أن يتمكّن مُنفّذو الإجراء من التعامل مع عدّة طلبات باستخدام dataName نفسه.
dataType LogDataType: LogDataType البيانات
dataStream InputStreamSource: InputStreamSource البيانات على مُنفِّذي الإجراء استدعاء createInputStream لبدء قراءة البيانات، والتأكّد من إغلاق InputStream الناتج عند اكتمال العملية.
logFile ‫LogFile: LogFile الذي يحتوي على البيانات الوصفية للملف المحفوظ

testModuleEnded

public final void testModuleEnded ()

الإبلاغ عن نهاية تشغيل وحدة

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

الإبلاغ عن بدء تشغيل وحدة يرتبط هذا المرجع الداعم بـ testModuleEnded() وهو اختياري في التسلسل. ولا يتم استخدامه إلا أثناء عملية تشغيل تستخدِم وحدات: برامج التشغيل المستندة إلى المجموعة.

المعلمات
moduleContext IInvocationContext: IInvocationContext الوحدة

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

الإبلاغ عن نهاية عملية الاختبار

المعلمات
elapsedTime ‫long: الوقت المنقضي الذي سجّله الجهاز، بالمللي ثانية
runMetrics : أزواج المفتاح/القيمة التي يتم تسجيلها في نهاية عملية تنفيذ الاختبار

testRunFailed

public final void testRunFailed (FailureDescription failure)

تعذّر إكمال تشغيل اختبار التقارير بسبب خطأ وصفه FailureDescription.

المعلمات
failure FailureDescription: FailureDescription لوصف الخطأ وسياقه

testRunFailed

public final void testRunFailed (String errorMessage)

تعذّر إكمال تشغيل اختبار التقارير بسبب خطأ فادح.

المعلمات
errorMessage String: String يوضّح سبب تعذُّر التنفيذ

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

الإبلاغ عن بدء عملية تنفيذ اختبار

المعلمات
runName String: اسم اختبار التنفيذ
testCount int: إجمالي عدد الاختبارات في اختبار التنفيذ
attemptNumber int: رقم الطلب، الذي يحدِّد المحاولات المختلفة لنفس اسم التشغيل الذي تم تنفيذه عدّة مرات. يتمّ ترقيم مَعلمة attemptNumber بدءًا من 0، ويجب أن تزيد كلّ مرّة تتم فيها عملية تشغيل جديدة. على سبيل المثال، إذا تمّت إعادة محاولة إجراء اختبار دقيق 3 مرّات، يجب أن يكون إجمالي عدد عمليات التشغيل 4 عمليات ضمن اسم التشغيل نفسه وأن تتراوح مَعلمة attemptNumber بين 0 و3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

طلبات معاودة الاتصال في اختبار التنفيذ

المعلمات
runName String: اسم اختبار التنفيذ
testCount int: إجمالي عدد الاختبارات في اختبار التنفيذ

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

الإبلاغ عن بدء عملية تنفيذ اختبار

المعلمات
runName String: اسم اختبار التنفيذ
testCount int: إجمالي عدد الاختبارات في اختبار التنفيذ
attemptNumber int: رقم الطلب، الذي يحدِّد المحاولات المختلفة لنفس اسم التشغيل الذي يتم تنفيذه عدة مرات. يتمّ ترقيم مَعلمة attemptNumber بدءًا من 0، ويجب أن تزيد كلّ مرّة يتمّ فيها تنفيذ عملية تشغيل جديدة. على سبيل المثال، إذا تمّت إعادة محاولة إجراء اختبار دقيق 3 مرّات، يجب أن يكون إجمالي عمليات التشغيل التي تمّ إجراؤها 4 مرّات ضمن اسم التشغيل نفسه، ويجب أن تتراوح مَعلمة attemptNumber بين 0 و3.
startTime long: وقت بدء التنفيذ، يتم قياسه من خلال System.currentTimeMillis()

testRunStopped

public final void testRunStopped (long elapsedTime)

توقّف تشغيل اختبار التقارير قبل اكتماله بناءً على طلب أحد المستخدِمين.

TODO: currently unused, consider removing

المعلمات
elapsedTime ‫long: الوقت المنقضي الذي سجّله الجهاز، بالمللي ثانية

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

يتمّ استدعاؤه عند تخطّي اختبار وعدم تنفيذه لسبب غير متوقّع عادةً. سيتمّ إعادة محاولة إجراء هذه الاختبارات لمحاولة الحصول على تنفيذ سليم.

المعلمات
test TestDescription: لتحديد الاختبار
reason SkipReason: SkipReason

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

بديل عن testStarted(com.android.tradefed.result.TestDescription) حيث نحدّد أيضًا وقت بدء الاختبار ، مع ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) لإجراء قياس دقيق.

المعلمات
test TestDescription: لتحديد الاختبار
startTime long: وقت بدء الاختبار، يتم قياسه من خلال System.currentTimeMillis()

testStarted

public final void testStarted (TestDescription test)

طلبات معاودة الاتصال لحالات الاختبار

المعلمات
test TestDescription: لتحديد الاختبار

الطرق المحمية

cleanUp

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

يمكنك إلغاء هذه الطريقة لتغيير نوع المقياس إذا لزم الأمر. يتم ضبط المقياس تلقائيًا على نوع تمّت معالجته.

المرتجعات
MetricMeasurement.DataType

getRunName

protected String getRunName ()

المرتجعات
String