Merge pull request #5 from kdcllc/dev

kdcllc · web-flow · commit a29698933ac2 · 2019-04-05T16:29:02.000-04:00
Update Salesforce Cli tool closes issue #4
diff --git a/README.md b/README.md
@@ -43,17 +43,32 @@ To verify the installation run:
 
 ## Usage of Salesforce dotnet cli tool
 
-The regular usage of this tool is within the Salesforce project that utilizes this library and contains configuration settings with the minimum of:
+There are several ways to run this cli tool.
+
+1. From any location with Consumer Key and Secret provided
+
+```bash
+    salesforce get-tokens --key:{key} --secret:{secret} --login:https://login.salesforce.com --verbose:information
+```
+
+2. Running the tool in the directory that contains `appsettings.json` file
+
+```bash
+    salesforce get-tokens --section Salesforce
+```
+Note: required configurations are as follows:
 
 ```json
   "Salesforce": {
     "ClientId": "",
-    "ClientSecret": ""
+    "ClientSecret": "",
+    "LoginUrl": ""
   }
 ````
 
-Or you can specify Azure Key Vault Url:
+3. Running with Azure Vault
 
+`appsettings.json
 ```json
     "AzureVault": {
      "BaseUrl": "https://{name}.vault.azure.net/"
@@ -63,7 +78,7 @@ Or you can specify Azure Key Vault Url:
 Then run:
 
 ```cmd
