TestBase 6.0.0.1-preview-1

.NET 6.0 .NET Standard 1.6 .NET Framework 4.5

This is a prerelease version of TestBase.

dotnet add package TestBase --version 6.0.0.1-preview-1

NuGet\Install-Package TestBase -Version 6.0.0.1-preview-1

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" Version="6.0.0.1-preview-1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add TestBase --version 6.0.0.1-preview-1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: TestBase, 6.0.0.1-preview-1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install TestBase as a Cake Addin
#addin nuget:?package=TestBase&version=6.0.0.1-preview-1&prerelease

// Install TestBase as a Cake Tool
#tool nuget:?package=TestBase&version=6.0.0.1-preview-1&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

TestBase gives you a flying start with

fluent assertions that are very easy to extend
Object and Collection comparers
Sharper error messages showing detailed Actual and Asserted
tools to help you test with “heavyweight” dependencies on
- AspNetCore.Mvc, AspNet.Mvc or WebApi Contexts
- HttpClient
- Ado.Net
- Streams & Logging
Mix & match with your favourite test runners & assertions.

UnitUnderTest.Action()
  .ShouldNotBeNull()
  .ShouldEqualByValueExceptFor(new {Id=1, Descr=expected}, ignoreList )
  .Payload
    .ShouldMatchIgnoringCase("I expected this")
    .Should(someOtherPredicate);
  .Items
    .ShouldAll(predicate)
    .ShouldContain(item)
    .ShouldNotContain(predicate)
    .Where(predicate)
    .SingleOrAssertFail()

# works with all kinds of object and collections, and report what differed.
objectOrCollection
 .ShouldEqualByValue().ShouldEqualByValueExceptFor(...).ShouldEqualByValueOnMembers() 
string
 .ShouldMatch(pattern).ShouldNotMatch().ShouldBeEmpty().ShouldNotBeEmpty()
 .ShouldNotBeNullOrEmptyOrWhiteSpace().ShouldEqualIgnoringCase()
 .ShouldContain().ShouldStartWith().ShouldEndWith().ShouldBeContainedIn(), ...
numeric
 .ShouldBeBetween().ShouldEqualWithTolerance()....GreaterThan....LessThan...GreaterOrEqualTo ...
ienumerable
 .ShouldAll().ShouldContain().ShouldNotContain().ShouldBeEmpty().ShouldNotBeEmpty() ...
stream
 .ShouldHaveSameStreamContentAs().ShouldContain()
value
 .ShouldBe().ShouldNotBe().ShouldBeOfType().ShouldBeAssignableTo()...

TestBase.HttpClient.Fake

new FakeHttpClient()
      .Setup(x=>x.RequestUri.PathAndQuery.StartsWith("/this"))
        .Returns(response)
      .Setup(x=>x.Method==HttpMethod.Put)
        .Returns(new HttpResponseMessage(HttpStatusCode.Accepted));

TestBase.AdoNet

FakeDbConnection

- db.SetupForQuery(…)
- db.SetupForExecuteNonQuery(…)
- db.ShouldHaveUpdated("tableName", …)
- db.ShouldHaveSelected("tableName", …)
- db.ShouldHaveDeleted("tableName", …)
- db.Verify( x=>x.CommandText.Matches("Insert [case] .*") 
             && x.Parameters["id"].Value==1 )
- db
    .ShouldHaveInvoked(cmd => predicate(cmd))
    .ShouldHaveParameter("name", value)

RecordingDbConnection

TestBase.Mvc.AspNetCore & TestBase.Mvc for Mvc 4 & Mvc 5

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

ShouldHaveViewDataContaining(), ShouldBeJsonResult() etc.

Test AspNetCore controllers with zero setup using controllerUnderTest.WithControllerContext(actionUnderTest)
Test more complex AspNetCore controller/application dependencies using HostedMvcTestFixtureBase and specify your MVCApplications Startup class.

[TestCase("/dummy")]
public async Task Put_Should_ReturnA(string url)
{
    var httpClient=GivenClientForRunningServer<Startup>();
    GivenRequestHeaders(httpClient, "CustomHeader", "HeaderValue1");

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

    result.ShouldBe_202Accepted();
}

For Mvc4 and Mvc 5, fake your http request & context, and use the RegisterRoutes method of your actual application to set up Controller.Url

ControllerUnderTest
  .WithHttpContextAndRoutes(
    RouteConfig.RegisterRoutes, 
    "/incomingurl"
  );

ApiControllerUnderTest.WithWebApiHttpContext<T>(
    httpMethod, 
    requestUri,
    routeTemplate)

Testable Logging

// Extensions.Logging.ListOfString
var log = new List<String>();
ILogger mslogger= new LoggerFactory().AddStringListLogger(log).CreateLogger("Test2");

