ReportGenerator

New Post: Feature Request: Support Xml input from Dynamic Code Coverage - CodeCoverage.exe

danielpalme — Wed, 19 Jun 2013 19:06:15 GMT

I have added support for this format in changeset #73194
I will publish a new release soon.

Source code checked in, #73194

danielpalme — Wed, 19 Jun 2013 19:05:53 GMT

Added support for Visual Studio coverage reports (CodeCoverage.exe)

New Post: Feature Request: Support Xml input from Dynamic Code Coverage - CodeCoverage.exe

danielpalme — Fri, 14 Jun 2013 06:50:38 GMT

Thanks for the hint.
I will have a look at it. But it will take some time, since I'm pretty busy at the moment.

New Post: Feature Request: Support Xml input from Dynamic Code Coverage - CodeCoverage.exe

rhullah — Fri, 14 Jun 2013 03:17:46 GMT

It looks like there's a new instrumentation tool called Dynamic Code Coverage (aptly named CodeCoverage.exe) in VS2012. By default it's installed in "\Program Files (x86)\Microsoft Visual Studio 11.0\Team Tools\Dynamic Code Coverage Tools". It can natively output xml coverage data.

I was wondering what the likelihood of ReportGenerator supporting this Xml input would be? Here's an output of a small program:

<?xml version="1.0" encoding="UTF-8" ?>
<results>
  <modules>
    <module name="coveragetest.exe" path="coveragetest.exe" id="48514CF9CA28824F892788AF9D461F3B05000000" block_coverage="62.50" line_coverage="61.90" blocks_covered="15" blocks_not_covered="9" lines_covered="13" lines_partially_covered="1" lines_not_covered="7">
      <functions>
        <function id="8272" token="0x6000001" name="Main(string[])" type_name="Program" block_coverage="0.00" line_coverage="0.00" blocks_covered="0" blocks_not_covered="1" lines_covered="0" lines_partially_covered="0" lines_not_covered="1">
          <ranges>
            <range source_id="0" covered="no" start_line="16" start_column="9" end_line="16" end_column="10" />
          </ranges>
        </function>
        <function id="8276" token="0x6000002" name="DoTests()" type_name="Program" block_coverage="70.59" line_coverage="73.33" blocks_covered="12" blocks_not_covered="5" lines_covered="11" lines_partially_covered="1" lines_not_covered="3">
          <ranges>
            <range source_id="0" covered="yes" start_line="21" start_column="13" end_line="21" end_column="26" />
            <range source_id="0" covered="yes" start_line="22" start_column="13" end_line="22" end_column="27" />
            <range source_id="0" covered="yes" start_line="23" start_column="13" end_line="23" end_column="19" />
            <range source_id="0" covered="yes" start_line="24" start_column="17" end_line="24" end_column="43" />
            <range source_id="0" covered="yes" start_line="25" start_column="13" end_line="25" end_column="24" />
            <range source_id="0" covered="no" start_line="26" start_column="17" end_line="26" end_column="52" />
            <range source_id="0" covered="partial" start_line="27" start_column="13" end_line="27" end_column="24" />
            <range source_id="0" covered="yes" start_line="28" start_column="17" end_line="28" end_column="52" />
            <range source_id="0" covered="yes" start_line="29" start_column="13" end_line="29" end_column="24" />
            <range source_id="0" covered="no" start_line="30" start_column="17" end_line="30" end_column="53" />
            <range source_id="0" covered="yes" start_line="31" start_column="18" end_line="31" end_column="28" />
            <range source_id="0" covered="yes" start_line="31" start_column="29" end_line="31" end_column="35" />
            <range source_id="0" covered="yes" start_line="33" start_column="13" end_line="33" end_column="39" />
            <range source_id="0" covered="yes" start_line="34" start_column="13" end_line="34" end_column="56" />
            <range source_id="0" covered="no" start_line="35" start_column="17" end_line="35" end_column="36" />
            <range source_id="0" covered="yes" start_line="36" start_column="9" end_line="36" end_column="10" />
          </ranges>
        </function>
        <function id="8384" token="0x6000003" name="Test2()" type_name="Program" block_coverage="0.00" line_coverage="0.00" blocks_covered="0" blocks_not_covered="2" lines_covered="0" lines_partially_covered="0" lines_not_covered="2">
          <ranges>
            <range source_id="0" covered="no" start_line="42" start_column="13" end_line="42" end_column="41" />
            <range source_id="0" covered="no" start_line="43" start_column="9" end_line="43" end_column="10" />
          </ranges>
        </function>
        <function id="8393" token="0x6000004" name="Test3()" type_name="Program" block_coverage="100.00" line_coverage="100.00" blocks_covered="2" blocks_not_covered="0" lines_covered="1" lines_partially_covered="0" lines_not_covered="0">
          <ranges>
            <range source_id="0" covered="yes" start_line="48" start_column="13" end_line="48" end_column="49" />
          </ranges>
        </function>
        <function id="8400" token="0x6000005" name="Test4()" type_name="Program" block_coverage="50.00" line_coverage="50.00" blocks_covered="1" blocks_not_covered="1" lines_covered="1" lines_partially_covered="0" lines_not_covered="1">
          <ranges>
            <range source_id="0" covered="yes" start_line="54" start_column="13" end_line="54" end_column="42" />
            <range source_id="0" covered="no" start_line="55" start_column="9" end_line="55" end_column="10" />
          </ranges>
        </function>
      </functions>
      <source_files>
        <source_file id="0" path="d:\Testing\CoverageTest\Program.cs">
        </source_file>
      </source_files>
    </module>
  </modules>
