[SalesForce] How to setup test data for Omni-Channel in Apex Test Classes

I am using UserServicePresence object in Apex to retrieve the user status on Omni-Channel and I get the users to perform further logic. It works fine.

Apex Class code snippet:

//Get the users who have the Omni Channel Status as online
List<UserServicePresence> onlineStatusList = [ select Id,UserId from UserServicePresence where IsCurrentState = true  and ServicePresenceStatus.DeveloperName = 'online' ];

if(onlineStatusList != null && onlineStatusList.size() > 0)
{
    // do some stuff here
}

However, I am not able to find a way to setup the test data for the UserServicePresence object in my test class in order to get the required test coverage. The UserServicePresence object is not writeable and it won't allow us to insert any test records in to it. So, whenever I test the class, the onlineStatusList would always have 0 rows. And there is a major portion of my code inside the if block which I am not able to cover using the test class.

Please let me know if there is a way to test out the Omni-Channel status in the Apex test classes.

Best Answer

I've got the same problem and I solved it using Test.isRunningTest() in the if condition. So you can do something like this:

if((onlineStatusList != null && onlineStatusList.size() > 0) || 
Test.isRunningTest())

It's not a "clean" solution but it works.

Related Solutions

[SalesForce] How to determine Omni-Channel Agent Status in APEX

UserServicePresence is the right place to look. Offline is simply the absence of a status. If there are no UserServicePresence records where IsCurrentState==true, the user is in an offline state.

[SalesForce] How to Test Omni-Channel User Service Presence in Apex Test Class

I recommend you use query mocking here. It's a flexible concept and you can build it many different ways. It's a very useful pattern for data types you cannot insert in a test context.

The simplest build is something like the following:

public virtual class Query
{
    static Query instance = new Query();
    @TestVisible void setMock(Query mock) { instance = mock; }

    public static List<SObject> records(List<SObject> input)
    {
        return instance.passThrough(input);
    }

    protected virtual List<SObject> passThrough(List<SObject> input) { return input; }
}

Doesn't look like much, but it has power. First step would be to wrap this function call around the query you wish to mock:

List<UserServicePresence> records = Query.records([
    SELECT ... FROM UserServicePresence WHERE ...
]);

Then in your test, you can simply overwrite the value the system will give you back.

class UserServicePresenceQuery extends Query
{
    protected override List<SObject> passThrough()
    {
        return new List<UserServicePresence>
        {
            new UserServicePresence(
                UserId=UserInfo.getUserId()
                // set other fields as needed
                // using comma separated key=value pairs
            )
        };
    }
}

If you need to mock the query results for multiple queries in a single call, you can build out a mechanism to map a separate data store for each using Map<SObjectType, List<SObject>, or something along those lines.

Related Topic

Custom Object Approval Process Omni-Channel Routing Configuration