-    salesforce get-tokens
+    salesforce get-tokens --verbose:debug
 ```
 
 Or specify url within the dotnet cli tool like so:
diff --git a/build/dependecies.props b/build/dependecies.props
@@ -1,7 +1,8 @@
 <Project>
 
   <PropertyGroup>
-    <NetCoreCommonVersion>2.1.1</NetCoreCommonVersion>
+    <NetCoreCommonVersion>2.2.*</NetCoreCommonVersion>
+    <BetCommonVersion>1.1.18</BetCommonVersion>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(TargetFramework)' == 'netcoreapp2.1' Or '$(TargetFramework)' == 'netstandard2.0'">
@@ -13,7 +14,7 @@
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(TargetFramework)' == 'netcoreapp3.0'">
-    <NetCoreCommonVersion>3.0.0-preview.19074.2</NetCoreCommonVersion>
+    <NetCoreCommonVersion>3.0.0-preview*</NetCoreCommonVersion>
   </PropertyGroup>
 
   <ItemGroup Label="NetCore">
@@ -39,15 +40,16 @@
     <PackageReference Update="Microsoft.AspNetCore.Http" Version="$(NetCoreCommonVersion)" />
   </ItemGroup>
 
-  <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.0'">
-    <PackageReference Update="Microsoft.AspNetCore.Hosting.Server.Abstractions" Version="3.0.0-preview-18571-0006" />
-    <PackageReference Update="Microsoft.AspNetCore.Http" Version="3.0.0-preview-18571-0006" />
+  <ItemGroup Label="Bet">
+    <PackageReference Update="Bet.Extensions.Options" Version="$(BetCommonVersion)" />
+    <PackageReference Update="Bet.Extensions.Hosting" Version="$(BetCommonVersion)" />
+    <PackageReference Update="Bet.Extensions.AzureVault" Version="$(BetCommonVersion)"/>
+    <PackageReference Update="Bet.Extensions.Logging"  Version="$(BetCommonVersion)"/>
   </ItemGroup>
 
   <ItemGroup Label="Shared Libraries">
-    <PackageReference Update="Bet.AspNetCore" Version="1.0.3" />
     <PackageReference Update="CometD.NetCore2" Version="2.0.0" />
-    <PackageReference Update="Bet.BuildingBlocks.SalesforceEventBus" Version="2.1.0-pre" />
+    <PackageReference Update="Bet.BuildingBlocks.SalesforceEventBus" Version="2.0.0" />
     <PackageReference Update="McMaster.Extensions.CommandLineUtils" Version="2.3.2"/>
     <PackageReference Update="NetCoreForce.Client" Version="2.5.0" />
     <PackageReference Update="Polly" Version="7.0.2" />
diff --git a/build/settings.props b/build/settings.props
@@ -6,7 +6,7 @@
     <LangVersion>latest</LangVersion>
     <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
     <SuppressNETCoreSdkPreviewMessage>true</SuppressNETCoreSdkPreviewMessage>
-    <NoWarn>$(NoWarn);CS1591</NoWarn>
+    <NoWarn>$(NoWarn);CS1591;IDE1006</NoWarn>
   </PropertyGroup>
 
   <PropertyGroup Label="Nuget Package Settings">
diff --git a/src/AuthApp/AuthApp.csproj b/src/AuthApp/AuthApp.csproj
@@ -10,7 +10,12 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Bet.AspNetCore" />
+
+    <PackageReference Include="Bet.Extensions.Options" />
+    <PackageReference Include="Bet.Extensions.Hosting" />
+    <PackageReference Include="Bet.Extensions.AzureVault" />
+    <PackageReference Include="Bet.Extensions.Logging" />
+
     <PackageReference Include="Colorful.Console" />
     <PackageReference Include="McMaster.Extensions.CommandLineUtils" />
     <PackageReference Include="Microsoft.AspNetCore.Hosting.Server.Abstractions" />
diff --git a/src/AuthApp/Host/HttpServer.cs b/src/AuthApp/Host/HttpServer.cs
@@ -94,8 +94,7 @@ await auth.WebServerAsync(
                         _config.ClientSecret,
                         redirectURI,
                         code,
-                        $"{_config.LoginUrl}/services/oauth2/token");
-
+                        $"{_config.LoginUrl}{_config.OAuthUri}");
 
                     Console.WriteLineFormatted("Access_token = {0}",Color.Green, Color.Yellow, auth.AccessInfo.AccessToken);
                     Console.WriteLineFormatted("Refresh_token = {0}", Color.Green, Color.Yellow, auth.AccessInfo.RefreshToken);
@@ -123,7 +122,7 @@ private int GetRandomUnusedPort()
 
         private string GetAuthorizationUrl(string redirectURI)
         {
-            var authEndpoint = $"{_config.LoginUrl}/services/oauth2/authorize";
+            var authEndpoint = $"{_config.LoginUrl}{_config.OAuthorizeUri}";
             var url = $"{authEndpoint}?response_type=code&access_type=offline&scope=openid%20profile%20api%20refresh_token%20offline_access&redirect_uri={Uri.EscapeDataString(redirectURI)}&client_id={_config.ClientId}";
             return url;
         }
diff --git a/src/AuthApp/Host/SfConfig.cs b/src/AuthApp/Host/SfConfig.cs
@@ -22,5 +22,12 @@ public class SfConfig
         [Required]
         [Url]
         public string LoginUrl { get; set; }
+
+        /// <summary>
+        /// Default set to /services/oauth2/token.
+        /// </summary>
+        public string OAuthUri { get; set; } = "/services/oauth2/token";
+
+        public string OAuthorizeUri { get; set; } = "/services/oauth2/authorize";
     }
 }
diff --git a/src/AuthApp/HostBuilderExtensions.cs b/src/AuthApp/HostBuilderExtensions.cs
@@ -4,7 +4,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using System;
 using System.Collections.Generic;
 using System.Drawing;
 using System.IO;
@@ -30,13 +29,13 @@ internal static IHostBuilder CreateDefaultBuilder(HostBuilderOptions options)
 
             var defaultConfigName = !string.IsNullOrWhiteSpace(options.ConfigFile) ? Path.GetFileName(options.ConfigFile) : "appsettings.json";
 
-
             if (options.Verbose)
             {
                 Console.WriteLine($"ContentRoot:{fullPath}", color: Color.Green);
             }
 
             builder
+                .UseStartupFilter()
                 .ConfigureAppConfiguration((context, config) =>
                 {
                     // appsettings file or others
@@ -70,7 +69,23 @@ internal static IHostBuilder CreateDefaultBuilder(HostBuilderOptions options)
                         config.AddAzureKeyVault(hostingEnviromentName:options.HostingEnviroment, options.UseAzureKeyPrefix);
                     }
 
-                    if (options.Verbose)
+                    if(!string.IsNullOrWhiteSpace(options.Settings.ClientId)
+                        && !string.IsNullOrWhiteSpace(options.Settings.ClientSecret))
+                    {
+                        var inputValues = new Dictionary<string, string>
+                            {
+                                {$"{options.SectionName}:ClientId", options.Settings.ClientId },
+                                {$"{options.SectionName}:ClientSecret", options.Settings.ClientSecret },
+                                {$"{options.SectionName}:LoginUrl", options.Settings.LoginUrl },
+                                {$"{options.SectionName}:OAuthUri", options.Settings.OAuthUri },
+                                {$"{options.SectionName}:OAuthorizeUri", options.Settings.OAuthorizeUri },
+                            };
+
+                        config.AddInMemoryCollection(inputValues);
+                    }
+
+                    if (options.Verbose && options.Level == LogLevel.Debug
+                    || options.Level == LogLevel.Trace)
                     {
                         config.Build().DebugConfigurations();
                     }
@@ -98,7 +113,10 @@ internal static IHostBuilder CreateDefaultBuilder(HostBuilderOptions options)
 
                     if (options.Verbose)
                     {
-                        services.AddLogging(x => x.AddFilter((_) => true));
+                        services.AddLogging(x => x.AddFilter((loglevel) =>
+                        {
+                            return loglevel == options.Level;
+                        }));
                     }
 
                     services.AddSingleton(PhysicalConsole.Singleton);
diff --git a/src/AuthApp/HostBuilderOptions.cs b/src/AuthApp/HostBuilderOptions.cs
@@ -1,4 +1,7 @@
-﻿namespace AuthApp
+﻿using AuthApp.Host;
+using Microsoft.Extensions.Logging;
+
+namespace AuthApp
 {
     internal class HostBuilderOptions
     {
@@ -12,6 +15,11 @@ internal class HostBuilderOptions
         /// </summary>
         public bool Verbose { get; set; }
 
+        /// <summary>
+        /// TraceLevel if verbose is present.
+        /// </summary>
+        public LogLevel  Level { get; set; }
+
         /// <summary>
         /// Ability to use Web project secrets.
         /// </summary>
@@ -31,5 +39,15 @@ internal class HostBuilderOptions
         /// Pass Hosting environment for the context of the application.
         /// </summary>
         public string HostingEnviroment { get; set; }
+
+        /// <summary>
+        /// Salesforce options.
+        /// </summary>
+        public SfConfig Settings { get; set; }
+
+        /// <summary>
+        /// The name of the configuration section for the options.
+        /// </summary>
+        public string SectionName { get; set; }
     }
 }
diff --git a/src/AuthApp/Program.cs b/src/AuthApp/Program.cs
@@ -1,4 +1,6 @@
-﻿using System.Reflection;
+﻿using System;
+using System.Drawing;
+using System.Reflection;
 using System.Threading.Tasks;
 using McMaster.Extensions.CommandLineUtils;
 using Console = Colorful.Console;
@@ -13,7 +15,8 @@ public class Program
     {
         private static Task<int> Main(string[] args)
         {
-            return CommandLineApplication.ExecuteAsync<Program>(args);
+
+            return  CommandLineApplication.ExecuteAsync<Program>(args);
         }
 
         private int OnExecute(CommandLineApplication app, IConsole console)
diff --git a/src/AuthApp/Properties/launchSettings.json b/src/AuthApp/Properties/launchSettings.json
@@ -2,7 +2,10 @@
   "profiles": {
     "AuthApp": {
       "commandName": "Project",
-      "commandLineArgs": "refresh-token --azure https://{name}.vault.azure.net/"
+      //"commandLineArgs": "get-tokens --azure https://{name}.vault.azure.net/"
+      //"commandLineArgs": "get-tokens --verbose:information --section:sfconfig"
+
+      "commandLineArgs": "get-tokens --key: --secret: --verbose:information --section:Salesforce"
     }
   }
 }
diff --git a/src/AuthApp/TokenGeneratorCommand.cs b/src/AuthApp/TokenGeneratorCommand.cs
@@ -1,17 +1,29 @@
 ﻿using AuthApp.Host;
-using Bet.AspNetCore.Options;
 using McMaster.Extensions.CommandLineUtils;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
 using System;
+using System.Drawing;
 using System.Threading.Tasks;
+using Console = Colorful.Console;
+
 namespace AuthApp
 {
     [Command("get-tokens",
         Description = "Generates Salesforce Access and Refresh Tokens",
         ThrowOnUnexpectedArgument = false)]
     internal class TokenGeneratorCommand
     {
+        [Option("--key", Description = "The Salesforce Consumer Key.")]
+        public string ClientId { get; set; }
+
+        [Option("--secret", Description = "The Salesforce Consumer Secret.")]
+        public string ClientSecret { get; set; }
+
+        [Option("--login", Description = "The Salesforce login url. The default value is https://login.salesforce.com.")]
+        public string LoginUrl { get; set; }
+
         [Option("--azure",
             Description = "Allows to specify Azure Vault Url. It overrides url specified in the appsetting.json file or any other configuration provider.")]
         public string AzureVault { get; set; }
@@ -22,44 +34,71 @@ internal class TokenGeneratorCommand
         [Option("--configfile", Description = "Allows to specify a configuration file besides appsettings.json to be specified.")]
         public string ConfigFile { get; set; }
 
-        [Option("--verbose", Description = "Allows Verbose logging for the tool. Enable this to get tracing information. Default is false.")]
-        public bool Verbose { get; set; }
+        /// <summary>
+        /// Property types of ValueTuple{bool,T} translate to CommandOptionType.SingleOrNoValue.
+        /// Input                   | Value
+        /// ------------------------|--------------------------------
+        /// (none)                  | (false, default(TraceLevel))
+        /// --verbose               | (true, LogLevel.Information)
+        /// --verbose:information   | (true, LogLevel.Information)
+        /// --verbose:debug         | (true, LogLevel.Debug)
+        /// --verbose:trace         | (true, LogLevel.Trace)
+        /// </summary>
+        [Option(Description = "Allows Verbose logging for the tool. Enable this to get tracing information. Default is false.")]
+        public (bool HasValue, LogLevel level) Verbose { get; }
 
         [Option("--usesecrets", Description = "Enable UserSecrets.")]
         public bool UserSecrets { get; set; }
 
         [Option("--environment", Description = "Specify Hosting Environment Name for the cli tool execution.")]
         public string HostingEnviroment { get; set; }
 
+        [Option("--section", Description ="Configuration Section Name to retrieve the options. The Default value is Salesforce.")]
+        public string SectionName { get; set; }
+
         private async Task<int> OnExecuteAsync()
         {
             var builderConfig = new HostBuilderOptions
             {
                 AzureVault = AzureVault,
                 UseAzureKeyPrefix = !UseAzureKeyPrefix,
                 ConfigFile = ConfigFile,
-                Verbose = Verbose,
+                Verbose = Verbose.HasValue,
+                Level = Verbose.level,
                 UserSecrets = UserSecrets,
-                HostingEnviroment = !string.IsNullOrWhiteSpace(HostingEnviroment) ? HostingEnviroment : "Development"
+                HostingEnviroment = !string.IsNullOrWhiteSpace(HostingEnviroment) ? HostingEnviroment : "Development",
+                Settings = new SfConfig
+                {
+                    ClientId = ClientId,
+                    ClientSecret = ClientSecret,
+                    LoginUrl = !string.IsNullOrWhiteSpace(LoginUrl) ? LoginUrl :  "https://login.salesforce.com"
+                },
+                SectionName = string.IsNullOrWhiteSpace(SectionName) ? "Salesforce" : SectionName,
             };
 
             try
             {
                 var builder = HostBuilderExtensions.CreateDefaultBuilder(builderConfig)
                                 .ConfigureServices((hostingContext, services) =>
                                 {
-                                    services.ConfigureWithDataAnnotationsValidation<SfConfig>("Salesforce");
+                                    services.ConfigureWithDataAnnotationsValidation<SfConfig>(hostingContext.Configuration, builderConfig.SectionName);
                                     services.AddHostedService<HttpServer>();
                                 });
 
                 await builder.RunConsoleAsync();
+
                 return 0;
             }
-            catch (Exception)
+            catch(Microsoft.Extensions.Options.OptionsValidationException exv)
+            {
+                Console.WriteLine("Not all of the required configurations has been provided.", Color.Red);
+            }
+            catch (Exception ex)
             {
-                throw;
+                Console.WriteLine(ex.Message, Color.Red);
             }
 
+            return 0;
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -22,5 +22,12 @@ public class SfConfig`
`22`	`22`	`[Required]`
`23`	`23`	`[Url]`
`24`	`24`	`public string LoginUrl { get; set; }`
	`25`	`+`
	`26`	`+ /// <summary>`
	`27`	`+ /// Default set to /services/oauth2/token.`
	`28`	`+ /// </summary>`
	`29`	`+ public string OAuthUri { get; set; } = "/services/oauth2/token";`
	`30`	`+`
	`31`	`+ public string OAuthorizeUri { get; set; } = "/services/oauth2/authorize";`