// Serilog.Sinks.ListOfString
Serilog.Logger slogger= new LoggerConfiguration().WriteTo.StringList(log).CreateLogger();

### Release Notes

6.0.0   Better Assertion output for core asserts includes ActualValue,ActualExpression,Asserted,AssertedDetail

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard1.6 is compatible. netstandard2.0 was computed. netstandard2.1 was computed.
.NET Framework	net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen30 was computed. tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETFramework 4.5
- ExpressionToCodeLib (>= 2.7.0)
- FastExpressionCompiler (>= 2.0.0)
- Newtonsoft.Json (>= 13.0.3)
- System.ValueTuple (>= 4.5.0)
.NETStandard 1.6
- ExpressionToCodeLib (>= 2.7.0)
- FastExpressionCompiler (>= 2.0.0)
- NETStandard.Library (>= 1.6.1)
- Newtonsoft.Json (>= 13.0.3)
- System.ComponentModel.Annotations (>= 4.4.1)
- System.ValueTuple (>= 4.5.0)
net6.0
- ExpressionToCodeLib (>= 2.7.0)
- FastExpressionCompiler (>= 2.0.0)
- Newtonsoft.Json (>= 13.0.3)
- TooString (>= 0.1.0)

NuGet packages (4)

Showing the top 4 NuGet packages that depend on TestBase:

