#49: Update TestSettings and GetGridPreferences method for OAuth access token support

Author: billybooth

src/EssSharp.Abstractions/IEssServerFactory.cs

@@ -1,10 +1,12 @@
-using System.Threading.Tasks;
+using System;
 using System.Threading;
+using System.Threading.Tasks;
 
 using Microsoft.Extensions.Logging;
 
 namespace EssSharp
 {
+    /// <summary />
     public interface IEssServerFactory
     {
         /// <summary>
@@ -17,6 +19,16 @@ public interface IEssServerFactory
         /// </summary>
         public int MaxDegreeOfParallelism { get; set; }
 
+        /// <summary>
+        /// Gets or sets the tmeout of requests by any <see cref="IEssServer"/> created by this factory.
+        /// </summary>
+        public TimeSpan Timeout { get; set; }
+
+        /// <summary>
+        /// Gets or sets the user agent of any <see cref="IEssServer"/> created by this factory.
+        /// </summary>
+        public string UserAgent { get; set; }
+
         /// <summary>
         /// Creates a new server and, optionally, connects with the given credentials.
         /// </summary>

src/EssSharp.Integration/GetServerObjectTests.cs

@@ -168,7 +168,7 @@ public async Task Essbase_AfterReportCreation_CannotGetDrillthroughReportDetails
         [Fact(DisplayName = @"GetServerObjectTests - 07 - Essbase_AfterReportCreation_CanGetDefaultGridPrefernces"), Priority(07)]
         public async Task Essbase_AfterReportCreation_CanGetDefaultGridPrefernces()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             var preferences = await server.GetDefaultGridPreferencesAsync();
@@ -185,7 +185,7 @@ public async Task Essbase_AfterReportCreation_CanGetDefaultGridPrefernces()
         [Fact(DisplayName = @"GetServerObjectTests - 08 - Essbase_AfterReportCreation_CanGetMembers"), Priority(08)]
         public async Task Essbase_AfterReportCreation_CanGetMembers()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -225,7 +225,7 @@ public async Task Essbase_AfterReportCreation_CanGetMembers()
         [Fact(DisplayName = @"GetServerObjectTests - 08 - Essbase_AfterReportCreation_CanGetMembersSelected"), Priority(08)]
         public async Task Essbase_AfterReportCreation_CanGetMembersByAlias()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -273,7 +273,7 @@ public async Task Essbase_AfterReportCreation_CanGetMembersByAlias()
         [Fact(DisplayName = @"GetServerObjectTests - 09 - Essbase_AfterReportCreation_CanGetMember"), Priority(09)]
         public async Task Essbase_AfterReportCreation_CanGetMember()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -309,7 +309,7 @@ public async Task Essbase_AfterReportCreation_CanGetMember()
         [Fact(DisplayName = @"GetServerObjectTests - 10 - Essbase_AfterReportCreation_CanGetAncestor"), Priority(10)]
         public async Task Essbase_AfterReportCreation_CanGetAncestor()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -337,7 +337,7 @@ public async Task Essbase_AfterReportCreation_CanGetAncestor()
         [Fact(DisplayName = @"GetServerObjectTests - 11 - Essbase_AfterReportCreation_CanGetDescendants"), Priority(11)]
         public async Task Essbase_AfterReportCreation_CanGetDescendants()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -357,7 +357,7 @@ public async Task Essbase_AfterReportCreation_CanGetDescendants()
         [Fact(DisplayName = @"GetServerObjectTests - 12 - Essbase_AfterReportCreation_CanGetSiblings"), Priority(12)]
         public async Task Essbase_AfterReportCreation_CanGetSiblings()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -375,7 +375,7 @@ public async Task Essbase_AfterReportCreation_CanGetSiblings()
         [Fact(DisplayName = @"GetServerObjectTests - 13 - Essbase_AfterReportCreation_CanGetMemberWithFields"), Priority(13)]
         public async Task Essbase_AfterReportCreation_CanGetMemberWithFields()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -395,7 +395,7 @@ public async Task Essbase_AfterReportCreation_CanGetMemberWithFields()
         [Fact(DisplayName = @"GetServerObjectTests - 14 - Essbase_AfterReportCreation_CanGetMember_returnLevelNumber"), Priority(14)]
         public async Task Essbase_AfterReportCreation_CanGetMember_returnLevelNumber()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -415,7 +415,7 @@ public async Task Essbase_AfterReportCreation_CanGetMember_returnLevelNumber()
         [Fact(DisplayName = @"GetServerObjectTests - 15 - Essbase_AfterReportCreation_CanGetMember_returnGenerationNumber"), Priority(15)]
         public async Task Essbase_AfterReportCreation_CanGetMember_returnGenerationNumber()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -435,7 +435,7 @@ public async Task Essbase_AfterReportCreation_CanGetMember_returnGenerationNumbe
         [Fact(DisplayName = @"GetServerObjectTests - 16 - Essbase_AfterReportCreation_CanGetMemberByGen"), Priority(16)]
         public async Task Essbase_AfterReportCreation_CanGetMemberByGen()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -451,7 +451,7 @@ public async Task Essbase_AfterReportCreation_CanGetMemberByGen()
         [Fact(DisplayName = @"GetServerObjectTests - 16 - Essbase_AfterReportCreation_CanGetMemberByLevel"), Priority(16)]
         public async Task Essbase_AfterReportCreation_CanGetMemberByLevel()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -467,7 +467,7 @@ public async Task Essbase_AfterReportCreation_CanGetMemberByLevel()
         [Fact(DisplayName = @"GetServerObjectTests - 17 - Essbase_AfterReportCreation_CanGetDimensionMembers"), Priority(17)]
         public async Task Essbase_AfterReportCreation_CanGetDimensionMembers()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -483,7 +483,7 @@ public async Task Essbase_AfterReportCreation_CanGetDimensionMembers()
         [Fact(DisplayName = @"GetServerObjectTests - 18 - Essbase_AfterReportCreation_CanGetDimensionFromMember"), Priority(18)]
         public async Task Essbase_AfterReportCreation_CanGetDimensionFromMember()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -501,7 +501,7 @@ public async Task Essbase_AfterReportCreation_CanGetDimensionFromMember()
         [Fact(DisplayName = @"GetServerObjectTests - 19 - Essbase_AfterReportCreation_CanGetSameGenerationMembers"), Priority(19)]
         public async Task Essbase_AfterReportCreation_CanGetSameGenerationMembers()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
@@ -530,8 +530,8 @@ public async Task Essbase_AfterReportCreation_CanGetSameGenerationMembers()
         [Fact(DisplayName = @"GetServerObjectTests - 20 - Essbase_AfterReportCreation_CanGetDynamicTimeSeriesMembersAsync"), Priority(20)]
         public async Task Essbase_AfterReportCreation_CanGetDynamicTimeSeriesMembersAsync()
         {
-            // Get an unconnected server as a regular user.
-            var server = GetEssServer(EssServerRole.User);
+            // Get an unconnected server.
+            var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
             var cube = await server
@@ -550,8 +550,8 @@ public async Task Essbase_AfterReportCreation_CanGetDynamicTimeSeriesMembersAsyn
         [Fact(DisplayName = @"GetServerObjectTests - 21 - Essbase_AfterReportCreation_CanGetDimensionsAsync"), Priority(21)]
         public async Task Essbase_AfterReportCreation_CanGetDimensionsAsync()
         {
-            // Get an unconnected server as a regular user.
-            var server = GetEssServer(EssServerRole.User);
+            // Get an unconnected server.
+            var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
             var cube = await server
@@ -578,8 +578,8 @@ public async Task Essbase_AfterReportCreation_CanGetDimensionsAsync()
         [Fact(DisplayName = @"GetServerObjectTests - 22 - Essbase_AfterReportCreation_CanGetDimensionGenerationsAsync"), Priority(22)]
         public async Task Essbase_AfterReportCreation_CanGetDimensionGenerationsAsync()
         {
-            // Get an unconnected server as a regular user.
-            var server = GetEssServer(EssServerRole.User);
+            // Get an unconnected server.
+            var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
             var cube = await server
@@ -605,8 +605,8 @@ public async Task Essbase_AfterReportCreation_CanGetDimensionGenerationsAsync()
         [Fact(DisplayName = @"GetServerObjectTests - 22 - Essbase_AfterReportCreation_CanGetDimensionLevelsAsync"), Priority(22)]
         public async Task Essbase_AfterReportCreation_CanGetDimensionLevelsAsync()
         {
-            // Get an unconnected server as a regular user.
-            var server = GetEssServer(EssServerRole.User);
+            // Get an unconnected server.
+            var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.
             var cube = await server
@@ -632,7 +632,7 @@ public async Task Essbase_AfterReportCreation_CanGetDimensionLevelsAsync()
         [Fact(DisplayName = @"GetServerObjectTests - 23 - Essbase_AfterReportCreation_CanGetBottemLevelDescendants"), Priority(23)]
         public async Task Essbase_AfterReportCreation_CanGetBottemLevelDescendants()
         {
-            // Get an unconnected server as a regular user.
+            // Get an unconnected server.
             var server = GetEssServer();
 
             // Get the Sample.Basic cube from the server.

src/EssSharp.Integration/Setup/IntegrationTestFactory.cs

@@ -213,7 +213,11 @@ internal static IEssServer GetEssServer( EssServerRole role = EssServerRole.Serv
 
             factory ??= new EssServerFactory();
 
-            return factory.CreateEssServer(connection.Server, connection.Username, connection.Password, connect: false);
+            return (connection is { AccessToken.Length: > 0 }) switch
+            {
+                true  => factory.CreateEssServer(connection.Server, oauthToken: connection.AccessToken, connect: false),
+                false => factory.CreateEssServer(connection.Server, username: connection.Username, password: connection.Password, connect: false)
+            };
         }
 
         /// <summary />

src/EssSharp.Integration/Setup/IntegrationTestSettings.cs

@@ -24,16 +24,20 @@ public class IntegrationTestSettingsConnection : ICloneable
         /// <summary />
         public string Password { get; set; }
 
+        /// <summary />
+        public string AccessToken { get; set; }
+
         /// <summary />
         public EssServerRole Role { get; set; }
 
         /// <inheritdoc />
         public object Clone() => new IntegrationTestSettingsConnection()
         {
-            Server   = this.Server,
-            Username = this.Username,
-            Password = this.Password,
-            Role     = this.Role
+            Server      = this.Server,
+            AccessToken = this.AccessToken,
+            Username    = this.Username,
+            Password    = this.Password,
+            Role        = this.Role
         };
     }
 

src/EssSharp.Integration/appsettings.json

@@ -6,18 +6,21 @@
     "Connections": [
       {
         "Server": "http://localhost:9000/essbase",
+        "AccessToken": "",
         "Username": "admin",
         "Password": "welcome1",
         "Role": "ServiceAdministrator"
       },
       {
         "Server": "http://localhost:9000/essbase",
+        "AccessToken": "",
         "Username": "poweruser",
         "Password": "welcome2",
         "Role": "PowerUser"
       },
       {
         "Server": "http://localhost:9000/essbase",
+        "AccessToken": "",
         "Username": "user",
         "Password": "welcome3",
         "Role": "User"

src/EssSharp/EssServer.cs

@@ -698,6 +698,7 @@ public async Task<IEssDatasource> GetDatasourceAsync (string datasourceName , Ca
                     // Apply the base configuration settings.
                     BasePath               = Configuration.BasePath,
                     MaxDegreeOfParallelism = Configuration.MaxDegreeOfParallelism,
+                    AccessToken            = Configuration.AccessToken,
                     Username               = Configuration.Username,
                     Password               = Configuration.Password,
                     Timeout                = Configuration.Timeout,

src/EssSharp/EssServerFactory.cs

@@ -1,4 +1,5 @@
-using System.Threading;
+using System;
+using System.Threading;
 using System.Threading.Tasks;
 
 using Microsoft.Extensions.Logging;
@@ -17,6 +18,14 @@ public class EssServerFactory : IEssServerFactory
         /// <remarks>The default number of concurrent requests is <c>4</c>.</remarks>
         public int MaxDegreeOfParallelism { get; set; } = 4;
 
+        /// <inheritdoc />
+        /// <remarks>The default timout is <see cref="int.MaxValue"/> milliseconds.</remarks>
+        public TimeSpan Timeout { get; set; } = TimeSpan.FromMilliseconds(int.MaxValue);
+
+        /// <inheritdoc />
+        /// <remarks>The default user agent is EssSharp/{version}.</remarks>
+        public string UserAgent { get; set; } = @$"{nameof(EssSharp)}/{typeof(EssServer).Assembly.GetName().Version}";
+
         /// <inheritdoc />
         /// <returns>An <see cref="EssServer" /> object.</returns>
         public IEssServer CreateEssServer( string server, string oauthToken, bool connect = true )
@@ -28,8 +37,10 @@ public IEssServer CreateEssServer( string server, string oauthToken, bool connec
         {
             var essServer = new EssServer(server, oauthToken);
             {
-                essServer.Configuration.Logger = Logger;
+                essServer.Configuration.Logger                 = Logger;
                 essServer.Configuration.MaxDegreeOfParallelism = MaxDegreeOfParallelism;
+                essServer.Configuration.Timeout                = Timeout;
+                essServer.Configuration.UserAgent              = UserAgent;
             }
 
             if ( connect )
@@ -49,8 +60,10 @@ public IEssServer CreateEssServer( string server, string username, string passwo
         {
             var essServer = new EssServer(server, username, password);
             {
-                essServer.Configuration.Logger = Logger;
+                essServer.Configuration.Logger                 = Logger;
                 essServer.Configuration.MaxDegreeOfParallelism = MaxDegreeOfParallelism;
+                essServer.Configuration.Timeout                = Timeout;
+                essServer.Configuration.UserAgent              = UserAgent;
             }
 
             if ( connect )

src/EssSharp/Extensions/ApiFactory.cs

@@ -5,6 +5,7 @@
 
 namespace EssSharp
 {
+    /// <summary />
     internal class ApiFactory
     {
         /// <summary />
@@ -13,21 +14,23 @@ internal class ApiFactory
         /// <param name="username" />
         /// <param name="password" />
         /// <param name="timeout" />
+        /// <param name="userAgent" />
         /// <param name="callerPath" />
         /// <param name="callerName" />
-        public static T GetApi<T>( string basePath, string username, string password, TimeSpan? timeout = null, [System.Runtime.CompilerServices.CallerFilePath] string callerPath = null, [System.Runtime.CompilerServices.CallerMemberName] string callerName = null ) where T : IApiAccessor, new() =>
-            GetApiAndClient<T>(new Configuration() { BasePath = basePath, Username = username, Password = password, Timeout = timeout ?? TimeSpan.FromMilliseconds(int.MaxValue), UserAgent = "EssSharp.Client/1.0.0.0" }, null, callerPath, callerName).Api;
+        public static T GetApi<T>( string basePath, string username, string password, TimeSpan? timeout = null, string userAgent = null, [System.Runtime.CompilerServices.CallerFilePath] string callerPath = null, [System.Runtime.CompilerServices.CallerMemberName] string callerName = null ) where T : IApiAccessor, new() =>
+            GetApiAndClient<T>(new Configuration() { BasePath = basePath, Username = username, Password = password, Timeout = timeout ?? TimeSpan.FromMilliseconds(int.MaxValue), UserAgent = userAgent ?? $"{nameof(EssSharp)}/{typeof(EssServer).Assembly.GetName().Version}" }, null, callerPath, callerName).Api;
 
         /// <summary />
         /// <typeparam name="T" />
         /// <param name="basePath" />
         /// <param name="username" />
         /// <param name="password" />
         /// <param name="timeout" />
+        /// <param name="userAgent" />
         /// <param name="callerPath" />
         /// <param name="callerName" />
-        public static (T Api, ApiClient Client) GetApiAndClient<T>( string basePath, string username, string password, TimeSpan? timeout = null, [System.Runtime.CompilerServices.CallerFilePath] string callerPath = null, [System.Runtime.CompilerServices.CallerMemberName] string callerName = null ) where T : IApiAccessor, new() =>
-            GetApiAndClient<T>(new Configuration() { BasePath = basePath, Username = username, Password = password, Timeout = timeout ?? TimeSpan.FromMilliseconds(int.MaxValue), UserAgent = "EssSharp.Client/1.0.0.0" }, null, callerPath, callerName);
+        public static (T Api, ApiClient Client) GetApiAndClient<T>( string basePath, string username, string password, TimeSpan? timeout = null, string userAgent = null, [System.Runtime.CompilerServices.CallerFilePath] string callerPath = null, [System.Runtime.CompilerServices.CallerMemberName] string callerName = null ) where T : IApiAccessor, new() =>
+            GetApiAndClient<T>(new Configuration() { BasePath = basePath, Username = username, Password = password, Timeout = timeout ?? TimeSpan.FromMilliseconds(int.MaxValue), UserAgent = userAgent ?? $"{nameof(EssSharp)}/{typeof(EssServer).Assembly.GetName().Version}" }, null, callerPath, callerName);
 
         /// <summary />
         /// <typeparam name="T" />