اطلاعات ساخت

public interface IBuildInfo
implements Serializable

com.android.tradefed.build.IBuildInfo


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

خلاصه

ثابت‌ها

String REMOTE_FILE_PREFIX

پیشوندی که در نام فایل استفاده می‌شود تا نشان دهد که دانلود فایل با تأخیر انجام می‌شود.

String REMOTE_FILE_VERSION

فایل راه دور نسخه‌بندی نشده است.

String UNKNOWN_BUILD_ID

مقدار پیش‌فرض زمانی که شناسه ساخت ناشناخته است.

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

default void addAppPackageFile (File appPackageFile, String version)

فایل apk محلی و نسخه مرتبط با آن را اضافه می‌کند.

abstract void addBuildAttribute (String attributeName, String attributeValue)

یک ویژگی ساخت اضافه کنید.

default void addBuildAttributes (Map<String, String> buildAttributes)

اضافه کردن ویژگی‌های ساخت

default void allowStagingRemoteFile (boolean stageRemoteFile)

مجوزی را برای امکان مرحله‌بندی فایل‌های راه دور تنظیم می‌کند.

abstract void cleanUp ()

فایل‌های ساخت موقت را پاک کنید

abstract void cleanUp (List<File> doNotDelete)

نسخه‌ای از cleanUp() که در آن برخی از فایل‌ها حذف نمی‌شوند.

abstract IBuildInfo clone ()

شیء IBuildInfo را کلون می‌کند.

default List< VersionedFile > getAppPackageFiles ()

یک کپی از مجموعه فایل(های) apk برنامه محلی و نسخه‌های آنها را دریافت می‌کند.

abstract Map<String, String> getBuildAttributes ()

مجموعه‌ای از جفت‌های نام-مقدار از ویژگی‌های اضافی که ساختار را توصیف می‌کنند، دریافت کنید.

abstract String getBuildBranch ()

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

abstract String getBuildFlavor ()

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

abstract String getBuildId ()

شناسه منحصر به فرد ساخت تحت آزمایش را برمی‌گرداند.

abstract String getBuildTargetName ()

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

abstract String getDeviceSerial ()
abstract File getFile (String name)

متد کمکی برای بازیابی فایلی با نام داده شده.

default File getFile ( BuildInfoKey.BuildInfoFileKey key)

متد کمکی برای بازیابی فایلی با استفاده از BuildInfoFileKey داده شده.

abstract Collection< VersionedFile > getFiles ()

تمام VersionedFile های ذخیره شده در این BuildInfo را برمی‌گرداند.

abstract Set< IBuildInfo.BuildInfoProperties > getProperties ()

یک کپی از ویژگی‌هایی که در حال حاضر روی IBuildInfo تنظیم شده‌اند را برمی‌گرداند.

default Set<File> getRemoteFiles ()

مسیرهای مربوط به ساخت مصنوعاتی که دانلود آنها با تأخیر مواجه است را دریافت کنید.

abstract String getTestTag ()

یک نام منحصر به فرد برای تست‌های در حال اجرا برمی‌گرداند.

default String getVersion ( BuildInfoKey.BuildInfoFileKey key)

متد کمکی برای بازیابی نسخه فایل با استفاده از BuildInfoFileKey داده شده.

abstract String getVersion (String name)

متد کمکی برای بازیابی نسخه فایل با نام داده شده.

default VersionedFile getVersionedFile ( BuildInfoKey.BuildInfoFileKey key)

متد کمکی برای بازیابی یک VersionedFile با یک BuildInfoFileKey داده شده.

default VersionedFile getVersionedFile (String name)

متد کمکی برای بازیابی یک VersionedFile با نام مشخص.

default Set<String> getVersionedFileKeys ()

مجموعه کلیدهای موجود برای جستجوی VersionedFile از طریق getFile(BuildInfoFileKey) را برمی‌گرداند.

default List< VersionedFile > getVersionedFiles ( BuildInfoKey.BuildInfoFileKey key)

متد کمکی برای بازیابی لیستی از VersionedFile های مرتبط با یک BuildInfoFileKey داده شده.

default void removeBuildAttribute (String attributeName)

یک ویژگی داده شده به نام Name را از ردیابی حذف کنید.

abstract void setBuildBranch (String branch)

