TST_Factory

Class · Group: Testing

global without sharing class TST_Factory

Factory class for generating test data, permission set assignments, share records, metadata updates, and failure logs across Salesforce objects. Optimized for unit tests and integration processes, providing methods to create records with random data and configure system settings such as API toggles, triggers, and scheduled jobs.

Example

User testUser = TST_Factory.newUser('Standard User');
insert testUser;

---

Methods

Method	Description
global static void createPermissionSetAssignments(List<User> users, Id permissionSetOrGroupId)	Creates PermissionSetAssignment records for a list of users and a permission set Id.
global static void createPermissionSetAssignments(List<User> users, String permissionSetOrGroupName)	Creates PermissionSetAssignment records for a list of users and a permission set.
global static ApiCall__c newApiCall()	Creates an uncommitted ApiCall__c record for a web service call.
global static ApiCall__c newApiCall(String serviceName)	Creates an uncommitted ApiCall__c record with a specified service name.
global static ContentVersion newContentVersion(Id linkToObjectId, String fileName, Blob body)	Creates an uncommitted ContentVersion record from file data.
global static FeatureFlag__mdt newFeatureFlag(String flagName)	Activates a feature flag for testing by injecting it into the selector cache.
global static ApiCall__c newInboundApiCall(String serviceName)	Creates an uncommitted ApiCall__c record for an inbound web service call.
global static ApiSetting__mdt newInboundApiSetting(String className, String endpointPath)	Creates a mock inbound ApiSetting__mdt record via TST_Mock for test routing.
global static ApiSetting__mdt newInboundApiSetting(String className, String endpointPath, Integer priority)	Creates a mock inbound ApiSetting__mdt record with a custom priority, registered with TST_Mock for query interception.
global static ApiSetting__mdt newInboundApiSetting(String className, String endpointPath, Integer priority, Map<SObjectField, Object> overrides)	Creates a mock inbound ApiSetting__mdt record with a custom priority and additional field overrides, registered with TST_Mock for query interception.
global static ApiCall__c newOutboundApiCall(String serviceName)	Creates an uncommitted ApiCall__c record for an outbound web service call.
global static ApiCall__c newOutboundApiCall(String serviceName, Id recordId)	Creates an uncommitted ApiCall__c record for an outbound web service call with a triggering object.
global static ApiCall__c newOutboundApiCall(String serviceName, Id recordId, Map<String, String> requestParameters)	Creates an uncommitted ApiCall__c record for an outbound web service call with parameters.
global static ApiCall__c newOutboundApiCall(String serviceName, Id recordId, String parameterName, String parameterValue)	Creates an uncommitted ApiCall__c record for an outbound web service call with a single parameter.
global static ApiSetting__mdt newOutboundApiSetting(String className, Map<SObjectField, Object> overrides)	Creates a mock outbound ApiSetting__mdt record via TST_Mock for query interception.
global static User newUser(String profileName)	Creates a single uncommitted User record with the specified profile.
global static User newUser(String profileName, String companyName)	Creates an uncommitted User record with a custom company name.
global static List<User> newUsers(String profileName, Integer numberOfUsers)	Creates a list of uncommitted User records with the specified profile.
global static User newUserWithPermissionSet(String profileName, String companyName, String permissionSetName)	Creates and inserts a User with the specified profile + company name, then assigns the named permission set (or permission set group).

createPermissionSetAssignments

global static void createPermissionSetAssignments(List<User> users, Id permissionSetOrGroupId)

Creates PermissionSetAssignment records for a list of users and a permission set Id.

Parameters

Parameter	Type	Description
users	List	The list of users to assign the permission set to.
permissionSetOrGroupId	User	The Id of the permission set.

Example

List<User> users = TST_Factory.newUsers('Standard User', 2);
insert users;
PermissionSet permissionSet = [SELECT Id FROM PermissionSet WHERE Name = 'CustomPermissionSet' LIMIT 1];
TST_Factory.createPermissionSetAssignments(users, permissionSet.Id);
System.debug('Permission Set Assignments Created');

