https://github.com/brendanconnolly/Xunit.Categories

Friendlier attributes to help categorize your tests
https://github.com/brendanconnolly/Xunit.Categories

xunit

Last synced: 2 months ago
JSON representation

Friendlier attributes to help categorize your tests

• Host: GitHub
• URL: https://github.com/brendanconnolly/Xunit.Categories
• Owner: brendanconnolly
• License: apache-2.0
• Created: 2016-11-27T19:03:59.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-13T15:24:16.000Z (5 months ago)
• Last Synced: 2024-09-14T06:25:05.013Z (5 months ago)
• Topics: xunit
• Language: C#
• Homepage:
• Size: 39.1 KB
• Stars: 129
• Watchers: 9
• Forks: 20
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-Nuget-Packages - **xunit.categories**

README

        
# Xunit.Categories

Friendlier attributes to help categorize your tests. 

## Messy Traits?

The xUnit built in option *Traits* can get a little messy. Its just 2 strings representing a key and value, unless you are familiar with xUnit and the Trait attribute it looks a little magical.

Also both key and value must be specified on the command line. This means if you decorate your test with 

`[Trait("Category","Bug")]` you cannot run only tests from a specific bug  without adding another trait `([Trait("Bug","8675309"])`

## Friendly Attributes Included

- Category 

- Feature

- User Story

- Bug

- Integration Test

- Unit Test

- Exploratory

- Documentation

- Known Bug

- Work Item

- System Test

- Test Case

- Database Test

- Snapshot Test

- Expensive

- Author

- Description

- Component

Open an issue or pull request to add more.

## Example

``` csharp

[Fact]

[Bug]

public void TestBug()

{

    throw new NotImplementedException("I'm a bug");

}

[Fact]

[Bug("777")]

public void TestBugWithId()

{

    throw new NotImplementedException("I've got your number");

}

```

Using this attribute you get descriptive information and flexibility when running tests. 

You can run all tests marked as Bugs

``` bat

xunit.console.exe ... -trait "Category=Bug"

-or via dotnet test

dotnet test --filter "Category=Bug" 

```

or get more granular

``` bat

xunit.console.exe ... -trait "Bug=777"

-or via dotnet test

dotnet test --filter "Bug=777" 

```