Issue #1645 Interface Support Mock Testing

sln/WebApiOData.Performance.Official.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 14
-VisualStudioVersion = 14.0.25420.1
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.30204.135
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebApiPerformance.Service", "..\test\PerfTest\WebApiPerformance.Service\WebApiPerformance.Service.csproj", "{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}"
 EndProject
@@ -19,12 +19,12 @@ Global
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.CodeAnalysis|Any CPU.ActiveCfg = Release|Any CPU
-		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.CodeAnalysis|Any CPU.Build.0 = Release|Any CPU
-		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.Debug|Any CPU.ActiveCfg = Release|Any CPU
-		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.Debug|Any CPU.Build.0 = Release|Any CPU
-		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.CodeAnalysis|Any CPU.ActiveCfg = Debug|Any CPU
+		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.CodeAnalysis|Any CPU.Build.0 = Debug|Any CPU
+		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.Release|Any CPU.ActiveCfg = Debug|Any CPU
+		{F7B5A5D5-0B2F-493B-94B2-039B881FD4D3}.Release|Any CPU.Build.0 = Debug|Any CPU
 		{5C4C506B-9BFE-429D-A48C-77CEC613877A}.CodeAnalysis|Any CPU.ActiveCfg = Release|Any CPU
 		{5C4C506B-9BFE-429D-A48C-77CEC613877A}.CodeAnalysis|Any CPU.Build.0 = Release|Any CPU
 		{5C4C506B-9BFE-429D-A48C-77CEC613877A}.Debug|Any CPU.ActiveCfg = Release|Any CPU
@@ -35,4 +35,7 @@ Global
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {07010717-A406-417E-B0C8-612DEF0AD8ED}
+	EndGlobalSection
 EndGlobal

src/Microsoft.AspNet.OData.Shared/EnableQueryAttribute.cs

