החל מ-27 במרץ 2025, מומלץ להשתמש ב-android-latest-release במקום ב-aosp-main כדי ליצור תרומות ל-AOSP. מידע נוסף זמין במאמר שינויים ב-AOSP.

דף זה תורגם על ידי Cloud Translation API.

ModuleDefinition

public class ModuleDefinition
extends Object implements ITestCollector

java.lang.Object
↳	com.android.tradefed.testtype.suite.ModuleDefinition

‫Container for the test run configuration. הכיתה הזו עוזרת לכם להתכונן להרצת הבדיקות ולהריץ אותן.

סיכום

ערכים קבועים
`String`	`ISOLATION_COST`
`String`	`MODULE_ABI`
`String`	`MODULE_CACHED` המאפיין הזה מוגדר כ-True אם התוצאות של מודול הבדיקה נשמרו במטמון.
`String`	`MODULE_CONTROLLER`
`String`	`MODULE_EXTERNAL_DEPENDENCIES`
`String`	`MODULE_ID` מזהה המודול, השם שישמש לזיהוי ייחודי של המודול במהלך testRunStart.
`String`	`MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY`
`String`	`MODULE_ISOLATED` המאפיין הזה מוגדר כ-true אם המודול פעל במכשיר שהוכן לאחרונה.
`String`	`MODULE_NAME` שם המודול הוא השם הבסיסי שמשויך למודול, בדרך כלל מגיע מקובץ ההגדרות של Xml TF שממנו נטען המודול.
`String`	`MODULE_PARAMETERIZATION`
`String`	`MODULE_SKIPPED` המאפיין הזה מוגדר כ-true אם מודול הבדיקה דולג
`String`	`MODULE_TEST_COUNT`
`String`	`PREPARATION_TIME`
`String`	`RETRY_FAIL_COUNT`
`String`	`RETRY_SUCCESS_COUNT`
`String`	`RETRY_TIME`
`String`	`SPARSE_MODULE` הערך של המאפיין הזה הוא true אם מדווחים רק על אירועים ברמת המודול.
`String`	`TEAR_DOWN_TIME`
`String`	`TEST_TIME`

Constructors ציבוריים
`ModuleDefinition()`
`ModuleDefinition(String name, tests, preparersPerDevice, multiPreparers, IConfiguration moduleConfig)` Constructor
`ModuleDefinition(String name, tests, preparersPerDevice, suitePreparersPerDevice, multiPreparers, IConfiguration moduleConfig)` Constructor

‫methods ציבוריים
`int`	`compareTo(ModuleDefinition moduleDef)`
`String`	`getId()` מחזירה את השם הייחודי של המודול.
`Integer`	`getIntraModuleShardCount()`
`Integer`	`getIntraModuleShardIndex()`
`IConfiguration`	`getModuleConfiguration()`
`IInvocationContext`	`getModuleInvocationContext()` הפונקציה מחזירה את `IInvocationContext` שמשויך למודול.
`TestInformation`	`getModuleTestInformation()`
	`getRequiredTokens(TestInformation testInfo)`