</results>

Commented Unassigned: No longer works with CruiseControl.NET [10145]

danielpalme — Fri, 31 May 2013 21:47:35 GMT

I don't like adding Comand-line arguments. If I would have added arguments for all the different requirements people have, then ReportGenerator would be really have a lot of them.

But I have plans to add some extension points to ReportGenerator, so you will have the possibility to generate custom reports and custom filtering (file based is a good idea!)
But this will take some time, since I'm pretty busy right now.

Commented Unassigned: No longer works with CruiseControl.NET [10145]

pdavis68 — Fri, 31 May 2013 18:59:03 GMT

I rolled back to 1.7.3 and I'm happy enough with that. You might want to consider adding a command-line argument to do a JavaScript free version or to otherwise create a CruiseControl.NET compatible output.

Another thing that I think would be an improvement would be the ability to use filter files instead of putting them on the command-line. We have a fairly large namespace with auto-generated code in a number of places and it would be nice to filter all that out, but there's simply not enough room on the command-line to enumerate all the filters we'd need and the way the code is autogenerated, there's no way to wildcard it.

Thanks for looking into it.

Closed Unassigned: No longer works with CruiseControl.NET [10145]

danielpalme — Fri, 31 May 2013 14:06:42 GMT

I was using an earlier version of ReportGenerator (1.6.1 or or 1.7.3. I overwrote it, so I'm not sure which). It worked just fine with CruiseControl.NET. I upgraded to 1.8.1 recently and now when you try to get the coverage details for a class, it gives an error.

For example, if I'm looking at the summary and I click on the link for: GEMS.Shared.Data.Filter.ANDFilter

It gives the error: Unknown object name : gems.shared_andfilter

For the reportgenerator I'm using the -reporttypes:HTML

In CruiseControl I'm using the htmlReportPlugin.

Is there a fix for this?

Thanks
Comments: I took a look at the problem. In ReportGenerator 1.8.0.0 the links to the class reports are generated in JavaScript (if JavaScript is enabled).
Those links are not rewritten by CruiseControl.NET. Only static links get changed.

I would suggest to run a script after the HTML report is generated to comment out all scripts.
Then the HTML links (which are rewritten) are used instead of the ones generated by the JavaScript.
That's not a perfect solution, since you won't be able to use the filtering and sorting capabilities in the Summary report.
But since JavaScript is not working, there's nothing I can do about it.

I updated my blog post that shows the complete setup with a PowerShell script:
http://www.palmmedia.de/Blog/2012/9/27/cruisecontrol-net-integration-of-coverage-reports

Commented Unassigned: No longer works with CruiseControl.NET [10145]

danielpalme — Wed, 29 May 2013 19:01:11 GMT

Thanks for reporting the issue. I will try to reproduce it and then I will see what I can do about it.

Created Unassigned: No longer works with CruiseControl.NET [10145]

pdavis68 — Wed, 29 May 2013 14:35:10 GMT

Patch Uploaded: #14485

frblondin — Wed, 15 May 2013 08:10:23 GMT

frblondin has uploaded a patch.

Description:
We use OpenCover to check the code coverage of a big project using the Html report. The resulting files were too big (>700 Mb in Jenkins for each buil :-(), and on the other hand the report produced by HtmlSummary was not complete enough: there is no table displaying the coverage by method. I had the choice between adding a new parameter to the tool or enhance the HtmlSummary report...

... but I ended up adding a new IncludeFileAnalysis argument (in command-line, MSBuild task, help...) so that the decorated code can be removed regardless what report format is specified.

Hope you can include the patch in your trunk so that I can stick with your latest releases.

Thanks for your usefull tool though!

Commented Issue: Class with all auto-properties shows 0% coverage [9988]

marklam — Wed, 03 Apr 2013 09:31:07 GMT

For a class which consists of only automatic get; set; properties, the coverage statistics show 0 covered and 0 uncovered of a possible 0 giving coverage of 0%.

Since there's no code there to test, it would be nice if 0 of 0 was interpreted as 100% rather than 0%, so the coverage bar could be green instead of red.
Comments: ** Comment from web user: marklam **

0 of 0 now showing as an empty bar for both cases.
Thanks for the fix.

Updated Release: ReportGenerator_1.8.1.0 (Apr 02, 2013)

danielpalme — Tue, 02 Apr 2013 19:05:21 GMT

This release contains binaries, the source code and documentation.
Requires .NET 4.0: Download

Released: ReportGenerator_1.8.1.0 (Apr 02, 2013)

Tue, 02 Apr 2013 19:05:21 GMT

This release contains binaries, the source code and documentation.
Requires .NET 4.0: Download

Closed Issue: Class with all auto-properties shows 0% coverage [9988]

danielpalme — Tue, 02 Apr 2013 18:57:54 GMT

Source code checked in, #72396

danielpalme — Tue, 02 Apr 2013 18:52:58 GMT

Issue #9988: Completely empty classes now show correct coverage

Commented Issue: Class with all auto-properties shows 0% coverage [9988]

marklam — Tue, 02 Apr 2013 09:05:34 GMT

Hi Daniel, yes it was version 1.8.0.0

I've attached a repro case including the coverage file (in the OpenCover subfolder). It wasn't a class containing only atuto-properties after all - it was an empty class, but I noticed that another type of class with no sequence points _is_ shown as 100% covered (also included in the attached archive).

If you want to regenerate the coverage, build the solution in Release and then run msbuild Cover.proj, but you'll need to add back in the NuGet packages for NUnit, Nunit.Runners, OpenCover and ReportGenerator because they're not in the attached archive.

Commented Issue: Class with all auto-properties shows 0% coverage [9988]

danielpalme — Thu, 28 Mar 2013 19:26:54 GMT

Are you using OpenCover?
Are you using the latest release of ReportGenerator (version 1.8.0.0)?

Could you provide me your coverage file and the source code of the class containing only auto properties?

Created Issue: Class with all auto-properties shows 0% coverage [9988]

marklam — Thu, 28 Mar 2013 17:08:11 GMT

Updated Wiki: Home

danielpalme — Mon, 25 Mar 2013 10:19:57 GMT

ReportGenerator

Project Description

ReportGenerator converts XML reports generated by PartCover, OpenCover or NCover into a readable report in various formats.
The reports do not only show the coverage quota, but also include the source code and visualize which line has been covered.

ReportGenerator supports merging several reports into one.
It is also possible to pass one XML file containing several reports to ReportGenerator (e.g. a build log file).

The following output formats are supported by ReportGenerator:

HTML, HTMLSummary
XML, XMLSummary
Latex, LatexSummary

Compatibility:

OpenCover
PartCover (4.0)
PartCover (2.2, 2.3)
Visual Studio
NCover (tested version 1.5.8, other versions may not work)

Also available as NuGet package: http://nuget.org/List/Packages/ReportGenerator

Additional information about ReportGenerator can be found under Resources.

Author: Daniel Palme
Blog: http://www.palmmedia.de
Twitter: @danielpalme

Screenshots

The screenshots show two snippets of the generated reports:

Usage

ReportGenerator is a commandline tool which requires the following parameters:

Parameters:
    ["]-reports:<report>[;<report>][;<report>]["]
    ["]-targetdir:<target directory>["]
    [[\"]-reporttypes:<None|Html|HtmlSummary|...>[;<(+|-)None|Html|HtmlSummary|...>][\"]]"
    [["]-sourcedirs:<directory>[;<directory>][;<directory>]["]]
    [["]-filters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]

Explanations:
   Reports:           The coverage reports that should be parsed (separated by 
                      semicolon). Wildcards are allowed.
   Targetdirectory:   The directory where the generated report should be saved.
   Reporttypes:       The output formats and scope (separated by semicolon).
                      Values: None, Html, HtmlSummary, Xml, XmlSummary, Latex,
                              LatexSummary
   SourceDirectories: Optional directories which contain the corresponding source code
                      (separated by semicolon).
                      The source files are used if coverage report contains classes
                      without path information.
   Filters:           Optional list of assemblies that should be included or excluded
                      in the report. Exclusion filters take precedence over inclusion 
                      filters. Wildcards are allowed.
   Verbosity:         The verbosity level of the log messages.
                      Values: Verbose, Info, Error

Default values:
   -reporttypes:Html
   -filters:+*
   -verbosity:Verbose

Examples:
   "-reports:coverage.xml" "-targetdir:C:\report"
   "-reports:target\*\*.xml" "-targetdir:C:\report" -reporttypes:Latex;HtmlSummary
   "-reports:coverage1.xml;coverage2.xml" "-targetdir:report"
   "-reports:coverage.xml" "-targetdir:C:\report" -reporttypes:Latex "-sourcedirs:C:\MyProject"
   "-reports:coverage.xml" "-targetdir:C:\report" "-sourcedirs:C:\MyProject1;C:\MyProject2" "-filters:+Included;-Exclude
d.*"

A MSBuild task also exists:

<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Coverage" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
  <UsingTask TaskName="ReportGenerator" AssemblyFile="ReportGenerator.exe" />
  <ItemGroup>
    <CoverageFiles Include="partcover.xml" />
    <SourceDirectories Include="C:\MyProject1" />
    <SourceDirectories Include="C:\MyProject2" />
  </ItemGroup>
  <Target Name="Coverage">
    <ReportGenerator ReportFiles="@(CoverageFiles)" TargetDirectory="report" ReportTypes="Html;Latex" SourceDirectories="@(SourceDirectories)" Filters="+Include;-Excluded" VerbosityLevel="Verbose" />
  </Target>
</Project>

Resources

Updated Release: ReportGenerator_1.8.0.0 (Mrz 08, 2013)

danielpalme — Sun, 24 Mar 2013 11:09:55 GMT

This release contains binaries, the source code and documentation.
Requires .NET 4.0: Download