ProtoResultReporter

public abstract class ProtoResultReporter
extends Object implements ILogSaverListener, ISupportGranularResults, ITestInvocationListener

java.lang.Object
   ↳ com.android.tradefed.result.proto.ProtoResultReporter


يُنشئ برنامج إعداد التقارير عن النتائج TestRecord بروتوكول buffer يحتوي على جميع النتائج. يجب توسيع نطاقها لتشمل كيفية التعامل مع النموذج الأوّلي النهائي في processFinalProto(TestRecord).

ملخّص

طُرق وضع التصميم العامة

ProtoResultReporter()

الإجراءات العامة

final void invocationEnded(long elapsedTime)

تعرض هذه السمة ما إذا تم إنهاء عملية الاستدعاء بنجاح أو بسبب حدوث خطأ.

void invocationFailed(FailureDescription failure)

تعرض هذه السمة عملية استدعاء غير مكتملة بسبب حدوث خطأ.

void invocationFailed(Throwable cause)

تعرض هذه السمة عملية استدعاء غير مكتملة بسبب حدوث خطأ.

void invocationSkipped(SkipReason reason)

تسجيل حالة استدعاء على أنّه تم تخطّيه

void invocationStarted(IInvocationContext context)

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

final void logAssociation(String dataName, LogFile logFile)

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

void processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs)

استخدِم سجلّ الاستدعاء لإرسال جميع السجلات النهائية للاستدعاء واحدًا تلو الآخر.

void processFinalProto(TestRecordProto.TestRecord finalRecord)

التعامل مع النموذج الأوّلي النهائي الذي يتضمّن جميع النتائج

void processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)

التعامل مع نموذج سجلّ اختبار الاستدعاء الجزئي بعد حدوث invocationStarted(IInvocationContext)

void processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)

التعامل مع النموذج الأوّلي لسجلّ حالة الاختبار النهائية بعد حدوث testEnded(TestDescription,long,HashMap)

void processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)

التعامل مع النموذج الأوّلي لسجلّ حالة الاختبار الجزئي بعد حدوث testStarted(TestDescription,long)

void processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)

التعامل مع نموذج سجلّ الوحدة النهائية بعد حدوث testModuleEnded()

void processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)

التعامل مع نموذج سجل الوحدة الجزئي بعد حدوث testModuleStarted(IInvocationContext)

void processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)

التعامل مع نموذج سجلّ التشغيل النهائي بعد حدوث testRunEnded(long,HashMap)

void processTestRunStarted(TestRecordProto.TestRecord runStartedRecord)

التعامل مع بروتوكول سجلّ تشغيل الاختبار الجزئي بعد حدوث testRunStarted(String,int)

void setGranularResults(boolean granularResults)
void setInlineRecordOfChildren(boolean inline)
boolean supportGranularResults()

تعرِض True إذا كان مقدّم التقارير يتيح نتائج تفصيلية، وFalse في الحالات الأخرى.

final void testAssumptionFailure(TestDescription test, String trace)

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

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

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

final void testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics)

بديل testEnded(TestDescription,Map) حيث يمكننا تحديد وقت الانتهاء مباشرةً.

void testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> 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 testModuleEnded()

تسجّل هذه السمة نهاية عملية تنفيذ وحدة.

final void testModuleStarted(IInvocationContext moduleContext)

تسجّل هذه السمة بداية تشغيل وحدة.

final void testRunEnded(long elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> runMetrics)

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

final void testRunFailed(FailureDescription failure)

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

final void testRunFailed(String errorMessage)

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

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

تسجّل هذه السمة بداية تشغيل تجريبي.

final void testRunStarted(String runName, int testCount)

تسجّل هذه السمة بداية تشغيل تجريبي.

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

تسجّل هذه السمة بداية تشغيل تجريبي.

final void testSkipped(TestDescription test, SkipReason reason)

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

final void testStarted(TestDescription test, long startTime)

بديل testStarted(TestDescription) حيث نحدّد أيضًا وقت بدء الاختبار، بالإضافة إلى testEnded(TestDescription,long,Map) للحصول على قياس دقيق.

final void testStarted(TestDescription test)

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

طُرق محمية