global static void createPermissionSetAssignments(List<User> users, String permissionSetOrGroupName)

Creates PermissionSetAssignment records for a list of users and a permission set.

Parameters

Parameter	Type	Description
users	List	The list of users to assign the permission set to.
permissionSetOrGroupName	User	The name of the permission set.

Throws

Exception	Description
AssertException	If no permission set is found for the specified name.

Example

List<User> users = TST_Factory.newUsers('Standard User', 2);
insert users;
TST_Factory.createPermissionSetAssignments(users, 'CustomPermissionSet');
System.debug('Permission Set Assignments Created');

newApiCall

global static ApiCall__c newApiCall()

Creates an uncommitted ApiCall__c record for a web service call.

Returns ApiCall__c — An uncommitted ApiCall__c record.

Example

ApiCall__c apiCall = TST_Factory.newApiCall();
insert apiCall;
System.debug('API Call Id: ' + apiCall.Id);

global static ApiCall__c newApiCall(String serviceName)

Creates an uncommitted ApiCall__c record with a specified service name.

Parameters

Parameter	Type	Description
serviceName	String	The name of the web service class.

Returns ApiCall__c — An uncommitted ApiCall__c record.

Example

ApiCall__c apiCall = TST_Factory.newApiCall('MyService');
insert apiCall;
System.debug('API Call Service: ' + apiCall.ServiceName__c);

newContentVersion

global static ContentVersion newContentVersion(Id linkToObjectId, String fileName, Blob body)

Creates an uncommitted ContentVersion record from file data.

Parameters

Parameter	Type	Description
linkToObjectId	Id	The Id of the object to link the content version to.
fileName	String	The name of the file.
body	Blob	The binary data of the file.

Returns ContentVersion — An uncommitted ContentVersion record.

Example

Account acc = TST_Factory.newAccount();
insert acc;
ContentVersion version = TST_Factory.newContentVersion(acc.Id, 'test.pdf', Blob.valueOf('Test data'));
insert version;
System.debug('ContentVersion Title: ' + version.Title);

newFeatureFlag

global static FeatureFlag__mdt newFeatureFlag(String flagName)

Activates a feature flag for testing by injecting it into the selector cache. UTIL_FeatureFlag.isEnabled(flagName) will return true after this call.

Parameters

Parameter	Type	Description
flagName	String	The developer name of the feature flag to activate.

Returns FeatureFlag__mdt — The activated FeatureFlag__mdt record.

Example

TST_Factory.newFeatureFlag('MyFeatureFlag');

newInboundApiCall

global static ApiCall__c newInboundApiCall(String serviceName)

Creates an uncommitted ApiCall__c record for an inbound web service call.

Parameters

Parameter	Type	Description
serviceName	String	The name of the web service class.

Returns ApiCall__c — An uncommitted ApiCall__c record.

Example

ApiCall__c inboundApiCall = TST_Factory.newInboundApiCall('InboundService');
insert inboundApiCall;
System.debug('Inbound API Call Id: ' + inboundApiCall.Id);

newInboundApiSetting

global static ApiSetting__mdt newInboundApiSetting(String className, String endpointPath)

Creates a mock inbound ApiSetting__mdt record via TST_Mock for test routing. The setting is registered in the mock cache and will be returned by SEL_ApiSetting queries.

Parameters

Parameter	Type	Description
className	String	The fully qualified name of the inbound API handler class
endpointPath	String	The URL path pattern for routing (e.g., '/echo/*')

Returns ApiSetting__mdt — A mock ApiSetting__mdt record

Example

ApiSetting__mdt setting = TST_Factory.newInboundApiSetting('API_Echo', '/echo/*');

global static ApiSetting__mdt newInboundApiSetting(String className, String endpointPath, Integer priority)

