System.Spec is testing tool for the C# programming language.
System.Spec uses the following frameworks to help it achieve the goal of a BDD framework:
- NSubstitute as the mocking framework
- FluentAssertions as the expected outcome framework
- NUnit as the testing framework
Below is an example specification in C#:
namespace YourCompany.Specs
{
using NSubstitute;
using System.Spec;
public class ImportantSpecification : Specification
{
protected override void Define()
{
Describe("A very cool specification", () => {
It("should do something that is good", () => {
var testInterface = Substitute.For<ITestInterface>();
testInterface.Received().TestMethod();
});
});
}
}
}
To execute your specifications execute the following:
./artifacts/spec.sh artifacts/
The default output will display the following example:
..FF........
Failures:
1) should be true
Failure/Error: FluentAssertions.Execution.AssertionFailedException: Expected True, but found False.
at FluentAssertions.Execution.FallbackTestFramework.Throw (System.String message) [0x00000] in <filename unknown>:0
at FluentAssertions.Execution.AssertionHelper.Throw (System.String message) [0x00000] in <filename unknown>:0
at FluentAssertions.Execution.Verification.FailWith (System.String failureMessage, System.Object[] failureArgs) [0x00000] in <filename unknown>:0
at FluentAssertions.Primitives.BooleanAssertions.BeTrue (System.String reason, System.Object[] reasonArgs) [0x00000] in <filename unknown>:0
at System.Spec.Examples.Specs.TestSpecificationWithFluentAssertions.<Define>m__C () [0x00000] in <filename unknown>:0
at System.Spec.StopwatchHelper.ExecuteTimedActionWithResult (System.Action action) [0x00000] in <filename unknown>:0
2) should call method
Failure/Error: NSubstitute.Exceptions.ReceivedCallsException: Expected to receive a call matching:
TestMethod()
Actually received no matching calls.
at NSubstitute.Core.ReceivedCallsExceptionThrower.Throw (ICallSpecification callSpecification, IEnumerable`1 matchingCalls, IEnumerable`1 nonMatchingCalls, NSubstitute.Core.Quantity requiredQuantity) [0x00000] in <filename unknown>:0
at NSubstitute.Routing.Handlers.CheckReceivedCallsHandler.Handle (ICall call) [0x00000] in <filename unknown>:0
at NSubstitute.Routing.Route+<>c__DisplayClass3.<Handle>b__0 (ICallHandler x) [0x00000] in <filename unknown>:0
at System.Linq.Enumerable+<CreateSelectIterator>c__Iterator25`2[NSubstitute.Core.ICallHandler,NSubstitute.Core.RouteAction].MoveNext () [0x00000] in <filename unknown>:0
at System.Linq.Enumerable.First[RouteAction] (IEnumerable`1 source, System.Func`2 predicate, Fallback fallback) [0x00000] in <filename unknown>:0
at System.Linq.Enumerable.FirstOrDefault[RouteAction] (IEnumerable`1 source, System.Func`2 predicate) [0x00000] in <filename unknown>:0
at NSubstitute.Routing.Route.Handle (ICall call) [0x00000] in <filename unknown>:0
at NSubstitute.Core.CallRouter.Route (ICall call) [0x00000] in <filename unknown>:0
at NSubstitute.Proxies.CastleDynamicProxy.CastleForwardingInterceptor.Intercept (IInvocation invocation) [0x00000] in <filename unknown>:0
at Castle.DynamicProxy.AbstractInvocation.Proceed () [0x00000] in <filename unknown>:0
at Castle.Proxies.ITestInterfaceProxy.TestMethod () [0x00000] in <filename unknown>:0
at System.Spec.Examples.Specs.TestSpecificationWithNSubstitute.<Define>m__11 () [0x00000] in <filename unknown>:0
at System.Spec.StopwatchHelper.ExecuteTimedActionWithResult (System.Action action) [0x00000] in <filename unknown>:0
Finished in 0.447 seconds
12 examples, 2 failures
System.Spec expects that you name your DLL's with the suffix Specs.dll. This is so that System.Spec does not load all of the assemblies in your path. You can override this with the -s switch.
The command spec has the following options:
Usage: spec options
OPTION TYPE POSITION DESCRIPTION
-Path string 0 The path to search all the Spec assemblies. The default is spec.
-Example (-e) string NA The example to execute. This could be a spec, example group or an example.
--example NA
-Pattern (-P) string NA Load files matching pattern. The default is Specs.
--pattern NA
-Output (-o) string NA The output path of the test results. The default is test-results.xml.
--out NA
-Format (-f) consoleformattertype NA Specifies what format to use for output.
--format NA
-DryRun (-d) switch NA Invokes formatters without executing the examples.
--dry-run NA
-Version (-v) switch NA Display the version.
--version NA
-Colour (-c) switch NA Enable colour in the output.
--colour NA
-Help (-h) switch NA You're looking at it.
--help NA
EXAMPLE: spec.(exe|sh) spec
Execute all the specs in the folder spec.
From version 2.0 we have changed the way you construct your specifications. Here is a list of changes:
- The new method to override is Define rather Validate.
- The Describe method does not pass an example to the Action.
- BeforeXXX and AfterXXX are now methods that take an action, rather than just an action.
- The command line options have changed to follow the rspec command line.
- The output follows RSpec format.
From version 3.0 we have changed a few more things
- The framework has been upgraded to 4.5
- The It method contains to default methods [CallerFilePath] string callingFilePath = "", [CallerLineNumber] int callingFileLineNumber = 0. This should not be filled in.
- There is a runner for VS 2012.
I have always been a fan of the Jasmine so I will be following that design. If you have any suggestions please raise a request or issue or better yet fork and contribute.