Added documentation summary for data provider test builders

Author: ivaylokenov

src/MyTested.Mvc/Builders/Attributes/BaseAttributesTestBuilder.cs

@@ -37,7 +37,7 @@ internal ICollection<Action<IEnumerable<object>>> GetAttributeValidations()
         }
 
         /// <summary>
-        /// Checks whether the collected attributes contain the provided attribute type.
+        /// Tests whether the action attributes contain the provided attribute type.
         /// </summary>
         /// <typeparam name="TAttribute">Type of expected attribute.</typeparam>
         /// <param name="failedValidationAction">Action to execute, if the validation fails.</param>
@@ -57,7 +57,7 @@ protected void ContainingAttributeOfType<TAttribute>(Action<string, string> fail
         }
 
         /// <summary>
-        /// Checks whether the collected attributes contain RouteAttribute.
+        /// Tests whether the action attributes contain RouteAttribute.
         /// </summary>
         /// <param name="template">Expected overridden route template of the action.</param>
         /// <param name="failedValidationAction">Action to execute, if the validation fails.</param>
@@ -100,7 +100,7 @@ protected void ChangingRouteTo(
         }
 
         /// <summary>
-        /// Checks whether the collected attributes contain AuthorizeAttribute.
+        /// Tests whether the action attributes contain <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>.
         /// </summary>
         /// <param name="failedValidationAction">Action to execute, if the validation fails.</param>
         /// <param name="withAllowedRoles">Optional expected authorized roles.</param>

src/MyTested.Mvc/Builders/Contracts/Attributes/IActionAttributesTestBuilder.cs