`long`	`getRuntimeHint()` הפונקציה מחזירה את הזמן המשוער להרצת כל הבדיקות במודול.
`boolean`	`hasModuleFailed()` הפונקציה מחזירה את הערך True אם הפונקציה testRunFailure הופעלה במודול *
`int`	`neededDevices()` הפונקציה מחזירה את מספר המכשירים שצפויים להריץ את הבדיקה הזו.
`int`	`numTests()` הפונקציה מחזירה את המספר הנוכחי של `IRemoteTest` שממתינים להרצה.
`final void`	`reportNotExecuted(ITestInvocationListener listener, String message)` דיווח על מודולים שלא בוצעו בכלל.
`final void`	`run(TestInformation moduleInfo, ITestInvocationListener listener, int maxRunLimit)` מריצים את כל ה-`IRemoteTest` שכלולים במודול ומשתמשים בכל ה-preparers לפני ואחרי כדי להגדיר ולנקות את המכשיר.
`final void`	`run(TestInformation moduleInfo, ITestInvocationListener listener)` מריצים את כל ה-`IRemoteTest` שכלולים במודול ומשתמשים בכל כלי ההכנה לפני ואחרי כדי להגדיר ולנקות את המכשיר.
`Throwable`	`runPreparation(boolean includeSuitePreparers)` מריצים את ההכנות של הבדיקה, כולל הכנות ברמת החבילה אם צוינו.
`void`	`setBuild(IBuildInfo build)` מזריקים את `IBuildInfo` לשימוש במהלך הבדיקות.
`void`	`setCollectTestsOnly(boolean collectTestsOnly)` המתג מפעיל או משבית את מצב איסוף הבדיקות
`void`	`setDevice(ITestDevice device)` מזריקים את `ITestDevice` לשימוש במהלך הבדיקות.
`void`	`setEnableDynamicDownload(boolean enableDynamicDownload)` האם להפעיל הורדה דינמית ברמת המודול.
`void`	`setIntraModuleInformation(int shardCount, int shardIndex)`
`void`	`setLogSaver(ILogSaver logSaver)` מעבירים את הכלי לשמירת יומן ההפעלה למודול כדי שיוכל להשתמש בו אם יהיה צורך.
`final void`	`setMergeAttemps(boolean mergeAttempts)` הגדרה שקובעת אם למזג את התוצאות או לא.
`void`	`setMetricCollectors( collectors)` מזריקים את רשימת `IMetricCollector` לשימוש על ידי המודול.
`void`	`setRecoverVirtualDevice(boolean recoverVirtualDevice)` הערכה אמורה לשחזר את המכשיר הווירטואלי.
`void`	`setRemoveModuleBuffering(boolean removeModuleBuffering)`
`void`	`setReportModuleEnd(boolean shouldReportModuleEnd)`
`void`	`setReportModuleStart(boolean shouldReportModuleStart)`
`final void`	`setRetryDecision(IRetryDecision decision)` הגדרת `IRetryDecision` לשימוש בניסיון חוזר בתוך המודול.
`void`	`setUseModuleResultsForwarder(boolean useModuleResultsForwarder)`
`boolean`	`shouldRecoverVirtualDevice()` הפונקציה מחזירה ערך אם צריך לשחזר מכשיר וירטואלי.
`String`	`toString()`
`void`	`transferSuiteLevelOptions(IConfiguration mSuiteConfiguration)` העתקת חלק מההגדרות ברמת החבילה

שיטות מוגנות
`boolean`	`hasTests()` הפונקציה מחזירה את הערך True אם עדיין יש `IRemoteTest` להפעלה במאגר של המודול.

ערכים קבועים

ISOLATION_COST

public static final String ISOLATION_COST

ערך קבוע: ‎"ISOLATION_COST"‎

MODULE_ABI

public static final String MODULE_ABI

ערך קבוע: "module-abi"

MODULE_CACHED

public static final String MODULE_CACHED

המאפיין הזה מוגדר כ-True אם התוצאות של מודול הבדיקה נשמרו במטמון.

ערך קבוע: "module-cached"

MODULE_CONTROLLER

public static final String MODULE_CONTROLLER

ערך קבוע: "module_controller"

MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_EXTERNAL_DEPENDENCIES

ערך קבוע: "module-external-dependencies"

MODULE_ID

public static final String MODULE_ID

מזהה המודול, השם שישמש לזיהוי ייחודי של המודול במהלך testRunStart. בדרך כלל זה יהיה שילוב של MODULE_ABI + MODULE_NAME.

ערך קבוע: "module-id"

MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

ערך קבוע: "module-flag-overrides"

MODULE_ISOLATED

public static final String MODULE_ISOLATED

המאפיין הזה מוגדר כ-true אם המודול פעל במכשיר שהוכן לאחרונה.

ערך קבוע: "module-isolated"

MODULE_NAME

public static final String MODULE_NAME

שם המודול הוא השם הבסיסי שמשויך למודול, בדרך כלל מגיע מקובץ ההגדרות של Xml TF שממנו נטען המודול.

ערך קבוע: ‎"module-name"‎

MODULE_PARAMETERIZATION

public static final String MODULE_PARAMETERIZATION

ערך קבוע: "module-param"

MODULE_SKIPPED

public static final String MODULE_SKIPPED

המאפיין הזה מוגדר כ-true אם מודול הבדיקה דולג

ערך קבוע: "module-skipped"

MODULE_TEST_COUNT

public static final String MODULE_TEST_COUNT

ערך קבוע: "MODULE_TEST_COUNT"

PREPARATION_TIME

public static final String PREPARATION_TIME

ערך קבוע: "PREP_TIME"

RETRY_FAIL_COUNT

public static final String RETRY_FAIL_COUNT

ערך קבוע: "MODULE_RETRY_FAILED"

RETRY_SUCCESS_COUNT

public static final String RETRY_SUCCESS_COUNT

