--- schema_version: "1" id: 223128b21c6861aebd4cfe86c3cb87277e10b651c70fe858cf6c5c8e116c645a title: Test Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_methods_system_test.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm source_site: developer.salesforce.com content_type: documentation content_hash: cf995085a032badab3c32cb0cfd842e34bb460906bf8d887fbc9225a13acd893 description: Contains methods related to Apex tests.Calculates aggregate permissions in specified permission set groups for testing.Calculates aggregate permissions in a specified permission set group for testing.Clear the messages on a Visualforce page while executing Apex test methods.Creates a stub that will respond to SOQL queries against the specified SObject type you can use during testing.Creates a stubbed version of an Apex class that you can use for testing. This method is part of the Apex stub API. You can use it with the System.StubProvider interface to create a mocking framework.Creates an instance of a stubbed SObject type that you can use to provide testing results in the extended System.SoqlStubProvider class.Creates instances of stubbed SObject types that you can use to provide testing results in the extended System.SoqlStubProvider class.Use this method in an Apex test so that change event notifications are generated for all supported Change Data Capture entities. Call this method at the beginning of your test before performing DML operations and calling Test.getEventBus().deliver();.Adds the specified number of jobs with no-operation contents to the test-context queue. It first fills the test batch queue, up to the maximum 5 jobs, and then places jobs in the test flex queue. It throws a limit exception when the number of jobs in the test flex queue exceeds the allowed limit of 100 jobs.Returns an instance of the test event bus broker, which lets you operate on platform event or change event messages in an Apex test. For example, you can call Test.getEventBus().deliver() to deliver event messages.Returns an ordered list of job IDs for jobs in the test-context flex queue. The job at index 0 is the next job slated to run. This method returns only test-context results, even if it’s annotated with @IsTest(SeeAllData=true).Returns the ID of the standard price book in the organization.Invokes the callback method for the specified controller and continuation in a test method.Returns true if the currently executing code was called by code contained in a test method, false otherwise. Use this method if you need to run different code depending on whether it was being called from a test.Returns true if a SOQL stub is defined for an SObject type; otherwise returns false.Inserts test records from the specified static resource .csv file and for the specified sObject type, and returns a list of the inserted sObjects.Tests a notification action handler implementation by simulating the execution of an action for a specific notification.Creates a new QuickAction.SendEmailQuickActionDefaults instance for testing a class implementing the QuickAction.QuickActionDefaultsHandler interface.Sets a mock response for a continuation HTTP request in a test method.Sets CreatedDate for a test-context sObject.A Visualforce test method that sets the current PageReference for the controller.A Visualforce test method that sets the current PageReference for the controller.Defines a list of fixed search results to be returned by all subsequent SOSL statements in a test method.Sets the response mock mode and instructs the Apex runtime to send a mock response whenever a callout is made through the HTTP classes or the auto-generated code from WSDLs.Sets the application mode for an organization to read-only in an Apex test to simulate read-only mode during Salesforce upgrades and downtimes. The application mode is reset to the default mode at the end of each Apex test run.Marks the point in your test code when your test actually begins. Use this method when you are testing governor limits.Marks the point in your test code when your test ends. Use this method in conjunction with the startTest method. Tests the implementation of the InstallHandler interface, which is used for specifying a post install script in packages. Tests run as the test initiator in the development environment.Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. Tests run as the test initiator in the development environment.Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. When RunAsAutoProcUser is true, tests run as Automated Process user in the development environment.Tests the implementation of the UninstallHandler interface, which is used for specifying an uninstall script in packages. Tests run as the test initiator in the development environment. --- # Test Class Contains methods related to Apex tests. ## Namespace [System](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_System.htm "The System namespace provides classes and methods for core Apex functionality.") ## Test Methods The following are methods for Test. All methods are static. - **[calculatePermissionSetGroup(psgIds)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_calculatePermissionSetGroup)** Calculates aggregate permissions in specified permission set groups for testing. - **[calculatePermissionSetGroup(psgId)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_calculatePermissionSetGroup_2)** Calculates aggregate permissions in a specified permission set group for testing. - **[clearApexPageMessages()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_clearApexPageMessages)** Clear the messages on a Visualforce page while executing Apex test methods. - **[createSoqlStub(targetType, soqlStub)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_createSoqlStub)** Creates a stub that will respond to SOQL queries against the specified SObject type you can use during testing. - **[createStub(parentType, stubProvider)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_createStub)** Creates a stubbed version of an Apex class that you can use for testing. This method is part of the Apex stub API. You can use it with the System.StubProvider interface to create a mocking framework. - **[createStubQueryRow(targetType, fieldMapWithRelationshipKeys)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_createStubQueryRow)** Creates an instance of a stubbed SObject type that you can use to provide testing results in the extended System.SoqlStubProvider class. - **[createStubQueryRows(targetType, fieldMapWithRelationshipKeysForMultipleRows)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_createStubQueryRows)** Creates instances of stubbed SObject types that you can use to provide testing results in the extended System.SoqlStubProvider class. - **[enableChangeDataCapture()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_enableChangeDataCapture)** Use this method in an Apex test so that change event notifications are generated for all supported Change Data Capture entities. Call this method at the beginning of your test before performing DML operations and calling Test.getEventBus().deliver();. - **[enqueueBatchJobs(numberOfJobs)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_enqueueBatchJobs)** Adds the specified number of jobs with no-operation contents to the test-context queue. It first fills the test batch queue, up to the maximum 5 jobs, and then places jobs in the test flex queue. It throws a limit exception when the number of jobs in the test flex queue exceeds the allowed limit of 100 jobs. - **[getEventBus()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_getEventBus)** Returns an instance of the test event bus broker, which lets you operate on platform event or change event messages in an Apex test. For example, you can call Test.getEventBus().deliver() to deliver event messages. - **[getFlexQueueOrder()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_getFlexQueueOrder)** Returns an ordered list of job IDs for jobs in the test-context flex queue. The job at index 0 is the next job slated to run. This method returns only test-context results, even if it’s annotated with @IsTest(SeeAllData=true). - **[getStandardPricebookId()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_getStandardPricebookId)** Returns the ID of the standard price book in the organization. - **[invokeContinuationMethod(controller, request)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_invokeContinuationMethod)** Invokes the callback method for the specified controller and continuation in a test method. - **[isRunningTest()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_isRunningTest)** Returns true if the currently executing code was called by code contained in a test method, false otherwise. Use this method if you need to run different code depending on whether it was being called from a test. - **[isSoqlStubDefined(targetType)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_isSoqlStubDefined)** Returns true if a SOQL stub is defined for an SObject type; otherwise returns false. - **[loadData(sObjectToken, resourceName)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_loadData)** Inserts test records from the specified static resource .csv file and for the specified sObject type, and returns a list of the inserted sObjects. - **[testNotificationActionHandler (handler, actionableNotification)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_NotificationActionHandler)** Tests a notification action handler implementation by simulating the execution of an action for a specific notification. - **[newSendEmailQuickActionDefaults(contextId, replyToId)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_newSendEmailQuickActionDefaults)** Creates a new QuickAction.SendEmailQuickActionDefaults instance for testing a class implementing the QuickAction.QuickActionDefaultsHandler interface. - **[setContinuationResponse(requestLabel, mockResponse)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_setContinuationResponse)** Sets a mock response for a continuation HTTP request in a test method. - **[setCreatedDate(recordId, createdDatetime)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_setCreatedDate)** Sets CreatedDate for a test-context sObject. - **[setCurrentPage(page)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_setCurrentPage)** A Visualforce test method that sets the current PageReference for the controller. - **[setCurrentPageReference(page)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_setCurrentPageReference)** A Visualforce test method that sets the current PageReference for the controller. - **[setFixedSearchResults(fixedSearchResults)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_setFixedSearchResults)** Defines a list of fixed search results to be returned by all subsequent SOSL statements in a test method. - **[setMock(interfaceType, instance)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_setMock)** Sets the response mock mode and instructs the Apex runtime to send a mock response whenever a callout is made through the HTTP classes or the auto-generated code from WSDLs. - **[setReadOnlyApplicationMode(applicationMode)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_setReadOnlyApplicationMode)** Sets the application mode for an organization to read-only in an Apex test to simulate read-only mode during Salesforce upgrades and downtimes. The application mode is reset to the default mode at the end of each Apex test run. - **[startTest()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_startTest)** Marks the point in your test code when your test actually begins. Use this method when you are testing governor limits. - **[stopTest()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_stopTest)** Marks the point in your test code when your test ends. Use this method in conjunction with the startTest method. - **[testInstall(installImplementation, version, isPush)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_testInstall)** Tests the implementation of the InstallHandler interface, which is used for specifying a post install script in packages. Tests run as the test initiator in the development environment. - **[testSandboxPostCopyScript(script, organizationId, sandboxId, sandboxName)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_testSandboxPostCopyScript)** Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. Tests run as the test initiator in the development environment. - **[testSandboxPostCopyScript(script, organizationId, sandboxId, sandboxName, RunAsAutoProcUser)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_testSandboxPostCopyScript_2)** Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. When RunAsAutoProcUser is true, tests run as Automated Process user in the development environment. - **[testUninstall(uninstallImplementation)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_test.htm#apex_System_Test_testUninstall)** Tests the implementation of the UninstallHandler interface, which is used for specifying an uninstall script in packages. Tests run as the test initiator in the development environment. ### calculatePermissionSetGroup(psgIds) Calculates aggregate permissions in specified permission set groups for testing. #### Signature public static void calculatePermissionSetGroup(List psgIds) #### Parameters - **psgIds**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\> A list of IDs for permission set groups. #### Return Value Type: void ### calculatePermissionSetGroup(psgId) Calculates aggregate permissions in a specified permission set group for testing. #### Signature public static void calculatePermissionSetGroup(String psgId) #### Parameters - **psgId**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") A single ID for a specified permission set group. #### Return Value Type: void ### clearApexPageMessages() Clear the messages on a Visualforce page while executing Apex test methods. #### Signature public static void clearApexPageMessages() #### Return Value Type: void #### Usage This method may only be used in tests. #### Example @IsTest static void clearMessagesTest() { Test.setCurrentPage(new PageReference('/')); ApexPages.addMessage( new ApexPages.Message(ApexPages.Severity.WARNING, 'Sample Warning') ); Assert.areEqual(1, ApexPages.getMessages().size()); Test.clearApexPageMessages(); Assert.areEqual(0, ApexPages.getMessages().size()); } ### createSoqlStub(targetType, soqlStub) Creates a stub that will respond to SOQL queries against the specified SObject type you can use during testing. #### Signature public static void createSoqlStub(Schema.SObjectType targetType, System.SoqlStubProvider soqlStub) #### Parameters - **targetType**: Type: [Schema.SObjectType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Schema_SObjectType.htm#apex_class_Schema_SObjectType "A Schema.sObjectType object is returned from the field describe result using the getReferenceTo method, or from the sObject describe result using the getSObjectType method.") The SObject type to be stubbed. This parameter can’t be null. - **soqlStub**: Type: [System.SoqlStubProvider](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_SoqlStubProvider.htm#apex_class_System_SoqlStubProvider "Contains a method to create a mock test class for handling SOQL query responses for Data 360 data model objects (DMOs).") An implementation of the SoqlStubProvider abstract class. #### Return Value Type: void #### See Also - [_Apex Developer Guide_: Mock SOQL Tests for Data Cloud Data Model Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/MockSOQLTestsForDMOs.htm "Apex Developer Guide: Mock SOQL Tests for Data Cloud Data Model Objects - HTML (New Window)") ### createStub(parentType, stubProvider) Creates a stubbed version of an Apex class that you can use for testing. This method is part of the Apex stub API. You can use it with the System.StubProvider interface to create a mocking framework. #### Signature public static Object createStub(System.Type parentType, System.StubProvider stubProvider) #### Parameters - **parentType**: Type: [System.Type](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_type.htm#apex_methods_system_type "Contains methods for getting the Apex type that corresponds to an Apex class and for instantiating new types.") The type of the Apex class to be stubbed. - **stubProvider**: [System.StubProvider](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_interface_System_StubProvider.htm#apex_interface_System_StubProvider "StubProvider is a callback interface that you can use as part of the Apex stub API to implement a mocking framework. Use this interface with the Test.createStub() method to create stubbed Apex objects for testing.") An implementation of the StubProvider interface. #### Return Value Type: Object Returns the stubbed object to use in testing. #### Usage The createStub() method works together with the System.StubProvider interface. You define the behavior of the stubbed object by implementing the StubProvider interface. Then you create a stubbed object using the createStub() method. When you invoke methods on the stubbed object, the handleMethodCall() method of the StubProvider interface is called to perform the behavior of the stubbed method. #### See Also - [_Apex Developer Guide_: Build a Mocking Framework with the Stub API](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_testing_stub_api.htm "Apex Developer Guide: Build a Mocking Framework with the Stub API - HTML (New Window)") ### createStubQueryRow(targetType, fieldMapWithRelationshipKeys) Creates an instance of a stubbed SObject type that you can use to provide testing results in the extended System.SoqlStubProvider class. #### Signature public static SObject createStubQueryRow(Schema.SObjectType targetType, Map fieldMapWithRelationshipKeys) #### Parameters - **targetType**: Type: [Schema.SObjectType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Schema_SObjectType.htm#apex_class_Schema_SObjectType "A Schema.sObjectType object is returned from the field describe result using the getReferenceTo method, or from the sObject describe result using the getSObjectType method.") The SObject type to be stubbed. This parameter can’t be null. - **fieldMapWithRelationshipKeys**: Type: [Map](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_map.htm#apex_methods_system_map "Contains methods for the Map collection type.") The map contains the fields for a parent entity, keyed by the field name with a value for each field. Key and value pairs can also be used for an aggregate relationship. The key holds the name of the aggregate relationship and the value is a list of SObjects. #### Return Value Type: [SObject](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_sobject.htm#apex_methods_system_sobject "Contains methods for the sObject data type.") Returns the stubbed SObject to use in testing. #### Example ssot\_\_EmailEngagement\_\_dlm engagement = (ssot\_\_EmailEngagement\_\_dlm)Test.createStubQueryRow(ssot\_\_EmailEngagement\_\_dlm.SObjectType, new Map { 'ssot\_\_Name\_\_c' => 'My Email Engagement', 'ssot\_\_CityName\_\_c' => 'San Francisco' } ); #### See Also - [_Apex Developer Guide_: Mock SOQL Tests for Data Cloud Data Model Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/MockSOQLTestsForDMOs.htm "Apex Developer Guide: Mock SOQL Tests for Data Cloud Data Model Objects - HTML (New Window)") ### createStubQueryRows(targetType, fieldMapWithRelationshipKeysForMultipleRows) Creates instances of stubbed SObject types that you can use to provide testing results in the extended System.SoqlStubProvider class. #### Signature public static List createStubQueryRows(Schema.SObjectType targetType, List> fieldMapWithRelationshipKeysForMultipleRows) #### Parameters - **targetType**: Type: [Schema.SObjectType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Schema_SObjectType.htm#apex_class_Schema_SObjectType "A Schema.sObjectType object is returned from the field describe result using the getReferenceTo method, or from the sObject describe result using the getSObjectType method.") The SObject type to be stubbed. This parameter can’t be null. - **fieldMapWithRelationshipKeysForMultipleRows**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Map](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_map.htm#apex_methods_system_map "Contains methods for the Map collection type.")> The list of maps containing the fields for a parent entity, keyed by the field name with a value for each field. Key and value pairs can also be used for an aggregate relationship used in the query. The key holds the name of the aggregate relationship and the value is a list of SObjects. #### Return Value Type: List<[SObject](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_sobject.htm#apex_methods_system_sobject "Contains methods for the sObject data type.")\> Returns a list of stubbed SObject types to use in testing. #### Example List> engagementMaps = new List>(); Map engagement = new Map { 'ssot\_\_Name\_\_c' => 'My Email Engagement', 'ssot\_\_CityName\_\_c' => 'San Francisco' }; Map engagement2 = new Map { 'ssot\_\_Name\_\_c' => 'My Other Email Engagement', 'ssot\_\_CityName\_\_c' => 'New York' }; engagementMaps.add(engagement); engagementMaps.add(engagement2); List engagements = (List)Test.createStubQueryRows(ssot\_\_EmailEngagement\_\_dlm.SObjectType, engagementMaps); #### See Also - [_Apex Developer Guide_: Mock SOQL Tests for Data Cloud Data Model Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/MockSOQLTestsForDMOs.htm "Apex Developer Guide: Mock SOQL Tests for Data Cloud Data Model Objects - HTML (New Window)") ### enableChangeDataCapture() Use this method in an Apex test so that change event notifications are generated for all supported Change Data Capture entities. Call this method at the beginning of your test before performing DML operations and calling Test.getEventBus().deliver();. #### Signature public static void enableChangeDataCapture() #### Return Value Type: void #### Usage The enableChangeDataCapture() method ensures that Apex tests can fire change event triggers regardless of the entities selected in Setup in the Change Data Capture page. The enableChangeDataCapture() method doesn’t affect the entities selected in Setup. #### See Also - [_Change Data Capture Developer Guide_](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_intro.htm "Change Data Capture Developer Guide - HTML (New Window)") ### enqueueBatchJobs(numberOfJobs) Adds the specified number of jobs with no-operation contents to the test-context queue. It first fills the test batch queue, up to the maximum 5 jobs, and then places jobs in the test flex queue. It throws a limit exception when the number of jobs in the test flex queue exceeds the allowed limit of 100 jobs. #### Signature public static List enqueueBatchJobs(Integer numberOfJobs) #### Parameters - **numberOfJobs**: Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_integer.htm#apex_methods_system_integer "Contains methods for the Integer primitive data type.") Number of test jobs to enqueue. #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.")\> A list of IDs of enqueued test jobs. #### Usage Use this method to reduce testing time. Instead of using your org's real batch jobs for testing, you can use this method to simulate batch-job enqueueing. Using enqueueBatchJobs(numberOfJobs) is faster than enqueuing real batch jobs. ### getEventBus() Returns an instance of the test event bus broker, which lets you operate on platform event or change event messages in an Apex test. For example, you can call Test.getEventBus().deliver() to deliver event messages. #### Signature public static EventBus.TestBroker getEventBus() #### Return Value Type: [EventBus.TestBroker](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_eventbus_TestBroker.htm#apex_class_eventbus_TestBroker "Contains methods that simulate the successful delivery or failed publishing of platform event or change event messages in an Apex test.") A broker for the test event bus. #### Usage Enclose Test.getEventBus().deliver() within the Test.startTest() and Test.stopTest() statement block. Test.startTest(); // Create test events // ... // Publish test events with EventBus.publish() // ... // Deliver test events Test.getEventBus().deliver(); // Perform validation // ... Test.stopTest(); #### See Also - [_Platform Events Developer Guide_](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm "Platform Events Developer Guide - HTML (New Window)") ### getFlexQueueOrder() Returns an ordered list of job IDs for jobs in the test-context flex queue. The job at index 0 is the next job slated to run. This method returns only test-context results, even if it’s annotated with @IsTest(SeeAllData=true). #### Signature public static List getFlexQueueOrder() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.")\> An ordered list of IDs of the jobs in the test’s flex queue. ### getStandardPricebookId() Returns the ID of the standard price book in the organization. #### Signature public static Id getStandardPricebookId() #### Return Value Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") The ID of the standard price book. #### Usage This method returns the ID of the standard price book in your organization regardless of whether the test can query organization data. By default, tests can’t query organization data unless they’re annotated with @isTest(SeeAllData=true). Creating price book entries with a standard price requires the ID of the standard price book. Use this method to get the standard price book ID so that you can create price book entries in your tests. #### Example This example creates some test data for price book entries. The test method in this example gets the standard price book ID and uses this ID to create a price book entry for a product with a standard price. Next, the test creates a custom price book and uses the ID of this custom price book to add a price book entry with a custom price. @IsTest public with sharing class PriceBookTest { // Utility method that can be called by Apex tests to create price book entries. @IsTest static void addPricebookEntries() { // First, set up test price book entries. // Insert a test product. Product2 prod = new Product2(Name = 'Laptop X200', Family = 'Hardware'); insert as user prod; // Get standard price book ID. // This is available irrespective of the state of SeeAllData. Id pricebookId = Test.getStandardPricebookId(); // 1. Insert a price book entry for the standard price book. // Standard price book entries require the standard price book ID we got earlier. PricebookEntry standardPrice = new PricebookEntry( Pricebook2Id = pricebookId, Product2Id = prod.Id, UnitPrice = 10000, IsActive = true); insert as user standardPrice; // Create a custom price book Pricebook2 customPB = new Pricebook2(Name='Custom Pricebook', isActive=true); insert as user customPB; // 2. Insert a price book entry with a custom price. PricebookEntry customPrice = new PricebookEntry( Pricebook2Id = customPB.Id, Product2Id = prod.Id, UnitPrice = 12000, IsActive = true); insert as user customPrice; // Next, perform some tests with your test price book entries. } } ### invokeContinuationMethod(controller, request) Invokes the callback method for the specified controller and continuation in a test method. #### Signature public static Object invokeContinuationMethod(Object controller, Continuation request) #### Parameters - **controller**: Type: Object An instance of the controller class that invokes the continuation request. - **request**: Type: Continuation The continuation that is returned by an action method in the controller class. #### Return Value Type: Object The response of the continuation callback method. #### Usage Use the Test.setContinuationResponse and Test.invokeContinuationMethod methods to test continuations. In test context, callouts of continuations aren’t sent to the external service. By using these methods, you can set a mock response and cause the runtime to call the continuation callback method to process the mock response. Call Test.setContinuationResponse before you call Test.invokeContinuationMethod. When you call Test.invokeContinuationMethod, the runtime executes the callback method that is associated with the continuation. The callback method processes the mock response that is set by Test.setContinuationResponse. ### isRunningTest() Returns true if the currently executing code was called by code contained in a test method, false otherwise. Use this method if you need to run different code depending on whether it was being called from a test. #### Signature public static Boolean isRunningTest() #### Return Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") ### isSoqlStubDefined(targetType) Returns true if a SOQL stub is defined for an SObject type; otherwise returns false. #### Signature public static Boolean isSoqlStubDefined(Schema.SObjectType targetType) #### Parameters - **targetType**: Type: [Schema.SObjectType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Schema_SObjectType.htm#apex_class_Schema_SObjectType "A Schema.sObjectType object is returned from the field describe result using the getReferenceTo method, or from the sObject describe result using the getSObjectType method.") The SObject type to check. This parameter can’t be null. #### Return Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") ### loadData(sObjectToken, resourceName) Inserts test records from the specified static resource .csv file and for the specified sObject type, and returns a list of the inserted sObjects. #### Signature public static List loadData(Schema.SObjectType sObjectToken, String resourceName) #### Parameters - **sObjectToken**: Type: [Schema.SObjectType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Schema_SObjectType.htm#apex_class_Schema_SObjectType "A Schema.sObjectType object is returned from the field describe result using the getReferenceTo method, or from the sObject describe result using the getSObjectType method.") The sObject type for which to insert test records. - **resourceName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The static resource that corresponds to the .csv file containing the test records to load. The name is case insensitive. #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[sObject](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_sobject.htm#apex_methods_system_sobject "Contains methods for the sObject data type.")\> #### Usage You must create the static resource prior to calling this method. The static resource is a comma-delimited file ending with a .csv extension. The file contains field names and values for the test records. The first line of the file must contain the field names and subsequent lines are the field values. To learn more about static resources, see “Defining Static Resources” in the Salesforce online help. Once you create a static resource for your .csv file, the static resource will be assigned a MIME type. Supported MIME types are: - text/csv - application/vnd.ms-excel - application/octet-stream - text/plain ### testNotificationActionHandler (handler, actionableNotification) Tests a notification action handler implementation by simulating the execution of an action for a specific notification. #### Signature public static Messaging.ActionResult testNotificationActionHandler( Messaging.NotificationActionHandler handler, Messaging.ActionableNotification actionableNotification ) #### Return Value Type: Messaging.ActionResult The result object generated by the handler, typically containing success status and any relevant error messages or return data. #### Usage This method allows you to perform unit tests on custom notification logic without needing to trigger an actual push notification through the platform. Use this in conjunction with Assert methods to verify that your handler processes inputs correctly and returns the expected ActionResult. #### Example The following example demonstrates how to use testNotificationActionHandler to verify a custom handler named LeadAssignmentHandler. @IsTest private with sharing class NotificationHandlerTest { @IsTest static void testNotificationSuccess() { // 1. Initialize your custom handler Messaging.NotificationActionHandler myHandler = new LeadAssignmentHandler(); // 2. Set up the mock ActionableNotification Messaging.ActionableNotification mockNotification = new Messaging.ActionableNotification(); // Assume 'AcceptLead' is a valid action ID for your handler logic mockNotification.setActionId('AcceptLead'); // 3. Invoke the test method Test.startTest(); Messaging.ActionResult result = Messaging.testNotificationActionHandler( myHandler, mockNotification ); Test.stopTest(); // 4. Verify the results Assert.isNotNull(result, 'The result should not be null.'); Assert.isTrue(result.isSuccess(), 'The action should have succeeded.'); } } ### newSendEmailQuickActionDefaults(contextId, replyToId) Creates a new QuickAction.SendEmailQuickActionDefaults instance for testing a class implementing the QuickAction.QuickActionDefaultsHandler interface. #### Signature public static QuickAction.SendEmailQuickActionDefaults newSendEmailQuickActionDefaults(ID contextId, ID replyToId) #### Parameters - **contextId**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") Parent record of the email message. - **replyToId**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") Previous email message ID if this email message is a reply. #### Return Value Type: [SendEmailQuickActionDefaults Class](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_QuickAction_SendEmailQuickActionDefaults.htm#apex_class_QuickAction_SendEmailQuickActionDefaults "Represents an Apex class that provides: the From address list; the original email’s email message ID, provided that the reply action was invoked on the email message feed item; and methods to specify related settings on templates. You can override these fields before the standard Email Action is rendered.") The default values used for an email message quick action. ### setContinuationResponse(requestLabel, mockResponse) Sets a mock response for a continuation HTTP request in a test method. #### Signature public static void setContinuationResponse(String requestLabel, System.HttpResponse mockResponse) #### Parameters - **requestLabel**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The unique label that corresponds to the continuation HTTP request. This label is returned by Continuation.addHttpRequest. - **mockResponse**: Type: [HttpResponse](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_classes_restful_http_httpresponse.htm#apex_classes_restful_http_httpresponse "Use the HttpResponse class to handle the HTTP response returned by the Http class.") The fake response to be returned by Test.invokeContinuationMethod. #### Return Value Type: void #### Usage Use the Test.setContinuationResponse and Test.invokeContinuationMethod methods to test continuations. In test context, callouts of continuations aren’t sent to the external service. By using these methods, you can set a mock response and cause the runtime to call the continuation callback method to process the mock response. Call Test.setContinuationResponse before you call Test.invokeContinuationMethod. When you call Test.invokeContinuationMethod, the runtime executes the callback method that is associated with the continuation. The callback method processes the mock response that is set by Test.setContinuationResponse. ### setCreatedDate(recordId, createdDatetime) Sets CreatedDate for a test-context sObject. #### Signature public static void setCreatedDate(Id recordId, Datetime createdDatetime) #### Parameters - **recordId**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") The ID of an sObject. - **createdDatetime**: Type: [Datetime](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_datetime.htm#apex_methods_system_datetime "Contains methods for the Datetime primitive data type.") The value to assign to the sObject’s CreatedDate field. #### Return Value Type: void #### Usage All database changes are rolled back at the end of a test. You can’t use this method on records that existed before your test executed. You also can’t use setCreatedDate in methods annotated with @isTest(SeeAllData=true), because those methods have access to all data in your org. If you set CreatedDate to a future value, it can cause unexpected results. This method takes two parameters—an sObject ID and a Datetime value—neither of which can be null. Insert your test record before you set its CreatedDate, as shown in this example. @IsTest private with sharing class SetCreatedDateTest { @IsTest static void testSetCreatedDate() { Account a = new Account(name='myAccount'); insert as user a; Test.setCreatedDate(a.Id, DateTime.newInstance(2012,12,12)); Test.startTest(); Account myAccount = \[SELECT Id, Name, CreatedDate FROM Account WHERE Name ='myAccount' WITH USER\_MODE LIMIT 1\]; Assert.areEqual(DateTime.newInstance(2012,12,12), myAccount.CreatedDate); Test.stopTest(); } } ### setCurrentPage(page) A Visualforce test method that sets the current PageReference for the controller. #### Signature public static Void setCurrentPage(PageReference page) #### Parameters - **page**: Type: [System.PageReference](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_system_pagereference.htm "A PageReference is a reference to an instantiation of a page. Among other attributes, PageReferences consist of a URL and a set of query parameter names and values.") #### Return Value Type: Void ### setCurrentPageReference(page) A Visualforce test method that sets the current PageReference for the controller. #### Signature public static Void setCurrentPageReference(PageReference page) #### Parameters - **page**: Type: [System.PageReference](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_system_pagereference.htm "A PageReference is a reference to an instantiation of a page. Among other attributes, PageReferences consist of a URL and a set of query parameter names and values.") #### Return Value Type: Void ### setFixedSearchResults(fixedSearchResults) Defines a list of fixed search results to be returned by all subsequent SOSL statements in a test method. #### Signature public static Void setFixedSearchResults(ID\[\] fixedSearchResults) #### Parameters - **fixedSearchResults**: Type: [ID](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.")\[\] The list of record IDs specified by opt\_set\_search\_results replaces the results that would normally be returned by the SOSL queries if they were not subject to any WHERE or LIMIT clauses. If these clauses exist in the SOSL queries, they are applied to the list of fixed search results. #### Return Value Type: Void #### Usage If opt\_set\_search\_results is not specified, all subsequent SOSL queries return no results. For more information, see [Dynamic SOSL](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_testing_SOSL.htm). ### setMock(interfaceType, instance) Sets the response mock mode and instructs the Apex runtime to send a mock response whenever a callout is made through the HTTP classes or the auto-generated code from WSDLs. #### Signature public static Void setMock(Type interfaceType, Object instance) #### Parameters - **interfaceType**: Type: [System.Type](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_type.htm#apex_methods_system_type "Contains methods for getting the Apex type that corresponds to an Apex class and for instantiating new types.") - **instance**: Type: Object #### Return Value Type: Void #### Usage ![Note](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note.png) #### Note To mock a callout if the code that performs the callout is in a managed package, call Test.setMock from a test method in the same package with the same namespace. ### setReadOnlyApplicationMode(applicationMode) Sets the application mode for an organization to read-only in an Apex test to simulate read-only mode during Salesforce upgrades and downtimes. The application mode is reset to the default mode at the end of each Apex test run. #### Signature public static Void setReadOnlyApplicationMode(Boolean applicationMode) #### Parameters - **applicationMode**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") #### Return Value Type: Void #### Usage Also see the [getApplicationReadWriteMode()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_system.htm#apex_System_System_getApplicationReadWriteMode "Returns the read write mode set for an organization during Salesforce.com upgrades and downtimes.") System method. Do not use setReadOnlyApplicationMode for purposes unrelated to Read-Only Mode testing, such as simulating DML exceptions. #### Example The following example sets the application mode to read-only and attempts to insert a new account record, which results in the exception. It then resets the application mode and performs a successful insert. @IsTest private with sharing class ApplicationReadOnlyModeTestClass { @IsTest public static void test() { // Create a test account that is used for querying later. Account testAccount = new Account(Name = 'TestAccount'); insert as user testAccount; // Set the application read only mode. Test.setReadOnlyApplicationMode(true); // Verify that the application is in read-only mode. Assert.areEqual( ApplicationReadWriteMode.READ\_ONLY, System.getApplicationReadWriteMode() ); // Create a new account object. Account testAccount2 = new Account(Name = 'TestAccount2'); try { // Get the test account created earlier. Should be successful. Account testAccountFromDb = \[ SELECT Id, Name FROM Account WHERE Name = 'TestAccount' WITH USER\_MODE \]; Assert.areEqual(testAccount.Id, testAccountFromDb.Id); // Inserts should result in the InvalidReadOnlyUserDmlException // being thrown. insert as user testAccount2; Assert.fail('Expected System.InvalidReadOnlyUserDmlException was not thrown.'); } catch (System.InvalidReadOnlyUserDmlException e) { // Expected exception caught successfully } // Insertion should work after read only application mode gets disabled. Test.setReadOnlyApplicationMode(false); insert as user testAccount2; Account testAccount2FromDb = \[ SELECT Id, Name FROM Account WHERE Name = 'TestAccount2' WITH USER\_MODE \]; Assert.areEqual(testAccount2.Id, testAccount2FromDb.Id); } } ### startTest() Marks the point in your test code when your test actually begins. Use this method when you are testing governor limits. #### Signature public static Void startTest() #### Return Value Type: Void #### Usage You can also use this method with stopTest to ensure that all asynchronous calls that come after the startTest method are run before doing any assertions or testing. Each test method is allowed to call this method only once. All of the code before this method should be used to initialize variables, populate data structures, and so on, allowing you to set up everything you need to run your test. Any code that executes after the call to startTest and before stopTest is assigned a new set of governor limits. ### stopTest() Marks the point in your test code when your test ends. Use this method in conjunction with the startTest method. #### Signature public static Void stopTest() #### Return Value Type: Void #### Usage Each test method is allowed to call this method only once. Any code that executes after the stopTest method is assigned the original limits that were in effect before startTest was called. All asynchronous calls made after the startTest method are collected by the system. When stopTest is executed, all asynchronous processes are run synchronously. ![Note](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note.png) #### Note Asynchronous calls, such as @future or executeBatch, called in a startTest, stopTest block, do not count against your limits for the number of queued jobs. ### testInstall(installImplementation, version, isPush) Tests the implementation of the InstallHandler interface, which is used for specifying a post install script in packages. Tests run as the test initiator in the development environment. #### Signature public static Void testInstall(InstallHandler installImplementation, Version version, Boolean isPush) #### Parameters - **installImplementation**: Type: [System.InstallHandler](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_install_handler.htm#apex_install_handler "Enables custom code to run after a managed package installation or upgrade.") A class that implements the InstallHandler interface. - **version**: Type: [System.Version](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_version.htm#apex_methods_system_version "Use the Version methods to get the version of a first-generation managed package (1GP) or a migrated second-generation managed package (2GP), and to compare package versions.") The version number of the existing package installed in the subscriber organization. - **isPush**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") (Optional) Specifies whether the upgrade is a push. The default value is false. #### Return Value Type: Void #### Usage This method throws a run-time exception if the test install fails. #### Example @isTest static void test() { PostInstallClass postinstall = new PostInstallClass(); Test.testInstall(postinstall, new Version(1,0)); } ### testSandboxPostCopyScript(script, organizationId, sandboxId, sandboxName) Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. Tests run as the test initiator in the development environment. #### Signature public static void testSandboxPostCopyScript(System.SandboxPostCopy script, Id organizationId, Id sandboxId, String sandboxName) #### Parameters - **script**: Type: [System.SandboxPostCopy](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_interface_System_SandboxPostCopy.htm#apex_interface_System_SandboxPostCopy "To make your sandbox environment business ready, automate data manipulation or business logic tasks. Extend this interface and add methods to perform post-copy tasks, then specify the class during sandbox creation.") A class that implements the SandboxPostCopy interface. - **organizationId**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") The sandbox organization ID - **sandboxId**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") The sandbox ID to be provided to the SandboxPostCopy script. - **sandboxName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The sandbox name to be provided to the SandboxPostCopy script. #### Return Value Type: void #### Usage This method throws a run-time exception if the test install fails. ![Note](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note.png) #### Note Salesforce recommends that you use the [testSandboxPostCopyScript(script, organizationId, sandboxId, sandboxName, isRunAsAutoProcUser)](#apex_System_Test_testSandboxPostCopyScript_2 "Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. When RunAsAutoProcUser is true, tests run as Automated Process user in the development environment.") overload instead of this method. When isRunAsAutoProcUser is true, the SandboxPostCopy script is tested with the same user access permissions as used by post-copy tasks during sandbox creation. Using the same permissions enables the test to better simulate the actual usage of the class, and to uncover potential issues. #### Example See [SandboxPostCopy Example Implementation](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_interface_System_SandboxPostCopy.htm#apex_interface_System_SandboxPostCopy_Example "These examples show a simple implementation of the SandboxPostCopy interface and a test for that implementation. To test your SandboxPostCopy implementation, use the System.Test.testSandboxPostCopyScript() method.") ### testSandboxPostCopyScript(script, organizationId, sandboxId, sandboxName, RunAsAutoProcUser) Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. When RunAsAutoProcUser is true, tests run as Automated Process user in the development environment. #### Signature public static void testSandboxPostCopyScript(System.SandboxPostCopy script, Id organizationId, Id sandboxId, String sandboxName, Boolean RunAsAutoProcUser) #### Parameters - **script**: Type: [System.SandboxPostCopy](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_interface_System_SandboxPostCopy.htm#apex_interface_System_SandboxPostCopy "To make your sandbox environment business ready, automate data manipulation or business logic tasks. Extend this interface and add methods to perform post-copy tasks, then specify the class during sandbox creation.") A class that implements the SandboxPostCopy interface. - **organizationId**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") The sandbox organization ID. - **sandboxId**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") The sandbox ID to be provided to the SandboxPostCopy script. - **sandboxName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The sandbox name to be provided to the SandboxPostCopy script. - **RunAsAutoProcUser**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") When true, the SandboxPostCopy script is tested with the same user access permissions as used by post-copy tasks during sandbox creation. Using the same permissions enables the test to better simulate the actual usage of the class, and to uncover potential issues. When false, the test runs as the test initiator. This option can alter the permissions with which the script is tested, such as the ability to access objects and features. #### Return Value Type: void #### Usage This method throws a run-time exception if the test install fails. #### Example See [SandboxPostCopy Example Implementation](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_interface_System_SandboxPostCopy.htm#apex_interface_System_SandboxPostCopy_Example "These examples show a simple implementation of the SandboxPostCopy interface and a test for that implementation. To test your SandboxPostCopy implementation, use the System.Test.testSandboxPostCopyScript() method.") ### testUninstall(uninstallImplementation) Tests the implementation of the UninstallHandler interface, which is used for specifying an uninstall script in packages. Tests run as the test initiator in the development environment. #### Signature public static Void testUninstall(UninstallHandler uninstallImplementation) #### Parameters - **uninstallImplementation**: Type: [System.UninstallHandler](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_uninstall_handler.htm#apex_System_UninstallHandler_methods) A class that implements the UninstallHandler interface. #### Return Value Type: Void #### Usage This method throws a run-time exception if the test uninstall fails. #### Example @isTest static void test() { UninstallClass uninstall = new UninstallClass(); Test.testUninstall(uninstall); }