Cloud.Core.Testing

Testing utility package used in all Cloud.Core projects. All reusable test helpers should live in this package to be reused through testing projects.

Read full Api documentation

Usage

Trait builders

Contains a set of Is* trait attributes that aggregate specific trait categories, to facilitate control over build test filters:

IsDev - "Dev"
IsUnit - "Unit"
IsIntegration - "Integration"
IsIntegrationReadOnly - "Integration" + "ReadOnly"
IsSmoke - "Smoke"
IsPerformance - "Performance"

This list can be added to when the build-release pipeline is defined.

Lorem Ipsum helper

It could be useful during tests to generate a list of text used in test cases. The Lorem Ipsum helper has been defined to do this. Generate words, sentences and paragraphs as follows:

var loremWords = Cloud.Core.Testing.Lorem.Lorem.GetWords(10); // number of words
var loremSentences = Cloud.Core.Testing.Lorem.Lorem.GetSentences(2);  // number of sentences
var loremParagraphs = Cloud.Core.Testing.Lorem.Lorem.GetParagraphs(5);  // number of paragraphs

LogExecutionTime Attribute

The LogExecutionTime attribute can be used to output the time it takes a test to run to completion.

[Fact]
[LogExecutionTime]
public void Test_Lorem_GetSingleParagraph()
{
     var paragraph = Lorem.Lorem.GetParagraph(3);

     var split = paragraph.Split('.').ToList();
     split.RemoveAll(string.IsNullOrEmpty);

     Assert.Equal(3, split.Count);
}

Fake Http Client

The fake Http Client can be used as an alternative to mocking http calls. You can setup responses to particular endpoints as follows:

// Setup fake response data.
var responseData = "test"; // this can be any object.

// Endpoint that is expected to be called, along with status of response and a payload.
var fakeHttpClient = new FakeHttpClient(FAKEAPIURL);
fakeHttpClient.AddEndPoint("api/values", HttpStatusCode.OK, responseData);

// Get the fake http client instance.
var client = fakeHttpClient.GetHttpClient();

// Make request and get our predicted response.
var response = client.GetAsync("api/values").GetAwaiter().GetResult();
var content = JsonConvert.DeserializeObject<string>(response.Content.ReadAsStringAsync().GetAwaiter().GetResult());

// Assert - response was as expected.
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
Assert.Equal(content, responseData);

Test Coverage

A threshold will be added to this package to ensure the test coverage is above 80% for branches, functions and lines. If it's not above the required threshold (threshold that will be implemented on ALL of the core repositories to gurantee a satisfactory level of testing), then the build will fail.

Compatibility

This package has has been written in .net Standard and can be therefore be referenced from a .net Core or .net Framework application. The advantage of utilising from a .net Core application, is that it can be deployed and run on a number of host operating systems, such as Windows, Linux or OSX. Unlike referencing from the a .net Framework application, which can only run on Windows (or Linux using Mono).

Setup

This package is built using .net Standard 2.1 and requires the .net Core 3.1 SDK, it can be downloaded here: https://www.microsoft.com/net/download/dotnet-core/

IDE of Visual Studio or Visual Studio Code, can be downloaded here: https://visualstudio.microsoft.com/downloads/

How to access this package

All of the Cloud.Core.* packages are published to a public NuGet feed. To consume this on your local development machine, please add the following feed to your feed sources in Visual Studio: https://dev.azure.com/cloudcoreproject/CloudCore/_packaging?_a=feed&feed=Cloud.Core

For help setting up, follow this article: https://docs.microsoft.com/en-us/vsts/package/nuget/consume?view=vsts

devr24 / Cloud.Core.Testing