Creates a mock inbound ApiSetting__mdt record with a custom priority, registered with TST_Mock for query interception.

Parameters

Parameter	Type	Description
className	String	The API handler class name
endpointPath	String	The URL path pattern for routing (e.g., '/echo/*')
priority	Integer	The routing priority (lower number wins when paths are equal)

Returns ApiSetting__mdt — A mock ApiSetting__mdt record

Example

ApiSetting__mdt setting = TST_Factory.newInboundApiSetting('API_Echo', '/echo/*', 50);

global static ApiSetting__mdt newInboundApiSetting(String className, String endpointPath, Integer priority, Map<SObjectField, Object> overrides)

Creates a mock inbound ApiSetting__mdt record with a custom priority and additional field overrides, registered with TST_Mock for query interception.

Parameters

Parameter	Type	Description
className	String	The API handler class name
endpointPath	String	The URL path pattern for routing (e.g., '/echo/*')
priority	Integer	The routing priority (lower number wins when paths are equal)
overrides	Map	Additional field values to apply on top of the defaults (may be null)

Returns ApiSetting__mdt — A mock ApiSetting__mdt record

Example

ApiSetting__mdt setting = TST_Factory.newInboundApiSetting('API_Echo', '/echo/*', 100, new Map<SObjectField, Object>
{
    ApiSetting__mdt.MockingEnabled__c => true
});

newOutboundApiCall

global static ApiCall__c newOutboundApiCall(String serviceName)

Creates an uncommitted ApiCall__c record for an outbound web service call.

Parameters

Parameter	Type	Description
serviceName	String	The name of the web service class.

Returns ApiCall__c — An uncommitted ApiCall__c record.

Example

ApiCall__c outboundApiCall = TST_Factory.newOutboundApiCall('OutboundService');
insert outboundApiCall;
System.debug('Outbound API Call Id: ' + outboundApiCall.Id);

global static ApiCall__c newOutboundApiCall(String serviceName, Id recordId)

Creates an uncommitted ApiCall__c record for an outbound web service call with a triggering object.

Parameters

Parameter	Type	Description
serviceName	String	The name of the web service class.
recordId	Id	The Id of the object triggering the service.

Returns ApiCall__c — An uncommitted ApiCall__c record.

Example

Account acc = TST_Factory.newAccount();
insert acc;
ApiCall__c apiCall = TST_Factory.newOutboundApiCall('OutboundService', acc.Id);
insert apiCall;
System.debug('API Call Id: ' + apiCall.Id);

global static ApiCall__c newOutboundApiCall(String serviceName, Id recordId, Map<String, String> requestParameters)

Creates an uncommitted ApiCall__c record for an outbound web service call with parameters.

Parameters

Parameter	Type	Description
serviceName	String	The name of the web service class.
recordId	Id	The Id of the object triggering the service.
requestParameters	Map	A map of name-value pairs for request parameters.

Returns ApiCall__c — An uncommitted ApiCall__c record.

Example

Account acc = TST_Factory.newAccount();
insert acc;
Map<String, String> params = new Map<String, String>
{
    'key' => 'value'
};
ApiCall__c apiCall = TST_Factory.newOutboundApiCall('OutboundService', acc.Id, params);
insert apiCall;
System.debug('API Call Id: ' + apiCall.Id);

global static ApiCall__c newOutboundApiCall(String serviceName, Id recordId, String parameterName, String parameterValue)

Creates an uncommitted ApiCall__c record for an outbound web service call with a single parameter.

Parameters

Parameter	Type	Description
serviceName	String	The name of the web service class.
recordId	Id	The Id of the object triggering the service.
parameterName	String	The name of the additional parameter.
parameterValue	String	The value of the additional parameter.

Returns ApiCall__c — An uncommitted ApiCall__c record.

Example

Account acc = TST_Factory.newAccount();
insert acc;
ApiCall__c apiCall = TST_Factory.newOutboundApiCall('OutboundService', acc.Id, 'key', 'value');
insert apiCall;
System.debug('API Call Id: ' + apiCall.Id);

