TestSurface 1.0.5

Test Surface

v1.0

Description

The lib defines a testing contract, provides a command line arguments parser, a simple printing utility and a test runner. In order to use the runner one has to implement the ITestSurface interface:

public interface ITestSurface
{
	string Info { get; }
	string FailureMessage { get; }
	bool? Passed { get; }
	bool IsComplete { get; }
	bool IndependentLaunchOnly { get; }
	Task Run(ArgMap args);
}

The runner can be launched in two modes:

• with a specific test class and arguments, by passing a -TheTestClassName as a command line parameter
• with -all to discover all the compatible classes and invoke their Run method. Tests having IndependentLaunchOnly = true will be ignored as they cannot be fed with specific data because that could brake the rest of the tests.

The ArgMap type is an IDictionary<string, List<string>> instance, produced by the ArgsParser. Inside the Run method each test is provided with a copy of the original dictionary, so that common test paths could be reused by adding arguments.

The IDictionary<string, List<string>> holds the switches as keys with the dash (e.g. -all) and a list of string arguments provided in the console after the switch.

Additional arguments:

• including -info will take the Info property and trace it instead of executing the Run method.
• with -notrace all Print.AsInfo(), Print.Trace() invocations will be ignored
• use -brake to stop the test launcher on the first failure

Launching with -all -info will trace all test descriptions.

Use Print to trace info during the test instead of Console directly for it can be suppressed with -notrace and also the Print.Trace() method has a lock for correct coloring in multi-threaded code.

Usage

Add a reference to the TestRunner.dll and implement the ITestSurface interface:

public class TestCase : ITestSurface
{
	public string Info => "Test description...";

	public string FailureMessage { get; private set; }
	public bool? Passed { get; private set; }
	public bool IndependentLaunchOnly => false;
	public bool IsComplete { get; private set; }

	public async Task Run(IDictionary<string, List<string>> args)
	{
		if (args.ContainsKey("-all"))
			// add default switches 
			args.Add("-param", new List<string>() { "10", "1000" });

		// The common path, i.e. either -all or -TestCase
		var w = args["-param"];

		// ...

		if (!Passed.HasValue) Passed = true;
		IsComplete = true;
	}
}

Launch a new Runner instance:

using System;
using TestSurface;

namespace Tests
{
    class Program
    {
        static int Main(string[] args)
        {
            var r = new Runner();
           
            // The args should contain -all or -ClassName
            r.Run(args);
            
            // Check the ResultMap, Exceptions or Passed/Failed/Skipped counters
            return (r.Exceptions.Count < 1 && r.Passed > 0) ? 0 : -r.Failed;
        }
    }
}