ערך קבוע: "MODULE_RETRY_SUCCESS"

RETRY_TIME

public static final String RETRY_TIME

ערך קבוע: "MODULE_RETRY_TIME"

SPARSE_MODULE

public static final String SPARSE_MODULE

הערך של המאפיין הזה הוא true אם מדווחים רק על אירועים ברמת המודול.

ערך קבוע: "sparse-module"

TEAR_DOWN_TIME

public static final String TEAR_DOWN_TIME

ערך קבוע: "TEARDOWN_TIME"

TEST_TIME

public static final String TEST_TIME

ערך קבוע: "TEST_TIME"

Constructors ציבוריים

ModuleDefinition

public ModuleDefinition ()

ModuleDefinition

public ModuleDefinition (String name, 
                 tests, 
                 preparersPerDevice, 
                 multiPreparers, 
                IConfiguration moduleConfig)

Constructor

פרמטרים
`name`	‫`String`: שם ייחודי של הגדרת הבדיקה.
`tests`	: רשימה של `IRemoteTest` שצריך להריץ.
`preparersPerDevice`	‫: רשימה של `ITargetPreparer` שישמשו להגדרת המכשיר.
`multiPreparers`
`moduleConfig`	‫`IConfiguration`: `IConfiguration` של הגדרת המודול הבסיסית.

ModuleDefinition

public ModuleDefinition (String name, 
                 tests, 
                 preparersPerDevice, 
                 suitePreparersPerDevice, 
                 multiPreparers, 
                IConfiguration moduleConfig)

Constructor

פרמטרים
`name`	‫`String`: שם ייחודי של הגדרת הבדיקה.
`tests`	: רשימה של `IRemoteTest` שצריך להריץ.
`preparersPerDevice`	‫: רשימה של `ITargetPreparer` שישמשו להגדרת המכשיר.
`suitePreparersPerDevice`
`multiPreparers`
`moduleConfig`	‫`IConfiguration`: ה-`IConfiguration` של הגדרת המודול הבסיסי.

‫methods ציבוריים

compareTo

public int compareTo (ModuleDefinition moduleDef)

פרמטרים
`moduleDef`	`ModuleDefinition`

החזרות
`int`

getId

public String getId ()

הפונקציה מחזירה את השם הייחודי של המודול.

החזרות
`String`

getIntraModuleShardCount

public Integer getIntraModuleShardCount ()

החזרות
`Integer`

getIntraModuleShardIndex

public Integer getIntraModuleShardIndex ()

החזרות
`Integer`

getModuleConfiguration

public IConfiguration getModuleConfiguration ()

החזרות
`IConfiguration`

getModuleInvocationContext

public IInvocationContext getModuleInvocationContext ()

הפונקציה מחזירה את IInvocationContext שמשויך למודול.

החזרות
`IInvocationContext`

getModuleTestInformation

public TestInformation getModuleTestInformation ()

החזרות
`TestInformation`

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

פרמטרים
`testInfo`	`TestInformation`

החזרות

getRuntimeHint

public long getRuntimeHint ()

הפונקציה מחזירה את הזמן המשוער להרצת כל הבדיקות במודול.

החזרות
`long`

hasModuleFailed

public boolean hasModuleFailed ()

הפונקציה מחזירה את הערך True אם הפונקציה testRunFailure הופעלה במודול *

החזרות
`boolean`

neededDevices

public int neededDevices ()

הפונקציה מחזירה את מספר המכשירים שצפויים להריץ את הבדיקה הזו.

החזרות
`int`

numTests

public int numTests ()

הפונקציה מחזירה את המספר הנוכחי של IRemoteTest שממתינים להרצה.

החזרות
`int`

reportNotExecuted

public final void reportNotExecuted (ITestInvocationListener listener, 
                String message)

דיווח על מודולים שלא בוצעו בכלל.

פרמטרים
`listener`	`ITestInvocationListener`
`message`	`String`

ראן

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener, 
                int maxRunLimit)

מריצים את כל ה-IRemoteTest שכלולים במודול ומשתמשים בכל כלי ההכנה לפני ואחרי כדי להגדיר ולנקות את המכשיר.

פרמטרים
`moduleInfo`	‫`TestInformation`: `TestInformation` של המודול.
`listener`	‫`ITestInvocationListener`: `ITestInvocationListener` המקום שבו מדווחים על התוצאות.
`maxRunLimit`	‫`int`: המספר המקסימלי של הרצות לכל מקרה בדיקה.

