گزارش‌گر نتیجه

public class ResultDBReporter
extends Object implements IConfigurationReceiver , ILogSaverListener , ISupportGranularResults , ITestSummaryListener

شیء جاوا
↳ com.android.tradefed.result.resultdb.ResultDBReporter

گزارشگر نتیجه که نتایج آزمایش را در ResultDB بارگذاری می‌کند.

خلاصه

فیلدها

protected IInvocationContext mContext

protected boolean mEnableAlTestProperties

سازندگان عمومی

ResultDBReporter ()

روش‌های عمومی

TestSummary getSummary ()

به InvocationListener اجازه می‌دهد تا خلاصه‌ای را برگرداند.

void invocationEnded (long elapsedTime)

گزارش می‌دهد که فراخوانی، چه با موفقیت و چه به دلیل وجود برخی خطاها، خاتمه یافته است.

void invocationFailed ( FailureDescription failure)

به دلیل وجود برخی شرایط خطا، فراخوانی ناقص را گزارش می‌دهد.

void invocationFailed (Throwable cause)

به دلیل وجود برخی شرایط خطا، فراخوانی ناقص را گزارش می‌دهد.

void invocationSkipped ( SkipReason reason)

یک فراخوانی را به عنوان رد شده گزارش می‌دهد

void invocationStarted ( IInvocationContext context)

شروع فراخوانی تست را گزارش می‌دهد.

boolean isDisabled ()
void logAssociation (String dataName, LogFile logFile)

در برخی موارد، log باید به شدت با یک مورد آزمایشی مرتبط باشد، اما امکان انجام این کار در فراخوانی مستقیم testLogSaved(String,LogDataType,InputStreamSource,LogFile) امکان‌پذیر نیست.

void setConfiguration ( IConfiguration configuration)

IConfiguration مورد استفاده را تزریق می‌کند.

void setLogSaver ( ILogSaver logSaver)

ILogSaver را طوری تنظیم کنید که به پیاده‌سازی‌کننده اجازه دهد فایل‌ها را ذخیره کند.

boolean supportGranularResults ()

اگر گزارشگر از نتایج جزئی پشتیبانی کند، مقدار True و در غیر این صورت مقدار False را برمی‌گرداند.

void testAssumptionFailure ( TestDescription test, String trace)

زمانی فراخوانی می‌شود که یک آزمایش اتمی، شرطی را نادرست فرض کند.

void testAssumptionFailure ( TestDescription test, FailureDescription failure)

زمانی فراخوانی می‌شود که یک آزمایش اتمی، شرطی را نادرست فرض کند.

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

جایگزینی برای testEnded(TestDescription,Map) که در آن می‌توانیم زمان پایان را مستقیماً مشخص کنیم.

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

پایان اجرای یک مورد آزمایشی (test case) را گزارش می‌دهد.

void testFailed ( TestDescription test, FailureDescription failure)

گزارش شکست یک مورد آزمایشی منفرد را می‌دهد.

void testFailed ( TestDescription test, String trace)

گزارش شکست یک مورد آزمایشی منفرد را می‌دهد.

void testIgnored ( TestDescription test)

زمانی فراخوانی می‌شود که یک تست اجرا نخواهد شد، عموماً به این دلیل که یک متد تست با org.junit.Ignore حاشیه‌نویسی شده است.

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

داده‌های مربوط به گزارش یا اشکال‌زدایی را از فراخوانی تست ارائه می‌دهد.

void testModuleEnded ()

پایان اجرای یک ماژول را گزارش می‌دهد.

void testModuleStarted ( IInvocationContext moduleContext)

شروع اجرای یک ماژول را گزارش می‌دهد.

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

پایان اجرای آزمایش را گزارش می‌دهد.

void testRunFailed ( FailureDescription failure)

گزارش می‌دهد که اجرای آزمایشی به دلیل خرابی شرح داده شده توسط FailureDescription ، با شکست مواجه شده است.

void testRunFailed (String errorMessage)

گزارش‌ها حاکی از آن است که اجرای آزمایشی به دلیل یک خطای مهلک با شکست مواجه شده است.

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