`25`	`32`	`}`
`26`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`		`-using System.Reflection;`
	`1`	`+using System;`
	`2`	`+using System.Drawing;`
	`3`	`+using System.Reflection;`
`2`	`4`	`using System.Threading.Tasks;`
`3`	`5`	`using McMaster.Extensions.CommandLineUtils;`
`4`	`6`	`using Console = Colorful.Console;`
`@@ -13,7 +15,8 @@ public class Program`
`13`	`15`	`{`
`14`	`16`	`private static Task<int> Main(string[] args)`
`15`	`17`	`{`
`16`		`- return CommandLineApplication.ExecuteAsync<Program>(args);`
	`18`	`+`
	`19`	`+ return CommandLineApplication.ExecuteAsync<Program>(args);`
`17`	`20`	`}`
`18`	`21`
`19`	`22`	`private int OnExecute(CommandLineApplication app, IConsole console)`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,10 @@`
`2`	`2`	`"profiles": {`
`3`	`3`	`"AuthApp": {`
`4`	`4`	`"commandName": "Project",`
`5`		`- "commandLineArgs": "refresh-token --azure https://{name}.vault.azure.net/"`
	`5`	`+ //"commandLineArgs": "get-tokens --azure https://{name}.vault.azure.net/"`
	`6`	`+ //"commandLineArgs": "get-tokens --verbose:information --section:sfconfig"`
	`7`	`+`
	`8`	`+ "commandLineArgs": "get-tokens --key: --secret: --verbose:information --section:Salesforce"`
`6`	`9`	`}`
`7`	`10`	`}`
`8`	`11`	`}`