void afterModuleEnd()
void beforeModuleStart()
TestRecordProto.ChildReference createModuleChildReference(TestRecordProto.TestRecord record)

تنشئ هذه السمة مرجعًا فرعيًا لوحدة.

طُرق وضع التصميم العامة

ProtoResultReporter

public ProtoResultReporter ()

الإجراءات العامة

invocationEnded

public final void invocationEnded (long elapsedTime)

تعرض هذه السمة ما إذا تم إنهاء عملية الاستدعاء بنجاح أو بسبب حدوث خطأ.

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

المعلَمات
elapsedTime long: الوقت المنقضي لتنفيذ الاستدعاء بالملّي ثانية

invocationFailed

public void invocationFailed (FailureDescription failure)

تعرض هذه السمة عملية استدعاء غير مكتملة بسبب حدوث خطأ.

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

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

invocationFailed

public void invocationFailed (Throwable cause)

تعرض هذه السمة عملية استدعاء غير مكتملة بسبب حدوث خطأ.

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

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

invocationSkipped

public void invocationSkipped (SkipReason reason)

تسجيل حالة استدعاء على أنّه تم تخطّيه

المعلَمات
reason SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

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

سيتم استدعاؤها تلقائيًا من خلال إطار عمل TradeFederation. على مقدّمي التقارير إلغاء هذه الطريقة لتفعيل إعداد التقارير على أجهزة متعددة.

المعلَمات
context IInvocationContext: معلومات حول طلب التنفيذ

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

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

المعلَمات
dataName String: اسم البيانات

logFile LogFile: LogFile الذي تم تسجيله من قبل ويجب ربطه بحالة الاختبار.

processFinalInvocationLogs

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

استخدِم سجلّ الاستدعاء لإرسال جميع السجلات النهائية للاستدعاء واحدًا تلو الآخر.

المعلَمات
invocationLogs TestRecordProto.TestRecord: يمثّل هذا الحقل النموذج الأولي النهائي لطلب التفعيل.

processFinalProto

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

التعامل مع النموذج الأوّلي النهائي الذي يتضمّن جميع النتائج

المعلَمات
finalRecord TestRecordProto.TestRecord: البروتوكول النهائي الذي يتضمّن جميع نتائج الاستدعاء

processStartInvocation

public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, 
                IInvocationContext invocationContext)

التعامل مع نموذج سجلّ اختبار الاستدعاء الجزئي بعد حدوث invocationStarted(IInvocationContext)

المعلَمات
invocationStartRecord TestRecordProto.TestRecord: البروتوكول الجزئي الذي تم ملؤه بعد invocationStart

invocationContext IInvocationContext: عبارة التفعيل IInvocationContext

processTestCaseEnded

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

التعامل مع النموذج الأوّلي لسجلّ حالة الاختبار النهائية بعد حدوث testEnded(TestDescription,long,HashMap)

المعلَمات
testCaseRecord TestRecordProto.TestRecord: يمثّل هذا الحقل النموذج الأوّلي النهائي الذي يمثّل حالة اختبار.

processTestCaseStarted

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

التعامل مع النموذج الأوّلي لسجلّ حالة الاختبار الجزئي بعد حدوث testStarted(TestDescription,long)

المعلَمات
testCaseStartedRecord TestRecordProto.TestRecord: يمثّل هذا الحقل البروتوكول الجزئي لحالة الاختبار.

processTestModuleEnd

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

التعامل مع نموذج سجلّ الوحدة النهائية بعد حدوث testModuleEnded()

المعلَمات
moduleRecord TestRecordProto.TestRecord: يمثّل هذا الحقل النموذج الأولي النهائي للوحدة.

processTestModuleStarted

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

التعامل مع نموذج سجل الوحدة الجزئي بعد حدوث testModuleStarted(IInvocationContext)

المعلَمات
moduleStartRecord TestRecordProto.TestRecord: يمثّل هذا الحقل البروتوكول الجزئي للوحدة.

processTestRunEnded

public void processTestRunEnded (TestRecordProto.TestRecord runRecord, 
                boolean moduleInProgress)

التعامل مع نموذج سجلّ التشغيل النهائي بعد حدوث testRunEnded(long,HashMap)

المعلَمات
runRecord TestRecordProto.TestRecord: تمثّل هذه السمة النموذج الأولي النهائي لعملية التنفيذ.

