Покрытие кода: как улучшить качество тестирования
Это позволяет использовать команду altcover в любом месте, не добавляя ее в проект.
И все-таки я собираюсь пройтись по руководству по быстрой настройке AltCover и посмотреть, как быстро я смогу это сделать!
Я установлю его в свой тестовый проект hanselminutes.core.tests,
Отлично. Мои тесты выполняются как обычно, но теперь у меня есть файл test.xml в тестовой папке. При желании я мог бы также сгенерировать отчеты LCov или Cobertura. Уже сейчас файл coverage.xml весит почти полмегабайта! В нем много полезной информации, но как я могу увидеть результаты в читаемом виде?
Файл имеет формат OpenCover XML, поэтому я могу запустить ReportGenerator для файла покрытия и получить целую кучу HTML-файлов. По сути, целый мини-сайт покрытия!
Обратите внимание на Risk Hotspots сверху! У меня есть CustomPageHandler со значительной сложностью NPath и два представления со значительной цикломатической сложностью.
Также оцените отличное покрытие путей, как указано здесь, в результатах отчета о покрытии. Можно заметить, что EnableAutoLinks всегда было истинным, поэтому я проверил только один путь. Возможно, я выполню здесь отрицательный тест и посмотрю, возникнут ли какие-либо побочные эффекты, если EnableAutoLinks будет ложным.
Изучите полное руководство по использованию AltCover. Существует множество способов запустить этот инструмент, от глобальных средств Global Tools, тестов dotnet, задач MSBuild до интеграции с PowerShell!
Use code coverage for unit testing
This article explains the creation of the example project. If you already have a project, you can skip ahead to the Code coverage tooling section.
This article is based on the sample source code project, available on samples browser.
System under test
The «system under test» refers to the code that you’re writing unit tests against, this could be an object, service, or anything else that exposes testable functionality. For this article, you’ll create a class library that will be the system under test, and two corresponding unit test projects.
Create a class library
The snippet below defines a simple PrimeService class that provides functionality to check if a number is prime. Copy the snippet below and replace the contents of the Class1.cs file that was automatically created in the Numbers directory. Rename the Class1.cs file to PrimeService.cs.
It is worth mentioning that the Numbers class library was intentionally added to the System namespace. This allows for System.Math to be accessible without a using System; namespace declaration. For more information, see namespace (C# Reference).
Create test projects
Create two new xUnit Test Project (.NET Core) templates from the same command prompt using the dotnet new xunit command:
Both of the newly created xUnit test projects need to add a project reference of the Numbers class library. This is so that the test projects have access to the PrimeService for testing. From the command prompt, use the dotnet add command:
The MSBuild project is named appropriately, as it will depend on the coverlet.msbuild NuGet package. Add this package dependency by running the dotnet add package command:
The previous command changed directories effectively scoping to the MSBuild test project, then added the NuGet package. When that was done, it then changed directories, stepping up one level.
Open both of the UnitTest1.cs files, and replace their contents with the following snippet. Rename the UnitTest1.cs files to PrimeServiceTests.cs.
Create a solution
From the command prompt, create a new solution to encapsulate the class library and the two test projects. Using the dotnet sln command:
This will create a new solution file name XUnit.Coverage in the UnitTestingCodeCoverage directory. Add the projects to the root of the solution.
Build the solution using the dotnet build command:
If the build is successful, you’ve created the three projects, appropriately referenced projects and packages, and updated the source code correctly. Well done!
Code coverage tooling
There are two types of code coverage tools:
The xUnit test project template already integrates with coverlet.collector by default. From the command prompt, change directories to the XUnit.Coverlet.Collector project, and run the dotnet test command:
The «XPlat Code Coverage» argument is a friendly name that corresponds to the data collectors from Coverlet. This name is required but is case insensitive.
Below is the example coverage.cobertura.xml file.
As an alternative, you could use the MSBuild package if your build system already makes use of MSBuild. From the command prompt, change directories to the XUnit.Coverlet.MSBuild project, and run the dotnet test command:
The resulting coverage.cobertura.xml file is output. You can follow MSBuild integration guide here
Generate reports
Run the tool and provide the desired options, given the output coverage.cobertura.xml file from the previous test run.
After running this command, an HTML file represents the generated report.
Coverlet collector что это
| Driver | Current version | Downloads |
|---|---|---|
| coverlet.collector |  |  |
| coverlet.msbuild |  |  |
| coverlet.console |  |  |
Coverlet documentation reflect the current repository state of the features, not the released ones.
Check the changelog to understand if the documented feature you want to use has been officially released.
Coverlet can be used through three different drivers
Coverlet is integrated into the Visual Studio Test Platform as a data collector. To get coverage simply run the following command:
After the above command is run, a coverage.cobertura.xml file containing the results will be published to the TestResults directory as an attachment.
See documentation for advanced usage.
MSBuild Integration (suffers of possible known issue)
N.B. You MUST add package only to test projects
Coverlet also integrates with the build system to run code coverage after tests. Enabling code coverage is as simple as setting the CollectCoverage property to true
After the above command is run, a coverage.json file containing the results will be generated in the root directory of the test project. A summary of the results will also be displayed in the terminal.
See documentation for advanced usage.
Requires a runtime that support .NET Standard 2.0 and above
.NET Global Tool (guide, suffers from possible known issue)
The following example shows how to use the familiar dotnet test toolchain:
See documentation for advanced usage.
.NET Coverlet global tool requires .NET Core 2.2 and above
Coverlet generates code coverage information by going through the following process:
Deterministic build support
Coverlet supports coverage for deterministic builds. The solution at the moment is not optimal and need a workaround.
Take a look at documentation.
Are you in trouble with some feature? Check on examples!
Unfortunately we have some known issues, check it here
If you’re using Cake Build for your build script you can use the Cake.Coverlet add-in to provide you extensions to dotnet test for passing Coverlet arguments in a strongly typed manner.
Visual Studio Add-In
If you want to visualize coverlet output inside Visual Studio while you code, you can use the following addins depending on your platform.
If you’re using Visual Studio on Windows, you can use the Fine Code Coverage extension. Visualization is updated when you run unit tests inside Visual Studio.
If you’re using Visual Studio for Mac, you can use the VSMac-CodeCoverage extension.
Consume nightly build
We offer nightly build of master for all packages. See the documentation
If you find a bug or have a feature request, please report them at this repository’s issues section. See the CONTRIBUTING GUIDE for details on building and contributing to this project.
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
Part of the code is based on work done by OpenCover team https://github.com/OpenCover
This project is licensed under the MIT license. See the LICENSE file for more info.
Coverlet collector что это
| Driver | Current version | Downloads |
|---|---|---|
| coverlet.collector | | |
| coverlet.msbuild | | |
| coverlet.console | | |
Coverlet documentation reflect the current repository state of the features, not the released ones.
Check the changelog to understand if the documented feature you want to use has been officially released.
Coverlet can be used through three different drivers
Coverlet is integrated into the Visual Studio Test Platform as a data collector. To get coverage simply run the following command:
After the above command is run, a coverage.cobertura.xml file containing the results will be published to the TestResults directory as an attachment.
See documentation for advanced usage.
MSBuild Integration (suffers of possible known issue)
N.B. You MUST add package only to test projects
Coverlet also integrates with the build system to run code coverage after tests. Enabling code coverage is as simple as setting the CollectCoverage property to true
After the above command is run, a coverage.json file containing the results will be generated in the root directory of the test project. A summary of the results will also be displayed in the terminal.
See documentation for advanced usage.
Requires a runtime that support .NET Standard 2.0 and above
.NET Global Tool (guide, suffers from possible known issue)
The following example shows how to use the familiar dotnet test toolchain:
See documentation for advanced usage.
.NET Coverlet global tool requires .NET Core 2.2 and above
Coverlet generates code coverage information by going through the following process:
Deterministic build support
Coverlet supports coverage for deterministic builds. The solution at the moment is not optimal and need a workaround.
Take a look at documentation.
Are you in trouble with some feature? Check on examples!
Unfortunately we have some known issues, check it here
If you’re using Cake Build for your build script you can use the Cake.Coverlet add-in to provide you extensions to dotnet test for passing Coverlet arguments in a strongly typed manner.
Visual Studio Add-In
If you want to visualize coverlet output inside Visual Studio while you code, you can use the following addins depending on your platform.
If you’re using Visual Studio on Windows, you can use the Fine Code Coverage extension. Visualization is updated when you run unit tests inside Visual Studio.
If you’re using Visual Studio for Mac, you can use the VSMac-CodeCoverage extension.
Consume nightly build
We offer nightly build of master for all packages. See the documentation
If you find a bug or have a feature request, please report them at this repository’s issues section. See the CONTRIBUTING GUIDE for details on building and contributing to this project.
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
Part of the code is based on work done by OpenCover team https://github.com/OpenCover
This project is licensed under the MIT license. See the LICENSE file for more info.
Использование объема протестированного кода для модульного тестирования
В этой статье объясняется, как создать пример проекта. Если у вас уже есть проект, можно перейти к разделу Средства для проверки объема протестированного кода.
Модульные тесты помогают подтвердить наличие нужной функциональности и предоставляют средства проверки действий по рефакторингу. Объем протестированного кода — это измерение объема кода, выполняемого модульными тестами (строки, ветви или методы). Например, если у вас есть простое приложение с двумя условными ветвями кода (ветвь a и ветвь b), модульный тест, проверяющий условную ветвь a сообщит об объеме протестированного кода ветви в 50 %.
Кроме того, в этой статье подробно описано, как использовать сведения об объеме протестированного кода, собранные из тестового запуска Coverlet, для создания отчета. Создание отчетов возможно с помощью другого проекта с открытым исходным кодом на сайте GitHub — ReportGenerator. ReportGenerator преобразует отчеты о покрытии, созданные Cobertura в числе многих других программ, в удобные для чтения отчеты в различных форматах.
В основе этой статьи лежит образец проекта исходного кода, доступный в обозревателе примеров.
Тестируемая система
Тестируемая система — это код, на котором вы пишете модульные тесты. Это может быть объект, служба или любая другая функция, которая предоставляет возможность тестирования. Выполняя приведенные в этой статье инструкции, вы создадите библиотеку классов, которая будет тестируемой системой, и два соответствующих проекта модульных тестов.
Создание библиотеки классов
Создание тестовых проектов
Создайте два новых шаблона тестового проекта xUnit (.NET Core) из одной командной строки с помощью команды dotnet new xunit :
Оба новых созданных тестовых проекта xUnit должны добавить ссылку на проект библиотеки классов Numbers. Это значит, что тестовые проекты имеют доступ к PrimeService для тестирования. В командной строке используйте команду dotnet add :
Проект MSBuild назван соответствующим образом, так как он будет зависеть от пакета NuGet coverlet.msbuild. Добавьте эту зависимость пакета, выполнив команду dotnet add package :
Предыдущая команда изменила каталоги в области действия на тестовый проект MSBuild, а затем добавила пакет NuGet. После этого были изменены каталоги, и выполнен шаг с заходом на один уровень вверх.
Откройте оба файла UnitTest1.cs и замените их содержимое следующим фрагментом кода. Переименуйте файлы UnitTest1.cs в PrimeServiceTests.cs.
Создание решения
В командной строке создайте новое решение для инкапсуляции библиотеки классов и двух тестовых проектов. С помощью команды dotnet sln :
Это приведет к созданию нового имени файла решения XUnit.Coverage в каталоге UnitTestingCodeCoverage. Добавьте проекты в корневую папку решения.
Если сборка выполнена успешно, это означает, что вы создали три проекта, соответствующие проекты и пакеты и обновили исходный код правильно. Отлично!
Средства для проверки объема протестированного кода
Существует два типа средств для проверки объема протестированного кода:
Шаблон тестового проекта xUnit по умолчанию интегрируется с coverlet.collector. В командной строке перейдите в каталог проекта XUnit.Coverlet.Collector и выполните команду dotnet test :
Аргумент «XPlat Code Coverage» — это понятное имя, соответствующее сборщикам данных из Coverlet. Это имя является обязательным (без учета регистра).
Ниже приведен пример файла coverage.cobertura.xml.
В качестве альтернативы можно использовать пакет MSBuild, если система сборки уже использует MSBuild. В командной строке перейдите в каталог проекта XUnit.Coverlet.MSBuild и выполните команду dotnet test :
Полученный файл coverage.cobertura.xml является выходным. Вы можете ознакомиться с руководством по интеграции MSBuild.
Создание отчетов
Запустите средство и укажите нужные параметры, используя файл выходных данных coverage.cobertura.xml из предыдущего тестового запуска.
После выполнения этой команды созданный отчет будет представлен в HTML-файле.
