ITestObjectProvider Interface

Signature

export interface ITestObjectProvider

Properties

Property	Type	Description
createFluidEntryPoint	(testContainerConfig?: ITestContainerConfig) => fluidEntryPoint
defaultCodeDetails	IFluidCodeDetails
documentId	string
documentServiceFactory	IDocumentServiceFactory
driver	ITestDriver
logger	ITelemetryBaseLogger
opProcessingController	IOpProcessingController
urlResolver	IUrlResolver

Methods

Method	Return Type	Description
createContainer(entryPoint, loaderProps)	Promise<IContainer>
createLoader(packageEntries, loaderProps)	IHostLoader
ensureSynchronized()	Promise<void>
loadContainer(entryPoint, loaderProps, requestHeader)	Promise<IContainer>
loadTestContainer(testContainerConfig, requestHeader)	Promise<IContainer>
makeTestContainer(testContainerConfig)	Promise<IContainer>
makeTestLoader(testContainerConfig)	IHostLoader	Used to create a test Container. The Loader/ContainerRuntime/DataRuntime might be different versioned. In generateLocalCompatTest(), this Container and its runtime will be arbitrarily-versioned.
reset()	void
updateDocumentId(url)	void

Property Details

createFluidEntryPoint

Signature

createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;

Type: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint

defaultCodeDetails

Signature

defaultCodeDetails: IFluidCodeDetails;

Type: IFluidCodeDetails

documentId

Signature

documentId: string;

Type: string

documentServiceFactory

Signature

documentServiceFactory: IDocumentServiceFactory;

Type: IDocumentServiceFactory

driver

Signature

driver: ITestDriver;

Type: ITestDriver

logger

Signature

logger: ITelemetryBaseLogger;

Type: ITelemetryBaseLogger

opProcessingController

Signature

opProcessingController: IOpProcessingController;

Type: IOpProcessingController

urlResolver

Signature

urlResolver: IUrlResolver;

Type: IUrlResolver

Method Details

createContainer

Signature

createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;

Parameters

Parameter	Modifiers	Type	Description
entryPoint		fluidEntryPoint
loaderProps	optional	Partial<ILoaderProps>

Returns

Return type: Promise<IContainer>

createLoader

Signature

createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): IHostLoader;

Parameters

Parameter	Modifiers	Type	Description
packageEntries		Iterable<[IFluidCodeDetails, fluidEntryPoint]>
loaderProps	optional	Partial<ILoaderProps>

Returns

Return type: IHostLoader

ensureSynchronized

Signature

ensureSynchronized(): Promise<void>;

Returns

Return type: Promise<void>

loadContainer

Signature

loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;

Parameters

Parameter	Modifiers	Type	Description
entryPoint		fluidEntryPoint
loaderProps	optional	Partial<ILoaderProps>
requestHeader	optional	IRequestHeader

Returns

Return type: Promise<IContainer>

loadTestContainer

Signature

loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;

Parameters

Parameter	Modifiers	Type	Description
testContainerConfig	optional	ITestContainerConfig
requestHeader	optional	IRequestHeader

Returns

Return type: Promise<IContainer>

makeTestContainer

Signature

makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;

Parameters

Parameter	Modifiers	Type	Description
testContainerConfig	optional	ITestContainerConfig

Returns

Return type: Promise<IContainer>

makeTestLoader

Used to create a test Container. The Loader/ContainerRuntime/DataRuntime might be different versioned. In generateLocalCompatTest(), this Container and its runtime will be arbitrarily-versioned.

Signature

makeTestLoader(testContainerConfig?: ITestContainerConfig): IHostLoader;

Parameters

Parameter	Modifiers	Type	Description
testContainerConfig	optional	ITestContainerConfig

Returns

Return type: IHostLoader

reset

Signature

reset(): void;

updateDocumentId

Signature

updateDocumentId(url: IResolvedUrl | undefined): void;

Parameters

Parameter	Type	Description
url	IResolvedUrl | undefined	Resolved container URL