Salesforce is a very dynamic platform which provides us(Developers - wink :P) different ways to accomplish the tasks. The sole choice lies with the developer to adapt the method in such a way to perform the task in an automated fashion.
Problem Case:
The main block which everyone doesn't like(as per the feedback from my friends) is the Apex Test Coverage as it hinders the developers to deploy to other instance(although it is a best practice to write the test coverage above 85%) but what if when we are working on a project where we are dealing with huge no of apex classes, how to deal with the coverage of so many classes. Unfortunately, Salesforce do not provide us a direct way where we can export it in portable format. Here in this post i will try to explore new technique by which we can export the Latest Org Test Coverage.
Code:
SFDC_ExportTest - GitHub Repo
Problem Case:
The main block which everyone doesn't like(as per the feedback from my friends) is the Apex Test Coverage as it hinders the developers to deploy to other instance(although it is a best practice to write the test coverage above 85%) but what if when we are working on a project where we are dealing with huge no of apex classes, how to deal with the coverage of so many classes. Unfortunately, Salesforce do not provide us a direct way where we can export it in portable format. Here in this post i will try to explore new technique by which we can export the Latest Org Test Coverage.
Pre-Requisites:
1) The Apex page and Apex class should be present in Org(Our technique to export the coverage in excel)
2) We should have executed Run All Test in Org before exporting coverage
3) The Admin user should be used to export the results
Solution:
Salesforce exposes the Test coverage results on classes through Tooling REST API, hence there are many ways to consume the API and create our utilities such as - create java based code to connect to SF and get results in local to parse the response. Here is my case, I have developed a Salesforce VF page which is rendered as excel doc after querying & parsing Response from Salesforce Tooling API to fetch coverage results.
API details:
/services/data/v43.0/tooling/query/?q=Select+id,ApexClassorTrigger.Name,NumLinesCovered,NumLinesUncovered+from+ApexCodeCoverageAggregate+order+by+ApexClassorTrigger.Name
In above query, we are querying results from "ApexCodeCoverageAggregate" and fetching the response to parse it into table(with some obvious calculations).
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| public class exportTestCoverage{ | |
| public CoverageWrapper cobj {get;set;} | |
| public exportTestCoverage(){ | |
| HttpRequest req = new HttpRequest(); | |
| req.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionID()); | |
| req.setHeader('Content-Type', 'application/json'); | |
| req.setEndpoint(URL.getSalesforceBaseURL().toExternalForm()+'/services/data/v34.0/tooling/query/?q=Select+id,ApexClassorTrigger.Name,NumLinesCovered,NumLinesUncovered+from+ApexCodeCoverageAggregate+order+by+ApexClassorTrigger.Name'); | |
| req.setMethod('GET'); | |
| Http h = new Http(); | |
| HttpResponse res = h.send(req); | |
| if(res.getStatusCode() == 200){ | |
| cobj = (CoverageWrapper)JSON.deserialize(res.getBody(),CoverageWrapper.class); | |
| system.debug('cobj '+cobj ); | |
| } | |
| } | |
| public class Attributes { | |
| public String type; | |
| public String url; | |
| } | |
| public class Records { | |
| public Attributes attributes; | |
| public String Id; | |
| public ApexClassOrTrigger ApexClassOrTrigger {get;set;} | |
| public Integer NumLinesCovered {get;set;} | |
| public Integer NumLinesUncovered {get;set;} | |
| } | |
| public class ApexClassOrTrigger { | |
| public Attributes attributes; | |
| public String Name{get;set;} | |
| } | |
| public class CoverageWrapper{ | |
| public Integer size; | |
| public Integer totalSize; | |
| public Boolean done; | |
| public Object queryLocator; | |
| public String entityTypeName; | |
| public List<Records> records{get;set;} | |
| } | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <apex:page controller="ExportTestCoverage" contentType="application/vnd.ms-excel#Coverage.xls"> | |
| <apex:variable value="{!0}" var="totalLines"/> | |
| <apex:variable value="{!0}" var="totalCoveredLines"/> | |
| <apex:dataTable value="{!cobj.records}" var="c"> | |
| <apex:column > | |
| <apex:facet name="header">Name</apex:facet> | |
| <apex:outputText value="{!c.ApexClassOrTrigger.Name}"/> | |
| </apex:column> | |
| <apex:column > | |
| <apex:facet name="header">Total Lines</apex:facet> | |
| <apex:variable var="totalLines" value="{!totalLines + (IF(ISBLANK(c.NumLinesCovered),0,c.NumLinesCovered) + IF(ISBLANK(c.NumLinesUncovered),0,c.NumLinesUncovered))}" /> | |
| <apex:outputText value="{!IF(ISBLANK(c.NumLinesCovered),0,c.NumLinesCovered) + IF(ISBLANK(c.NumLinesUncovered),0,c.NumLinesUncovered)}"/> | |
| </apex:column> | |
| <apex:column > | |
| <apex:facet name="header">Lines Covered</apex:facet> | |
| <apex:variable var="totalCoveredLines" value="{!totalCoveredLines + c.NumLinesCovered}" /> | |
| <apex:outputText value="{!c.NumLinesCovered}"/> | |
| </apex:column> | |
| <apex:column > | |
| <apex:facet name="header">Lines Uncovered</apex:facet> | |
| <apex:outputText value="{!IF(ISBLANK(c.NumLinesUncovered),0,c.NumLinesUncovered)}"/> | |
| </apex:column> | |
| <apex:column > | |
| <apex:facet name="header">Percentage Covered</apex:facet> | |
| <apex:outputText value="{!IF((IF(ISBLANK(c.NumLinesCovered),0,c.NumLinesCovered) + IF(ISBLANK(c.NumLinesUncovered),0,c.NumLinesUncovered)) > 0,ROUND((IF(ISBLANK(c.NumLinesCovered),0,c.NumLinesCovered)/(IF(ISBLANK(c.NumLinesCovered),0,c.NumLinesCovered) + IF(ISBLANK(c.NumLinesUncovered),0,c.NumLinesUncovered)))*100,0),0)}"/> | |
| </apex:column> | |
| </apex:dataTable> | |
| <br/> | |
| <b> | |
| <apex:outputText value="Total Lines in Org : {!totalLines}"/><br/> | |
| <apex:outputText value="Total Lines Covered in Org : {!totalCoveredLines}"/><br/> | |
| <apex:outputText value="Code Coverage: {!IF(totalLines > 0,ROUND((totalCoveredLines/totalLines)*100,0),0)}%"/> | |
| </b> | |
| </apex:page> |
SFDC_ExportTest - GitHub Repo