Package	Downloads
TestBase-Mvc TestBase gets you off to a flying start when unit testing projects with dependencies. TestBase-Mvc adds a rich extensible set of fluent assertions for verifying Mvc ActionResults and for easy setup of ControllerContext and HttpContext for both Mvc and WebApi TestBase.Shoulds ------------------- Chainable fluent assertions get you to the point concisely ControllerUnderTest.Action() .ShouldbeViewResult() .ShouldHaveModel<TModel>() .ShouldEqualByValue(expected) ControllerUnderTest.Action() .ShouldBeRedirectToRouteResult() .ShouldHaveRouteValue("expectedKey", [Optional] "expectedValue"); ShouldHaveViewDataContaining(), ShouldBeJsonResult() etc. TestBase ---------- Controller extensions 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<RouteCollection> mvcApplicationRoutesRegistration, [optional] string requestUrl, [Optional] string query = "", [Optional] string appVirtualPath = "/", [Optional] HttpApplication applicationInstance) ApiControllerUnderTest.WithWebApiHttpContext<T>( HttpMethod httpMethod, [Optional] string requestUri, [Optional] string routeTemplate)	74.2K
TestBase.AdoNet TestBase.AdoNet TestBase.FakeDb ------------------ Fake and verify AdoNet queries and commands ``` - 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.ShouldHaveExecutedStoredProcedure("name") - fakeDbConnection.ShouldHaveXXX().ShouldHaveParameter("name", value) - fakeDbConnection.Verify(x=>x.CommandText.Matches("Insert [case] .") && x.Parameters["id"].Value==1) ``` TestBase.RecordingDb -------------------- `new RecordingDbConnection(IDbConnection)` helps you profile Ado.Net Db calls See also - TestBase - TestBase.Mvc - TestBase.AdoNet - Serilog.Sinks.ListOfString - Extensions.Logging.ListOfString	17.8K
TestBase.Mvc.AspNetCore TestBase gives you a flying start with - fluent assertions that are easy to extend - sharp error messages - tools to help you test with “heavyweight” dependencies on - AspNetCore.Mvc, AspNet.Mvc or WebApi Contexts - HttpClient - Ado.Net - Streams & Logging Chainable fluent assertions get you to the point concisely: ``` ControllerUnderTest.Action() .ShouldbeViewResult() .ShouldHaveModel<TModel>() .ShouldEqualByValue(expected, exceptForTheseFields); .Reference .ShouldMatchIgnoringCase("I expected this"); ControllerUnderTest.Action() .ShouldBeRedirectToRouteResult() .ShouldHaveRouteValue(""expectedKey"", [Optional] ""expectedValue""); ShouldHaveViewDataContaining(), ShouldBeJsonResult() etc. ``` Quickly test AspNetCore controllers with zero setup using `controllerUnderTest.WithControllerContext()` : ``` [TestFixture] public class WhenTestingControllersUsingFakeControllerContext { [Test] public void ControllerUrlAndOtherPropertiesShouldWorkAsExpected__GivenControllerContext() { var uut = new FakeController().WithControllerContext(); uut.Url.Action(""a"", ""b"").ShouldEqual(""/b/a""); uut.ControllerContext.ShouldNotBeNull(); uut.HttpContext.ShouldBe(uut.ControllerContext.HttpContext); uut.Request.ShouldNotBeNull(); uut.ViewData.ShouldNotBeNull(); uut.TempData.ShouldNotBeNull(); uut.MyAction(param) .ShouldBeViewResult() .ShouldHaveModel<YouSaidViewModel>() .YouSaid.ShouldBe(param); } [Test] public void ShouldBeAbleToUseServicesConfiguredInStartupInTests() { var moreServicesFromDI=TestServerBuilder.RunningServerUsingStartup<TStartup>().Host.ServiceProvider; var controllerUnderTest = new AController() .WithControllerContext(virtualPathTemplate:""/{Action}/Before/{Controller}""); var result= controllerUnderTest .Action(""SomeController"",""SomeAction"") .ShouldBeViewWithModel<AClass>(""ViewName""); .FooterLink .ShouldBe(""/SomeAction/Before/SomeController""); } } ``` ... Or test against complex application dependencies using `HostedMvcTestFixtureBase` and specify your `Startup` class: ``` [TestFixture] public class WhenTestingControllersUsingAspNetCoreTestTestServer : HostedMvcTestFixtureBase { [TestCase(""/dummy/action?id={id}"")] public async Task Get_Should_ReturnActionResult(string url) { var id=Guid.NewGuid(); var httpClient=GivenClientForRunningServer<Startup>(); GivenRequestHeaders(httpClient, ""CustomHeader"", ""HeaderValue1""); var result= await httpClient.GetAsync(url.Formatz(new {id})); 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 ); } } ``` See also - TestBase - TestBase.Mvc for Mvc4 and Mvc 5 - TestBase.HttpClient.Fake - TestBase.AdoNet - Serilog.Sinks.ListOfString - Extensions.Logging.ListOfString	14.4K
TestBase.AspNetCore.Mvc TestBase gives you a flying start with - fluent assertions that are easy to extend - sharp error messages - tools to help you test with “heavyweight” dependencies on - AspNetCore.Mvc, AspNet.Mvc or WebApi Contexts - HttpClient - Ado.Net - Streams & Logging Chainable fluent assertions get you to the point concisely: ``` ControllerUnderTest.Action() .ShouldbeViewResult() .ShouldHaveModel<TModel>() .ShouldEqualByValue(expected, exceptForTheseFields); .Reference .ShouldMatchIgnoringCase("I expected this"); ControllerUnderTest.Action() .ShouldBeRedirectToRouteResult() .ShouldHaveRouteValue(""expectedKey"", [Optional] ""expectedValue""); ShouldHaveViewDataContaining(), ShouldBeJsonResult() etc. ``` Quickly test AspNetCore controllers with zero setup using `controllerUnderTest.WithControllerContext()` : ``` [TestFixture] public class WhenTestingControllersUsingFakeControllerContext { [Test] public void ControllerUrlAndOtherPropertiesShouldWorkAsExpected__GivenControllerContext() { var uut = new FakeController().WithControllerContext(); uut.Url.Action(""a"", ""b"").ShouldEqual(""/b/a""); uut.ControllerContext.ShouldNotBeNull(); uut.HttpContext.ShouldBe(uut.ControllerContext.HttpContext); uut.Request.ShouldNotBeNull(); uut.ViewData.ShouldNotBeNull(); uut.TempData.ShouldNotBeNull(); uut.MyAction(param) .ShouldBeViewResult() .ShouldHaveModel<YouSaidViewModel>() .YouSaid.ShouldBe(param); } [Test] public void ShouldBeAbleToUseServicesConfiguredInStartupInTests() { var moreServicesFromDI=TestServerBuilder.RunningServerUsingStartup<TStartup>().Host.ServiceProvider; var controllerUnderTest = new AController() .WithControllerContext(virtualPathTemplate:""/{Action}/Before/{Controller}""); var result= controllerUnderTest .Action(""SomeController"",""SomeAction"") .ShouldBeViewWithModel<AClass>(""ViewName""); .FooterLink .ShouldBe(""/SomeAction/Before/SomeController""); } } ``` ... Or test against complex application dependencies using `HostedMvcTestFixtureBase` and specify your `Startup` class: ``` [TestFixture] public class WhenTestingControllersUsingAspNetCoreTestTestServer : HostedMvcTestFixtureBase { [TestCase(""/dummy/action?id={id}"")] public async Task Get_Should_ReturnActionResult(string url) { var id=Guid.NewGuid(); var httpClient=GivenClientForRunningServer<Startup>(); GivenRequestHeaders(httpClient, ""CustomHeader"", ""HeaderValue1""); var result= await httpClient.GetAsync(url.Formatz(new {id})); 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 ); } } ``` See also - TestBase - TestBase.Mvc for Mvc4 and Mvc 5 - TestBase.HttpClient.Fake - TestBase.AdoNet - Serilog.Sinks.ListOfString - Extensions.Logging.ListOfString	3.7K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
6.0.0.1-preview-1	46	7/11/2024
4.1.4.4	11,615	7/11/2020
4.1.4.3	11,198	11/20/2018
4.1.4.1	6,918	11/16/2018
4.1.3.2	5,230	10/28/2018
4.1.3.1	5,061	10/26/2018
4.1.2.7	5,192	10/24/2018
4.1.2.4	5,538	10/16/2018
4.1.2.3	9,311	5/22/2018
4.1.2.2	5,408	5/22/2018
4.1.2.1	6,618	5/22/2018
4.1.2	8,195	5/19/2018
4.1.1	5,455	4/8/2018
4.1.0	5,502	4/3/2018
4.0.9.2	5,529	3/31/2018
4.0.9.1	6,240	3/28/2018
4.0.9	6,914	3/23/2018
4.0.8	5,362	3/23/2018
4.0.7	6,634	3/22/2018
4.0.6.2	6,971	3/9/2018
4.0.6.1	6,495	3/7/2018
4.0.5.2	6,640	3/2/2018
4.0.5	6,505	3/1/2018
4.0.4.2	5,249	3/1/2018
4.0.4	5,556	2/25/2018
4.0.3	5,583	2/25/2018
4.0.2	5,237	2/24/2018
4.0.1	5,626	2/24/2018
3.1.0	6,231	7/24/2016
3.0.8.5	5,974	7/23/2016
3.0.8.3	6,024	4/14/2016
3.0.8.2	6,109	3/31/2016
3.0.8.1	6,055	3/30/2016
3.0.8	5,994	3/29/2016
3.0.7.6	6,026	3/14/2016
3.0.7.5	6,026	3/10/2016
3.0.7.4	6,081	2/11/2016
3.0.7.3	6,062	1/29/2016
3.0.6.2	6,249	1/27/2016
3.0.6.1	6,079	1/26/2016
3.0.5	6,540	1/15/2016
3.0.4	6,141	1/13/2016
3.0.3	6,060	12/28/2015
3.0.2	8,457	12/27/2013
3.0.1.1	6,083	12/23/2013
3.0.1	6,294	11/28/2013
2.0.5	6,223	11/28/2013
2.0.4.1	6,047	11/12/2013
2.0.4	6,139	11/12/2013
2.0.3.1	6,057	11/8/2013
2.0.3	5,540	11/7/2013
2.0.2	5,451	11/7/2013
2.0.1	6,089	11/1/2013
1.0.4	5,451	10/31/2013
1.0.3	5,518	10/23/2013

