Merge pull request #231 from ivaylokenov/development

Moved documentation into master branch

Author: ivaylokenov

MyTested.AspNetCore.Mvc.sln

@@ -7,13 +7,33 @@ MyTested.AspNetCore.Mvc is a unit testing library (currently in preview version)
 
 ## Getting started
 
-It is strongly advised to start with the [tutorial](http://docs.mytestedasp.net/tutorial/intro.html) (coming soon) in order to get familiar with MyTested.AspNetCore.Mvc. Additionally, you may see the [testing guide](http://docs.mytestedasp.net/guide/intro.html) (coming soon) or the [API reference](http://docs.mytestedasp.net/api/index.html) for full list of available features. MyTested.AspNetCore.Mvc is 100% covered by [more than 1500 unit tests](https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/tree/master/test/) and should work correctly. Almost all items in the [issues page](https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/issues) are expected future features and enhancements.
+It is strongly advised to start with the [tutorial](http://docs.mytestedasp.net/tutorial/intro.html) (coming soon) in order to get familiar with MyTested.AspNetCore.Mvc. Additionally, you may see the [testing guide](http://docs.mytestedasp.net/guide/intro.html) (coming soon) or the [API reference](http://docs.mytestedasp.net/api/index.html) for full list of available features. MyTested.AspNetCore.Mvc is 100% covered by [more than 1800 unit tests](https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/tree/master/test/) and should work correctly. Almost all items in the [issues page](https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/issues) are expected future features and enhancements.
 
 ## Installation
 
 You can install this library using NuGet into your test project (or reference it directly in your `project.json` file). Currently MyTested.AspNetCore.Mvc works with ASP.NET Core MVC 1.0.0.
 
-    Install-Package MyTested.AspNetCore.Mvc -Pre
+    Install-Package MyTested.AspNetCore.Mvc.Universe
+
+This package will include all available assertion methods in your test project, including ones for authentication, database, session, caching and more. If you want only the MVC related features, install `MyTested.AspNetCore.Mvc`. Additionally, if you prefer, you can be more specific by including only some of the packages:
+
+ - `MyTested.AspNetCore.Mvc.Controllers` - contains setup and assertion methods for controllers
+ - `MyTested.AspNetCore.Mvc.Routing` - contains setup and assertion methods for routes
+ - `MyTested.AspNetCore.Mvc.Core` - contains setup and assertion methods for MVC core features
+ - `MyTested.AspNetCore.Mvc.TempData` - contains setup and assertion methods for `ITempDataDictionary`
+ - `MyTested.AspNetCore.Mvc.ViewData` - contains assertion methods for `ViewDataDictionary` and dynamic `ViewBag`
+ - `MyTested.AspNetCore.Mvc.ViewActionResults` - contains setup and assertion methods for view action results
+ - `MyTested.AspNetCore.Mvc.ViewComponents` - contains setup and assertion methods for view components
+ - `MyTested.AspNetCore.Mvc.ViewFeatures` - contains setup and assertion methods for MVC view features
+ - `MyTested.AspNetCore.Mvc.Http` - contains setup and assertion methods for HTTP context, request and response
+ - `MyTested.AspNetCore.Mvc.Authentication` - contains setup methods for `ClaimsPrincipal`
+ - `MyTested.AspNetCore.Mvc.ModelState` - contains setup and assertion methods for `ModelStateDictionary` validations
+ - `MyTested.AspNetCore.Mvc.DataAnnotations` - contains setup and assertion methods for data annotation validations
+ - `MyTested.AspNetCore.Mvc.EntityFrameworkCore` - contains setup and assertion methods for `DbContext`
+ - `MyTested.AspNetCore.Mvc.DependencyInjection` - contains setup methods for dependency injection services
+ - `MyTested.AspNetCore.Mvc.Caching` - contains setup and assertion methods for `IMemoryCache`
+ - `MyTested.AspNetCore.Mvc.Session` - contains setup and assertion methods for `ISession`
+ - `MyTested.AspNetCore.Mvc.Options` - contains setup and assertion methods for `IOptions`
 
 After the downloading is complete, just add `using MyTested.AspNetCore.Mvc;` to your source code and you are ready to test in the most elegant and developer friendly way.
 
@@ -32,7 +52,7 @@ Make sure to check out the [tutorial](http://docs.mytestedasp.net/tutorial/intro
 
 You can also check out the [provided samples](https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/tree/master/samples) for real-life ASP.NET Core MVC application testing.
 
-First we need to create a `TestStartup` class in the root of the test project in order to register the dependency injection services. The easiest way is to inherit from the web project's `Startup` class and replace some of the services with mocked ones by using the provided extension methods.
+The easiest way to start with MyTested.AspNetCore.Mvc is to create a `TestStartup` class at the root of the test project in order to register the dependency injection services which will be used by all test cases in the assembly. A fast solution is to inherit from the web project's `Startup` class and replace some of the services with mocked ones by using the provided extension methods.
 
 ```c#
 namespace MyApp.Tests
@@ -78,8 +98,7 @@ namespace MyApp.Tests.Controllers
 }
 ```
 
-The example uses [xUnit](http://xunit.github.io/) but you can use whatever testing framework you want.
-Basically, MyTested.AspNetCore.Mvc throws an unhandled exception with a friendly error message if the assertion does not pass and the test fails.
+Basically, MyTested.AspNetCore.Mvc throws an unhandled exception with a friendly error message if the assertion does not pass and the test fails. The example uses [xUnit](http://xunit.github.io/) but you can use any other framework you like. See the [samples](https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/tree/master/samples) for other types of test runners and `Startup` class configurations.
 
 ## Examples
 
@@ -88,7 +107,7 @@ Here are some random examples of what the fluent testing API is capable of:
 ```c#
 // tests a route for correct controller, action and resolved route values
 MyMvc
-	.Routes()
+	.Routing()
 	.ShouldMap(request => request
 		.WithLocation("/My/Action/1")
 		.WithMethod(HttpMethod.Post)
@@ -151,7 +170,9 @@ MyMvc
 	.MemoryCache(cache => cache
 		.ContainingEntry(entry => entry
 			.WithKey("CacheEntry")
-			.WithSlidingExpiration(TimeSpan.FromMinutes(10))))
+			.WithSlidingExpiration(TimeSpan.FromMinutes(10))
+			.WithValueOfType<CachedModel>()
+			.Passing(a => a.Id == 1)))
 	.AndAlso()
 	.ShouldReturn()
 	.View()
@@ -169,7 +190,8 @@ MyMvc
 		.ChangingActionNameTo("AnotherAction"));
 
 // tests whether model state error exists by using lambda expression
-// and specific tests for the error messages
+// and with specific tests for the error messages
+// and tests whether the action return view with the same request model
 MyMvc
 	.Controller<MvcController>()
 	.Calling(c => c.MyAction(requestWithErrors))
@@ -178,7 +200,10 @@ MyMvc
 		.ContainingNoErrorFor(m => m.NonRequiredProperty)
 		.AndAlso()
 		.ContainingErrorFor(m => m.RequiredProperty)
-		.ThatEquals("The RequiredProperty field is required."));
+		.ThatEquals("The RequiredProperty field is required."))
+	.AndAlso()
+	.ShouldReturn()
+	.View(requestWithErrors);
 
 // tests whether the action throws
 // with exception of certain type and with certain message

README.md

@@ -0,0 +1,12 @@
+
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+.
+../src
+../test

docs/_docfx/.gitignore

@@ -0,0 +1,5 @@
+
+###############
+#  temp file  #
+###############
+*.yml

docs/_docfx/api/.gitignore

@@ -0,0 +1,29 @@
+# Welcome to the API Reference
+
+Here you will find [My Tested ASP.NET Core MVC](https://mytestedasp.net/Core/Mvc) API reference containing detailed information on all publicly available assertion methods and classes.
+
+<strong class="article-contents">Test case starting points</strong>
+
+- [MyMvc](/api/MyTested.AspNetCore.Mvc.MyMvc.html) - contains all available starting points
+- [MyApplication](/api/MyTested.AspNetCore.Mvc.MyApplication.html) - specifies the test application
+- [MyController](/api/MyTested.AspNetCore.Mvc.MyController-1.html) - specifies controller test case
+- [MyViewComponent](/api/MyTested.AspNetCore.Mvc.MyViewComponent-1.html) - specifies view component test case
+- [MyRouting](/api/MyTested.AspNetCore.Mvc.MyRouting.html) - specifies route test case
+
+<strong class="article-contents">Commonly used test builders</strong>
+
+- [IControllerBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.Controllers.IControllerBuilder-1.html) - controller test builder
+- [IViewComponentBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.ViewComponents.IViewComponentBuilder-1.html) - view component test builder
+- [IRouteTestBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.Routes.IRouteTestBuilder.html) - route test builder
+- [IApplicationConfigurationBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.Application.IApplicationConfigurationBuilder.html) - application configuration builder
+
+<strong class="article-contents">Helper classes</strong>
+
+- [From](/api/MyTested.AspNetCore.Mvc.From.html) - helps with resolving values in lambda expressions
+- [With](/api/MyTested.AspNetCore.Mvc.With.html) - helps with null, default and ignored values
+- [AuthenticationScheme](/api/MyTested.AspNetCore.Mvc.AuthenticationScheme.html) - contains common authentication schemes
+- [ContentType](/api/MyTested.AspNetCore.Mvc.ContentType.html) - contains common content type header values
+- [HttpHeader](/api/MyTested.AspNetCore.Mvc.HttpHeader.html) - contains common HTTP header names
+- [HttpMethod](/api/MyTested.AspNetCore.Mvc.HttpMethod.html) - contains common HTTP methods
+- [HttpScheme](/api/MyTested.AspNetCore.Mvc.HttpScheme.html) - contains common HTTP schemes
+- [HttpStatusCode](/api/MyTested.AspNetCore.Mvc.HttpStatusCode.html) - contains common HTTP status codes

docs/_docfx/api/.manifest

@@ -0,0 +1,31 @@
+function transform(model, _attrs){
+  var vm = {};
+  // Copy default _attrs and override name/id
+  for (var key in _attrs) {
+    if (_attrs.hasOwnProperty(key)) {
+      vm[key] = _attrs[key];
+    }
+  }
+  // Copy model
+  for (var key in model) {
+    if (model.hasOwnProperty(key)) {
+      vm[key] = model[key];
+    }
+  }
+  // If toc is not defined in model, read it from _attrs
+  if (vm._tocPath && vm._tocPath.indexOf("~/") == 0) {
+    vm._tocPath = vm._tocPath.substring(2);
+  }
+  if (vm._navPath === vm._tocPath){
+    vm._allowToc = false;
+  }else{
+    vm._allowToc = true;
+  }
+  if (!vm.hasOwnProperty("_allowAffix")) {
+    vm._allowAffix = true;
+  } else {
+    // parse from string to bool
+    vm._allowAffix = vm._allowAffix === "true"
+  }
+  return vm;
+}

docs/_docfx/api/index.md

@@ -0,0 +1,19 @@
+{{!include(/^styles/.*/)}}
+{{!include(/^fonts/.*/)}}
+{{!include(favicon.ico)}}
+{{!include(logo.svg)}}
+<!DOCTYPE html>
+<!--[if IE]><![endif]-->
+<html>
+  {{>partials/head}}
+  <body data-spy="scroll" data-target="#affix">
+    <div id="wrapper">
+      <header>
+        {{>partials/navbar}}
+      </header>
+      {{{conceptual}}}
+      {{>partials/footer}}
+    </div>
+    {{>partials/scripts}}
+  </body>
+</html>

docs/_docfx/custom/favicon.ico

@@ -0,0 +1,11 @@
+<footer>
+  <div class="grad-bottom"></div>
+  <div class="footer">
+    <div class="container">
+      <span class="pull-right">
+        <a href="#top">Back to top</a>
+      </span>
+      <span>Copyright © 2015-2016 <strong><a href="http://mytestedasp.net">MyTestedASP.NET</a></strong>. All Rights Reserved. Generated by <strong><a href="http://dotnet.github.io/docfx/">DocFX</a></strong></span>
+    </div>
+  </div>
+</footer>