شروع یک آزمایش را گزارش می‌دهد.

void testRunStarted (String runName, int testCount)

شروع یک آزمایش را گزارش می‌دهد.

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

شروع یک آزمایش را گزارش می‌دهد.

void testRunStopped (long elapsedTime)

گزارش می‌دهد که اجرای آزمایشی به دلیل درخواست کاربر قبل از تکمیل متوقف شده است.

void testSkipped ( TestDescription test, SkipReason reason)

زمانی فراخوانی می‌شود که یک تست نادیده گرفته شده و به دلیلی که معمولاً انتظار نمی‌رود، اجرا نشده است.

void testStarted ( TestDescription test, long startTime)

جایگزینی برای testStarted(TestDescription) که در آن زمان شروع تست را نیز مشخص می‌کنیم، و برای اندازه‌گیری دقیق‌تر با testEnded(TestDescription,long,Map) ترکیب می‌شود.

void testStarted ( TestDescription test)

شروع یک مورد آزمایشی (test case) منفرد را گزارش می‌دهد.

void uploadStoragePath (String resourceId, String storagePath, LogFile logFile)

مسیر ذخیره‌سازی یک مصنوع آزمایشی AnTS را در ResultDB بارگذاری می‌کند.

فیلدها

متن m 

protected IInvocationContext mContext

ویژگی‌های فعال‌سازی mEnableAlTest 

protected boolean mEnableAlTestProperties

سازندگان عمومی

گزارش‌گر نتیجه 

public ResultDBReporter ()

روش‌های عمومی

خلاصه دریافت 

public TestSummary getSummary ()

به InvocationListener اجازه می‌دهد تا خلاصه‌ای را برگرداند.

بازگشت‌ها
TestSummary یک TestSummary که خلاصه‌ای از اجرا را نشان می‌دهد، یا null

فراخوان پایان یافت 

public void invocationEnded (long elapsedTime)

گزارش می‌دهد که فراخوانی، چه با موفقیت و چه به دلیل وجود برخی خطاها، خاتمه یافته است.

به طور خودکار توسط چارچوب TradeFederation فراخوانی خواهد شد.

پارامترها
elapsedTime long : زمان سپری شده از فراخوانی بر حسب میلی‌ثانیه

فراخوانی ناموفق 

public void invocationFailed (FailureDescription failure)

به دلیل وجود برخی شرایط خطا، فراخوانی ناقص را گزارش می‌دهد.

به طور خودکار توسط چارچوب TradeFederation فراخوانی خواهد شد.

پارامترها
failure FailureDescription : FailureDescription علت خرابی را توصیف می‌کند.

فراخوانی ناموفق 

public void invocationFailed (Throwable cause)

به دلیل وجود برخی شرایط خطا، فراخوانی ناقص را گزارش می‌دهد.

به طور خودکار توسط چارچوب TradeFederation فراخوانی خواهد شد.

پارامترها
cause Throwable : علت Throwable خرابی

فراخوانی رد شد 

public void invocationSkipped (SkipReason reason)

یک فراخوانی را به عنوان رد شده گزارش می‌دهد

پارامترها
reason SkipReason

فراخوان شروع شد 

public void invocationStarted (IInvocationContext context)

شروع فراخوانی تست را گزارش می‌دهد.

به طور خودکار توسط چارچوب TradeFederation فراخوانی می‌شود. گزارشگران برای پشتیبانی از گزارش‌دهی چندین دستگاه، باید این متد را بازنویسی کنند.

پارامترها
context IInvocationContext : اطلاعاتی درباره فراخوانی

غیرفعال شده است 

public boolean isDisabled ()

بازگشت‌ها
boolean

انجمن ورود به سیستم 

public void logAssociation (String dataName, 
                LogFile logFile)

در برخی موارد، log باید به شدت با یک مورد آزمایشی مرتبط باشد، اما امکان انجام این کار در فراخوانی مستقیم testLogSaved(String,LogDataType,InputStreamSource,LogFile) امکان‌پذیر نیست. بنابراین، این فراخوانی امکان ارائه یک ارتباط قوی را به طور صریح فراهم می‌کند.

