It has been almost 3 and a half year since first version of LightBDD has been released on Nuget (1.1.0) and almost half a year since last update (1.7.2).
Since the beginning of the project, new C# language features have become more popular like async/await and new platform such as .NET Core or standards like .NET Standard emerged.
Due to a fact that LightBDD 1.X is targeting .NET Framework 4.0 and its few implementation details (like usage of ThreadLocal<>, StackTrace or CriticalFinalizerObject), it made it difficult to adapt to new trends.
Also, with project evolution some of its features became obsolete.
Because of these reasons, it is time to make bigger changes in the framework and take it to version 2.
What will change?
Full async support in core engine
The version 2 engine will be designed to run scenarios and steps in asynchronous manner. The async scenario and step methods will be supported but ultimately it will depend on step syntax implementation. It is planned to support async execution in extended step syntax (parameterized steps) but not in simplified one.
Support for other platforms and frameworks
The first release of version 2 will be targeting .NET Framework 4.6 as well as .NET Standard 1.6 making LightBDD available for new frameworks and platforms.
LightBDD will be officially supporting .NET Core and .NET Framework platforms and possibly more in future.
After release, an additional investigations and tests will be made in order to check possibility to extend support to .NET Framework 4.5 (the lack of AsyncLocal<> class makes it problematic).
Currently, there is a plan to drop .NET Framework 4.0 support.
Testing framework support
LightBDD version 2 will support following testing frameworks:
- NUnit3 (.NET Framework and .NET Core),
- XUnit2 (.NET Framework and .NET Core),
- MsTest (.NET Framework and .NET Core).
MbUnit support will be dropped as the project is dead – it may be however added later if there would be a need for it.
The LightBDD projects have been reworked in order to separate LightBDD features from the core engine.
Features such as step execution syntax, step commenting or summary generation will be separated into dedicated packages enabling:
- an ability to version and evolve features independently,
- users to pick features they really need.
In code configuration
Due to a fact that app.config is not available across all platforms, the LightBDD engine will be now configured in code.
For each testing framework, a LightBDD scope initialization code will have to be present (the scope initialization may look differently, depending on testing framework) and it will allow to configure the runner, including:
- customizing summary report generation,
- enabling additional features and extensions,
- customizing framework core mechanics like culture info, step name formatting method and more.
The code below may change on release but it visualizes how configuration will be done:
class ConfiguredLightBddScope : LightBddScopeAttribute
protected override void OnConfigure(LightBddConfiguration configuration)
The new version will eliminate some of the caveats of LightBDD 1.X implementation.
It will be no longer needed to apply
[assembly: Debuggable(true, true)] workaround to properly format scenario names in release mode – instead, it would be required to use LightBDD specific [Scenario] attribute to mark scenario methods instead of test framework specific attribute like [Test], [Fact] or [TestMethod].
Also, the explicit LightBDD scope makes summary files to always generate, where in version 1.X summary files were not generated if their creation was taking more than 3 seconds (limitation of CriticalFinalizerObject).
Migrating LightBDD 1.X to 2.0
The upgrade to version 2 will require test code update, however the number of changes are reduced to minimum and most likely will cover:
- namespaces update,
- framework specific test method attribute update to [Scenario] attribute,
- LightBDD configuration change from app.config to in-code configuration,
- updates in context based scenarios.
LightBDD 2 will be no binary compatible with LightBDD 1.X.
When LightBDD 2 would be available?
The current state of the project is that all the implementation changes are finished, however other tasks have to be done before the release, including finalizing the layout of projects, updating CI pipeline, documentation and wiki page.
The new release should be available in next few weeks.