+ Start a Discussion
CloudGeekCloudGeek 

Need input for TestClass for @HttpGet method / REST Method

Hi ,

I have a REST Class like below, How should we write TestClass for this @HttpGet Method ?
 
@RestResource(urlMapping='/myURL/*')

global with sharing class myController 
{
@HttpGet
    global static List<Wrapper> getMeListOfProducts() 
    {
        RestRequest req = RestContext.request;
        
        string region = req.params.get('region');
        string segment= req.params.get('segment');
        string offertype = req.params.get('offertype');
       
        ///Some code
    return listOfProducts;
  }

}


    
Best Answer chosen by CloudGeek
pconpcon
Can you please include the test class that you are using?  As stated in both Amit and my test classes, you have to set the RestContext variable
 
RestContext.request = req;
RestContext.response = res;

All Answers

pconpcon
You write this like you would any other test method.  The only difference beng that you generate the RestRequest prior to running your class
 
static testMethod void getMeListOfProducts() {
    RestRequest req = new RestRequest();
    req.params.put('region', 'my_region');
    req.params.put('segment', 'my_segment');
    req.params.put('offertype', 'my_offertype');
    RestResponse res = new RestResponse();

    RestContext.request = req;
    RestContext.response = res;

    Test.startTest();

    List<MyController.Wrapper> results = MyController.getMeListOfProducts();

    Test.stopTest();

    System.assert(..., ..., '...');
}

 
Amit Chaudhary 8Amit Chaudhary 8
Please try below test class.
@isTest
public class myControllerTest
{
  static testMethod void testMethodForAll()
  {
  
    Account testAccount = new Account();
    testAccount.Name='Test Account' ;
    testAccount.Industry='Bank';
    insert testAccount;
	
	// Create Required data here	
	
		Test.startTest();

            RestResponse res = new RestResponse();
            RestRequest req = new RestRequest(); 

			req.params.put('region', 'my_region');
			req.params.put('segment', 'my_segment');
			req.params.put('offertype', 'my_offertype');			
			
            req.httpMethod = 'Get';
            req.addHeader('Content-Type', 'application/json'); // Add a JSON Header as it is validated 
            req.requestURI = '/services/apexrest/myURL/all' ;  
            RestContext.request = req;
            RestContext.response = res;

            //List<Wrapper> lstWrapper = myController.getMeListOfProducts(); // Use this line if wrapper class is outside
			List<MyController.Wrapper> results = MyController.getMeListOfProducts(); 
			
		Test.stopTest();   
  }

  
}
Please check below post for test classes.
1) http://amitsalesforce.blogspot.in/search/label/Test%20Class
2) http://amitsalesforce.blogspot.in/2015/06/best-practice-for-test-classes-sample.html


Please follow below salesforce Best Practice for Test Classes :-

1. Test class must start with @isTest annotation if class class version is more than 25
2. Test environment support @testVisible , @testSetUp as well
3. Unit test is to test particular piece of code working properly or not .
4. Unit test method takes no argument ,commit no data to database ,send no email ,flagged with testMethod keyword .
5. To deploy to production at-least 75% code coverage is required
6. System.debug statement are not counted as a part of apex code limit.
7. Test method and test classes are not counted as a part of code limit
9. We should not focus on the  percentage of code coverage ,we should make sure that every use case should covered including positive, negative,bulk and single record .
Single Action -To verify that the the single record produces the correct an expected result .
Bulk action -Any apex record trigger ,class or extension must be invoked for 1-200 records .
Positive behavior : Test every expected behavior occurs through every expected permutation , i,e user filled out every correctly data and not go past the limit .
Negative Testcase :-Not to add future date , Not to specify negative amount.
Restricted User :-Test whether a user with restricted access used in your code .
10. Test class should be annotated with @isTest .
11 . @isTest annotation with test method  is equivalent to testMethod keyword .
12. Test method should static and no void return type .
13. Test class and method default access is private ,no matter to add access specifier .
14. classes with @isTest annotation can't be a interface or enum .
15. Test method code can't be invoked by non test request .
16. Stating with salesforce API 28.0 test method can not reside inside non test classes .
17. @Testvisible annotation to make visible private methods inside test classes.
18. Test method can not be used to test web-service call out . Please use call out mock .
19. You can't  send email from test method.
20.User, profile, organization, AsyncApexjob, Corntrigger, RecordType, ApexClass, ApexComponent ,ApexPage we can access without (seeAllData=true) .
21. SeeAllData=true will not work for API 23 version eailer .
22. Accessing static resource test records in test class e,g List<Account> accList=Test.loadData(Account,SobjectType,'ResourceName').
23. Create TestFactory class with @isTest annotation to exclude from organization code size limit .
24. @testSetup to create test records once in a method  and use in every test method in the test class .
25. We can run unit test by using Salesforce Standard UI,Force.com IDE ,Console ,API.
26. Maximum number of test classes run per 24 hour of period is  not grater of 500 or 10 multiplication of test classes of your organization.
27. As apex runs in system mode so the permission and record sharing are not taken into account . So we need to use system.runAs to enforce record sharing .
28. System.runAs will not enforce user permission or field level permission .
29. Every test to runAs count against the total number of DML issued in the process .