@@ -8,49 +8,49 @@
     public interface IActionAttributesTestBuilder
     {
         /// <summary>
-        /// Checks whether the collected attributes contain the provided attribute type.
+        /// Tests whether the action attributes contain the provided attribute type.
         /// </summary>
         /// <typeparam name="TAttribute">Type of expected attribute.</typeparam>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndActionAttributesTestBuilder"/>.</returns>
         IAndActionAttributesTestBuilder ContainingAttributeOfType<TAttribute>()
             where TAttribute : Attribute;
 
         /// <summary>
-        /// Checks whether the collected attributes contain ActionNameAttribute.
+        /// Tests whether the action attributes contain <see cref="Microsoft.AspNetCore.Mvc.ActionNameAttribute"/>.
         /// </summary>
         /// <param name="actionName">Expected overridden name of the action.</param>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndActionAttributesTestBuilder"/>.</returns>
         IAndActionAttributesTestBuilder ChangingActionNameTo(string actionName);
 
         /// <summary>
-        /// Checks whether the collected attributes contain RouteAttribute.
+        /// Tests whether the action attributes contain <see cref="Microsoft.AspNetCore.Mvc.RouteAttribute"/>.
         /// </summary>
         /// <param name="template">Expected overridden route template of the action.</param>
         /// <param name="withName">Optional expected route name.</param>
         /// <param name="withOrder">Optional expected route order.</param>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndActionAttributesTestBuilder"/>.</returns>
         IAndActionAttributesTestBuilder ChangingRouteTo(
             string template,
             string withName = null,
             int? withOrder = null);
 
         /// <summary>
-        /// Checks whether the collected attributes contain AllowAnonymousAttribute.
+        /// Tests whether the action attributes contain <see cref="Microsoft.AspNetCore.Authorization.AllowAnonymousAttribute"/>.
         /// </summary>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndActionAttributesTestBuilder"/>.</returns>
         IAndActionAttributesTestBuilder AllowingAnonymousRequests();
 
         /// <summary>
-        /// Checks whether the collected attributes contain AuthorizeAttribute.
+        /// Tests whether the action attributes contain <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>.
         /// </summary>
         /// <param name="withAllowedRoles">Optional expected authorized roles.</param>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndActionAttributesTestBuilder"/>.</returns>
         IAndActionAttributesTestBuilder RestrictingForAuthorizedRequests(string withAllowedRoles = null);
 
         /// <summary>
-        /// Checks whether the collected attributes contain NonActionAttribute.
+        /// Tests whether the action attributes contain <see cref="Microsoft.AspNetCore.Mvc.NonActionAttribute"/>.
         /// </summary>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndActionAttributesTestBuilder"/>.</returns>
         IAndActionAttributesTestBuilder DisablingActionCall();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Attributes/IAndActionAttributesTestBuilder.cs

@@ -1,14 +1,14 @@
 namespace MyTested.Mvc.Builders.Contracts.Attributes
 {
     /// <summary>
-    /// Used for adding AndAlso() method to the the attribute tests.
+    /// Used for adding AndAlso() method to the action attributes tests.
     /// </summary>
     public interface IAndActionAttributesTestBuilder : IActionAttributesTestBuilder
     {
         /// <summary>
-        /// AndAlso method for better readability when chaining attribute tests.
+        /// AndAlso method for better readability when chaining action attributes tests.
         /// </summary>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IActionAttributesTestBuilder"/>.</returns>
         IActionAttributesTestBuilder AndAlso();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Attributes/IAndControllerAttributesTestBuilder.cs

@@ -1,14 +1,14 @@
 namespace MyTested.Mvc.Builders.Contracts.Attributes
 {
     /// <summary>
-    /// Used for adding AndAlso() method to the the attribute tests.
+    /// Used for adding AndAlso() method to the controller attributes tests.
     /// </summary>
     public interface IAndControllerAttributesTestBuilder : IControllerAttributesTestBuilder
     {
         /// <summary>
-        /// AndAlso method for better readability when chaining attribute tests.
+        /// AndAlso method for better readability when chaining controller attributes tests.
         /// </summary>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IControllerAttributesTestBuilder"/>.</returns>
         IControllerAttributesTestBuilder AndAlso();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Attributes/IControllerAttributesTestBuilder.cs

@@ -11,33 +11,33 @@ public interface IControllerAttributesTestBuilder
         /// Checks whether the collected attributes contain the provided attribute type.
         /// </summary>
         /// <typeparam name="TAttribute">Type of expected attribute.</typeparam>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndControllerAttributesTestBuilder"/>.</returns>
         IAndControllerAttributesTestBuilder ContainingAttributeOfType<TAttribute>()
             where TAttribute : Attribute;
 
         /// <summary>
-        /// Checks whether the collected attributes contain RouteAttribute.
+        /// Checks whether the collected attributes contain <see cref="Microsoft.AspNetCore.Mvc.RouteAttribute"/>.
         /// </summary>
         /// <param name="template">Expected overridden route template of the controller.</param>
         /// <param name="withName">Optional expected route name.</param>
         /// <param name="withOrder">Optional expected route order.</param>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndControllerAttributesTestBuilder"/>.</returns>
         IAndControllerAttributesTestBuilder ChangingRouteTo(
             string template,
             string withName = null,
             int? withOrder = null);
-        
+
         /// <summary>
-        /// Checks whether the collected attributes contain AllowAnonymousAttribute.
+        /// Checks whether the collected attributes contain <see cref="Microsoft.AspNetCore.Authorization.AllowAnonymousAttribute"/>.
         /// </summary>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndControllerAttributesTestBuilder"/>.</returns>
         IAndControllerAttributesTestBuilder AllowingAnonymousRequests();
 
         /// <summary>
-        /// Checks whether the collected attributes contain AuthorizeAttribute.
+        /// Checks whether the collected attributes contain <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>.
         /// </summary>
         /// <param name="withAllowedRoles">Optional expected authorized roles.</param>
-        /// <returns>The same attributes test builder.</returns>
+        /// <returns>The same <see cref="IAndControllerAttributesTestBuilder"/>.</returns>
         IAndControllerAttributesTestBuilder RestrictingForAuthorizedRequests(
             string withAllowedRoles = null);
     }

src/MyTested.Mvc/Builders/Contracts/Authentication/IAndAuthenticationPropertiesTestBuilder.cs

@@ -1,14 +1,14 @@
 namespace MyTested.Mvc.Builders.Contracts.Authentication
 {
     /// <summary>
-    /// Used for adding AndAlso() method to the authentication properties tests.
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/> tests.
     /// </summary>
     public interface IAndAuthenticationPropertiesTestBuilder : IAuthenticationPropertiesTestBuilder
     {
         /// <summary>
-        /// AndAlso method for better readability when testing authentication properties.
+        /// AndAlso method for better readability when testing <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/>.
         /// </summary>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAuthenticationPropertiesTestBuilder"/>.</returns>
         IAuthenticationPropertiesTestBuilder AndAlso();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Authentication/IAndClaimsIdentityBuilder.cs

@@ -1,14 +1,14 @@
 namespace MyTested.Mvc.Builders.Contracts.Authentication
 {
     /// <summary>
-    /// Used for adding AndAlso() method to the claims identity builder.
+    /// Used for adding AndAlso() method to the <see cref="System.Security.Claims.ClaimsIdentity"/> builder.
     /// </summary>
     public interface IAndClaimsIdentityBuilder : IClaimsIdentityBuilder
     {
         /// <summary>
-        /// AndAlso method for better readability when building claims identity.
+        /// AndAlso method for better readability when building mocked <see cref="System.Security.Claims.ClaimsIdentity"/>.
         /// </summary>
-        /// <returns>The same claims identity builder.</returns>
+        /// <returns>The same <see cref="IClaimsIdentityBuilder"/>.</returns>
         IClaimsIdentityBuilder AndAlso();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Authentication/IAndClaimsPrincipalBuilder.cs

@@ -1,14 +1,14 @@
 namespace MyTested.Mvc.Builders.Contracts.Authentication
 {
     /// <summary>
-    /// Used for adding AndAlso() method to the claims principal builder.
+    /// Used for adding AndAlso() method to the <see cref="System.Security.Claims.ClaimsPrincipal"/> builder.
     /// </summary>
     public interface IAndClaimsPrincipalBuilder : IClaimsPrincipalBuilder
     {
         /// <summary>
-        /// AndAlso method for better readability when building claims principal.
+        /// AndAlso method for better readability when building <see cref="System.Security.Claims.ClaimsPrincipal"/>.
         /// </summary>
-        /// <returns>The same claims principal builder.</returns>
+        /// <returns>The same <see cref="IClaimsPrincipalBuilder"/>.</returns>
         IClaimsPrincipalBuilder AndAlso();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Authentication/IAuthenticationPropertiesTestBuilder.cs

@@ -4,65 +4,81 @@
     using System.Collections.Generic;
 
     /// <summary>
-    /// Used for testing authentication properties.
+    /// Used for testing <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/>.
     /// </summary>
     public interface IAuthenticationPropertiesTestBuilder
     {
         /// <summary>
-        /// Tests whether authentication properties has the same allow refresh value as the provided one.
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.AllowRefresh"/> value as the provided one.
         /// </summary>
         /// <param name="allowRefresh">Expected allow refresh value.</param>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
         IAndAuthenticationPropertiesTestBuilder WithAllowRefresh(bool? allowRefresh);
 
         /// <summary>
-        /// Tests whether authentication properties has the same expires value as the provided one.
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.ExpiresUtc"/> value as the provided one.
         /// </summary>
         /// <param name="expiresUtc">Expected expires value.</param>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
         IAndAuthenticationPropertiesTestBuilder WithExpires(DateTimeOffset? expiresUtc);
 
         /// <summary>
-        /// Tests whether authentication properties has the same is persistent value as the provided one.
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.IsPersistent"/> value as the provided one.
         /// </summary>
         /// <param name="isPersistent">Expected is persistent value.</param>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
         IAndAuthenticationPropertiesTestBuilder WithIsPersistent(bool isPersistent);
 
         /// <summary>
-        /// Tests whether authentication properties has the same issued value as the provided one.
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.IssuedUtc"/> value as the provided one.
         /// </summary>
         /// <param name="issuedUtc">Expected issued value.</param>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
         IAndAuthenticationPropertiesTestBuilder WithIssued(DateTimeOffset? issuedUtc);
 
         /// <summary>
-        /// Tests whether authentication properties contains the provided item key.
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/>
+        /// contains the provided item key in its <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.Items"/> collection.
         /// </summary>
         /// <param name="itemKey">Expected item key.</param>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
         IAndAuthenticationPropertiesTestBuilder WithItem(string itemKey);
 
         /// <summary>
-        /// Tests whether authentication properties contains the provided item key and value.
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/> contains the provided item key and value
+        /// in its <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.Items"/> collection.
         /// </summary>
         /// <param name="itemKey">Expected item key.</param>
         /// <param name="itemValue">Expected item value.</param>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
         IAndAuthenticationPropertiesTestBuilder WithItem(string itemKey, string itemValue);
 
         /// <summary>
-        /// Tests whether authentication properties contains the provided items.
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/> contains the provided items
+        /// in its <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.Items"/> collection.
+        /// </summary>
+        /// <param name="items">Expected items as anonymous object.</param>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
+        IAndAuthenticationPropertiesTestBuilder WithItems(object items);
+
+        /// <summary>
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/> contains the provided items
+        /// in its <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.Items"/> collection.
         /// </summary>
         /// <param name="items">Expected items as dictionary.</param>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
         IAndAuthenticationPropertiesTestBuilder WithItems(IDictionary<string, string> items);
 
         /// <summary>
-        /// Tests whether authentication properties has the same redirect URI as the provided one.
+        /// Tests whether <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties.RedirectUri"/> as the provided one.
         /// </summary>
         /// <param name="redirectUri">Expected redirect URI.</param>
-        /// <returns>The same authentication properties test builder.</returns>
+        /// <returns>The same <see cref="IAndAuthenticationPropertiesTestBuilder"/>.</returns>
         IAndAuthenticationPropertiesTestBuilder WithRedirectUri(string redirectUri);
     }
 }