آی سندباکس

public interface ISandbox

com.android.tradefed.sandbox.ISandbox


رابطی که یک جعبه شنی (sandbox) را تعریف می‌کند که می‌تواند برای اجرای یک فراخوانی (invocation) استفاده شود.

خلاصه

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

abstract String createClasspath (File workingDir)

یک classpath بر اساس محیط و دایرکتوری کاری برگردانده شده توسط getTradefedSandboxEnvironment(IInvocationContext,IConfiguration,String[]) ایجاد کنید.

abstract IConfiguration createThinLauncherConfig (String[] args, IKeyStoreClient keyStoreClient, IRunUtil runUtil, File globalConfig)

حالت ویژه جدا از اجرای اصلی: وقتی به نظر نمی‌رسد پیکربندی در والد وجود داشته باشد، به thin launcher برمی‌گردیم که در آن سعی می‌کنیم sandbox را با اطلاعات شناخته‌شده‌ی فعلی راه‌اندازی کنیم و دایرکتوری کاری را پر کنیم تا پیکربندی به‌طور کامل در دایرکتوری نسخه‌بندی‌شده ایجاد شود.

default Map<String, List<String>> discoverTests ( IInvocationContext context, IConfiguration configuration)

یک زیرمرحله از prepareEnvironment(IInvocationContext,IConfiguration,ITestInvocationListener) که در صورت فعال بودن SandboxOptions.shouldUseTestDiscovery() تست‌ها را کشف می‌کند.

default Map<String, List<String>> discoverTests ( IInvocationContext context, IConfiguration configuration, ITestLogger logger)
default IFolderBuildInfo fetchSandboxExtraArtifacts ( IInvocationContext context, IConfiguration configuration, String[] args)

زیرمرحله‌ی prepareEnvironment(IInvocationContext,IConfiguration,ITestInvocationListener) که فایل‌های اضافی مورد نیاز برای sandbox را دریافت می‌کند.

default File getTradefedSandboxEnvironment ( IInvocationContext context, IConfiguration nonVersionedConfig, String[] args)

TF محیط sandbox را که باید بر اساس آرگومان‌های خط فرمان استفاده شود، برمی‌گرداند.

default File getTradefedSandboxEnvironment ( IInvocationContext context, IConfiguration nonVersionedConfig, ITestLogger logger, String[] args)
abstract Exception prepareEnvironment ( IInvocationContext context, IConfiguration configuration, ITestInvocationListener listener)

محیط را برای اجرای صحیح سندباکس آماده کنید.

abstract CommandResult run ( TestInformation info, IConfiguration configuration, ITestLogger logger)

سندباکس را با محیطی که تنظیم شده بود اجرا کنید.

abstract void tearDown ()

هر حالت، فایل یا محیطی را که ممکن است تغییر کرده باشد، پاک کنید.

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

ایجادکلاس‌مسیر

public abstract String createClasspath (File workingDir)

یک classpath بر اساس محیط و دایرکتوری کاری برگردانده شده توسط getTradefedSandboxEnvironment(IInvocationContext,IConfiguration,String[]) ایجاد کنید.

پارامترها
workingDir File : دایرکتوری کاری فعلی برای سندباکس.

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

پرتاب‌ها
ConfigurationException

ایجادThinLauncherConfig

public abstract IConfiguration createThinLauncherConfig (String[] args, 
                IKeyStoreClient keyStoreClient, 
                IRunUtil runUtil, 
                File globalConfig)

حالت ویژه جدا از اجرای اصلی: وقتی به نظر نمی‌رسد پیکربندی در والد وجود داشته باشد، به thin launcher برمی‌گردیم که در آن سعی می‌کنیم sandbox را با اطلاعات شناخته‌شده‌ی فعلی راه‌اندازی کنیم و دایرکتوری کاری را پر کنیم تا پیکربندی به‌طور کامل در دایرکتوری نسخه‌بندی‌شده ایجاد شود.

پارامترها
args String : آرگومان‌های اصلی خط فرمان.

keyStoreClient IKeyStoreClient : کلاینت کی‌استور فعلی که برای ایجاد پیکربندی‌ها استفاده می‌شود.

runUtil IRunUtil : IRunUtil فعلی برای اجرای دستورات میزبان.

globalConfig File : پیکربندی سراسری مورد استفاده برای اجرای زیرفرآیندهای TF.