Please let us know if this post will help you

Thanks
Amit Chaudhary

 
CloudGeekCloudGeek
Hello pcon and Amit,

Thanks for your response!

The actuall method code is like below:
 
@HttpGet
    global static List<OnlineSalesCatalogWrapper> getOfferedProductsList() 
    {
        RestRequest req = RestContext.request;
        
        string region = req.params.get('region');
        string segment= req.params.get('segment');
        string offertype = req.params.get('offertype');
        
        region = (!String.isBlank(region))? region : 'USA'; 
        
        System.debug('@@@ params region= '+region+' segment='+segment+' offerType='+offertype);
        
        List<OnlineSalesCatalogWrapper> wrappers = new List<OnlineSalesCatalogWrapper>();
        wrappers = OnlineSalesCatalogHelper.getOnlineSalesCatalogWrapperForRegion( region );
        
        System.debug('@@@ wrappers from OnlineSalesCatalogHelper.getOnlineSalesCatalogWrapperForRegion( region ) METHOD ===='+wrappers);
        
        List<OnlineSalesCatalogWrapper> wrappersWithFilters = new List<OnlineSalesCatalogWrapper>();
        List<OnlineSalesCatalogWrapper> finalWrappers = new List<OnlineSalesCatalogWrapper>();
        
        if(segment!= '' && offertype !='' && !(wrappers.isEmpty()))
        {
            
            for(OnlineSalesCatalogWrapper w : wrappers)
                {
                     if(w.segment.equals(segment) && w.offerType.equals(offertype))
                     {
                         wrappersWithFilters.add(w);
                     }   
                }
             finalWrappers =  wrappersWithFilters.clone();               
        }  
        
        else { finalWrappers = wrappers.clone(); }          
     
        
        return finalWrappers;
    
    }


In the test class always , the wrapers are empty in the returned list. But on the page it is getting data properly.
Any ideas on this ?

 
pconpcon
Can you please include the test class that you are using?  As stated in both Amit and my test classes, you have to set the RestContext variable
 
RestContext.request = req;
RestContext.response = res;
This was selected as the best answer
CloudGeekCloudGeek
Hi pcon,

Please find the class below:
 
@isTest
public class OSCTestClass
{

static testMethod void getMeListOfProducts() {
    
    RestRequest req = new RestRequest();
    RestResponse res = new RestResponse();
    
    req.params.put('region', 'USA');
    req.params.put('segment', 'ANY');
    req.params.put('offertype', 'TRIAL');
    List<OnlineSalesCatalogWrapper> results = new List<OnlineSalesCatalogWrapper>();
    
    RestContext.request = req;
    RestContext.response = res;

    Test.startTest();
    
     results = OnlineSalesCatalogController.getOfferedProductsList();
    System.debug('size of results = '+results.size());
    
    string pwd = OnlineSalesCatalogController.getTempPassword('8');
    System.debug('pwd = '+pwd);
    
    Lead ld = new Lead();
    
    Test.stopTest();

    //System.assert(..., ..., '...');
}
}