זריקות
`DeviceNotAvailableException`	אם המכשיר עובר למצב אופליין.

ראן

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener)

מריצים את כל ה-IRemoteTest שכלולים במודול ומשתמשים בכל ה-preparers לפני ואחרי כדי להגדיר ולנקות את המכשיר.

פרמטרים
`moduleInfo`	`TestInformation`
`listener`	‫`ITestInvocationListener`: `ITestInvocationListener` המקום שבו מדווחים על התוצאות.

זריקות
`DeviceNotAvailableException`	אם המכשיר עובר למצב אופליין.

runPreparation

public Throwable runPreparation (boolean includeSuitePreparers)

מריצים את ההכנות של הבדיקה, כולל הכנות ברמת החבילה אם צוינו.

פרמטרים
`includeSuitePreparers`	‫`boolean`: מגדירים את הערך `true` כדי להפעיל גם את כלי ההכנה ברמת החבילה.

החזרות
`Throwable`	`Throwable` של כל חריגה שמועלית כשמריצים את כלי ההכנה.

setBuild

public void setBuild (IBuildInfo build)

מזריקים את IBuildInfo לשימוש במהלך הבדיקות.

פרמטרים
`build`	`IBuildInfo`

setCollectTestsOnly

public void setCollectTestsOnly (boolean collectTestsOnly)

המתג מפעיל או משבית את מצב איסוף הבדיקות

setDevice

public void setDevice (ITestDevice device)

מזריקים את ITestDevice לשימוש במהלך הבדיקות.

פרמטרים
`device`	`ITestDevice`

setEnableDynamicDownload

public void setEnableDynamicDownload (boolean enableDynamicDownload)

האם להפעיל הורדה דינמית ברמת המודול.

פרמטרים
`enableDynamicDownload`	`boolean`

setIntraModuleInformation

public void setIntraModuleInformation (int shardCount, 
                int shardIndex)

פרמטרים
`shardCount`	`int`
`shardIndex`	`int`

setLogSaver

public void setLogSaver (ILogSaver logSaver)

מעבירים את הכלי לשמירת יומן ההפעלה למודול כדי שיוכל להשתמש בו אם יהיה צורך.

פרמטרים
`logSaver`	`ILogSaver`

setMergeAttemps

public final void setMergeAttemps (boolean mergeAttempts)

הגדרה שקובעת אם למזג את התוצאות או לא.

פרמטרים
`mergeAttempts`	`boolean`

setMetricCollectors

public void setMetricCollectors ( collectors)

מזריקים את רשימת IMetricCollector לשימוש על ידי המודול.

פרמטרים
`collectors`

setRecoverVirtualDevice

public void setRecoverVirtualDevice (boolean recoverVirtualDevice)

הסטים אמורים לשחזר את המכשיר הווירטואלי.

פרמטרים
`recoverVirtualDevice`	`boolean`

setRemoveModuleBuffering

public void setRemoveModuleBuffering (boolean removeModuleBuffering)

פרמטרים
`removeModuleBuffering`	`boolean`

setReportModuleEnd

public void setReportModuleEnd (boolean shouldReportModuleEnd)

פרמטרים
`shouldReportModuleEnd`	`boolean`

setReportModuleStart

public void setReportModuleStart (boolean shouldReportModuleStart)

פרמטרים
`shouldReportModuleStart`	`boolean`

setRetryDecision

public final void setRetryDecision (IRetryDecision decision)

הגדרת IRetryDecision לשימוש בניסיון חוזר בתוך המודול.

פרמטרים
`decision`	`IRetryDecision`

setUseModuleResultsForwarder

public void setUseModuleResultsForwarder (boolean useModuleResultsForwarder)

פרמטרים
`useModuleResultsForwarder`	`boolean`

shouldRecoverVirtualDevice

public boolean shouldRecoverVirtualDevice ()

הפונקציה מחזירה ערך אם צריך לשחזר מכשיר וירטואלי.

החזרות
`boolean`

toString

public String toString ()

החזרות
`String`

transferSuiteLevelOptions

public void transferSuiteLevelOptions (IConfiguration mSuiteConfiguration)

העתקת חלק מההגדרות ברמת החבילה

פרמטרים
`mSuiteConfiguration`	`IConfiguration`

שיטות מוגנות

hasTests

protected boolean hasTests ()

הפונקציה מחזירה את הערך True אם עדיין יש IRemoteTest להפעלה במאגר של המודול. אחרת, הפלט הוא False.

החזרות
`boolean`