TestModuleContainer

@group

Modules

Index

Constructors

• constructor

Properties

• octo

Methods

• commit
• createResources
• createTestAnchor
• createTestModels
• createTestOverlays
• createTestResources
• initialize
• mapTransactionActions
• orderModules
• registerCapture
• reset
• runModule
• runModules

Constructors

constructor

• TestModuleContainer(): TestModuleContainer

• Returns TestModuleContainer

Properties

readonlyocto

octo: Octo

Methods

commit

• commit(app: App, __namedParameters?: { enableResourceCapture?: boolean; filterByModuleIds?: string[] }): Promise<{ modelDiffs: DiffMetadata[][]; modelTransaction: DiffMetadata[][]; resourceDiffs: DiffMetadata[][]; resourceTransaction: DiffMetadata[][] }>

• Parameters

  • app: App

  • __namedParameters: { enableResourceCapture?: boolean; filterByModuleIds?: string[] } = {}

  • optionalenableResourceCapture: boolean = false

  • optionalfilterByModuleIds: string[] = []

  Returns Promise<{ modelDiffs: DiffMetadata[][]; modelTransaction: DiffMetadata[][]; resourceDiffs: DiffMetadata[][]; resourceTransaction: DiffMetadata[][] }>

createResources

• createResources(moduleId: string, args: UnknownResource[], options?: { save?: boolean }): Promise<Promise<{}>>

• Parameters

  • moduleId: string

  • args: UnknownResource[]

  • optionaloptions: { save?: boolean }

  • optionalsave: boolean

  Returns Promise<Promise<{}>>

createTestAnchor

• createTestAnchor<S>(anchorId: string, properties: S[properties], parent: S[parentInstance]): UnknownAnchor

• Type parameters

  • S: BaseAnchorSchema & { parentInstance: UnknownModel }

  Parameters

  • anchorId: string

  • properties: S[properties]

  • parent: S[parentInstance]

  Returns UnknownAnchor

createTestModels

• createTestModels(moduleId: string, args: { account?: (string | Account)[]; app?: (string | App)[]; deployment?: (string | Deployment)[]; environment?: (string | Environment)[]; execution?: (string | Execution)[]; filesystem?: (string | Filesystem)[]; image?: (string | Image)[]; pipeline?: (string | Pipeline)[]; region?: (string | Region)[]; server?: (string | Server)[]; service?: (Service | [string, Record<string, unknown>?])[]; subnet?: (string | Subnet)[] }): Promise<{ account: Account[]; app: App[]; deployment: Deployment[]; environment: Environment[]; execution: Execution[]; filesystem: Filesystem[]; image: Image[]; pipeline: Pipeline[]; region: Region[]; server: Server[]; service: Service[]; subnet: Subnet[] }>

• Parameters

  • moduleId: string

  • args: { account?: (string | Account)[]; app?: (string | App)[]; deployment?: (string | Deployment)[]; environment?: (string | Environment)[]; execution?: (string | Execution)[]; filesystem?: (string | Filesystem)[]; image?: (string | Image)[]; pipeline?: (string | Pipeline)[]; region?: (string | Region)[]; server?: (string | Server)[]; service?: (Service | [string, Record<string, unknown>?])[]; subnet?: (string | Subnet)[] }

  • optionalaccount: (string | Account)[]

  • optionalapp: (string | App)[]

  • optionaldeployment: (string | Deployment)[]

  • optionalenvironment: (string | Environment)[]

  • optionalexecution: (string | Execution)[]

  • optionalfilesystem: (string | Filesystem)[]

  • optionalimage: (string | Image)[]

  • optionalpipeline: (string | Pipeline)[]

  • optionalregion: (string | Region)[]

  • optionalserver: (string | Server)[]

  • optionalservice: (Service | [string, Record<string, unknown>?])[]

  • optionalsubnet: (string | Subnet)[]

  Returns Promise<{ account: Account[]; app: App[]; deployment: Deployment[]; environment: Environment[]; execution: Execution[]; filesystem: Filesystem[]; image: Image[]; pipeline: Pipeline[]; region: Region[]; server: Server[]; service: Service[]; subnet: Subnet[] }>

createTestOverlays

• createTestOverlays(moduleId: string, args: { anchors: UnknownAnchor[]; context: string; properties?: {} }[]): Promise<Promise<{}>>

• Parameters

  • moduleId: string

  • args: { anchors: UnknownAnchor[]; context: string; properties?: {} }[]

  Returns Promise<Promise<{}>>

createTestResources

• createTestResources<S>(moduleId: string, args: { [ K in string | number | symbol ]: Partial<Pick<S[K<K>], properties | response | tags>> & { parents?: UnknownResource[] | string[]; resourceActions?: IUnknownResourceAction[]; resourceContext: string } }, options?: { save?: boolean }): Promise<Promise<{}>>

• Type parameters

  • S: BaseResourceSchema[]

  Parameters

  • moduleId: string

  • args: { [ K in string | number | symbol ]: Partial<Pick<S[K<K>], properties | response | tags>> & { parents?: UnknownResource[] | string[]; resourceActions?: IUnknownResourceAction[]; resourceContext: string } }

  • optionaloptions: { save?: boolean }

  • optionalsave: boolean

  Returns Promise<Promise<{}>>

initialize

• initialize(stateProvider?: IStateProvider, initializeInContainer?: { options?: { args?: unknown[]; metadata?: {} }; type: string | Constructable<unknown> }[], excludeInContainer?: { type: string | Constructable<unknown> }[]): Promise<void>

• Parameters

  • optionalstateProvider: IStateProvider

  • optionalinitializeInContainer: { options?: { args?: unknown[]; metadata?: {} }; type: string | Constructable<unknown> }[]

  • optionalexcludeInContainer: { type: string | Constructable<unknown> }[]

  Returns Promise<void>

mapTransactionActions

• mapTransactionActions(transaction: DiffMetadata[][]): string[][]

• Parameters

  • transaction: DiffMetadata[][]

  Returns string[][]

orderModules

• orderModules(modules: (string | Constructable<UnknownModule>)[]): Promise<void>

• Parameters

  • modules: (string | Constructable<UnknownModule>)[]

  Returns Promise<void>

registerCapture

• registerCapture<S>(resourceContext: string, response: Partial<S[response]>): void

• Type parameters

  • S: BaseResourceSchema

  Parameters

  • resourceContext: string

  • response: Partial<S[response]>

  Returns void

reset

• reset(): Promise<void>

• Returns Promise<void>

runModule

• runModule<M>(module: TestModule<M>): Promise<{}>

• Type parameters

  • M: UnknownModule

  Parameters

  • module: TestModule<M>

  Returns Promise<{}>

runModules

• runModules<M>(modules: TestModule<M>[]): Promise<{}>

• Type parameters

  • M: UnknownModule

  Parameters

  • modules: TestModule<M>[]

  Returns Promise<{}>