salesforce 零基礎學習（六十八）http callout test class寫法

此篇可以參考：

https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_restful_http_testing_httpcalloutmock.htm

https://developer.salesforce.com/trailhead/force_com_dev_intermediate/apex_integration_services/apex_integration_rest_callouts

在項目中我們經常會用到通過http方式和其他系統交互，在salesforce 零基礎學習（三十三）通過REST方式訪問外部數據以及JAVA通過rest方式訪問salesforce這篇講過http callout方式使用，

簡單callout demo如下：

public class CalloutClass {
    
    //default out of time
    private static final Integer OUT_OF_TIME = 10000;
    //default method : get
    private static final String DEFAULT_METHOD_GET = 'GET';
    
    private static final Integer STATUS_CODE_OK = 200;
    
    public static String getDataViaHttp(String endPoint,String param) {
        return getDataViaHttp(endPoint,DEFAULT_METHOD_GET,param);
    }
    
    public static String getDataViaHttp(String endPoint,String method,String param) {
        return getDataViaHttp(endPoint,method,param,OUT_OF_TIME);
    }
    
    public static String getDataViaHttp(String endPoint,String method,String param,Integer outOfTime) {
        HttpRequest req = new HttpRequest();
        Http h = new Http();
        req.setMethod(method);
        req.setHeader('Content-Type', 'application/json');
        if(param != null) {
            req.setBody(param);
        }
        req.setEndpoint(endPoint);
        req.setTimeout(outOfTime);
        HttpResponse res = h.send(req);
        if(res.getStatusCode() == STATUS_CODE_OK) {
            return res.getBody();
        } else {
            throw new CallOutException('訪問失敗');
        }
    }
    
    class CallOutException extends Exception {
        
    }
}

 有的時候我們需要在batch中調用http接口和其他系統交互進行字段更新等操作，如果在batch中需要用到http callout，需要實現Database.AllowsCallouts接口，demo如下：

public with sharing class CalloutBatchClass implements Database.Batchable<sObject>,Database.AllowsCallouts{
    public Database.QueryLocator start(Database.BatchableContext BC) {
        String fetchSQL = 'fetch sql';
        return Database.getQueryLocator(fetchSQL);
    }
    
    public void execute(Database.BatchableContext BC, List<sObject> objList) {
        String endPoint = 'site end point';
        String responseData = CalloutClass.getDataViaHttp(endPoint,null);
        for(sObject obj : objList) {
            //TODO
        }
    }
    
    public void finish(Database.BatchableContext BC) {
        
    }
}

 項目中test class是必需的，而且正常要求test class覆蓋率超過75%。test class中不允許http callout，我們可以通過實現HttpCalloutMock接口模擬http請求的返回值。通過重寫respond方法實現

不同的http請求所返回的不同的response狀態和body內容。

@isTest
global class MockHttpResponseGenerator implements HttpCalloutMock {
    global String method;
    
    global String METHOD1_BODY = '{"foo":"bar"}';
    
    global String METHOD2_BODY = '{"foo":"bar2"}';
    
    global MockHttpResponseGenerator() {}
    
    
    global MockHttpResponseGenerator(String requestMethod) {
        method = requestMethod;
    }
    
    // Implement this interface method
    global HTTPResponse respond(HTTPRequest req) {
        // Create a fake response
        HttpResponse res = new HttpResponse();
        res.setHeader('Content-Type', 'application/json');
        String body;
        if(method == 'method1') {
            body = METHOD1_BODY;
        } else if(method == 'method2') {
            body = METHOD2_BODY;
        } else if(method == 'methodError') {
            res.setStatusCode(500);
        }
        res.setBody('{"foo":"bar"}');
        if(res.getStatusCode() != null) {
            res.setStatusCode(200);
        }
        return res;
    }
}

簡單的測試CalloutClass的測試類如下：