newOutboundApiSetting

global static ApiSetting__mdt newOutboundApiSetting(String className, Map<SObjectField, Object> overrides)

Creates a mock outbound ApiSetting__mdt record via TST_Mock for query interception. The setting defaults to active and Outbound direction; overrides can replace any field value including IsActive__c. Pass null when no overrides are needed.

Parameters

Parameter	Type	Description
className	String	The fully qualified name of the outbound API handler class
overrides	Map	Additional field values to apply on top of the defaults (may be null)

Returns ApiSetting__mdt — A mock ApiSetting__mdt record

Example

ApiSetting__mdt setting = TST_Factory.newOutboundApiSetting('API_SendEmail', null);

newUser

global static User newUser(String profileName)

Creates a single uncommitted User record with the specified profile.

Parameters

Parameter	Type	Description
profileName	String	The name of the profile to assign to the user.

Returns User — An uncommitted User record.

Example

User testUser = TST_Factory.newUser('System Administrator');
insert testUser;
System.debug('User Email: ' + testUser.Email);

global static User newUser(String profileName, String companyName)

Creates an uncommitted User record with a custom company name.

The company name can be used as a unique identifier to later retrieve this specific user

Parameters

Parameter	Type	Description
profileName	String	The Profile name to assign to the user.
companyName	String	A unique company name for this user.

Returns User — An uncommitted User record with the specified company name.

Example

@TestSetup
private static void setupTestData()
{
    User testUser = TST_Factory.newUser('Standard User', 'my-test-user');
    insert testUser;
}
private static User getTestUser()
{
    return new SEL_User().findByCompanyName('my-test-user');
}

newUsers

global static List<User> newUsers(String profileName, Integer numberOfUsers)

Creates a list of uncommitted User records with the specified profile.

Parameters

Parameter	Type	Description
profileName	String	The name of the profile to assign to the users.
numberOfUsers	Integer	The number of users to create.

Returns User — A list of uncommitted User records.

Example

List<User> mockUsers = TST_Factory.newUsers('Standard User', 5);
insert mockUsers;
for (User u : mockUsers)
{
System.debug('User Email: ' + u.Email);
}

newUserWithPermissionSet

global static User newUserWithPermissionSet(String profileName, String companyName, String permissionSetName)

Creates and inserts a User with the specified profile + company name, then assigns the named permission set (or permission set group). Composes newUser(profileName, companyName), insert, and createPermissionSetAssignments(List , String).

Intended for use in @TestSetup as a committed test admin that test methods reach via System.runAs. Because runAs re-evaluates permissions for the inner scope, the test admin receives a fresh permission cache — bypassing the stale-cache issue that affects mutation of the currently-running user's permission set mid-transaction (the failure mode that made assignAdministratorPermissionSet() unreliable in the 2GP synthetic validation org).

Parameters

Parameter	Type	Description
profileName	String	The Profile name to assign to the user.
companyName	String	A unique company name for this user. Used as the retrieval discriminator via SEL_User.findByCompanyName.
permissionSetName	String	The API name of the permission set (or permission set group) to assign.

Returns User — The committed User record with the permission set assigned.

Throws

Exception	Description
AssertException	If the profile or permission set cannot be resolved for the target org.

Example

private static final String TEST_ADMIN_COMPANY = 'MyClass_TEST-admin';
@TestSetup
private static void setupTestAdmin()
{
    TST_Factory.newUserWithPermissionSet(
            'System Administrator',
            TEST_ADMIN_COMPANY,
            SEL_PermissionSet.ADMIN_PERMISSION_SET_API_NAME
    );
}
private static User getTestAdmin()
{
    return new SEL_User().findByCompanyName(TEST_ADMIN_COMPANY);
}
@IsTest
private static void shouldDoX()
{
    System.runAs(getTestAdmin())
    {
        // test body
    }
}