شاخه ساخت را تنظیم کنید

abstract void setBuildFlavor (String buildFlavor)

طعم ساخت را تنظیم کنید.

abstract void setBuildId (String buildId)

شناسه منحصر به فرد ساخت تحت آزمایش را تنظیم می‌کند.

abstract void setDeviceSerial (String serial)

سریال ITestDevice مرتبط با این ساخت را تنظیم کنید.

default void setFile ( BuildInfoKey.BuildInfoFileKey key, File file, String version)

فایلی را که با BuildInfoFileKey مشخص شده است، در این اطلاعات ساخت ذخیره می‌کند.

abstract void setFile (String name, File file, String version)

فایلی با نام داده شده را در این اطلاعات ساخت ذخیره می‌کند.

abstract void setProperties ( BuildInfoProperties... properties)

BuildInfoProperties برای نمونه IBuildInfo تنظیم کنید.

abstract void setTestTag (String testTag)

نام منحصر به فرد برای تست‌های در حال اجرا را تنظیم می‌کند.

default File stageRemoteFile (String fileName, File workingDir)

فایلی را که بخشی از فایل‌های راه دور در دایرکتوری ریشه build info است، استیج کنید.

default BuildInformation.BuildInfo toProto ()

یک نمونه BuildInfo را به یک protobuf سریالایز کنید.

ثابت‌ها

پیشوند_فایل_راه_دور

public static final String REMOTE_FILE_PREFIX

پیشوندی که در نام فایل استفاده می‌شود تا نشان دهد که دانلود فایل با تأخیر انجام می‌شود.

مقدار ثابت: "remote_file:"

نسخه_فایل_راه_دور

public static final String REMOTE_FILE_VERSION

فایل راه دور نسخه‌بندی نشده است.

مقدار ثابت: ""

شناسه ساخت ناشناس

public static final String UNKNOWN_BUILD_ID

مقدار پیش‌فرض زمانی که شناسه ساخت ناشناخته است.

مقدار ثابت: "-1"

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

فایل بسته‌ی برنامه‌ی اضافه

public void addAppPackageFile (File appPackageFile, 
                String version)

فایل apk محلی و نسخه مرتبط با آن را اضافه می‌کند. توجه داشته باشید که apkها به ترتیبی که توسط این متد اضافه شده‌اند، از getAppPackageFiles() برگردانده می‌شوند.

پارامترها
appPackageFile File

version String

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

یک ویژگی ساخت اضافه کنید. این اجازه نمی‌دهد که یک ویژگی نام موجود را نادیده بگیرید.

پارامترها
attributeName String : نام ویژگی منحصر به فرد

attributeValue String : مقدار ویژگی

addBuildAttributes

public void addBuildAttributes (Map<String, String> buildAttributes)

اضافه کردن ویژگی‌های ساخت

پارامترها
buildAttributes Map : نقشه ویژگی‌هایی که باید اضافه شوند

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

مجوزی را برای امکان مرحله‌بندی فایل‌های راه دور تنظیم می‌کند.

پارامترها
stageRemoteFile boolean

پاکسازی

public abstract void cleanUp ()

فایل‌های ساخت موقت را پاک کنید

پاکسازی

public abstract void cleanUp (List<File> doNotDelete)

نسخه‌ای از cleanUp() که در آن برخی از فایل‌ها حذف نمی‌شوند.

پارامترها
doNotDelete List

کلون

public abstract IBuildInfo clone ()

شیء IBuildInfo را کلون می‌کند.

بازگشت‌ها
IBuildInfo

دریافت فایل‌های بسته‌ی برنامه

public List<VersionedFile> getAppPackageFiles ()

یک کپی از مجموعه فایل(های) apk برنامه محلی و نسخه‌های آنها را دریافت می‌کند. ترتیب برگردانده شده با ترتیبی که apkها به IAppBuildInfo اضافه شده‌اند، مطابقت دارد.

بازگشت‌ها
List< VersionedFile >

getBuildAttributes

public abstract Map<String, String> getBuildAttributes ()

مجموعه‌ای از جفت‌های نام-مقدار از ویژگی‌های اضافی که ساختار را توصیف می‌کنند، دریافت کنید.

بازگشت‌ها
Map<String, String> Map از ویژگی‌های ساخت. null نخواهد بود، اما می‌تواند خالی باشد.

