Added documentation summary on action test builder

Author: ivaylokenov

src/MyTested.Mvc/Builders/Actions/ShouldHave/ShouldHaveViewBag.cs

@@ -34,9 +34,9 @@ public IAndTestBuilder<TActionResult> ViewBag(int? withNumberOfEntries = null)
         }
 
         /// <inheritdoc />
-        public IAndTestBuilder<TActionResult> ViewBag(Action<IViewBagTestBuilder> viewDataTestBuilder)
+        public IAndTestBuilder<TActionResult> ViewBag(Action<IViewBagTestBuilder> viewBagTestBuilder)
         {
-            viewDataTestBuilder(new ViewBagTestBuilder(this.TestContext));
+            viewBagTestBuilder(new ViewBagTestBuilder(this.TestContext));
             return this.NewAndTestBuilder();
         }
     }

src/MyTested.Mvc/Builders/Contracts/Actions/IActionResultTestBuilder.cs

@@ -3,27 +3,27 @@
     using Base;
 
     /// <summary>
-    /// Used for building the action result which will be tested.
+    /// Used for testing the action and its result.
     /// </summary>
     /// <typeparam name="TActionResult">Type of action result to be tested.</typeparam>
     public interface IActionResultTestBuilder<TActionResult> : IBaseTestBuilderWithActionResult<TActionResult>
     {
         /// <summary>
-        /// Used for testing action attributes and model state.
+        /// Used for testing the action's additional data - action attributes, HTTP response, view bag and more.
         /// </summary>
-        /// <returns>Should have test builder.</returns>
+        /// <returns>Test builder of <see cref="IShouldHaveTestBuilder{TActionResult}"/> type.</returns>
         IShouldHaveTestBuilder<TActionResult> ShouldHave();
 
         /// <summary>
-        /// Used for testing whether action throws exception.
+        /// Used for testing whether the action throws exception.
         /// </summary>
-        /// <returns>Should throw test builder.</returns>
+        /// <returns>Test builder of <see cref="IShouldThrowTestBuilder"/>.</returns>
         IShouldThrowTestBuilder ShouldThrow();
 
         /// <summary>
         /// Used for testing returned action result.
         /// </summary>
-        /// <returns>Should return test builder.</returns>
+        /// <returns>Test builder of <see cref="IShouldReturnTestBuilder<TActionResult>"/>.</returns>
         IShouldReturnTestBuilder<TActionResult> ShouldReturn();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Actions/IShouldHaveTestBuilder.cs

@@ -9,85 +9,163 @@
     using Models;
 
     /// <summary>
-    /// Used for testing action attributes and model state.
+    /// Used for testing the action's additional data - action attributes, HTTP response, view bag and more.
     /// </summary>
     /// <typeparam name="TActionResult">Result from invoked action in ASP.NET Core MVC controller.</typeparam>
     public interface IShouldHaveTestBuilder<TActionResult> : IBaseTestBuilderWithActionResult<TActionResult>
     {
         /// <summary>
-        /// Checks whether the tested action has no attributes of any type. 
+        /// Tests whether the action has no attributes of any type. 
         /// </summary>
-        /// <returns>Test builder with AndAlso method.</returns>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> NoActionAttributes();
 
         /// <summary>
-        /// Checks whether the tested action has at least 1 attribute of any type. 
+        /// Tests whether the action has at least 1 attribute of any type. 
         /// </summary>
         /// <param name="withTotalNumberOf">Optional parameter specifying the exact total number of attributes on the tested action.</param>
-        /// <returns>Test builder with AndAlso method.</returns>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> ActionAttributes(int? withTotalNumberOf = null);
 
         /// <summary>
-        /// Checks whether the tested action has at specific attributes. 
+        /// Tests whether the action has specific attributes. 
         /// </summary>
         /// <param name="attributesTestBuilder">Builder for testing specific attributes on the action.</param>
-        /// <returns>Test builder with AndAlso method.</returns>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> ActionAttributes(Action<IActionAttributesTestBuilder> attributesTestBuilder);
 
         /// <summary>
-        /// Provides way to continue test case with specific model state errors.
+        /// Tests whether the action has specific <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> errors.
         /// </summary>
         /// <typeparam name="TRequestModel">Request model type to be tested for errors.</typeparam>
-        /// <returns>Test builder with AndAlso method.</returns>
+        /// <param name="modelErrorTestBuilder">Builder for testing specific <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>
+        /// errors for the provided model type.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> ModelStateFor<TRequestModel>(Action<IModelErrorTestBuilder<TRequestModel>> modelErrorTestBuilder);
 
         /// <summary>
-        /// Checks whether the tested action's provided model state is valid.
+        /// Tests whether the action has valid <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> with no errors.
         /// </summary>
-        /// <returns>Test builder with AndAlso method.</returns>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> ValidModelState();
 
         /// <summary>
-        /// Checks whether the tested action's provided model state is not valid.
+        /// Tests whether the action has invalid <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
         /// </summary>
-        /// <param name="withNumberOfErrors">Expected number of errors. If default null is provided, the test builder checks only if any errors are found.</param>
-        /// <returns>Test builder with AndAlso method.</returns>
+        /// <param name="withNumberOfErrors">Expected number of <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> errors.
+        /// If default null is provided, the test builder checks only if any errors are found.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> InvalidModelState(int? withNumberOfErrors = null);
-        
+
+        /// <summary>
+        /// Tests whether the action sets entries in the <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
+        /// </summary>
+        /// <param name="withNumberOfEntries">Expected number of <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/> entries.
+        /// If default null is provided, the test builder checks only if any entries are found.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> MemoryCache(int? withNumberOfEntries = null);
 
+        /// <summary>
+        /// Tests whether the action sets specific <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> entries.
+        /// </summary>
+        /// <param name="memoryCacheTestBuilder">Builder for testing specific <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> entries.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> MemoryCache(Action<IMemoryCacheTestBuilder> memoryCacheTestBuilder);
 
+        /// <summary>
+        /// Tests whether the action does not set any <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> entries.
+        /// </summary>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> NoMemoryCache();
 
+        /// <summary>
+        /// Tests whether the action sets entries in the <see cref="Microsoft.AspNetCore.Http.Features.ISession"/>.
+        /// </summary>
+        /// <param name="withNumberOfEntries">Expected number of <see cref="Microsoft.AspNetCore.Http.Features.ISession"/> entries.
+        /// If default null is provided, the test builder checks only if any entries are found.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> Session(int? withNumberOfEntries = null);
 
+        /// <summary>
+        /// Tests whether the action sets specific <see cref="Microsoft.AspNetCore.Http.Features.ISession"/> entries.
+        /// </summary>
+        /// <param name="sessionTestBuilder">Builder for testing specific <see cref="Microsoft.AspNetCore.Http.Features.ISession"/> entries.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> Session(Action<ISessionTestBuilder> sessionTestBuilder);
 
+        /// <summary>
+        /// Tests whether the action does not set any <see cref="Microsoft.AspNetCore.Http.Features.ISession"/> entries.
+        /// </summary>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> NoSession();
 
+        /// <summary>
+        /// Tests whether the action sets entries in the <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ITempDataDictionary"/>.
+        /// </summary>
+        /// <param name="withNumberOfEntries">Expected number of <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ITempDataDictionary"/> entries.
+        /// If default null is provided, the test builder checks only if any entries are found.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> TempData(int? withNumberOfEntries = null);
 
+        /// <summary>
+        /// Tests whether the action sets specific entries in the <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ITempDataDictionary"/>.
+        /// </summary>
+        /// <param name="tempDataTestBuilder">Builder for testing specific <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ITempDataDictionary"/> entries.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> TempData(Action<ITempDataTestBuilder> tempDataTestBuilder);
 
+        /// <summary>
+        /// Tests whether the action does not set any <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ITempDataDictionary"/> entries.
+        /// </summary>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> NoTempData();
-        
+
+        /// <summary>
+        /// Tests whether the action sets entries in the <see cref="Microsoft.AspNetCore.Mvc.Controller.ViewBag"/>.
+        /// </summary>
+        /// <param name="withNumberOfEntries">Expected number of <see cref="Microsoft.AspNetCore.Mvc.Controller.ViewBag"/> entries.
+        /// If default null is provided, the test builder checks only if any entries are found.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> ViewBag(int? withNumberOfEntries = null);
 
-        IAndTestBuilder<TActionResult> ViewBag(Action<IViewBagTestBuilder> viewDataTestBuilder);
+        /// <summary>
+        /// Tests whether the action sets specific entries in the <see cref="Microsoft.AspNetCore.Mvc.Controller.ViewBag"/>.
+        /// </summary>
+        /// <param name="viewBagTestBuilder">Builder for testing specific <see cref="Microsoft.AspNetCore.Mvc.Controller.ViewBag"/> entries.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
+        IAndTestBuilder<TActionResult> ViewBag(Action<IViewBagTestBuilder> viewBagTestBuilder);
 
+        /// <summary>
+        /// Tests whether the action does not set any <see cref="Microsoft.AspNetCore.Mvc.Controller.ViewBag"/> entries.
+        /// </summary>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> NoViewBag();
 
+        /// <summary>
+        /// Tests whether the action sets entries in the <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary"/>.
+        /// </summary>
+        /// <param name="withNumberOfEntries">Expected number of <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary"/> entries.
+        /// If default null is provided, the test builder checks only if any entries are found.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> ViewData(int? withNumberOfEntries = null);
 
+        /// <summary>
+        /// Tests whether the action sets specific entries in the <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary"/>.
+        /// </summary>
+        /// <param name="viewBagTestBuilder">Builder for testing specific <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary"/> entries.</param>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> ViewData(Action<IViewDataTestBuilder> viewDataTestBuilder);
 
+        /// <summary>
+        /// Tests whether the action does not set any <see cref="Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary"/> entries.
+        /// </summary>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> NoViewData();
 
         /// <summary>
-        /// Checks whether the tested action applies additional features to the HTTP response.
+        /// Tests whether the action applies additional features to the HTTP response.
         /// </summary>
-        /// <returns>Test builder with AndAlso method.</returns>
+        /// <returns>Test builder of <see cref="IAndTestBuilder<TActionResult>"/> type.</returns>
         IAndTestBuilder<TActionResult> HttpResponse(Action<IHttpResponseTestBuilder> httpResponseTestBuilder);
     }
 }