{"id":12665,"date":"2017-01-11T10:59:29","date_gmt":"2017-01-11T18:59:29","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/powershell\/?p=12665"},"modified":"2019-02-18T12:38:05","modified_gmt":"2019-02-18T19:38:05","slug":"code-coverage-now-available-for-powershell-core","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/code-coverage-now-available-for-powershell-core\/","title":{"rendered":"Code Coverage now available for PowerShell Core!"},"content":{"rendered":"

This is the first of a series of posts on PowerShell Core and the tools we use to test it. If you\u2019ve looked at the main project for PowerShell (https:\/\/github.com\/PowerShell\/PowerShell<\/a>, you may have noticed a new badge down in the Build status of nightly builds:<\/p>\n

\"badge\"<\/a><\/p>\n

We are supplying code coverage numbers for our test pass via the OpenCover project (https:\/\/github.com\/OpenCover\/opencover<\/a>) and we visualize our code coverage percentage via coveralls.io (https:\/\/coveralls.io\/github\/PowerShell\/PowerShell?branch=master<\/a>).\u00a0This means you can see some details about our testing and how much of PowerShell is covered by our test code.<\/p>\n

You can get your own coverage numbers easily via our OpenCover module which may be found in the <RepoRoot>test\/tools\/OpenCover directory.\u00a0To generate a code coverage report, you need to create a build which supports code coverage.\u00a0Currently, that\u2019s only available on Windows, but we do have an easy way to get it:<\/p>\n

(All of these commands assume that you are at the root of the PowerShell repo)<\/p>\n

# create a code coverage build.\nPS> Start-PSBuild -Configuration CodeCoverage -Publish\n\n# Now that you have a build, save away the build location\nPS> $psdir = split-path -parent (get-psoutput)\n\n# Import the OpenCover Module\nPS> Import-module $pwd\/test\/tools\/OpenCover\n\n# install the opencover package\nPS> Install-OpenCover $env:TEMP\n\n# now invoke a coverage test run\nPS> Invoke-OpenCover -OutputLog Coverage.xml -test $PWD\/test\/powershell -OpenCoverPath $env:Temp\/OpenCover -PowerShellExeDirectory $psdir\n\n<\/pre>\n
If you want to get code coverage for only the tests that we run in our Continuous Integration (CI) environment, add the parameter -CIOnly.\u00a0Then you\u2019ll need to wait for a bit (on my system and using -CIOnly, it takes about 2.5 hours to run).<\/p>\n
Looking at the Data<\/h2>\n
The OpenCover module can also help you visualize the results from a very high level.<\/p>\n
# first collect the coverage data with the Get-CodeCoverage cmdlet\nPS> $coverData = Get-CodeCoverage .\\Coverage.xml\n# here\u2019s the coverage summary\nPS> $coverData.CoverageSummary\nNumSequencePoints\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 : 309755\nVisitedSequencePoints\u00a0\u00a0 : 123779\nNumBranchPoints\u00a0\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0: 105816\nVisitedBranchPoints\u00a0\u00a0\u00a0\u00a0 : 39842\nSequenceCoverage\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 : 39.96\nBranchCoverage\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 : 37.65\nMaxCyclomaticComplexity : 398\nMinCyclomaticComplexity : 1\nVisitedClasses\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 : 2005\nNumClasses\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 : 3309\nVisitedMethods\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 : 14912\nNumMethods\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 : 33910\n\n# you can look at coverage data based on the assembly\nPS> $coverData.Assembly | ft AssemblyName, Branch, Sequence\n\nAssemblyName\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Branch Sequence\n------------\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ------ --------\npowershell\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0100\u00a0\u00a0\u00a0 100\nMicrosoft.PowerShell.CoreCLR.AssemblyLoadContext 45.12\u00a0 94.75\nMicrosoft.PowerShell.ConsoleHost\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 22.78\u00a0 23.21\nSystem.Management.Automation\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 41.18\u00a0 42.96\nMicrosoft.PowerShell.CoreCLR.Eventing\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 23.33\u00a0 28.57\nMicrosoft.PowerShell.Security\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 12.62\u00a0 14.43\nMicrosoft.PowerShell.Commands.Management\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 14.69\u00a0 16.76\nMicrosoft.PowerShell.Commands.Utility\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 52.72\u00a0 54.40\nMicrosoft.WSMan.Management\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 0.36\u00a0\u00a0 0.65\nMicrosoft.WSMan.Runtime\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 100\u00a0\u00a0\u00a0 100\nMicrosoft.PowerShell.Commands.Diagnostics\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 42.99\u00a0 46.62\nMicrosoft.PowerShell.LocalAccounts\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 0\u00a0\u00a0\u00a0\u00a0\u00a0 0\nMicrosoft.PowerShell.PSReadLine\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 6.98\u00a0\u00a0 9.86<\/pre>\n
I’m not going to go through all the different properties that are reported, we’ll take a closer look at\u00a0those in future posts.\u00a0\u00a0The Get-CoverageData cmdlet is still fairly rudimentary, but it will provide some<\/em> details. This is part of our public repo, so I encourage you to enhance it and log issues if you find them!<\/p>\n
Better Coverage Visualization<\/h3>\n
Another way to view coverage data is via the ReportGenerator package, which creates HTML reports and provides much<\/em> more details about the coverage. The ReportGenerator package is available via the find-package<\/span> cmdlet in the PackageManagement module. The following will install the package, and show how to run it:<\/p>\n
# find and install the report generator package\nPS> find-package ReportGenerator -ProviderName nuget -Source https:\/\/nuget.org\/api\/v2<\/a> | install-package -Scope CurrentUser\nPS> $ReportGenExe = \u201c$HOME\\AppData\\Local\\PackageManagement\\NuGet\\Packages\\ReportGenerator.2.5.2\\tools\\ReportGenerator.exe\u201d\n# invoke the report generator and create the report in c:\\temp\\Coverage\nPS> & $ReportGenExe -reports:Coverage.xml -targetdir:c:\\temp\\Coverage<\/pre>\n
Now that you\u2019ve created the reports, you can visualize them with your browser.<\/p>\n
PS> invoke-item C:\\temp\\Coverage\\index.htm<\/pre>\n
Click on the \u201cEnable filtering button\u201d, and then \u201cCollapse all\u201d and you should see something similar to:<\/p>\n
\"coverage1\"<\/a><\/p>\n
You can then drill in on what interests you (Microsoft.PowerShell.Commands.Utility, for example)<\/p>\n
\"coverage2\"<\/a><\/p>\n
 <\/p>\n
Of course, there\u2019s a lot more detail to discover, and I encourage you to poke around. In my next post, I\u2019ll go through an entire workflow:<\/p>\n