شاخه‌ی ساخت‌وساز

public abstract String getBuildBranch ()

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

بازگشت‌ها
String شاخه ساخت یا در صورت تنظیم نشدن/عدم کاربرد، null

دریافت‌کننده

public abstract String getBuildFlavor ()

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

یک پیاده‌سازی رایج برای ساخت‌های پلتفرم اندروید، برگرداندن (build product)-(build os)-(build variant) است. یعنی generic-linux-userdebug

بازگشت‌ها
String اگر unset/unapplicable باشد، مقدار build flavor یا null برمی‌گرداند.

دریافت شناسه ساخت

public abstract String getBuildId ()

شناسه منحصر به فرد ساخت تحت آزمایش را برمی‌گرداند. هرگز نباید تهی باشد. مقدار پیش‌فرض UNKNOWN_BUILD_ID است.

بازگشت‌ها
String

دریافت نام هدف Build

public abstract String getBuildTargetName ()

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

یک پیاده‌سازی رایج، ساخت نام هدف ساخت از ترکیبی از طعم ساخت و نام شاخه است. [یعنی (نام شاخه)-(طعم ساخت)]

بازگشت‌ها
String

سریال دستگاه را دریافت کنید

public abstract String getDeviceSerial ()

بازگشت‌ها
String سریال ITestDevice که این ساخت روی آن اجرا شده است. اگر هیچ دستگاهی با این ساخت مرتبط نباشد، null را برمی‌گرداند.

دریافت فایل

public abstract File getFile (String name)

متد کمکی برای بازیابی فایلی با نام داده شده.

بازگشت‌ها
File فایل تصویر یا در صورت عدم یافتن، null

دریافت فایل

public File getFile (BuildInfoKey.BuildInfoFileKey key)

متد کمکی برای بازیابی فایلی با استفاده از BuildInfoFileKey داده شده.

پارامترها
key BuildInfoKey.BuildInfoFileKey : کلید BuildInfoFileKey که درخواست شده است.

بازگشت‌ها
File فایل تصویر یا در صورت عدم یافتن، null

دریافت فایل‌ها

public abstract Collection<VersionedFile> getFiles ()

تمام VersionedFile های ذخیره شده در این BuildInfo را برمی‌گرداند.

بازگشت‌ها
Collection< VersionedFile >

دریافت ویژگی‌ها

public abstract Set<IBuildInfo.BuildInfoProperties> getProperties ()

یک کپی از ویژگی‌هایی که در حال حاضر روی IBuildInfo تنظیم شده‌اند را برمی‌گرداند.

بازگشت‌ها
Set< IBuildInfo.BuildInfoProperties >

دریافت فایل‌های راه دور

public Set<File> getRemoteFiles ()

مسیرهای مربوط به ساخت مصنوعاتی که دانلود آنها با تأخیر مواجه است را دریافت کنید.

بازگشت‌ها
Set<File>

تگ getTest

public abstract String getTestTag ()

یک نام منحصر به فرد برای تست‌های در حال اجرا برمی‌گرداند.

بازگشت‌ها
String

دریافت نسخه

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

متد کمکی برای بازیابی نسخه فایل با استفاده از BuildInfoFileKey داده شده.

پارامترها
key BuildInfoKey.BuildInfoFileKey : کلید BuildInfoFileKey درخواست شده.

بازگشت‌ها
String نسخه تصویر یا در صورت عدم یافتن، null

دریافت نسخه

public abstract String getVersion (String name)

متد کمکی برای بازیابی نسخه فایل با نام داده شده.

بازگشت‌ها
String نسخه تصویر یا در صورت عدم یافتن، null

دریافت فایل نسخه‌بندی‌شده

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

متد کمکی برای بازیابی یک VersionedFile با یک BuildInfoFileKey داده شده.

پارامترها
key BuildInfoKey.BuildInfoFileKey : کلید BuildInfoFileKey درخواست شده.

بازگشت‌ها
VersionedFile فایل نسخه‌بندی شده یا در صورت عدم یافتن null

دریافت فایل نسخه‌بندی‌شده

public VersionedFile getVersionedFile (String name)

متد کمکی برای بازیابی یک VersionedFile با نام مشخص.

