@salesforce/salesforcedx-vscode-test-tools
Version:
Test automation framework for Salesforce Extensions for VS Code
34 lines (33 loc) • 1.42 kB
TypeScript
import { TestSetup } from '../../src/testSetup';
/**
* Sets up a scratch org for testing
* @param testSetup - The test setup configuration
* @param scratchOrgEdition - The edition of the scratch org to create
*/
export declare function setUpScratchOrg(testSetup: TestSetup): Promise<TestSetup>;
/**
* Authorizes a DevHub for use in tests
* @param testSetup - The test setup configuration
* @throws Error if DevHub alias or username are not set
*/
export declare function authorizeDevHub(testSetup: TestSetup): Promise<void>;
/**
* Verifies that the alias and user name are set and match an org in the org list
* @throws Error if DevHub alias or username are not set or can't be found in org list
*/
export declare function verifyAliasAndUserName(): Promise<void>;
export declare const createDefaultScratchOrgViaCli: (testSetup: TestSetup) => Promise<TestSetup>;
/**
* Creates a default scratch org for testing
* @param testSetup - The test setup configuration
* @param edition - The edition of the scratch org to create (defaults to 'developer')
* @throws Error if scratch org creation fails
* @private
*/
export declare function createDefaultScratchOrg(): Promise<string>;
/**
* Deletes scratch org information from the DevHub
* @param testSetup - The test setup configuration
* @throws Error if deletion fails
*/
export declare function deleteScratchOrgInfo(testSetup: TestSetup): Promise<void>;