README.md

Tired of trying to find and test all edge cases in your methods or APIs? BreakIt tries solve this problem by automatically going through all input and sending extreme values or funky data with the goal to "break it".

It's also customizable so you can change, add or remove which input to test for each data type.

Currently we support:

• bool
• int
• double
• float
• decimal
• short
• string?
• enum
• IList
• Dictionary (and IDictionary)

Install

NuGet

https://www.nuget.org/packages/Testura.BreakIt

PM> Install-Package Testura.BreakIt

Usage

Example 1 - Simple method

Method or api to test:

using System;
using System.Collections.Generic;

namespace Testura.BreakIt.Tests.Help
{
    public class MyApi
    {
        public void CallApi(int id, string name) { .. }
    }
}

Execute the test:

var myApi = new MyApi(); 
var breakIt = new BreakIt();

var result = breakIt.Execute(myApi, nameof(myApi.CallApi), new List<object> { 1, "testName });

After execution we get this result:

Testing parameter id => 2147483647, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter id => -2147483648, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter name => empty, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter name => null, Validation => No validation done, Return value => null or no return value, Exception => No exception

It's very important that you provide default parameters that is valid and match the method (new List<object> { 1, "testName } in the example).

Example 2 - More advanced case

Method or api to test:

using System;
using System.Collections.Generic;

namespace Testura.BreakIt.Tests.Help
{
    public class MyApi
    {
        public void CallApiComplex(int id, List<SomeComplexType> list, Dictionary<string, SomeComplexType> dictionary, SomeEnum someEnum) { .. }
    }
}

Execute the test:

var myApi = new MyApi(); 
var breakIt = new BreakIt();

var defaultValue = new SomeComplexType { Name = "Test", Number = 3 };
var result breakIt.Execute(myApi, nameof(myApi.CallApiComplex), new List<object> { 1, new List<SomeComplexType> { defaultValue }, new Dictionary<string, SomeComplexType> { ["Key"] = defaultValue }, MyApi.SomeEnum.FirstValue });

After execution we get this result:

Testing parameter id => 2147483647, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter id => -2147483648, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter list[0].Name => empty, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter list[0].Name => null, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter list[0].Number => 2147483647, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter list[0].Number => -2147483648, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter dictionary[Key].Name => empty, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter dictionary[Key].Name => null, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter dictionary[Key].Number => 2147483647, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter dictionary[Key].Number => -2147483648, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter someEnum => FirstValue, Validation => No validation done, Return value => null or no return value, Exception => No exception
Testing parameter someEnum => SecondValue, Validation => No validation done, Return value => null or no return value, Exception => No exception

As you can see it go through both list and dictionaries as long as they contain a default value.

Options

It is possible to provide a validation method or exclude types/members/parameters through the option object.

Example for validation (check if method throws internal server error):

private bool Validation(TestValue value, object returnValues, Exception exception)
{
	return !exception.Message.Contains("internal server error");
}

var breakIt = new BreakIt();
breakIt.Execute(someApi, nameof(someApi.SomeMethod), new List<object> { .. }, new BreakItOptions { Validation = Validation });

Example to exclude all members/parameters that contains "NotUsed" in it's name:

private bool Exclude(string memberPath, Type type)
{
	return memberPath.Contains("NotUsed");
}

var options = new BreakItOptions();
options.AddExclude(Exclude);

var breakIt = new BreakIt();
breakIt.Execute(someApi, nameof(someApi.SomeMethod), new List<object> { .. }, option);

Extend with new types

It is possible to extend the framework with your own test types if you want to handle them in a specific way.

First you implement the ISimpleTestType interface:

public interface ISimpleTestType
{
	/// <summary>
	/// Get the test values for a specific type.
	/// </summary>
	/// <param name="memberPath">Member path to the specifc test value</param>
	/// <returns>An array of all test values. </returns>
	TestValue[] GetTestValue(string memberPath);
}

Then you add it the TestValueFactory when creating a BreakIt instance>

var dictionary = new Dictionary<Type, ISimpleTestType>
{
	[yourType] = new YourImplementedISimpleTestType()
};

var breakIt = new BreakIt(testValueFactory: new TestValueFactory(dictionary));

Logging

BreakIt returns a result object but sometimes it's also good to log all values. Currently we have three diffrent loggers:

• ConsoleTestValueLogger
• FileTestValueLogger
• MemoryTestValueLogger

And you simple provide them when creating a new BreakIt instance:

var breakIt = new BreakIt(new ConsoleTestValueLogger());

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

Contact

Visit www.testura.net, twitter at @testuranet