بازگشت‌ها
VersionedFile فایل نسخه‌بندی شده یا در صورت عدم یافتن null

کلیدهای فایل نسخه‌بندی‌شده را دریافت کنید

public Set<String> getVersionedFileKeys ()

مجموعه کلیدهای موجود برای جستجوی VersionedFile از طریق getFile(BuildInfoFileKey) را برمی‌گرداند.

بازگشت‌ها
Set<String>

فایل‌های دریافت‌شده

public List<VersionedFile> getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

متد کمکی برای بازیابی لیستی از VersionedFile های مرتبط با یک BuildInfoFileKey داده شده. در صورتی که کلید اجازه ذخیره لیست را بدهد.

پارامترها
key BuildInfoKey.BuildInfoFileKey : کلید BuildInfoFileKey درخواست شده.

بازگشت‌ها
List< VersionedFile > فایل نسخه‌بندی شده یا در صورت عدم یافتن null

حذف ویژگی ساخت

public void removeBuildAttribute (String attributeName)

یک ویژگی داده شده به نام Name را از ردیابی حذف کنید.

پارامترها
attributeName String : ویژگی برای توقف ردیابی

شاخه‌ی تنظیم‌شده‌ی ساخت

public abstract void setBuildBranch (String branch)

شاخه ساخت را تنظیم کنید

پارامترها
branch String : نام شاخه

مجموعه ساخت طعم

public abstract void setBuildFlavor (String buildFlavor)

طعم ساخت را تنظیم کنید.

شناسه ساخت را تنظیم کنید

public abstract void setBuildId (String buildId)

شناسه منحصر به فرد ساخت تحت آزمایش را تنظیم می‌کند. هرگز نباید تهی باشد.

پارامترها
buildId String

سریال دستگاه را تنظیم کنید

public abstract void setDeviceSerial (String serial)

سریال ITestDevice مرتبط با این ساخت را تنظیم کنید.

پارامترها
serial String : شماره سریال ITestDevice که این ساخت با آن اجرا شده است.

تنظیم فایل

public void setFile (BuildInfoKey.BuildInfoFileKey key, 
                File file, 
                String version)

فایلی را که با BuildInfoFileKey مشخص شده است، در این اطلاعات ساخت ذخیره می‌کند.

پارامترها
key BuildInfoKey.BuildInfoFileKey : نام منحصر به فرد فایل بر اساس BuildInfoFileKey .

file File : File محلی

version String : نسخه فایل

تنظیم فایل

public abstract void setFile (String name, 
                File file, 
                String version)

فایلی با نام داده شده را در این اطلاعات ساخت ذخیره می‌کند.

پارامترها
name String : نام منحصر به فرد فایل

file File : File محلی

version String : نسخه فایل

مجموعه ویژگی‌ها

public abstract void setProperties (BuildInfoProperties... properties)

BuildInfoProperties برای نمونه IBuildInfo تنظیم کنید. هر ویژگی موجود تنظیم شده قبلی را لغو کنید.

پارامترها
properties BuildInfoProperties : فهرست ویژگی‌هایی که باید اضافه شوند.

تنظیمTestTag

public abstract void setTestTag (String testTag)

نام منحصر به فرد برای تست‌های در حال اجرا را تنظیم می‌کند.

پارامترها
testTag String

فایل از راه دور مرحله‌ای

public File stageRemoteFile (String fileName, 
                File workingDir)

فایلی را که بخشی از فایل‌های راه دور در دایرکتوری ریشه build info است، استیج کنید.

TODO(b/138416078): این رابط و فراخواننده‌ی آن را هنگامی که ماژول‌های مورد نیاز یک تست می‌توانند به درستی ساخته شوند و خروجی را در دایرکتوری خود ماژول تست قرار دهند، حذف کنید.

پارامترها
fileName String : نام فایلی که قرار است در فایل‌های راه دور قرار گیرد.

workingDir File : یک شیء File از دایرکتوری برای مرحله‌بندی فایل.

بازگشت‌ها
File شیء File مربوط به فایلی که در workingDir محلی قرار دارد.

توپروتو

public BuildInformation.BuildInfo toProto ()

یک نمونه BuildInfo را به یک protobuf سریالایز کنید.

بازگشت‌ها
BuildInformation.BuildInfo