TestBase.HttpClient.Fake 4.0.9

.NET Standard 1.3
There is a newer version of this package available.
See the version list below for details.
dotnet add package TestBase.HttpClient.Fake --version 4.0.9
NuGet\Install-Package TestBase.HttpClient.Fake -Version 4.0.9
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TestBase.HttpClient.Fake" Version="4.0.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TestBase.HttpClient.Fake --version 4.0.9
#r "nuget: TestBase.HttpClient.Fake, 4.0.9"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install TestBase.HttpClient.Fake as a Cake Addin
#addin nuget:?package=TestBase.HttpClient.Fake&version=4.0.9

// Install TestBase.HttpClient.Fake as a Cake Tool
#tool nuget:?package=TestBase.HttpClient.Fake&version=4.0.9

TestBase.HttpClient.Fake

[Test]
public async Task Should_MatchTheRightExpectationAndReturnTheSetupResponse__GivenMultipleSetups()
{
    var httpClient = new FakeHttpClient()
        .Setup(x=>x.Method==HttpMethod.Put).Returns(new HttpResponseMessage(HttpStatusCode.Accepted))
        .Setup(x=>x.RequestUri.PathAndQuery.StartsWith("/this")).Returns(thisResponse)
        .Setup(x=>x.RequestUri.PathAndQuery.StartsWith("/that")).Returns(thatResponse)
        .Setup(x=>x.RequestUri.PathAndQuery.StartsWith("/forbidden"))
             .Returns(new HttpResponseMessage(HttpStatusCode.Forbidden));

    (await httpClient.GetAsync("http://localhost/that")).ShouldEqualByValue(thatResponse);
    (await httpClient.GetAsync("http://localhost/forbidden")).StatusCode.ShouldBe(HttpStatusCode.Forbidden);


    httpClient.Verify(x=>x.Method==HttpMethod.Put);
    httClient.VerifyAll();     
}

TestBase

TestBase gives you a flying start with

  • fluent assertions that are easy to extend
  • tools to help you test with dependencies on AspNetMvc, HttpClient, Ado.Net, Streams and Logging

Chainable fluent assertions get you to the point concisely:

- ShouldEqualByValue(), ShouldEqualByValueExceptFor() 
  work with all kinds of object and collections, and report what differed.
- string.ShouldMatch() ShouldNotBeNullOrEmptyOrWhiteSpace(), ShouldEqualIgnoringCase(), ShouldBeContainedIn(), ...
- numeric.ShouldBeBetween(), ShouldEqualWithTolerance(), GreaterThan, LessThan, GreaterOrEqualTo ...
- IEnumerable.ShouldAll(), ShouldContain(), ShouldNotContain(), ShouldBeEmpty(), ShouldNotBeEmpty() ...
- Stream.ShouldHaveSameStreamContentAs() , Stream.ShouldContain()
- ShouldBe(), ShouldNotBe(), ShouldBeOfType(), ...

UnitUnderTest.Action()
    .ShouldNotBeNull()
    .ShouldEqualByValueExceptFor(new {Id=1, Payload=expected}, ignoreList )
    .Payload
        .ShouldMatchIgnoringCase("I expected this")
		.Should(someOtherPredicate);

TestBase.FakeDb

Works with Ado.Net and technologies on top of it, including Dapper.