@isTest
private class CalloutClassTest {
     @isTest static void testSuccessCallout() {
         Test.startTest();
        // Set mock callout class 
        Test.setMock(HttpCalloutMock.class, new MockHttpResponseGenerator('method1'));
        String endPoint = 'http://api.salesforce.com/foo/bar';
        String result = CalloutClass.getDataViaHttp(endPoint,'test param');
        String expectedValue = '{"foo":"bar"}';
        System.assertEquals(result, expectedValue);
        Test.stopTest();
    }
}

 這只是我們碰到的所謂最理想的情況，有的時候我們往往會碰到這樣一種情況：一個方法里面需要調用到多個http callout。比如需要先進行http callout，將返回值作為參數或者oauth setting內容然后繼續進行callout，這種情況下使用上述的方式便比較難實現，畢竟上述mock形式僅作為一個http callout的response。這個時候我們要變通一下，看看前面的調用是否是必要的--前后幾次調用是否有並列關系，還是僅將前幾次調用作為相關參數為最后一次做准備，此種情況下，可以在類中設置相關的靜態變量來跳過相關的調用；如果前后幾次調用屬於並列關系，需要對每一次的response的內容進行相關處理，這種情況下的test class便需要使用multi mock形式。

一.非並列關系：此種方式可以使用變量方式跳過相關的調用

public with sharing class CalloutClassUseVariable {
    public static Boolean skipForTest{get;set;}
    public STring getResult(String endPoint1,String endPoint2) {
        String result1 = '';
        if(skipForTest == null ||skipForTest == false) {
            result1 = CalloutClass.getDataViaHttp(endPoint1,'');
        }
        String result2 = CalloutClass.getDataViaHttp(endPoint2,result1);
        return result2;
    }
}

相關test class處理

@isTest
private class CalloutClassUseVariableTest {
    static testMethod void testMethod1() {
        Test.startTest();
        Test.setMock(HttpCalloutMock.class, new MockHttpResponseGenerator('method1'));
        String endPoint = 'http://api.salesforce.com/foo/bar';
        CalloutClassUseVariable.skipForTest = true;
        String result = CalloutClassUseVariable.getResult('', endPoint);
        String expectedValue = '{"foo":"bar"}';
        System.assertEquals(result, expectedValue);
        Test.stopTest();
    }
}

二.並列關系：此種方式需要使用MultiStaticResourceCalloutMock方式。

salesforce提供MultiStaticResourceCalloutMock接口實現多個callout的test class模擬response請求，可以將response的body值放在txt文檔中上傳至static resources中，然后test class引用相關靜態資源實現模擬多個response返回。

public with sharing class CalloutController {
    public String result{get;set;}
    public void getResult(String endPoint1,String endPoint2) {
        String result1 = CalloutClass.getDataViaHttp(endPoint1,'');
        String result2 = CalloutClass.getDataViaHttp(endPoint2,'');
        result = result1 + result2;
    }
}

相關test class處理：

1.將需要的相關response body值上傳至static resource中；

2.test class編寫

@isTest
private class CalloutClassUseMultiStaticResourceTest {
    static testMethod void testMethod1() {
        MultiStaticResourceCalloutMock mock = new MultiStaticResourceCalloutMock();
        String endPoint1 = 'http://api.salesforce.com/foo/bar';
        String endPoint2 = 'http://api.salesforce.com/foo/sfdc';
        mock.setStaticResource(endPoint1, 'Callout_Method1_TestResponse');
        mock.setStaticResource(endPoint2, 'Callout_Method2_TestResponse');
        mock.setStatusCode(200);
        mock.setHeader('Content-Type', 'application/json');        
        Test.setMock(HttpCalloutMock.class, mock);
        Test.startTest();
        CalloutController controller = new CalloutController();
        controller.getResult(endPoint1,endPoint2);
        String expectedResult = '{"foo":"bar"}{"foo":"bar2"}';
        system.assertEquals(expectedResult,controller.result);
        Test.stopTest();
    }
}

總結：callout test class編寫可以主要看方法中對於callout執行次數以及形式，如果僅是單次請求或者非並列形式，推薦使用httpcalloutMock方式，簡單粗暴，而且自己造數據，不用上傳靜態資源，即使在其他環境下也可以正常跑，如果進行了多次請求，並且請求之間需要有並行操作那就只能使用multi callout 形式，使用此種方式記得在移到其他平台以前將靜態資源上傳。如果篇中有錯誤地方歡迎指正，有問題歡迎留言。