code-coverage1.html

<!DOCTYPE html>
<html>
    <head>
        <script src="sdk/scripts/VSS.SDK.min.js"></script>
        <script type="text/javascript">
            // Initialize
            VSS.init({
                explicitNotifyLoaded: true,
                usePlatformStyles: true,
                usePlatformScripts: true
            });

            VSS.require(["TFS/Dashboards/WidgetHelpers", "TFS/Build/RestClient", "TFS/TestManagement/RestClient"], 
            function (WidgetHelpers, TFS_Build_WebApi, TFS_TestMgmt_WebApi) {
                WidgetHelpers.IncludeWidgetStyles();

                VSS.register("CodeCoverageWidget1", function () {
                    var projectId = VSS.getWebContext().project.id;
                    var getBuildBuildInfo = function (widgetSettings) {
                        var settings = JSON.parse(widgetSettings.customSettings.data);
                        if (!settings || !settings.buildDefinition) {                      
                            // Initialize display values
                            $("#init-label").show();
                            $("div.big-count").hide();
                            $("#percent-label").hide();
                            
                            return WidgetHelpers.WidgetStatusHelper.Success()
                        }

                        if (settings && settings.checkOptionBuildName == true) {
                            // Show build name
                            $("#build-name").show();
                        }
                        else {
                            // Hide build name
                            $("#build-name").hide();
                        }
                        
                        // Output diagnostics info to console
                        console.log('settings.buildDefinition: ' + settings.buildDefinition);
                        
                        if (parseInt(settings.buildDefinition) > 0) {
                            // Get most recent successful build details
                            // .getBuilds(project, definitions, queues, buildNumber, minFinishTime, maxFinishTime, requestedFor, reasonFilter, statusFilter, resultFilter, tagFilters, properties, type, top, continuationToken, maxBuildsPerDefinition, deletedFilter, queryOrder, branchName)
                            TFS_Build_WebApi.getClient().getBuilds(projectId, [parseInt(settings.buildDefinition)], null, null, null, null, null, null, "Completed", "Failed,PartiallySucceeded,Succeeded", null, null, null, 1, null, null, null, null, null)
                                .then(function (query2) {
                                    // Evaluate build details of first result  
                                    if (query2[0]) {
                                        var buildId = query2[0].id; 
                                        var buildName = query2[0].buildNumber;
                                        var buildWeb = query2[0]._links.web.href

                                        // Output diagnostics info to console
                                        console.log('buildId: ' + buildId);

                                        // Get code coverage summary for most recent build
                                        TFS_TestMgmt_WebApi.getClient().getCodeCoverageSummary(projectId, buildId)
                                            .then(function (query3) {
                                                // Evaluate for where there is no coverage data                                        
                                                if (query3.coverageData[0]) {
                                                    // Output diagnostics info to console
                                                    console.log('event: coverageData found');
                                                    // Filter for selected coverage measurement
                                                    var coverageMeasurement = "";
                                                    if (!settings || !settings.coverageMeasurement) {
                                                        // Default to Lines if not previously chosen
                                                        coverageMeasurement = "Lines";
                                                    }
                                                    else {
                                                        coverageMeasurement = settings.coverageMeasurement;
                                                    }
                                                    var coverageData = query3.coverageData[0].coverageStats.filter(function (el) {
                                                        return el.label == coverageMeasurement;
                                                    });
                                                    
                                                    // Iterate and count code coverage items
                                                    var totalMeasurement = 0;
                                                    var coveredMeasurement = 0;
                                                    var coveragePct = 0;
                                                    var deltaMeasurement = 0;
                                                    $.each(coverageData, function(key, value) {
                                                        totalMeasurement += value.total;
                                                        coveredMeasurement += value.covered;
                                                        deltaMeasurement += value.delta;
                                                        // Output diagnostics info to console
                                                        console.log('event: delta found');
                                                    });
                                                    
                                                    // Output diagnostics info to console
                                                    console.log('deltaMeasurement: ' + deltaMeasurement);

                                                    // Calculate code coverage percentage
                                                    // This check avoids divide by zero error
                                                    if (totalMeasurement > 0) {
                                                        coveragePct = ((coveredMeasurement / totalMeasurement) * 100);
                                                        // Determine and set the requested number of decimal places
                                                        if (!settings || !settings.decimalPlaces) {
                                                            // Default to zero if not previously chosen
                                                            coveragePct = coveragePct.toFixed(0);
                                                        }
                                                        else {
                                                            coveragePct = coveragePct.toFixed(parseInt(settings.decimalPlaces));
                                                        }
                                                    }

                                                    // Update UI with code coverage percentage
                                                    $("div.big-count").hide();
                                                    $("#percent-label").hide();

                                                    if (settings && settings.checkOptionMeasurementName == true) {
                                                        // Add the measurement name to the percent label
                                                        $("#percent-label").text("Percent (" + coverageMeasurement + ")");
                                                    }
                                                    else {
                                                        // Use the default percent label
                                                        $("#percent-label").text("Percent");
                                                    }
                                                    var percentLabelString = $("#percent-label").text();

                                                    // Evaluate for delta display
                                                    if (settings && settings.checkOptionDelta == true) {
                                                        // Add the delta to the percent label
                                                        $("#percent-label").text(percentLabelString + " (" + deltaMeasurement + "%)");
                                                    }

                                                    $("div.big-count").text(coveragePct);
                                                    $("div.big-count").show();
                                                    $("#percent-label").show();
                                                    $("#init-label").hide();
                                                    $("#build-name").text(buildName);
                                                    $("#build-link").prop("href", buildWeb);  
                                                    $("#build-link").prop("target", "_top");                                             
                                                }
                                                else {
                                                    // Output diagnostics info to console
                                                    console.log('event: no coverageData found');
                                                    // Set display values for no coverage data
                                                    $("div.big-count").hide();
                                                    $("#percent-label").hide();
                                                    $("#init-label").text("No code coverage details found for this build definition");
                                                    $("#init-label").show();
                                                    $("#build-name").text("");
                                                    $("#build-link").removeProp("href");
                                                }
                                            });
                                    }
                                    else {
                                        // Set display values for build details
                                        $("div.big-count").hide();
                                        $("#percent-label").hide();
                                        $("#init-label").text("No code coverage details found for this build definition");
                                        $("#init-label").show();
                                        $("#build-name").text("");
                                        $("#build-link").removeProp("href");
                                    };
                                });
                        }

                        // Get a client to make REST calls
                        return TFS_Build_WebApi.getClient().getDefinition(settings.buildDefinition, projectId)
                            .then(function (query) {                              
                                // Use the widget helper and return success as Widget Status
                                return WidgetHelpers.WidgetStatusHelper.Success();
                            }, function (error) {
                                // Use the widget helper and return failure as Widget Status
                                return WidgetHelpers.WidgetStatusHelper.Failure(error.message);
                            });
                    }

                    return {
                        load: function (widgetSettings) {
                            // Set title
                            $("h2.title").text(widgetSettings.name);

                            // Output diagnostics info to console
                            console.log('event: load called');

                            return getBuildBuildInfo(widgetSettings);
                        },
                        reload: function (widgetSettings) {
                            // Set title
                            $("h2.title").text(widgetSettings.name);
                            
                            // Output diagnostics info to console
                            console.log('event: reload called');

                            return getBuildBuildInfo(widgetSettings);
                        }
                    }
                });
                VSS.notifyLoadSucceeded();
            });
        </script>
    </head>
    <body>
        <div class="widget">
            <h2 class="title"></h2>
            <label id="init-label" hidden>No build definition selected</label>
            <div class="big-count" hidden></div>
            <label id="percent-label" hidden>Percent</label>
            <a id="build-link" target="_blank">
                <div id="build-name" class="subtitle"></div>
            </a>
        </div>
    </body>
</html>