Class TestContext

constructor

• new TestContext(options?): TestContext

• Parameters

  • options: {
        sandbox?: SinonSandbox;
        setup?: boolean;
        sinon?: SinonStatic;
    } = {}

    • Optionalsandbox?: SinonSandbox

    • Optionalsetup?: boolean

    • Optionalsinon?: SinonStatic

  Returns TestContext

configStubs

id

SANDBOX

SANDBOXES

stubs

TEST_LOGGER

fakeConnectionRequest

• fakeConnectionRequest(request, options?): Promise<AnyJson>

• Used to mock http request to Salesforce.

  Parameters

  • request: AnyJson

    An HttpRequest.
  • Optionaloptions: AnyJson

    Additional options.

    See Connection.request

  Returns Promise<AnyJson>

getConfigStubContents

• getConfigStubContents(name, group?): ConfigContents

• Gets a config stub contents by name.

  Parameters

  • name: string

    The name of the config.
  • Optionalgroup: string

    If the config supports groups.

  Returns ConfigContents

globalPathRetriever

• globalPathRetriever(uid): Promise<string>

• A function used when resolving the global path. Calls globalPathResolverSync by default.

  Parameters

  • uid: string

    Unique id.

  Returns Promise<string>

globalPathRetrieverSync

• globalPathRetrieverSync(uid): string

• A function used when resolving the global path.

  Parameters

  • uid: string

    Unique id.

  Returns string

init

• init(): void

• Returns void

inProject

• inProject(inProject?): void

• Set stubs for working in the context of a SfProject

  Parameters

  • inProject: boolean = true

  Returns void

localPathRetriever

• localPathRetriever(uid): Promise<string>

• A function used when resolving the local path. Calls localPathResolverSync by default.

  Parameters

  • uid: string

    Unique id.

  Returns Promise<string>

localPathRetrieverSync

• localPathRetrieverSync(uid): string

• A function used when resolving the local path.

  Parameters

  • uid: string

    Unique id.

  Returns string

restore

• restore(): void

• Returns void

rootPathRetriever

• rootPathRetriever(isGlobal, uid?): Promise<string>

• A function used for resolving paths. Calls localPathRetriever and globalPathRetriever.

  Parameters

  • isGlobal: boolean

    true if the config is global.
  • Optionaluid: string

    user id.

  Returns Promise<string>

rootPathRetrieverSync

• rootPathRetrieverSync(isGlobal, uid?): string

• A function used for resolving paths. Calls localPathRetrieverSync and globalPathRetrieverSync.

  Parameters

  • isGlobal: boolean

    true if the config is global.
  • Optionaluid: string

    user id.

  Returns string

setConfigStubContents

• setConfigStubContents(name, value): void

• Sets a config stub contents by name

  Parameters

  • name: string

    The name of the config stub.
  • value: ConfigContents

    The actual stub contents. The Mock data.

  Returns void

setup

• setup(): void

• Add beforeEach and afterEach hooks to init the stubs and restore them. This is called automatically when the class is instantiated unless the setup option is set to false.

  Returns void

stubAliases

• stubAliases(aliases, group?): void

• Stub the aliases in the global aliases config file.

  Parameters

  • aliases: Record<string, string>
  • group: string = aliasAccessorEntireFile.DEFAULT_GROUP

  Returns void

stubAuths

• stubAuths(...orgs): Promise<void>

• Stub salesforce org authorizations.

  Parameters

  • Rest...orgs: MockTestOrgData[]

  Returns Promise<void>

stubConfig

• stubConfig(config): Promise<void>

• Stub contents in the config file.

  Parameters

  • config: Record<string, string>

  Returns Promise<void>

stubSandboxes

• stubSandboxes(...sandboxes): Promise<void>

• Stub salesforce sandbox authorizations.

  Parameters

  • Rest...sandboxes: MockTestSandboxData[]

  Returns Promise<void>

stubUsers

• stubUsers(users): void

• Stub salesforce user authorizations.

  Parameters

  • users: Record<string, MockTestOrgData[]>

    The users to stub. The key is the username of the admin user and it must be included in the users array in order to obtain the orgId key for the remaining users. The admin user is excluded from the users array.

  Returns void

uniqid

• uniqid(): string

• Generate unique string.

  Returns string