پارامترها
dataName String : نام داده

logFile LogFile : LogFile که قبلاً لاگ شده و باید با مورد آزمایشی مرتبط باشد.

پیکربندی set 

public void setConfiguration (IConfiguration configuration)

IConfiguration مورد استفاده را تزریق می‌کند.

پارامترها
configuration IConfiguration

تنظیم لاگ سیور 

public void setLogSaver (ILogSaver logSaver)

ILogSaver را طوری تنظیم کنید که به پیاده‌سازی‌کننده اجازه دهد فایل‌ها را ذخیره کند.

پارامترها
logSaver ILogSaver : ILogSaver

پشتیبانی از نتایج گرانولار 

public boolean supportGranularResults ()

اگر گزارشگر از نتایج جزئی پشتیبانی کند، مقدار True و در غیر این صورت مقدار False را برمی‌گرداند.

بازگشت‌ها
boolean

آزمون فرض شکست 

public void testAssumptionFailure (TestDescription test, 
                String trace)

زمانی فراخوانی می‌شود که یک آزمایش اتمی، شرطی را نادرست فرض کند.

پارامترها
test TestDescription : تست را مشخص می‌کند.

trace String : ردپای پشته از خرابی

آزمون فرض شکست 

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

زمانی فراخوانی می‌شود که یک آزمایش اتمی، شرطی را نادرست فرض کند.

پارامترها
test TestDescription : تست را مشخص می‌کند.

failure FailureDescription : FailureDescription خرابی و زمینه آن را توصیف می‌کند.

آزمون پایان یافت 

public 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 از معیارهای منتشر شده

آزمون پایان یافت 

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

پایان اجرای یک مورد آزمایشی (test case) را گزارش می‌دهد.

اگر testFailed(TestDescription, FailureDescription) فراخوانی نشده باشد، این تست با موفقیت انجام شده است. همچنین هر معیار کلید/مقداری را که ممکن است در طول اجرای مورد تست منتشر شده باشد، برمی‌گرداند.

پارامترها
test TestDescription : تست را مشخص می‌کند.

testMetrics HashMap : Map از معیارهای منتشر شده

تست ناموفق 

public void testFailed (TestDescription test, 
                FailureDescription failure)

گزارش شکست یک مورد آزمایشی منفرد را می‌دهد.

بین testStarted و testEnded فراخوانی خواهد شد.

پارامترها
test TestDescription : تست را مشخص می‌کند.

failure FailureDescription : FailureDescription خرابی و زمینه آن را توصیف می‌کند.

تست ناموفق 

public void testFailed (TestDescription test, 
                String trace)

گزارش شکست یک مورد آزمایشی منفرد را می‌دهد.

بین testStarted و testEnded فراخوانی خواهد شد.

پارامترها
test TestDescription : تست را مشخص می‌کند.

trace String : ردپای پشته از خرابی

آزمون نادیده گرفته شد 

public void testIgnored (TestDescription test)

زمانی فراخوانی می‌شود که یک تست اجرا نخواهد شد، عموماً به این دلیل که یک متد تست با org.junit.Ignore حاشیه‌نویسی شده است.

پارامترها
test TestDescription : تست را مشخص می‌کند.

تست لاگ 

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

داده‌های مربوط به گزارش یا اشکال‌زدایی را از فراخوانی تست ارائه می‌دهد.

