SpecFlow icon indicating copy to clipboard operation
SpecFlow copied to clipboard

Updated misleading documentation

Open DrJohnT opened this issue 2 years ago • 3 comments

Note that the images for Visual Studio Test task are incorrect. The Test filter MUST be TestCategory and NOT Category. These should be updated along with the text

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue).
  • [ ] New feature (non-breaking change which adds functionality).
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • [ ] Performance improvement
  • [ ] Refactoring (so no functional change)
  • [x] Other (docs, build config, etc)

Checklist:

  • [ ] I've added tests for my code. (most of the time mandatory)
  • [ ] I have added an entry to the changelog. (mandatory)
  • [x] My change requires a change to the documentation.
  • [x] I have updated the documentation accordingly.

DrJohnT avatar Mar 01 '22 13:03 DrJohnT

I am not sure if we have the same understanding what VSTest is. For me, it is the platform for test execution in .NET. All Testframeworks (xUnit, NUnit, MSTest, SpecFlow+ Runner) are integrated into it. So having it on the same list as them, makes no sense for me. For me it can only be VSTest+NUnit, VSTest+xUnit, etc. There is no VSTest for me alone.

AFAIK it passes the filters through to the test framework which does then the filtering. That's at least how I implemented it in the SpecFlow+ Runner.

What does VSTest mean for you?

SabotageAndi avatar Mar 02 '22 09:03 SabotageAndi

My point is that the Azure DevOps screen shots are wrong as using Category=XX DOES NOT WORK! image

The word Category should be changed for TestCategory. The screenshot should look like this: image

Examples of using TestCategory (not Category) can be found here https://gasparnagy.com/2016/05/specflow-tips-run-only-specific-scenarios-in-tfsvsts-build/

Documentation for VsTest can be found here https://github.com/microsoft/vstest-docs

DrJohnT avatar Mar 02 '22 11:03 DrJohnT

The screenshots are from a project that uses xUnit, in which Category works (https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#filter-option-details). That is not stated here and should be.

But you did other changes which adds VSTest to some places that I don't understand why.

SabotageAndi avatar Mar 02 '22 12:03 SabotageAndi