بازگشت‌ها
IConfiguration فایلی که به پیکربندی XML مربوط به TF برای اشیاء NON_VERSIONED اشاره می‌کند. در صورتی که نتوان پیکربندی thin launcher ایجاد کرد، مقدار null را برمی‌گرداند.

کشف تست‌ها

public Map<String, List<String>> discoverTests (IInvocationContext context, 
                IConfiguration configuration)

یک زیرمرحله از prepareEnvironment(IInvocationContext,IConfiguration,ITestInvocationListener) که در صورت فعال بودن SandboxOptions.shouldUseTestDiscovery() تست‌ها را کشف می‌کند.

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

configuration IConfiguration : IConfiguration مربوط به دستوری که قرار است اجرا شود.

بازگشت‌ها
Map<String, List<String>> نقشه تست‌های کشف‌شده یا در صورت عدم پشتیبانی یا شکست، null.

کشف تست‌ها

public Map<String, List<String>> discoverTests (IInvocationContext context, 
                IConfiguration configuration, 
                ITestLogger logger)

پارامترها
context IInvocationContext

configuration IConfiguration

logger ITestLogger

بازگشت‌ها
Map<String, List<String>>

fetchSandboxExtraArtifacts

public IFolderBuildInfo fetchSandboxExtraArtifacts (IInvocationContext context, 
                IConfiguration configuration, 
                String[] args)

زیرمرحله‌ی prepareEnvironment(IInvocationContext,IConfiguration,ITestInvocationListener) که فایل‌های اضافی مورد نیاز برای sandbox را دریافت می‌کند.

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

configuration IConfiguration : IConfiguration مربوط به دستوری که قرار است اجرا شود.

args String : آرگومان‌های خط فرمان.

بازگشت‌ها
IFolderBuildInfo نسخهٔ واکشی‌شده برای فایل‌های اضافیِ در جعبهٔ شنی.

پرتاب‌ها
خطای بازیابی ساخت در com.android.tradefed.build.Build
com.android.tradefed.config.ConfigurationException
استثنای java.io.IO
BuildRetrievalError
ConfigurationException
IOException

محیط getTradedefedSandbox

public File getTradefedSandboxEnvironment (IInvocationContext context, 
                IConfiguration nonVersionedConfig, 
                String[] args)

TF محیط sandbox را که باید بر اساس آرگومان‌های خط فرمان استفاده شود، برمی‌گرداند.

پارامترها
context IInvocationContext : همان IInvocationContext مربوط به والد است.

nonVersionedConfig IConfiguration : IConfiguration که نشان‌دهنده‌ی اشیاء بدون نسخه است.

args String : آرگومان‌های خط فرمان.

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

پرتاب‌ها
Exception

محیط getTradedefedSandbox

public File getTradefedSandboxEnvironment (IInvocationContext context, 
                IConfiguration nonVersionedConfig, 
                ITestLogger logger, 
                String[] args)

پارامترها
context IInvocationContext

nonVersionedConfig IConfiguration

logger ITestLogger

args String

بازگشت‌ها
File

پرتاب‌ها
Exception

آماده‌سازی محیط

public abstract Exception prepareEnvironment (IInvocationContext context, 
                IConfiguration configuration, 
                ITestInvocationListener listener)

محیط را برای اجرای صحیح سندباکس آماده کنید.

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

configuration IConfiguration : IConfiguration مربوط به دستوری که قرار است اجرا شود.

listener ITestInvocationListener : فراخوانی فعلی ITestInvocationListener که نتایج نهایی باید به آن pipe شوند.

بازگشت‌ها
Exception یک Exception شامل شکست. یا در صورت موفقیت، Null.

دویدن

public abstract CommandResult run (TestInformation info, 
                IConfiguration configuration, 
                ITestLogger logger)

سندباکس را با محیطی که تنظیم شده بود اجرا کنید.

پارامترها
info TestInformation : TestInformation فراخوانی را توصیف می‌کند.

configuration IConfiguration : IConfiguration مربوط به دستوری که قرار است اجرا شود.

logger ITestLogger : یک ITestLogger که می‌توانیم فایل‌ها را در آن ثبت کنیم.

بازگشت‌ها
CommandResult یک CommandResult با وضعیت اجرای sandbox و گزارش‌ها.

پرتاب‌ها
Throwable

اشک‌ریزان

public abstract void tearDown ()

هر حالت، فایل یا محیطی را که ممکن است تغییر کرده باشد، پاک کنید.