باید قبل از ERROR(ITestInvocationListener.invocationFailed(Throwable)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable)) یا ERROR(/ITestInvocationListener#invocationEnded(long)) فراخوانی شود.

چارچوب TradeFederation به طور خودکار این متد را فراخوانی می‌کند و گزارش میزبان و در صورت لزوم، گزارش دستگاه را ارائه می‌دهد.

پارامترها
dataName String : یک نام توصیفی String از داده‌ها. مثلاً "device_logcat". توجه داشته باشید که dataName ممکن است در هر فراخوانی منحصر به فرد نباشد. یعنی پیاده‌سازی‌کنندگان باید بتوانند چندین فراخوانی را با همان dataName مدیریت کنند.

dataType LogDataType : نوع داده‌ی LogDataType

dataStream InputStreamSource : InputStreamSource داده‌ها. پیاده‌سازی‌کنندگان باید createInputStream را برای شروع خواندن داده‌ها فراخوانی کنند و اطمینان حاصل کنند که InputStream حاصل را پس از اتمام ببندند. فراخوانی‌کنندگان باید اطمینان حاصل کنند که منبع داده‌ها تا زمان تکمیل متد testLog موجود و در دسترس باقی می‌ماند.

testModuleEnd 

public void testModuleEnded ()

پایان اجرای یک ماژول را گزارش می‌دهد.

ماژول تست شروع شد 

public void testModuleStarted (IInvocationContext moduleContext)

شروع اجرای یک ماژول را گزارش می‌دهد. این فراخوانی با testModuleEnded() مرتبط است و در دنباله اختیاری است. فقط در طول اجرایی که از اجراکننده‌های مبتنی بر modules: suite استفاده می‌کند، استفاده می‌شود.

پارامترها
moduleContext IInvocationContext : همان IInvocationContext مربوط به ماژول است.

تست اجرا شده 

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

پایان اجرای تست را گزارش می‌دهد. رفع مشکل: ما نمی‌توانیم دو رابط Map<> با انواع مختلف داشته باشیم، بنابراین باید از HashMap در اینجا استفاده کنیم.

پارامترها
elapsedTimeMillis long : زمان سپری شده گزارش شده توسط دستگاه، بر حسب میلی ثانیه

runMetrics HashMap : جفت‌های کلید-مقدار که در پایان اجرای تست با Metric گزارش می‌شوند.

تست اجرا ناموفق 

public void testRunFailed (FailureDescription failure)

گزارش می‌دهد که اجرای آزمایشی به دلیل خرابی شرح داده شده توسط FailureDescription ، با شکست مواجه شده است.

پارامترها
failure FailureDescription : FailureDescription خرابی و زمینه آن را توصیف می‌کند.

تست اجرا ناموفق 

public void testRunFailed (String errorMessage)

گزارش‌ها حاکی از آن است که اجرای آزمایشی به دلیل یک خطای مهلک با شکست مواجه شده است.

پارامترها
errorMessage String : String دلیل عدم موفقیت در اجرا را توصیف می‌کند.

تست شروع شد 

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

شروع یک آزمایش را گزارش می‌دهد.

پارامترها
runName String : نام اجرای آزمایشی

testCount int : تعداد کل تست‌ها در اجرای تست

attemptNumber int : شماره ترتیب، که تلاش‌های مختلف یک runName را که چندین بار اجرا شده‌اند، مشخص می‌کند. شماره تلاش با اندیس ۰ اندیس‌گذاری شده است و باید هر بار که یک اجرای جدید اتفاق می‌افتد، افزایش یابد. به عنوان مثال، یک تست ۳ بار به صورت جزئی تکرار می‌شود، باید ۴ بار در کل تحت یک runName اجرا شود و شماره تلاش از ۰ تا ۳ است.

تست شروع شد 

public void testRunStarted (String runName, 
                int testCount)

شروع یک آزمایش را گزارش می‌دهد.

پارامترها
runName String : نام اجرای آزمایشی

testCount int : تعداد کل تست‌ها در اجرای تست

تست شروع شد 

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

شروع یک آزمایش را گزارش می‌دهد.

پارامترها
runName String : نام اجرای آزمایشی

testCount int : تعداد کل تست‌ها در اجرای تست

attemptNumber int : شماره ترتیب، که تلاش‌های مختلف یک runName را که چندین بار اجرا شده‌اند، مشخص می‌کند. شماره تلاش با اندیس ۰ اندیس‌گذاری شده است و باید هر بار که یک اجرای جدید اتفاق می‌افتد، افزایش یابد. به عنوان مثال، یک تست ۳ بار به صورت جزئی تکرار می‌شود، باید ۴ بار در کل تحت یک runName اجرا شود و شماره تلاش از ۰ تا ۳ است.

startTime long : زمان شروع اجرا، که از طریق System.currentTimeMillis() اندازه‌گیری می‌شود.

testRunStopped 

public void testRunStopped (long elapsedTime)

گزارش می‌دهد که اجرای آزمایشی به دلیل درخواست کاربر قبل از تکمیل متوقف شده است.

TODO: در حال حاضر استفاده نشده، حذف را در نظر بگیرید

پارامترها
elapsedTime long : زمان سپری شده گزارش شده توسط دستگاه، بر حسب میلی ثانیه

آزمون رد شد 

public void testSkipped (TestDescription test, 
                SkipReason reason)

زمانی فراخوانی می‌شود که یک تست نادیده گرفته شده و به دلیلی که معمولاً انتظار نمی‌رود، اجرا نشده باشد. این تست‌ها برای اجرای مجدد تلاش خواهند کرد تا به طور صحیح اجرا شوند.

پارامترها
test TestDescription : تست را مشخص می‌کند.

reason SkipReason : SkipReason

تست شروع شد 

public void testStarted (TestDescription test, 
                long startTime)

جایگزینی برای testStarted(TestDescription) که در آن زمان شروع تست را نیز مشخص می‌کنیم، و برای اندازه‌گیری دقیق‌تر با testEnded(TestDescription,long,Map) ترکیب می‌شود.

پارامترها
test TestDescription : تست را مشخص می‌کند.

startTime long : زمان شروع تست، که از طریق System.currentTimeMillis() اندازه‌گیری می‌شود.

تست شروع شد 

public void testStarted (TestDescription test)

شروع یک مورد آزمایشی (test case) را گزارش می‌دهد. رابط‌های قدیمی‌تر، در صورت امکان باید testStarted(TestDescription) استفاده کنند.

پارامترها
test TestDescription : تست را مشخص می‌کند.

آپلودStoragePath 

public void uploadStoragePath (String resourceId, 
                String storagePath, 
                LogFile logFile)

مسیر ذخیره‌سازی یک مصنوع آزمایشی AnTS را در ResultDB بارگذاری می‌کند.

این یک راه حل موقت برای مهاجرت از AnTS به ResultDB است (به go/convergence-tr مراجعه کنید). این متد باید توسط گزارشگر AnTS زمانی که مسیر ذخیره سازی یک مصنوع در دسترس قرار می‌گیرد، فراخوانی شود.

گزارشگر AnTS تضمین می‌کند که این متد را برای هر مصنوعاتی که آپلود می‌کند، فراخوانی خواهد کرد. این گزارشگر، به نوبه خود، تمام این مصنوعات را با ارتباط تست صحیح در ResultDB بارگذاری می‌کند. برای ارتباط صحیح لاگ، لازم است که logAssociation(String,LogFile) از قبل برای همان شناسه منبع فراخوانی شده باشد. این تضمین می‌کند که مصنوع از قبل ردیابی شده است. در غیر این صورت، مصنوع با واحد کاری سطح بالای فراخوانی مبادله شده مرتبط خواهد شد.

این متد نباید قبل از invocationStarted(IInvocationContext) فراخوانی شود. می‌تواند پس از invocationEnded(long) برای فراخوانی‌هایی که توسط یک سیستم بالادستی مدیریت می‌شوند، فراخوانی شود، زیرا توسط این گزارشگر نهایی نشده‌اند. این موضوع در مورد فراخوانی‌های ایجاد شده محلی که در invocationEnded(long) نهایی می‌شوند، صدق نمی‌کند.

TODO(b/464941055): این متد را به محض اینکه بتوانیم به درستی مصنوعات AnTS را به ResultDB منتقل کنیم، حذف کنید.

پارامترها
resourceId String : شناسه منبع مصنوع.

storagePath String : مسیر ذخیره‌سازی مصنوع (مثلاً مسیر /bigstore/).

logFile LogFile : شیء LogFile مرتبط با مصنوع.