You've already forked linux-packaging-mono
Imported Upstream version 5.2.0.175
Former-commit-id: bb0468d0f257ff100aa895eb5fe583fb5dfbf900
This commit is contained in:
Xamarin Public Jenkins (auto-signing)
parent
4bdbaf4a88
commit
966bba02bb
@@ -1,9 +1,7 @@
|
||||
Code Coverage
|
||||
=============
|
||||
|
||||
"Code coverage" is a measure that indicates how much of our library code is exercised by our test suites. We measure code coverage using the [OpenCover](https://github.com/opencover/opencover), and a report of our latest code coverage results can be seen by clicking the coverage badge on the [CoreFX home page](https://github.com/dotnet/corefx):
|
||||
|
||||
[](http://dotnet-ci.cloudapp.net/job/dotnet_corefx_coverage_windows/lastBuild/Code_Coverage_Report/)
|
||||
"Code coverage" is a measure that indicates how much of our library code is exercised by our test suites. We measure code coverage using the [OpenCover](https://github.com/opencover/opencover), and a report of our latest code coverage results can be seen by clicking the coverage badge on the [CoreFX home page](https://github.com/dotnet/corefx), linking to the latest [Coverage Report](https://ci.dot.net/job/dotnet_corefx/job/master/job/code_coverage_windows/Code_Coverage_Report/).
|
||||
|
||||
This report shows each library currently being tested with code coverage and provides statistics around the quality of the code coverage for the library. It also provides a line-by-line breakdown of what lines are being covered and what lines are not.
|
||||
|
||||
@@ -30,6 +28,16 @@ An issue need not be addressed in its entirety. We happily accept contributions
|
||||
|
||||
Code coverage runs are performed by Jenkins approximately twice a day. The results of these runs are all available from the site linked to by the code coverage badge on the home page.
|
||||
|
||||
## PR Code Coverage Runs
|
||||
|
||||
Jenkins can create a coverage report using your PR. Ask for it using `@dotnet-bot test code coverage please`.
|
||||
|
||||
After it's done the report can be found in the build log, it looks like eg
|
||||
`https://ci.dot.net/job/dotnet_corefx/job/master/job/code_coverage_windows_prtest/16/artifact/bin/tests/coverage`
|
||||
then add index.htm on the end:
|
||||
`https://ci.dot.net/job/dotnet_corefx/job/master/job/code_coverage_windows_prtest/16/artifact/bin/tests/coverage/index.htm`
|
||||
You can navigate to this from your PR by clicking the "Details" link to the right of the code coverage job listed at the bottom of the PR after having issued the above request to dotnet-bot. In the Jenkins UI for the resulting build, click the "Build Artifacts" link and navigate through the resulting hierarchy to the index.htm file.
|
||||
|
||||
## Local Code Coverage Runs
|
||||
|
||||
You can perform code coverage runs locally on your own machine. Normally to build your entire CoreFX repo, from the root of your repo you'd run:
|
||||
@@ -50,11 +58,11 @@ You can also build and test with code coverage for a particular test project rat
|
||||
|
||||
msbuild /t:BuildAndTest
|
||||
|
||||
To do so with code coverage, as with ```build``` append the ```/p:Coverage=true``` argument:
|
||||
To do so with code coverage, append the ```/p:Coverage=true``` argument:
|
||||
|
||||
msbuild /t:BuildAndTest /p:Coverage=true
|
||||
|
||||
The results for this one library will then also show up in the aforementioned index.htm file. For example, to build, test, and get code coverage results for the System.Diagnostics.Debug library, from the root of my repo I can do:
|
||||
The results for this one library will then show up in the aforementioned index.htm file. For example, to build, test, and get code coverage results for the System.Diagnostics.Debug library, from the root of the repo one can do:
|
||||
|
||||
cd src\System.Diagnostics.Debug\tests\
|
||||
msbuild /t:BuildAndTest /p:Coverage=true
|
||||
@@ -63,22 +71,11 @@ And then once the run completes:
|
||||
|
||||
..\..\..\bin\tests\coverage\index.htm
|
||||
|
||||
## Code coverage with mscorlib code
|
||||
## Code coverage with System.Private.CoreLib code
|
||||
|
||||
Some of the libraries for which contracts and tests live in the corefx repo are actually implemented in the core runtime library in another repo, e.g. the implementation that backs the System.Runtime contract is in System.Private.Corlib.dll in either the coreclr or corert repo. To run coverage reports for these projects, you need to build mscorlib locally from the coreclr repo.
|
||||
Some of the libraries for which contracts and tests live in the corefx repo are actually fully or partially implemented in the core runtime library in another repo, e.g. the implementation that backs the System.Runtime contract is in System.Private.CoreLib.dll in either the coreclr or corert repo. To run coverage reports for these projects, you need to build System.Private.CoreLib locally from the coreclr repo. To get coverage of System.Private.CoreLib while running the tests for a particular library:
|
||||
|
||||
The following steps can be used manually to produce a coverage report, but a customizable batch file can be found [here](facade-code-coverage.bat). Changing the parameters in the first couple of lines lets you run a coverage report easily for any facade project.
|
||||
1. Follow the steps outlined at [Testing with Private CoreClr Bits](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/developer-guide.md#testing-with-private-coreclr-bits). Make sure to include the optional steps listed as being required for code coverage.
|
||||
2. Add /p:CodeCoverageAssemblies="System.Private.CoreLib" to the previously discussed msbuild command, e.g. msbuild /t:BuildAndTest /p:Coverage=true /p:CodeCoverageAssemblies="System.Private.CoreLib"
|
||||
|
||||
1. Build the local test project (`msbuild /T:Build`)
|
||||
3. Build coreclr locally in Debug or Release (`build.cmd all Debug skiptests`)
|
||||
2. Navigate to the built test directory in the corefx bin (e.g. `bin/tests/AnyOS.AnyCPU.Debug/System.Runtime/netcoreapp1.0` for `System.Runtime`
|
||||
4. Delete `coreclr.dll`, `mscorlib.dll`, `mscorlib.ni.dll`, `System.Private.CoreLib.dll` and `System.Private.CoreLib.ni.dll` from that directory
|
||||
5. Copy all files in the coreclr `bin` directory to the test directory
|
||||
6. Copy all files in the coreclr `bin/PDB` directory to the test directory
|
||||
7. Run an OpenCover command with `xunit.console.netcore.exe`. For example:
|
||||
|
||||
<corefx-root>/packages/OpenCover/<opencover-version>/tools/OpenCover.Console.exe -oldStyle -filter:"+[*]* -[*.Tests]* -[xunit.*]*" -excludebyfile:"*\Common\src\System\SR.*" -nodefaultfilters -excludebyattribute:*.ExcludeFromCodeCoverage* -skipautoprops -hideskipped:All -threshold:1 -returntargetcode -register:user -targetdir:<path-to corefx-bin> -target:CoreRun.exe -output:coverage.xml -targetargs:"xunit.console.netcore.exe System.Runtime.Tests -xml testResults.xml -notrait Benchmark=true -notrait category=OuterLoop -notrait category=failing -notrait category=nonwindowstests"
|
||||
|
||||
8. Run a ReportGenerator command with the generated `coverage.xml` file. For example:
|
||||
|
||||
<corefx-root>/packages/ReportGenerator/<opencover-version>/tools/ReportGenerator.exe -reporttypes:Html;Badges -reports:coverage.xml
|
||||
The resulting code coverage report should now also include details for System.Private.CoreLib.
|
||||
|
||||
Reference in New Issue
Block a user