ChangeLog
     ---------
     6.0.0.1 Better Assertion output for core asserts includes ActualValue,ActualExpression,Asserted,AssertedDetail
     4.2.0   TestBase-Mvc works on mono
     4.2.0   TestBase.FakeHttpClient.SetupGet() and SetupPost() overloads
     4.1.4.4 BugFix Comparer.MemberCompare() when left or right is null or FileSystemInfo
     4.1.4.3 Release for both netstandard and net45
     4.1.4.2 TestBase fix typos. TestBase.AspNetCore.Mvc added Request.SetRequestCookies()
     4.1.4.1 TestBase stepped down to netstandard 1.6
     4.1.4.0 TestBase.FakeHttpClient stepped down to netstandard 1.2
     4.1.3.1 Corrected Assertion.ToString() to show BoolWithString detail. Added ShouldEqualByValueOnMembers()
     4.1.2.7 Added item.ShouldBeOneOf / .ShouldNotBeOneOf
     4.1.2.6 Added String.ShouldContainEachOf()
     4.1.2.5 Make Extensions.Logging.ListOfString Scopes public
     4.1.2.4 TestBase.AdoNet providers VerifyFirst(), VerifyLast(), VerifySingle(). Added ToCodeString() overload
     4.1.2.1 Added TestBase.Pdf.DocumentWithLineOfText
     4.1.2.0 TestBase.Mvc.AspNetCore provides WithControllerContext()
     4.1.1.0 Should(assertion) and ShouldHave(assertion) as well as Should(predicate)
     4.1.0.0 [ExpressionToCodeLib](ExpressionToCodeLib) and [FastExpressionCompiler](FastExpressionCompiler) ftw. Awesomer, and faster, assertions.
     4.0.9.2 ShouldNotMatch(pattern)
     4.0.9.1 ShouldNotContain( item or predicate)
     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

TestBase 6.0.0.1-preview-1

TestBase.AdoNet

TestBase.Mvc.AspNetCore & TestBase.Mvc for Mvc 4 & Mvc 5

.NETFramework 4.5

.NETStandard 1.6

net6.0

NuGet packages (4)

GitHub repositories