Dotnet Test Reporter

A GitHub action to parse test results and post them as a PR comment.
The action can process dotnet test results (a single or multiple .trx files), if there are any failing tests the action will fail.
Optionally, test coverage can be provided (a single opencover or cobertura .xml file) as well as a minimum coverage percentage. If a minimum coverage is provided and the coverage is not sufficient the action will fail.

Comment example

The action also generates a workflow summary - a more detailed overview of processed tests and coverage (in case a coverage file was provided). You can review the summary by following the link in the PR comment.

Summary example

Tests

✔️ Passed	❌ Failed	⚠️ Skipped	⏱️ Time
29	3	3	8.2s

✔️ Microsoft.eShopWeb.UnitTests.ApplicationCore.Entities.BasketTests.BasketAddItem - 6/6

Result	Test
✔️	AddsBasketItemIfNotPresent
✔️	CantAddItemWithNegativeQuantity
✔️	CantModifyQuantityToNegativeNumber
✔️	DefaultsToQuantityOfOne
✔️	IncrementsQuantityOfItemIfPresent
✔️	KeepsOriginalUnitPriceIfMoreItemsAdded

✔️ Microsoft.eShopWeb.UnitTests.ApplicationCore.Entities.BasketTests.BasketRemoveEmptyItems - 1/1

Result	Test
✔️	RemovesEmptyBasketItems

✔️ Microsoft.eShopWeb.UnitTests.ApplicationCore.Entities.BasketTests.BasketTotalItems - 2/2

Result	Test
✔️	ReturnsTotalQuantityWithMultipleItems
✔️	ReturnsTotalQuantityWithOneItem

✔️ Microsoft.eShopWeb.UnitTests.ApplicationCore.Entities.OrderTests.OrderTotal - 1/3

Result	Test	Output
⚠️	IsCorrectGiven1Item	Skipped test 1
⚠️	IsCorrectGiven3Items	Skipped test 2
✔️	IsZeroForNewOrder

✔️ Microsoft.eShopWeb.UnitTests.ApplicationCore.Extensions.JsonExtensions - 3/3

Result	Test
✔️	CorrectlyDeserializesJson(json: "{ \"id\": 3124, \"name\": \"Test Value 1\" }", expectedId: 3124, expectedName: "Test Value 1")
✔️	CorrectlyDeserializesJson(json: "{ \"id\": 9, \"name\": \"Another test\" }", expectedId: 9, expectedName: "Another test")
✔️	CorrectlySerializesAndDeserializesObject

❌ Microsoft.eShopWeb.UnitTests.ApplicationCore.Services.BasketServiceTests.AddItemToBasket - 1/2

Result	Test	Output
❌	InvokesBasketRepositoryGetBySpecAsyncOnce	Error Message Assert.Fail(): Failed test 1 Stack Trace at Microsoft.eShopWeb.UnitTests.ApplicationCore.Services.BasketServiceTests.AddItemToBasket.InvokesBasketRepositoryGetBySpecAsyncOnce() in C:\Users\testuser\Files\Projects\eShopOnWeb\tests\UnitTests\ApplicationCore\Services\BasketServiceTests\AddItemToBasket.cs:line 20 --- End of stack trace from previous location ---
✔️	InvokesBasketRepositoryUpdateAsyncOnce

✔️ Microsoft.eShopWeb.UnitTests.ApplicationCore.Services.BasketServiceTests.DeleteBasket - 1/1

Result	Test
✔️	ShouldInvokeBasketRepositoryDeleteAsyncOnce

✔️ Microsoft.eShopWeb.UnitTests.ApplicationCore.Services.BasketServiceTests.TransferBasket - 4/4

Result	Test
✔️	CreatesNewUserBasketIfNotExists
✔️	InvokesBasketRepositoryFirstOrDefaultAsyncOnceIfAnonymousBasketNotExists
✔️	RemovesAnonymousBasketAfterUpdatingUserBasket
✔️	TransferAnonymousBasketItemsWhilePreservingExistingUserBasketItems

❌ Microsoft.eShopWeb.UnitTests.ApplicationCore.Specifications.BasketWithItems - 3/4

Result	Test	Output
❌	MatchesBasketWithGivenBasketId	Error Message System.Exception : Test exception Stack Trace at Microsoft.eShopWeb.UnitTests.ApplicationCore.Specifications.BasketWithItems.MatchesBasketWithGivenBasketId() in C:\Users\testuser\Files\Projects\eShopOnWeb\tests\UnitTests\ApplicationCore\Specifications\BasketWithItemsSpecification.cs:line 24
✔️	MatchesBasketWithGivenBuyerId
✔️	MatchesNoBasketsIfBasketIdNotPresent
✔️	MatchesNoBasketsIfBuyerIdNotPresent

❌ Microsoft.eShopWeb.UnitTests.ApplicationCore.Specifications.CatalogFilterPaginatedSpecification - 0/2

Result	Test	Output
⚠️	Returns2CatalogItemsWithSameBrandAndTypeId	Skipped test 3
❌	ReturnsAllCatalogItems	Error Message Assert.Fail(): Failed test 2 Stack Trace at Microsoft.eShopWeb.UnitTests.ApplicationCore.Specifications.CatalogFilterPaginatedSpecification.ReturnsAllCatalogItems() in C:\Users\testuser\Files\Projects\eShopOnWeb\tests\UnitTests\ApplicationCore\Specifications\CatalogFilterPaginatedSpecification.cs:line 11

✔️ Microsoft.eShopWeb.UnitTests.ApplicationCore.Specifications.CatalogFilterSpecification - 7/7

