(GH-158) Deprecate the usage of Username and password

fixes #158

Author: AdmiringWorm

Source/GitReleaseManager.Cli/Options/BaseVcsSubOptions.cs

@@ -5,16 +5,21 @@
 
 namespace GitReleaseManager.Cli.Options
 {
+    using System;
     using CommandLine;
     using Destructurama.Attributed;
 
     public abstract class BaseVcsOptions : BaseSubOptions
     {
-        [Option('u', "username", HelpText = "The username to access Version Control System with.", Required = true, SetName = "Basic Auth")]
+        internal const string OBSOLETE_MESSAGE = "Authentication using username and password have been deprecated, and will be removed in a future release. Please use --token instead!";
+
+        [Obsolete(OBSOLETE_MESSAGE)]
+        [Option('u', "username", HelpText = "(DEPRECATED) The username to access Version Control System with.", Required = true, SetName = "Basic Auth")]
         public string UserName { get; set; }
 
+        [Obsolete(OBSOLETE_MESSAGE)]
         [LogMasked(Text = "[REDACTED]")]
-        [Option('p', "password", HelpText = "The password to access Version Control System with.", Required = true, SetName = "Basic Auth")]
+        [Option('p', "password", HelpText = "(DEPRECATED) The password to access Version Control System with.", Required = true, SetName = "Basic Auth")]
         public string Password { get; set; }
 
         [LogMasked(Text = "[REDACTED]")]

Source/GitReleaseManager.Cli/Program.cs

@@ -42,6 +42,7 @@ private static async Task<int> Main(string[] args)
                     .WithParsed<BaseSubOptions>(LogConfiguration.ConfigureLogging)
                     .WithParsed<BaseSubOptions>(CreateFiglet)
                     .WithParsed<BaseSubOptions>(LogOptions)
+                    .WithParsed<BaseVcsOptions>(ReportUsernamePasswordDeprecation)
                     .MapResult(
                     (CreateSubOptions opts) => CreateReleaseAsync(opts),
                     (DiscardSubOptions opts) => DiscardReleaseAsync(opts),
@@ -76,6 +77,14 @@ private static async Task<int> Main(string[] args)
             }
         }
 
+        private static void ReportUsernamePasswordDeprecation(BaseVcsOptions options)
+        {
+            if (!string.IsNullOrEmpty(options.UserName) || !string.IsNullOrEmpty(options.Password))
+            {
+                Log.Warning(BaseVcsOptions.OBSOLETE_MESSAGE);
+            }
+        }
+
         private static void CreateFiglet(BaseSubOptions options)
         {
             if (options.NoLogo)

Source/GitReleaseManager/GitHubProvider.cs

@@ -33,13 +33,21 @@ public class GitHubProvider : IVcsProvider
         private readonly IMapper _mapper;
         private GitHubClient _gitHubClient;
 
+        [Obsolete("Use overload with token only instead")]
         public GitHubProvider(IMapper mapper, Config configuration, string userName, string password, string token)
         {
             _mapper = mapper;
             _configuration = configuration;
             CreateClient(userName, password, token);
         }
 
+        public GitHubProvider(IMapper mapper, Config configuration, string token)
+        {
+            _mapper = mapper;
+            _configuration = configuration;
+            CreateClient(token);
+        }
+
         public Task<int> GetNumberOfCommitsBetween(Milestone previousMilestone, Milestone currentMilestone, string user, string repository)
         {
             if (currentMilestone is null)
@@ -95,6 +103,7 @@ public async Task<ReadOnlyCollection<Milestone>> GetReadOnlyMilestonesAsync(stri
             return new ReadOnlyCollection<Milestone>(_mapper.Map<List<Milestone>>(closed.Concat(open).ToList()));
         }
 
+        [Obsolete("Use overload with token only instead")]
         public void CreateClient(string userName, string password, string token)
         {
             var credentials = string.IsNullOrWhiteSpace(token)
@@ -105,6 +114,13 @@ public void CreateClient(string userName, string password, string token)
             _gitHubClient = github;
         }
 
+        public void CreateClient(string token)
+        {
+            var credentials = new Credentials(token);
+            var github = new GitHubClient(new ProductHeaderValue("GitReleaseManager")) { Credentials = credentials };
+            _gitHubClient = github;
+        }
+
         public string GetCommitsLink(string user, string repository, Milestone milestone, Milestone previousMilestone)
         {
             if (milestone is null)