moduleInProgress boolean: تحدّد ما إذا كانت الوحدة قيد التقدّم أم لا.

processTestRunStarted

public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

التعامل مع بروتوكول سجلّ تشغيل الاختبار الجزئي بعد حدوث testRunStarted(String,int)

المعلَمات
runStartedRecord TestRecordProto.TestRecord: يمثّل هذا الحقل البروتوكول الجزئي لعملية التشغيل.

setGranularResults

public void setGranularResults (boolean granularResults)

المعلَمات
granularResults boolean

setInlineRecordOfChildren

public void setInlineRecordOfChildren (boolean inline)

المعلَمات
inline boolean

supportGranularResults

public boolean supportGranularResults ()

تعرِض True إذا كان مقدّم التقارير يتيح نتائج تفصيلية، وFalse في الحالات الأخرى.

المرتجعات
boolean

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, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

بديل testEnded(TestDescription,Map) حيث يمكننا تحديد وقت الانتهاء مباشرةً. يمكنك الجمع بينها وبين testStarted(TestDescription,long) للحصول على قياس دقيق.

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

endTime long: الوقت الذي انتهى فيه الاختبار، ويتم قياسه باستخدام System.currentTimeMillis()

testMetrics HashMap: Map للمقاييس التي تمّ إرسالها

testEnded

public void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

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

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

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

testMetrics HashMap: 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: تحدّد الاختبار

testModuleEnded

public final void testModuleEnded ()

تسجّل هذه السمة نهاية عملية تنفيذ وحدة.

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

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

المعلَمات
moduleContext IInvocationContext: IInvocationContext الخاص بالوحدة

testRunEnded

public final void testRunEnded (long elapsedTimeMillis, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

تقارير نهاية عملية الاختبار FIXME: We cannot have two Map<> interfaces with different type, so we have to use HashMap here.

المعلَمات
elapsedTimeMillis long: الوقت المنقضي الذي أبلغ عنه الجهاز، بالمللي ثانية

runMetrics HashMap: أزواج المفتاح/القيمة التي يتمّ تسجيلها في نهاية عملية الاختبار باستخدام Metric.

testRunFailed

public final void testRunFailed (FailureDescription failure)

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

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

testRunFailed

public final void testRunFailed (String errorMessage)

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

المعلَمات
errorMessage String: String تصف سبب تعذُّر تنفيذ عملية التشغيل.

testRunStarted

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

تسجّل هذه السمة بداية تشغيل تجريبي.

المعلَمات
runName String: اسم عملية التشغيل التجريبي

testCount int: إجمالي عدد الاختبارات في عملية التشغيل التجريبي

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

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

تسجّل هذه السمة بداية تشغيل تجريبي.

المعلَمات
runName String: اسم عملية التشغيل التجريبي

testCount int: إجمالي عدد الاختبارات في عملية التشغيل التجريبي

testRunStarted

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

تسجّل هذه السمة بداية تشغيل تجريبي.

المعلَمات
runName String: اسم عملية التشغيل التجريبي

testCount int: إجمالي عدد الاختبارات في عملية التشغيل التجريبي

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

startTime long: الوقت الذي بدأ فيه التمرين، ويتم قياسه باستخدام System.currentTimeMillis()

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

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

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

reason SkipReason: SkipReason

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

بديل testStarted(TestDescription) حيث نحدّد أيضًا وقت بدء الاختبار، بالإضافة إلى testEnded(TestDescription,long,Map) للحصول على قياس دقيق.

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

startTime long: الوقت الذي بدأت فيه التجربة، ويتم قياسه باستخدام System.currentTimeMillis()

testStarted

public final void testStarted (TestDescription test)

تسجّل هذه السمة بداية حالة اختبار فردية. واجهة قديمة، يجب استخدام testStarted(TestDescription) كلما أمكن ذلك.

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

طُرق محمية

afterModuleEnd

protected void afterModuleEnd ()

beforeModuleStart

protected void beforeModuleStart ()

createModuleChildReference

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

تنشئ هذه السمة مرجعًا فرعيًا لوحدة.

المعلَمات
record TestRecordProto.TestRecord

المرتجعات
TestRecordProto.ChildReference