Result	Test
✔️	MatchesExpectedNumberOfItems(brandId: 1, typeId: 3, expectedCount: 1)
✔️	MatchesExpectedNumberOfItems(brandId: 1, typeId: null, expectedCount: 3)
✔️	MatchesExpectedNumberOfItems(brandId: 2, typeId: 3, expectedCount: 0)
✔️	MatchesExpectedNumberOfItems(brandId: 2, typeId: null, expectedCount: 2)
✔️	MatchesExpectedNumberOfItems(brandId: null, typeId: 1, expectedCount: 2)
✔️	MatchesExpectedNumberOfItems(brandId: null, typeId: 3, expectedCount: 1)
✔️	MatchesExpectedNumberOfItems(brandId: null, typeId: null, expectedCount: 5)

Coverage

📏 Line	🌿 Branch
121 / 263 (46.01%)	5 / 18 (27.78%)

✔️ ApplicationCore - 46.01%

File	Total	Line	Branch	Lines to Cover
CatalogSettings.cs	0 / 1	0%	100%	5
Entities\BaseEntity.cs	1 / 1	100%	100%
Entities\BasketAggregate\Basket.cs	18 / 19	94.74%	100%	9
Entities\BasketAggregate\BasketItem.cs	3 / 4	75%	100%	8
Entities\BuyerAggregate\Buyer.cs	0 / 11	0%	100%	9, 11, 13, 15, 16, 18, 20-24
Entities\BuyerAggregate\PaymentMethod.cs	0 / 3	0%	100%	5-7
Entities\CatalogBrand.cs	0 / 1	0%	100%	7
Entities\CatalogItem.cs	2 / 8	25%	100%	7-10, 12, 14
Entities\CatalogType.cs	0 / 1	0%	100%	7
Entities\OrderAggregate\Address.cs	13 / 14	92.86%	100%	17
Entities\OrderAggregate\CatalogItemOrdered.cs	12 / 15	80%	100%	22, 23, 25
Entities\OrderAggregate\Order.cs	21 / 25	84%	100%	10, 11, 13, 40
Entities\OrderAggregate\OrderItem.cs	9 / 12	75%	100%	10, 11, 13
Exceptions\BasketNotFoundException.cs	3 / 12	25%	100%	11-13, 15-17, 19-21
Exceptions\GuardExtensions.cs	3 / 4	75%	50%	12
Services\BasketService.cs	17 / 51	33.33%	0%	24, 25, 27, 29, 30, 39-46, 48-51, 58-68, 74-79
Services\OrderService.cs	0 / 22	0%	0%	17-24, 27-38, 40, 41
Services\UriComposer.cs	0 / 4	0%	100%	9, 12-14
Specifications\BaseSpecification.cs	11 / 33	33.33%	100%	17-19, 21, 22, 30-32, 34-38, 40-42, 44-46, 50-52
Specifications\BasketWithItemsSpecification.cs	4 / 8	50%	100%	13-16
Specifications\CatalogFilterPaginatedSpecification.cs	0 / 5	0%	100%	8-12
Specifications\CatalogFilterSpecification.cs	4 / 4	100%	100%
Specifications\CustomerOrdersWithItemsSpecification.cs	0 / 5	0%	100%	8-12

Note: despite this action was created specifically for dotnet you can use it with other languages and frameworks as long as you can generate trx files. For example, your project can be a C#/dotnet backend with a TS/react frontend, in that case you would use the action twice. For react app you would need to

install jest-trx-results-processor package to generate trx test result files
add cobertura to coverageReporters array in case you would like to include a coverage

Inputs

`github-token`

Required - GitHub repository token.

`results-path`

Required - Path to the trx file(s) containing test results. Supports glob patterns.
Examples: ./TestResults/result.trx, ./**/*.trx

`coverage-path`

Optional - Path to the file containing test coverage. Supports glob patterns.
Examples: ./TestResults/coverage.xml, ./**/coverage.xml

`coverage-type`

Optional - Coverage file type. Supported types are opencover and cobertura.
Default: opencover

`coverage-threshold`

Optional - Minimum allowed coverage. You can provide a coverage percentage ranging from 0.00 to 100.00.
Example: 80.42

`comment-title`

Optional - Pull Request comment title.
Example: My Custom Title
Default: Test Results

`post-new-comment`

Optional - Boolean flag. Set to true to post a new comment after each run. Set to false or leave blank to only update an existing comment.
Default: false

`allow-failed-tests`

Optional - Boolean flag. Set to true to prevent failed tests from failing the job. Set to false or leave blank to fail the job if there are any failed tests (recommended).
Default: false

Outputs

`tests-total`

Total number of tests

`tests-passed`

Number of tests passed

`tests-failed`

Number of tests failed

`tests-skipped`

Number of tests skipped

`coverage-line`

Line code coverage

`coverage-lines-total`

Total lines of code

`coverage-lines-covered`

Lines of code covered

`coverage-branch`

Branch code coverage

`coverage-branches-total`

Total branches

`coverage-branches-covered`

Branches covered

Example usage

uses: bibipkins/dotnet-test-reporter@v1.3.0
with:
  github-token: ${{ secrets.GITHUB_TOKEN }}
  comment-title: 'Unit Test Results'
  results-path: ./TestResults/*.trx
  coverage-path: ./TestResults/coverage.xml
  coverage-threshold: 80

shawner18/dotnet-test-reporter

Dotnet Test Reporter

Comment example

Summary example

Tests

Coverage

Inputs

github-token

results-path

coverage-path

coverage-type

coverage-threshold

comment-title

post-new-comment

allow-failed-tests

Outputs

tests-total

tests-passed

tests-failed

tests-skipped

coverage-line

coverage-lines-total

coverage-lines-covered

coverage-branch

coverage-branches-total

coverage-branches-covered