ByteDev.Testing 4.0.0

ByteDev.Testing

.NET Standard library that provides some testing related functionality.

Installation

ByteDev.Testing has been written as a .NET Standard 2.0 library, so you can consume it from a .NET Core or .NET Framework 4.6.1 (or greater) application.

ByteDev.Testing is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:

Install-Package ByteDev.Testing

Further details can be found on the nuget page.

Release Notes

Releases follow semantic versioning.

Full details of the release notes can be viewed on GitHub.

Usage

Builders

Builders to help create both directories and files quickly for testing purposes.

// Create a directory quickly on disk
DirectoryInfo dir = DirectoryBuilder.InFileSystem
                        .WithPath(@"C:\Temp\Testing")
                        .EmptyIfExists()
                        .Build();


// Create a file quickly on disk
FileInfo file = FileBuilder.InFileSystem
                    .WithPath(@"C:\Temp\Testing\TestFile1.txt")
                    .WithSize(10)
                    .OverwriteIfExists(true)
                    .Build();

TestConnectionString & TestApiKey

The TestConnectionString and TestApiKey types both represent different types of single value string settings that live external to the test project.

These settings can be stored possibly in either an environment variable or file.

Example usage of TestConnectionString:

// Get reference to assembly that is running the tests
var assembly = Assembly.GetAssembly(typeof(SomeIntTests));

// Create an instance of the type. A number of default file paths will be set on FilePath
// when a reference to the containing assembly is passed on the constructor.
var testConn = new TestConnectionString(assembly);

// Set the name of a possible environment variable where the connection might be held
testConn.EnvironmentVarName = "MyIntTests-ConnString";

// Set extra file paths where the connection string might be held.
testConn.FilePaths.Add(@"X:\Secure\MyIntTests.connstring");

string connStr = testConn.GetValue();

TestSettings

The TestSettings type represents sets of test settings that live external to the test project in a JSON file.

Example custom settings type:

public class MyAppSettings
{
    public string MySecret1 { get; set; }

    public string MySecret2 { get; set; }
}

Example JSON settings file MyApp.settings.json (property name case is ignored):

{
  "MySecret1": "some secret 1",
  "MySecret2": "some secret 2"
}

Example code to retrie MyAppSettings:

// Get reference to assembly that is running the tests
var assembly = Assembly.GetAssembly(typeof(SomeIntTests));

// Create an instance of the type. A number of default file paths will be set on FilePath
// when a reference to the containing assembly is passed on the constructor.
var testSettings = new TestSettings(assembly);

// // Set extra file paths where the test settings might be held
testSettings.FilePaths.Add(@"X:\Secure\MyApp.settings.json");

MyAppSettings settings = testSettings.GetSettings<MyAppSettings>();

// settings.MySecret1 == "some secret 1"
// settings.MySecret2 == "some secret 2"

As well as defining and providing your own settings type you can also use the built in TestAzureSettings type.

For example:

TestAzureSettings settings = testSettings.GetAzureSettings();

// TestAzureSettings contains common Azure settings, including:
// SubscriptionId, TenantId, ClientId, ClientSecret etc.

FakeHttpMessageHandler

Allows you to provide a sequence of outcomes (HTTP responses or exceptions thrown) that correspond to each HTTP request made.

Reference the ByteDev.Testing.Http namespace.

var uri = new Uri("http://www.google.com/");

// Create a sequence of outcomes...
// 1st request will return a response OK with content.
// 2nd request will throw request timeout exception.
var outcomes = new List<FakeRequestOutcome>
{
    new FakeRequestOutcome(new HttpResponseMessage(HttpStatusCode.OK)
    {
        Content = new StringContent("Testing")
    }),
    new FakeRequestOutcome(FakeRequestOutcome.CreateRequestTimeout())
}

// Create a fake HTTP handler
var handler = new FakeHttpMessageHandler(outcomes);

var httpClient = new HttpClient(handler);

var response1 = await httpClient.GetAsync(uri);
var content = await response1.Content.ReadAsStringAsync();

// response1.StatusCode == HttpStatusCode.OK
// content == "Testing"

// Throws TaskCanceledException("Request has timed out.")
var response2 = await httpClient.GetAsync(uri);

// handler.RequestsMade == 2