Machine.Specifications

Machine.Specifications is a Context/Specification framework for .NET that removes language noise and simplifies tests.

Code Quality Rank: L5

Programming language: C#

License: MIT License

Tags: Test     Unit     Testing     TDD     MSpec     BDD     Context     Specification    

Latest version: v1.0.0

README

Machine.Specifications

MSpec is called a "context/specification" test framework because of the "grammar" that is used in describing and coding the tests or "specs". The grammar reads roughly like this

When the system is in such a state, and a certain action occurs, it should do such-and-such or be in some end state.

You should be able to see the components of the traditional Arrange-Act-Assert model in there. To support readability and remove as much "noise" as possible, MSpec eschews the traditional attribute-on-method model of test construction. Instead it uses custom delegates that you assign anonymous methods, and asks you to name them following a certain convention.

using Machine.Specifications;

[Subject("Authentication")]
class When_authenticating_an_admin_user
{
    static SecurityService subject;
    static UserToken user_token;

    Establish context = () => 
        subject = new SecurityService();

    Because of = () =>
        user_token = subject.Authenticate("username", "password");

    It should_indicate_the_users_role = () =>
        user_token.Role.ShouldEqual(Roles.Admin);

    It should_have_a_unique_session_id = () =>
        user_token.SessionId.ShouldNotBeNull();
}

Getting Started

1. Create a .NET Framework or .NET Core library project.
2. Install Nuget packages as follows:

Install-Package Machine.Specifications

1. Install the test SDK and Visual Studio runner:

Install-Package Microsoft.NET.Test.SDK
Install-Package Machine.Specifications.Runner.VisualStudio

1. Optionally, install the assert and mocking libraries:

Install-Package Machine.Specifications.Should
Install-Package Machine.Fakes

Documentation

For project documentation, please visit the wiki.

Training

A PluralSight course by @kevinkuebler is available here.

Get in touch

Discuss with us on Discussions, chat with us on Gitter, or raise an issue.

Packages

Project	Build	NuGet
Machine.Specifications
Machine.Specifications.Reporting
Machine.Specifications.Runner.Console
Machine.Specifications.Runner.ReSharper
Machine.Specifications.Runner.Rider
Machine.Specifications.Runner.TDNet
Machine.Specifications.Runner.Utility
Machine.Specifications.Runner.VisualStudio
Machine.Specifications.Should
Machine.Fakes