For help with troubleshooting common issues, refer to the Troubleshooting section.
What is SpecFlow?
SpecFlow aims to bridge the communication gap between domain experts and developers. Acceptance tests in SpecFlow follow the BDD paradigm of defining specifications with examples, so that they are also understandable to business users. Acceptance tests can then be tested automatically as needed, while their specification serves as a living documentation of the system.
SpecFlow integrates with Visual Studio, but can be also used from the command line (e.g. on a build server).
SpecFlow+ adds additional functionality to SpecFlow, such as a stand-alone IDE for Gherkin specifications, advanced reporting and much more.
What is the difference between SpecFlow and SpecFlow+?
SpecFlow is open source and free of charge. It covers all your basic needs for managing and testing specifications by example.
SpecFlow+ is a series of extensions that introduce additional features, such as a stand-alone IDE for Gherkin specifications, advanced reporting, specify and execute Gherkin in Excel, execute tests in multiple threads, and define complex filters to determine which tests to run.
For an overview of the differences between SpecFlow and SpecFlow+, see the comparison of features.
How do I install SpecFlow?
To install SpecFlow and SpecFlow+, you first need to install the SpecFlow Visual Studio integration. Once you have done this, you can then add SpecFlow to each of your projects using NuGet. For more details, see the Getting Started article.
SpecFlow is an open source project. Anyone can download and edit the source code, and SpecFlow relies on contributions from its users to fix bugs and add new features.
I have found an issue with SpecFlow. How can I get support?
If you encounter problems using SpecFlow or have any questions, one of the best places to turn for help is the SpecFlow Google Group. Posts to this group are regularly read by contributors to the SpecFlow project. SpecFlow is also popular on Stack Overflow, so you might find the answer to your question there as well.
If you have found a bug, please first search the SpecFlow issues on GitHub to check that this is not already a known issue. If you cannot find a matching issue on GitHub, please submit a GitHub issue including as much information and context as possible, and ideally a code sample that allows the issue to be reproduced. The easier you make it for contributors to diagnose and fix your issue, the more likely you are to see results.
Please include the following information when submitting a bug report:
- Your SpecFlow version
- The test runner and version number you are using, as well as information on how you are executing the tests (e.g. include your command line)
- Your Visual Studio version
- Your .NET framework version
- A link to a project that reproduces the issue, if possible
Once you have submitted an issue relating to a bug, a contributor needs to take on the issue and provide a pull request containing a fix. Depending on the nature of your issue, how well it is described and how easy it is to reproduce, a fix may be delivered quickly or take a long time. You are actively encouraged to contribute and doing so can significantly reduce the time needed to fix issues that impact on your work with SpecFlow. Because SpecFlow relies on contributions from the community, there are no guarantees that a particular issue will be fixed within a specific time frame. If you urgently need a fix, the quickest way is to provide one yourself!
If time is of the essence, TechTalk can offer paid support and deliver fixes for a fee invoiced either by effort or per incident. Details on the associated costs are available here.
How can I learn more about SpecFlow and BDD/Specification-by-Example? Where can I find training material online?
Gaspar Nagy - the creator of SpecFlow - offers a training course that covers the methodology behind SpecFlow, from writing the initial specification to binding tests to your application's code. He also covers many of the more advanced options available in SpecFlow. You can find out more about Gaspar's schedule on the training page. You may also want to visit Gaspar's web site and sign up for his newsletter.
We’ve listed the most important resources here. Many of them are free or inexpensive.
Gojko Adzic's books (Bridging the Communication Gap: Specification by Example and Agile Acceptance Testing and Specification by Example: How Successful Teams Deliver the Right Software) are an excellent introduction to the methodology. Gojko uses a lot of real life examples to relate his ideas to real software development and to show the potential pitfalls and benefits of different approaches.
If you are just getting started with SpecFlow, you should definitely follow the Getting Started tutorial that guides you through the process of setting up a Visual Studio project with SpecFlow, writing your first tests, binding the tests to your code, and executing your tests. You should get the basic idea of how testing with SpecFlow works and ought to be able to apply the basic concepts you have learnt to your own projects.
As you progress, you will probably start wanting to look into the more advanced options in SpecFlow, such as using tables to supply arguments for your tests, sharing data between steps and more. An overview of some of these concepts can be found on the Beyond the Basics page with links to the appropriate sections of the documentation.
I have a feature request; how can I submit it?
We currently have a long list of features awaiting implementation and are therefore limited in our capacity to implement feature requests. However, as SpecFlow is open source, you can implement new features yourself (more information available here).
If you require a specific feature but are unable to develop it yourself, you can also sponsor the feature for the benefit of the community or pay outright for development services provided by TechTalk.
Analytics and Data Collection
Does SpecFlow or SpecFlow+ collect any personal information?
We do not collect any personal information from within SpecFlow or SpecFlow+.
Does SpecFlow or SpecFlow+ collect any data?
To improve the quality of our extensions we are use Azure Application Insights, an analytics platform provided by Microsoft. Only anonymous usage data is transferred to Azure Application Insights, for further details, please see Microsoft’s documentation by clicking here.
You can disable these analytics if you do not wish to share this information.
How can I contribute to SpecFlow's development?
Details on how you can contribute to SpecFlow's development can be found here.
Who are the developers behind SpecFlow?
SpecFlow was originally created by Gáspár Nagy and used internally by TechTalk in various software development projects. Since then developers from around the world have contributed to the open source project; an overview can be found here.
Can I use the SpecFlow name for my own projects based on SpecFlow?
We are always happy to see projects that extend SpecFlow’s feature set, and SpecFlow is open source to specifically encourage such contributions from the community. We have however reserved the rights to the name “SpecFlow” as well as the official SpecFlow logo. We need to retain control over this aspect of the project, as we share responsibility for supporting and maintaining SpecFlow, along with all other contributors in the community.
When naming your project, one of our primary concerns is therefore that the name of your project avoids any confusion concerning project ownership and avoids creating the impression that your project is officially supported by us. Of course this is benefits you as well - we surely both want to ensure that feedback concerning your project is directed to the right place, and prevent users from submitting support issues to the SpecFlow community that concern third-party projects.
If you want to use “SpecFlow” in the name of your project, we would suggest naming your project something along the lines of “XXX for SpecFlow”. Please avoid names that start with “SpecFlow” as this suggests an official affiliation with the SpecFlow project (similar to SpecFlow, SpecFlow+, SpecFlow+ Runner etc.).
If you are unsure as to whether your preferred project name meets these guidelines, you can always contact us to make sure. We are always happy to hear about new projects that benefit the SpecFlow community, and if your project is well received and proves popular, we may approach you about the possibility of integrating your project within the official SpecFlow project.
Does SpecFlow support coded UI tests?
Coded UI tests include special coded UI attributes that can only be interpreted by MS Test. If you are using coded UI tests, you can only execute them using the MS Test test runner. For more details on getting coded UI working with SpecFlow, see this blog post (thanks to Mario Majčica).