@@ -387,7 +387,7 @@ private object OnActionExecuted(
             IWebApiActionDescriptor actionDescriptor,
             IWebApiRequestMessage request,
             Func<Type, IEdmModel> modelFunction,
-            Func<ODataQueryContext, ODataQueryOptions> createQueryOptionFunction,
+            Func<ODataQueryContext, IODataQueryOptions> createQueryOptionFunction,
             Action<HttpStatusCode> createResponseAction,
             Action<HttpStatusCode, string, Exception> createErrorAction)
         {
@@ -466,9 +466,9 @@ private object OnActionExecuted(
         /// </summary>
         /// <param name="queryable">The original queryable instance from the response message.</param>
         /// <param name="queryOptions">
-        /// The <see cref="ODataQueryOptions"/> instance constructed based on the incoming request.
+        /// The <see cref="IODataQueryOptions"/> instance constructed based on the incoming request.
         /// </param>
-        public virtual IQueryable ApplyQuery(IQueryable queryable, ODataQueryOptions queryOptions)
+        public virtual IQueryable ApplyQuery(IQueryable queryable, IODataQueryOptions queryOptions)
         {
             if (queryable == null)
             {
@@ -487,10 +487,10 @@ public virtual IQueryable ApplyQuery(IQueryable queryable, ODataQueryOptions que
         /// </summary>
         /// <param name="entity">The original entity from the response message.</param>
         /// <param name="queryOptions">
-        /// The <see cref="ODataQueryOptions"/> instance constructed based on the incoming request.
+        /// The <see cref="IODataQueryOptions"/> instance constructed based on the incoming request.
         /// </param>
         /// <returns>The new entity after the $select and $expand query has been applied to.</returns>
-        public virtual object ApplyQuery(object entity, ODataQueryOptions queryOptions)
+        public virtual object ApplyQuery(object entity, IODataQueryOptions queryOptions)
         {
             if (entity == null)
             {
@@ -588,12 +588,12 @@ private object ExecuteQuery(
             IWebApiActionDescriptor actionDescriptor,
             Func<Type, IEdmModel> modelFunction,
             IWebApiRequestMessage request,
-            Func<ODataQueryContext, ODataQueryOptions> createQueryOptionFunction)
+            Func<ODataQueryContext, IODataQueryOptions> createQueryOptionFunction)
         {
             ODataQueryContext queryContext = GetODataQueryContext(responseValue, singleResultCollection, actionDescriptor, modelFunction, request.Context.Path);
 
             // Create and validate the query options.
-            ODataQueryOptions queryOptions = createQueryOptionFunction(queryContext);
+            IODataQueryOptions queryOptions = createQueryOptionFunction(queryContext);
 
             // apply the query
             IEnumerable enumerable = responseValue as IEnumerable;
@@ -718,7 +718,7 @@ internal static object SingleOrDefault(
         /// Validate the select and expand options.
         /// </summary>
         /// <param name="queryOptions">The query options.</param>
-        internal static void ValidateSelectExpandOnly(ODataQueryOptions queryOptions)
+        internal static void ValidateSelectExpandOnly(IODataQueryOptions queryOptions)
         {
             if (queryOptions.Filter != null || queryOptions.Count != null || queryOptions.OrderBy != null
                 || queryOptions.Skip != null || queryOptions.Top != null)

src/Microsoft.AspNet.OData.Shared/Formatter/Serialization/ODataSerializerContext.cs

@@ -229,9 +229,9 @@ internal ExpandedReferenceSelectItem CurrentExpandedSelectItem
         internal SelectItem CurrentSelectItem { get; set; }
 
         /// <summary>
-        /// Gets or sets the <see cref="ODataQueryOptions"/>.
+        /// Gets or sets the <see cref="IODataQueryOptions"/>.
         /// </summary>
-        public ODataQueryOptions QueryOptions { get; internal set; }
+        public IODataQueryOptions QueryOptions { get; internal set; }
 
         /// <summary>
         /// Gets or sets the relative path to the resouce being serialized

src/Microsoft.AspNet.OData.Shared/Interfaces/IODataQueryOptions.cs

@@ -0,0 +1,151 @@
+using Microsoft.AspNet.OData.Formatter;
+using Microsoft.AspNet.OData.Query;
+using Microsoft.AspNet.OData.Query.Validators;
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
+
+namespace Microsoft.AspNet.OData.Query
+{
+    /// <summary>
+    /// This defines a composite OData query options that can be used to perform query composition.
+    /// Currently this only supports $filter, $orderby, $top, $skip, and $count.
+    /// </summary>
+    [ODataQueryParameterBinding]
+    [NonValidatingParameterBinding]
+    public interface IODataQueryOptions
+    {
+        /// <summary>
+        ///  Gets the given <see cref="ODataQueryContext"/>
+        /// </summary>
+        ODataQueryContext Context { get; }
+        /// <summary>
+        /// Gets the raw string of all the OData query options
+        /// </summary>
+        ODataRawQueryOptions RawValues { get; }
+        /// <summary>
+        /// Gets the <see cref="SelectExpandQueryOption"/>.
+        /// </summary>
+        SelectExpandQueryOption SelectExpand { get; }
+        /// <summary>
+        /// Gets the <see cref="ApplyQueryOption"/>.
+        /// </summary>
+        ApplyQueryOption Apply { get; }
+        /// <summary>
+        /// Gets the <see cref="FilterQueryOption"/>.
+        /// </summary>
+        FilterQueryOption Filter { get; }
+        /// <summary>
+        /// Gets the <see cref="OrderByQueryOption"/>.
+        /// </summary>
+        OrderByQueryOption OrderBy { get; }
+        /// <summary>
+        /// Gets the <see cref="SkipQueryOption"/>.
+        /// </summary>
+         SkipQueryOption Skip { get; }
+
+        /// <summary>
+        /// Gets the <see cref="SkipTokenQueryOption"/>.
+        /// </summary>
+         SkipTokenQueryOption SkipToken { get; }
+
+        /// <summary>
+        /// Gets the <see cref="TopQueryOption"/>.
+        /// </summary>
+         TopQueryOption Top { get; }
+
+        /// <summary>
+        /// Gets the <see cref="CountQueryOption"/>.
+        /// </summary>
+         CountQueryOption Count { get; }
+
+        /// <summary>
+        /// Gets or sets the query validator.
+        /// </summary>
+         ODataQueryValidator Validator { get; set; }
+
+        /// <summary>
+        /// Gets the <see cref="ETag"/> from IfMatch header.
+        /// </summary>
+        ETag IfMatch { get; }
+
+        /// <summary>
+        /// Gets the <see cref="ETag"/> from IfNoneMatch header.
+        /// </summary>
+        ETag IfNoneMatch { get; }
+
+        /// <summary>
+        /// Apply the individual query to the given IQueryable in the right order.
+        /// </summary>
+        /// <param name="query">The original <see cref="IQueryable"/>.</param>
+        /// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
+        IQueryable ApplyTo(IQueryable query);
+
+        /// <summary>
+        /// Apply the individual query to the given IQueryable in the right order.
+        /// </summary>
+        /// <param name="query">The original <see cref="IQueryable"/>.</param>
+        /// <param name="ignoreQueryOptions">The query parameters that are already applied in queries.</param>
+        /// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
+        IQueryable ApplyTo(IQueryable query, AllowedQueryOptions ignoreQueryOptions);
+
+        /// <summary>
+        /// Apply the individual query to the given IQueryable in the right order.
+        /// </summary>
+        /// <param name="query">The original <see cref="IQueryable"/>.</param>
+        /// <param name="querySettings">The settings to use in query composition.</param>
+        /// <param name="ignoreQueryOptions">The query parameters that are already applied in queries.</param>
+        /// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
+        IQueryable ApplyTo(IQueryable query, ODataQuerySettings querySettings, AllowedQueryOptions ignoreQueryOptions);
+
+        /// <summary>
+        /// Apply the individual query to the given IQueryable in the right order.
+        /// </summary>
+        /// <param name="query">The original <see cref="IQueryable"/>.</param>
+        /// <param name="querySettings">The settings to use in query composition.</param>
+        /// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
+        [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity", Justification = "These are simple conversion function and cannot be split up.")]
+        IQueryable ApplyTo(IQueryable query, ODataQuerySettings querySettings);
+
+        /// <summary>
+        /// Apply the individual query to the given IQueryable in the right order.
+        /// </summary>
+        /// <param name="entity">The original entity.</param>
+        /// <param name="querySettings">The <see cref="ODataQuerySettings"/> that contains all the query application related settings.</param>
+        /// <param name="ignoreQueryOptions">The query parameters that are already applied in queries.</param>
+        /// <returns>The new entity after the $select and $expand query has been applied to.</returns>
+        /// <remarks>Only $select and $expand query options can be applied on single entities. This method throws if the query contains any other
+        /// query options.</remarks>
+        object ApplyTo(object entity, ODataQuerySettings querySettings, AllowedQueryOptions ignoreQueryOptions);
+
+        /// <summary>
+        /// Applies the query to the given entity using the given <see cref="ODataQuerySettings"/>.
+        /// </summary>
+        /// <param name="entity">The original entity.</param>
+        /// <param name="querySettings">The <see cref="ODataQuerySettings"/> that contains all the query application related settings.</param>
+        /// <returns>The new entity after the $select and $expand query has been applied to.</returns>
+        /// <remarks>Only $select and $expand query options can be applied on single entities. This method throws if the query contains any other
+        /// query options.</remarks>
+        object ApplyTo(object entity, ODataQuerySettings querySettings);
+
+        /// <summary>
+        /// Generates the Stable OrderBy query option based on the existing OrderBy and other query options. 
+        /// </summary>
+        /// <returns>An order by query option that ensures stable ordering of the results.</returns>
+        OrderByQueryOption GenerateStableOrder();
+
+        /// <summary>
+        /// Check if the given query option is the supported query option.
+        /// </summary>
+        /// <param name="queryOptionName">The name of the query option.</param>
+        /// <returns>Returns <c>true</c> if the query option is the supported query option.</returns>
+        [SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Justification = "Need lower case string here.")]
+        bool IsSupportedQueryOption(string queryOptionName);
+
+        /// <summary>
+        /// Validate all OData queries, including $skip, $top, $orderby and $filter, based on the given <paramref name="validationSettings"/>.
+        /// It throws an ODataException if validation failed.
+        /// </summary>
+        /// <param name="validationSettings">The <see cref="ODataValidationSettings"/> instance which contains all the validation settings.</param>
+        void Validate(ODataValidationSettings validationSettings);
+    }
+}

src/Microsoft.AspNet.OData.Shared/Interfaces/IODataQueryOptionsOfTEntity.cs

@@ -0,0 +1,26 @@
+using Microsoft.AspNet.OData.Formatter;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Microsoft.AspNet.OData.Query
+{
+    /// <summary>
+    /// This defines a composite OData query options that can be used to perform query composition.
+    /// Currently this only supports $filter, $orderby, $top, $skip.
+    /// </summary>
+    [ODataQueryParameterBinding]
+    public interface IODataQueryOptions<TEntity>
+        : IODataQueryOptions
+    {
+        /// <summary>
+        /// Gets the <see cref="ETag{TEntity}"/> from IfMatch header.
+        /// </summary>
+        new ETag<TEntity> IfMatch { get; }
+
+        /// <summary>
+        /// Gets the <see cref="ETag{TEntity}"/> from IfNoneMatch header.
+        /// </summary>
+        new ETag<TEntity> IfNoneMatch { get; }
+    }
+}

src/Microsoft.AspNet.OData.Shared/Interfaces/IWebApiContext.cs

@@ -3,10 +3,10 @@
 
 using System;
 using System.Collections.Generic;
-using Microsoft.AspNet.OData.Query;
 using Microsoft.AspNet.OData.Routing.Conventions;
-using Microsoft.OData.UriParser;
+using Microsoft.AspNet.OData.Query;
 using Microsoft.OData.UriParser.Aggregation;
+using Microsoft.OData.UriParser;
 using ODataPath = Microsoft.AspNet.OData.Routing.ODataPath;
 
 namespace Microsoft.AspNet.OData.Interfaces
@@ -63,9 +63,9 @@ internal interface IWebApiContext
         SelectExpandClause ProcessedSelectExpandClause { get; set; }
 
         /// <summary>
-        /// Gets or sets the <see cref="ODataQueryOptions"/> of the request.
+        /// Gets or sets the <see cref="IODataQueryOptions"/> of the request.
         /// </summary>
-        ODataQueryOptions QueryOptions { get; set; }
+        IODataQueryOptions QueryOptions { get; set; }
 
         /// <summary>
         /// Gets or sets the total count for the OData response.

src/Microsoft.AspNet.OData.Shared/Microsoft.AspNet.OData.Shared.projitems

@@ -68,6 +68,8 @@
     <Compile Include="$(MSBuildThisFileDirectory)Formatter\QueryStringMediaTypeMapping.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Formatter\Serialization\ODataSerializerProvider.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)GetNextPageHelper.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)Interfaces\IODataQueryOptions.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)Interfaces\IODataQueryOptionsOfTEntity.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)IPerRouteContainer.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)CompatibilityOptions.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)ODataNullValueMessageHandler.cs" />
@@ -169,7 +171,7 @@
     <Compile Include="$(MSBuildThisFileDirectory)Builder\DynamicPropertyDictionaryAnnotation.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Query\Expressions\AggregationBinder.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Query\Expressions\ComputeBinder.cs" />
-    <Compile Include="$(MSBuildThisFileDirectory)Query\Expressions\TransformationBinderBase.cs" />    
+    <Compile Include="$(MSBuildThisFileDirectory)Query\Expressions\TransformationBinderBase.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Query\ApplyQueryOption.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Query\Expressions\DynamicTypeWrapper.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Query\Expressions\ExpressionBinderBase.cs" />

src/Microsoft.AspNet.OData.Shared/ODataQueryParameterBindingAttribute.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Diagnostics.Contracts;
 using System.Linq;
+using Microsoft.AspNet.OData.Interfaces;
 using Microsoft.AspNet.OData.Query;
 
 namespace Microsoft.AspNet.OData
@@ -18,7 +19,8 @@ internal static Type GetEntityClrTypeFromParameterType(Type parameterType)
             Contract.Assert(parameterType != null);
 
             if (parameterType.IsGenericType &&
-                parameterType.GetGenericTypeDefinition() == typeof(ODataQueryOptions<>))
+                (parameterType.GetGenericTypeDefinition() == typeof(ODataQueryOptions<>) ||
+                 parameterType.GetGenericTypeDefinition() == typeof(IODataQueryOptions<>)))
             {
                 return parameterType.GetGenericArguments().Single();
             }

src/Microsoft.AspNet.OData.Shared/Query/DefaultSkipTokenHandler.cs

@@ -10,6 +10,7 @@
 using Microsoft.AspNet.OData.Common;
 using Microsoft.AspNet.OData.Formatter;
 using Microsoft.AspNet.OData.Formatter.Serialization;
+using Microsoft.AspNet.OData.Interfaces;
 using Microsoft.AspNet.OData.Query.Expressions;
 using Microsoft.OData;
 using Microsoft.OData.Edm;
@@ -181,7 +182,7 @@ public override IQueryable ApplyTo(IQueryable query, SkipTokenQueryOption skipTo
             }
 
             ODataQuerySettings querySettings = skipTokenQueryOption.QuerySettings;
-            ODataQueryOptions queryOptions = skipTokenQueryOption.QueryOptions;
+            IODataQueryOptions queryOptions = skipTokenQueryOption.QueryOptions;
             IList<OrderByNode> orderByNodes = null;
 
             if (queryOptions != null)

src/Microsoft.AspNet.OData.Shared/Query/ODataQueryOptions.cs

@@ -30,6 +30,7 @@ namespace Microsoft.AspNet.OData.Query
     [ODataQueryParameterBinding]
     [SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling", Justification = "Relies on many ODataLib classes.")]
     public partial class ODataQueryOptions
+        : IODataQueryOptions
     {
         private static readonly MethodInfo _limitResultsGenericMethod = typeof(ODataQueryOptions).GetMethods(BindingFlags.Public | BindingFlags.Static)
             .Single(mi => mi.Name == "LimitResults" && mi.ContainsGenericParameters && mi.GetParameters().Length == 4);
@@ -51,7 +52,7 @@ public partial class ODataQueryOptions
         private OrderByQueryOption _stableOrderBy;
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ODataQueryOptions"/> class based on the incoming request and some metadata information from
+        /// Initializes a new instance of the <see cref="IODataQueryOptions"/> class based on the incoming request and some metadata information from
         /// the <see cref="ODataQueryContext"/>.
         /// </summary>
         /// <param name="context">The <see cref="ODataQueryContext"/> which contains the <see cref="IEdmModel"/> and some type information.</param>