- fakeDbConnection.SetupForQuery(IEnumerable<TFakeData>; )
- fakeDbConnection.SetupForQuery(IEnumerable<Tuple<TFakeDataForTable1,TFakeDataForTable2>> )
- fakeDbConnection.SetupForQuery(fakeData, new[] {"FieldName1", FieldName2"})
- fakeDbConnection.SetupForExecuteNonQuery(rowsAffected)
- fakeDbConnection.ShouldHaveUpdated("tableName", [Optional] fieldList, whereClauseField)
- fakeDbConnection.ShouldHaveSelected("tableName", [Optional] fieldList, whereClauseField)
- fakeDbConnection.ShouldHaveUpdated("tableName", [Optional] fieldList, whereClauseField)
- fakeDbConnection.ShouldHaveDeleted("tableName", whereClauseField)
- fakeDbConnection.ShouldHaveInvoked(cmd => predicate(cmd))
- fakeDbConnection.ShouldHaveXXX().ShouldHaveParameter("name", value)
- fakeDbConnection.Verify(x=>x.CommandText.Matches("Insert [case] .*") && x.Parameters["id"].Value==1)

TestBase.Mvc

ControllerUnderTest.Action()
  .ShouldbeViewResult()
  .ShouldHaveModel<TModel>()
  .ShouldEqualByValue(expected)
ControllerUnderTest.Action()
  .ShouldBeRedirectToRouteResult()
  .ShouldHaveRouteValue("expectedKey", [Optional] "expectedValue");

ShouldHaveViewDataContaining(), ShouldBeJsonResult() etc.

TestBase.Mvc Version 4 for netstandard20 & AspNetCore Mvc

  • Test most controllers with zero setup using controllerUnderTest.WithControllerContext(actionUnderTest) :
[Test]
public void ShouldBeViewWithModel_ShouldAssertViewResultAndNameAndModel()
{
    var controllerUnderTest = new AController().WithControllerContext("Action");
    
    var result= controllerUnderTest.ActionName().ShouldBeViewWithModel<AClass>("ViewName");
    
    result.ShouldBeOfType<AClass>().FooterLink.ShouldBe("/AController/ActionName");
}

  • Test controllers with complex application dependencies using HostedMvcTestFixtureBase and specify your MVCApplications Startup class:
[TestFixture]
public class WhenTestingControllersUsingAspNetCoreTestTestServer : HostedMvcTestFixtureBase
{
    [TestCase("/dummy/action?id={id}")]
    public async Task Get_Should_ReturnActionResult(string url)
    {
        var httpClient=GivenClientForRunningServer<Startup>();
        GivenRequestHeaders(httpClient, "CustomHeader", "HeaderValue1");
            
        var result= await httpClient.GetAsync(url.Formatz(new {Guid.NewGuid()}));

        result
            .ShouldBe_200Ok()
            .Content.ReadAsStringAsync().Result
            .ShouldBe("Content");
    }

    [TestCase("/dummy")]
    public async Task Put_Should_ReturnA(string url)
    {
        var something= new Fixture().Create<Something>();
        var jsonBody= new StringContent(something.ToJSon(), Encoding.UTF8, "application/json");
        var httpClient=GivenClientForRunningServer<Startup>();
        GivenRequestHeaders(httpClient, "CustomHeader", "HeaderValue1");

        var result = await httpClient.PutAsync(url, jsonBody);

        result.ShouldBe_202Accepted();
        DummyController.Putted.ShouldEqualByValue( something );
    }
}

TestBase.Mvc Version 3 for Net4

Use the Controller.WithHttpContextAndRoutes() extension methods to fake the http request & context. By injecting the RegisterRoutes method of your MvcApplication, you can use and test Controller.Url with your application's configured routes.

ControllerUnderTest
  .WithHttpContextAndRoutes(
    [Optional] Action&lt;RouteCollection&gt; mvcApplicationRoutesRegistration, 
    [optional] string requestUrl,
    [Optional] string query = "",
    [Optional] string appVirtualPath = "/",
    [Optional] HttpApplication applicationInstance)

ApiControllerUnderTest.WithWebApiHttpContext<T>(
    HttpMethod httpMethod, 
    [Optional] string requestUri,
    [Optional] string routeTemplate)

Testable Logging with StringListLogger

Extensions.Logging.ListOfString for Microsoft.Extensions.Logging.Abstractions:

var logger= new LoggerFactory.AddProvider(new StringListLoggerProvider()).CreateLogger("Test1");
// or
var loggedLines = new List<string>();
var logger= new LoggerFactory().AddStringListLogger(loggedLines).CreateLogger("Test2");

 ... ;
StringListLogger.Instance
	.LoggedLines
	.ShouldContain(x=>x.Matches("kilroy was here"));

Serilog.Sinks.ListOfString for Serilog:

var loglines= new List<String>();
var logger=new LoggerConfiguration().WriteTo.StringList(loglines).CreateLogger();
... ;
logLines.ShouldContain(x=>x.Matches("kilroy was here"));
  • Mix and match with your favourite test runners and assertions
  • Building on Mono : define compile symbol NoMSTest to remove dependency on Microsoft.VisualStudio.QualityTools.UnitTestFramework

ChangeLog

4.0.9.0 Remove dependency on net4 version of Mono.Linq.Expressions 4.0.8.0 Separated Serilog.Sinks.ListOfString and Extensions.Logging.StringListLogger 4.0.7.0 Added TestBase.FakeHttpClient Added Should(predicate,...) as synonym of ShouldHave(predicate,...) 4.0.6.2 TestBase.Mvc can run controller actions on aspnetcore using controller.WithControllerContext() 4.0.5.2 TestBase.Mvc partially ported to AspNetcore 4.0.4.0 StreamShoulds 4.0.3.0 StringListLogger as MS Logger and as Serilogger 4.0.1.0 Port to NetCore 3.0.3.0 Improves FakeDb setup 3.0.x.0 adds and/or corrects missing Shoulds() 2.0.5.0 adds some intellisense and FakeDbConnection.Verify(..., message,args) overload

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard1.3 netstandard1.4 netstandard1.5 netstandard1.6 netstandard2.0 netstandard2.1
.NET Framework net46 net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen30 tizen40 tizen60
Universal Windows Platform uap uap10.0
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on TestBase.HttpClient.Fake:

Package Downloads
FixtureBase

Don't spend hours writing code to mock a dozen dependencies, and more hours debugging it. Just write your test code, and let FixtureBase create the dependencies for you. FixtureBase constructs your UnitUnderTest to test your codebase end-to-end, with external dependencies auto-faked and automatically injected in just the right place; even constructor dependencies that are several layers deep. You just write your tests: ``` public class FixtureBaseExample : FixtureBaseWithDbAndHttpFor<AUseCase> { [Fact] public void UUTSendsDataToDb() { var newDatum = new Datum{Id=99, Name="New!" }; UnitUnderTest.InsertDb(newDatum); Db.ShouldHaveInserted("Data",newDatum); } [Fact] public void UUTreturnsDataFromDbQuerySingleColumn() { var dbData = new[] { "row1", "row2", "row3", "row4"}; Db.SetUpForQuerySingleColumn(dbData); UnitUnderTest.FromDbStrings().ShouldEqualByValue(dbData); } [Fact] public async Task UUTGetHttpReturnsDataFromService() { var contentFromService = "IGotThis!"; HttpClient .Setup(m => true) .Returns(new HttpResponseMessage(HttpStatusCode.OK) {Content = new StringContent(contentFromService)}); (await UnitUnderTest.GetHttp()).ShouldBe(contentFromService); HttpClient.Verify(x=>x.Method==HttpMethod.Get); } } ```   The included examples demonstrate FixtureBases for applications which depend on Ado.Net IDbConnections and on HttpClient network connections. - To create your own FixtureBase with your own preferred Fakes, see the examples at <https://github.com/chrisfcarroll/ActivateAnything/blob/master/FixtureBase/FixtureExample.cs.md> - For how it's done, see <https://github.com/chrisfcarroll/ActivateAnything/blob/master/FixtureBase/FixtureBase.cs> Construction is done by - [ActivateAnything](https://www.nuget.org/packages/ActivateAnything)   Faking is done by - [TestBase.AdoNet](https://www.nuget.org/packages/TestBase.AdoNet) - [TestBase.HttpClient.Fake](https://www.nuget.org/packages/TestBase.HttpClient.Fake) For more tools focussed on cutting the cost of unit testing, see also: - [TestBase](https://www.nuget.org/packages/TestBase) - [TestBase.AspNetCore.Mvc](https://www.nuget.org/packages/TestBase.AspNetCore.Mvc) - [TestBase-Mvc](https://www.nuget.org/packages/TestBase-Mvc) - [TestBase.AdoNet](https://www.nuget.org/packages/TestBase.AdoNet) - [TestBase.HttpClient.Fake](https://www.nuget.org/packages/TestBase.HttpClient.Fake) - [Serilog.Sinks.ListOfString](https://www.nuget.org/packages/Serilog.Sinks.Listofstring) - [Extensions.Logging.ListOfString](https://www.nuget.org/packages/Extensions.Logging.ListOfString)

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.2.0 1,505 12/2/2018
4.1.4.3 1,632 11/20/2018
4.1.4 574 11/5/2018
4.0.9 947 3/23/2018
4.0.7.1 790 3/22/2018
4.0.7 788 3/22/2018

ChangeLog
---------
4.0.9.0 Removed dependency on net4 version of Mono.Linq.Expressions
4.0.8.0 Separated Serilog.Sinks.ListOfString and Extensions.Logging.StringListLogger
4.0.7.0 Added TestBase.FakeHttpClient. Added Should(predicate,...) as synonym of ShouldHave(predicate,...)
4.0.6.2 TestBase.Mvc can run controller actions on aspnetcore using controller.WithControllerContext()
4.0.5.2 TestBase.Mvc partially ported to netstandard20 / AspNetCore
4.0.4.1 StreamShoulds
4.0.3.0 StringListLogger as MS Logger and as Serilogger
4.0.1.0 Port to NetCore
3.0.3.0 Improves FakeDb setup
3.0.x.0 adds and/or corrects missing Shoulds()
2.0.5.0 adds some intellisense and FakeDbConnection.Verify(..., message,args) overload