Writing a Test Class for AuraEnabled HTTPResponse Callouts

Question

I am trying to write a test class for a @AuraEnabled Apex Class. But I can not get it to pass. The first thing is you can not return an HTTPRequest or Response to a @AuraEnabled Class so I can not match the types from the Test to the Main Class. Any Help getting this code to pass would be greatly appreciated.

Main Class

---

public class APICaller{
@AuraEnabled

public static String CallApi(){

HttpRequest req = new HttpRequest();
                      req.setEndpoint({MY-URL-ENDPOINT});
                      req.setMethod('POST'); 
                      req.setHeader('Content-Type', 'application/json');
                      req.setTimeout(120000);
                      String body = '{"Username":"username"}';
                      req.setBody(body);
                      Http http = new Http();
                      HTTPResponse res = http.send(req);
                      return res.getBody();
    }

}

Test Class

---

@isTest
public class KonnectidAlpha_GetClients_Test{

@isTest  public static void CallTestApi(){

// Associate the callout with a mock response
Test.setMock(HttpCalloutMock.class, new HttpCalloutMockClass());

    // Call method to test
  String response = APICaller.CallApi();
  System.debug(response);
  String actualValue =  response;
  String expectedValue = '{"response": "Records Synced"}';
  System.assertEquals(actualValue, expectedValue);

 } 
}

HTTPCalloutMock Class

---

@isTest
global class HttpCalloutMockClass implements HttpCalloutMock {
// Implement this interface method

global HTTPResponse respond(HTTPRequest request) {
    // Create a fake response
    HttpResponse response = new HttpResponse();
    response.setHeader('Content-Type', 'application/json');
    String body = '{"response": "Records Synced"}';
    response.setBody(body);
    response.setStatusCode(200);
    return response; 
  }
}

Answer 1

The code you posted in your question passes with 100% coverage in my developer org when copied verbatim, except for changing {MY-URL-ENDPOINT} to a real String.

As a sanity test, I also wrote a unit test of my own, included below.

public class q190011 {
    @AuraEnabled public static String doRequest() {
        HttpRequest req = new HttpRequest();
        req.setEndpoint('https://www.google.com/');
        req.setMethod('GET');
        return (new Http().send(req)).getBody();
    }
}

---

@isTest class q190011t {
    public class Mock implements HttpCalloutMock {
        public HttpResponse respond(HttpRequest req) {
            HttpResponse res = new HttpResponse();
            res.setBody('OKAY!');
            res.setStatus('OK');
            res.setStatusCode(200);
            return res;
        }
    }
    @isTest static void test() {
        Test.setMock(HttpCalloutMock.class, new Mock());
        String result = q190011.doRequest();
        System.assertEquals('OKAY!', result);
    }
}

---

As you can see, there's no particular magic for an @AuraEnabled method as opposed to any other type of method. Everything included in your question is correctly written as-is.

Remember that your mock is not returning a HttpResponse "directly" to the live code, but does so through the Http.send call. Your @AuraEnabled method should indeed be returning a String or some other "normal" type, but not an HttpRequest or HttpResponse directly.

The only "problem" that you have in the code you've posted is that the actual arguments to System.assertEquals should be expectedValue, actualValue. Reversing the order of the parameters will lead to some confusion if your tests fail on that assertion, because the error message will read differently than you expect.