(GH-21) Began work of including config for labels

- Refactored Options to include base options for LogFilePath, and
TargetPath
- Split other options so milestone isn't expected for all
- Added some additional tests to cover issue not including correct label
- Added configuration options for labels to include and exclude
- Configured logging for Command Line Application

Author: gep13

Source/GitHubReleaseManager.Cli/BaseGitHubSubConfig.cs

@@ -0,0 +1,32 @@
+// <copyright file="BaseGitHubSubConfig.cs" company="gep13">
+//     Copyright (c) gep13. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace GitHubReleaseManager.Cli
+{
+    using CommandLine;
+    using Octokit;
+
+    public abstract class BaseGitHubSubConfig : BaseSubOptions
+    {
+        [Option('u', "username", HelpText = "The username to access GitHub with.", Required = true)]
+        public string UserName { get; set; }
+
+        [Option('p', "password", HelpText = "The password to access GitHub with.", Required = true)]
+        public string Password { get; set; }
+
+        [Option('o', "owner", HelpText = "The owner of the repository.", Required = true)]
+        public string RepositoryOwner { get; set; }
+
+        [Option('r', "repository", HelpText = "The name of the repository.", Required = true)]
+        public string RepositoryName { get; set; }
+
+        public GitHubClient CreateGitHubClient()
+        {
+            var creds = new Credentials(this.UserName, this.Password);
+            var github = new GitHubClient(new ProductHeaderValue("GitHubReleaseManager")) { Credentials = creds };
+            return github;
+        }
+    }
+}

Source/GitHubReleaseManager.Cli/BaseSubOptions.cs

@@ -0,0 +1,19 @@
+//-----------------------------------------------------------------------
+// <copyright file="BaseSubOptions.cs" company="gep13">
+//     Copyright (c) gep13. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace GitHubReleaseManager.Cli
+{
+    using CommandLine;
+
+    public abstract class BaseSubOptions
+    {
+        [Option('t', "targetPath", HelpText = "The directory on which GitHubReleaseManager should be executed. Defaults to current directory.", Required = false)]
+        public string TargetPath { get; set; }
+
+        [Option('l', "logFilePath", HelpText = "Path to where log file should be created. Defaults to logging to console.", Required = false)]
+        public string LogFilePath { get; set; }
+    }
+}

Source/GitHubReleaseManager.Cli/CommonSubOptions.cs

@@ -7,26 +7,10 @@
 namespace GitHubReleaseManager.Cli
 {
     using CommandLine;
-    using Octokit;
 
-    public abstract class CommonSubOptions
+    public abstract class CommonSubOptions : BaseGitHubSubConfig
     {
-        [Option('u', "username", HelpText = "The username to access GitHub with.", Required = true)]
-        public string UserName { get; set; }
-        [Option('p', "password", HelpText = "The password to access GitHub with.", Required = true)]
-        public string Password { get; set; }
-        [Option('o', "owner", HelpText = "The owner of the repository.", Required = true)]
-        public string RepositoryOwner { get; set; }
-        [Option('r', "repository", HelpText = "The name of the repository.", Required = true)]
-        public string RepositoryName { get; set; }
         [Option('m', "milestone", HelpText = "The milestone to use.", Required = true)]
         public string Milestone { get; set; }
-
-        public GitHubClient CreateGitHubClient()
-        {
-            var creds = new Credentials(this.UserName, this.Password);
-            var github = new GitHubClient(new ProductHeaderValue("GitHubReleaseManager")) { Credentials = creds };
-            return github;
-        }
     }
 }

Source/GitHubReleaseManager.Cli/ExportSubOptions.cs

@@ -8,7 +8,7 @@ namespace GitHubReleaseManager.Cli
 {
     using CommandLine;
 
-    public class ExportSubOptions : CommonSubOptions
+    public class ExportSubOptions : BaseGitHubSubConfig
     {
         [Option('f', "fileOutputPath", HelpText = "Path to the file export releases.", Required = true)]
         public string FileOutputPath { get; set; }

Source/GitHubReleaseManager.Cli/GitHubReleaseManager.Cli.csproj

@@ -75,6 +75,8 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="AssemblyInfo.cs" />
+    <Compile Include="BaseGitHubSubConfig.cs" />
+    <Compile Include="BaseSubOptions.cs" />
     <Compile Include="CloseSubOptions.cs" />
     <Compile Include="CommonSubOptions.cs" />
     <Compile Include="CreateSubOptions.cs" />

Source/GitHubReleaseManager.Cli/InitSubOptions.cs

@@ -6,7 +6,15 @@
 
 namespace GitHubReleaseManager.Cli
 {
-    public class InitSubOptions
+    using CommandLine;
+    using CommandLine.Text;
+
+    public class InitSubOptions : BaseSubOptions
     {
+        [HelpVerbOption]
+        public string GetUsage(string verb)
+        {
+            return HelpText.AutoBuild(this, verb);
+        }
     }
 }

Source/GitHubReleaseManager.Cli/Program.cs

@@ -7,8 +7,11 @@
 namespace GitHubReleaseManager.Cli
 {
     using System;
+    using System.Collections.Generic;
+    using System.Globalization;
     using System.IO;
     using System.Linq;
+    using System.Text;
     using System.Threading.Tasks;
     using CommandLine;
     using GitHubReleaseManager.Configuration;
@@ -18,6 +21,8 @@ namespace GitHubReleaseManager.Cli
 
     public static class Program
     {
+        private static StringBuilder log = new StringBuilder();
+
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Not required")]
         private static int Main(string[] args)
         {
@@ -30,13 +35,21 @@ private static int Main(string[] args)
                 options,
                 (verb, subOptions) =>
                     {
+                        if (subOptions != null)
+                        {
+                            if (string.IsNullOrEmpty(((BaseSubOptions)subOptions).TargetPath))
+                            {
+                                ((BaseSubOptions)subOptions).TargetPath = Environment.CurrentDirectory;
+                            }
+
+                            ConfigureLogging(((BaseSubOptions)subOptions).LogFilePath);
+                        }
+
                         var fileSystem = new FileSystem();
-                        var currentFilePath = System.Reflection.Assembly.GetExecutingAssembly().Location;
-                        var currentDirectory = Path.GetDirectoryName(currentFilePath);
 
                         if (verb == "create")
                         {
-                            result = CreateReleaseAsync((CreateSubOptions)subOptions).Result;
+                            result = CreateReleaseAsync((CreateSubOptions)subOptions, fileSystem).Result;
                         }
 
                         if (verb == "close")
@@ -56,13 +69,13 @@ private static int Main(string[] args)
 
                         if (verb == "init")
                         {
-                            ConfigurationProvider.WriteSample(currentDirectory, fileSystem);
+                            ConfigurationProvider.WriteSample(((InitSubOptions)subOptions).TargetPath, fileSystem);
                             result = 0;
                         }
 
                         if (verb == "showconfig")
                         {
-                            Console.WriteLine(ConfigurationProvider.GetEffectiveConfigAsString(currentDirectory, fileSystem));
+                            Console.WriteLine(ConfigurationProvider.GetEffectiveConfigAsString(((ShowConfigSubOptions)subOptions).TargetPath, fileSystem));
                             result = 0;
                         }
                     }))
@@ -73,13 +86,14 @@ private static int Main(string[] args)
             return result;
         }
 
-        private static async Task<int> CreateReleaseAsync(CreateSubOptions options)
+        private static async Task<int> CreateReleaseAsync(CreateSubOptions subOptions, IFileSystem fileSystem)
         {
             try
             {
-                var github = options.CreateGitHubClient();
+                var github = subOptions.CreateGitHubClient();
+                var configuration = ConfigurationProvider.Provide(subOptions.TargetPath, fileSystem);
 
-                await CreateRelease(github, options.RepositoryOwner, options.RepositoryName, options.Milestone, options.TargetCommitish, options.AssetPath);
+                await CreateRelease(github, subOptions.RepositoryOwner, subOptions.RepositoryName, subOptions.Milestone, subOptions.TargetCommitish, subOptions.AssetPath, configuration);
 
                 return 0;
             }
@@ -91,13 +105,13 @@ private static async Task<int> CreateReleaseAsync(CreateSubOptions options)
             }
         }
 
-        private static async Task<int> CloseMilestoneAsync(CloseSubOptions options)
+        private static async Task<int> CloseMilestoneAsync(CloseSubOptions subOptions)
         {
             try
             {
-                var github = options.CreateGitHubClient();
+                var github = subOptions.CreateGitHubClient();
 
-                await CloseMilestone(github, options.RepositoryOwner, options.RepositoryName, options.Milestone);
+                await CloseMilestone(github, subOptions.RepositoryOwner, subOptions.RepositoryName, subOptions.Milestone);
 
                 return 0;
             }
@@ -109,15 +123,15 @@ private static async Task<int> CloseMilestoneAsync(CloseSubOptions options)
             }
         }
 
-        private static async Task<int> CloseAndPublishReleaseAsync(PublishSubOptions options)
+        private static async Task<int> CloseAndPublishReleaseAsync(PublishSubOptions subOptions)
         {
             try
             {
-                var github = options.CreateGitHubClient();
+                var github = subOptions.CreateGitHubClient();
 
-                await CloseMilestone(github, options.RepositoryOwner, options.RepositoryName, options.Milestone);
+                await CloseMilestone(github, subOptions.RepositoryOwner, subOptions.RepositoryName, subOptions.Milestone);
 
-                await PublishRelease(github, options.RepositoryOwner, options.RepositoryName, options.Milestone);
+                await PublishRelease(github, subOptions.RepositoryOwner, subOptions.RepositoryName, subOptions.Milestone);
 
                 return 0;
             }
@@ -129,15 +143,15 @@ private static async Task<int> CloseAndPublishReleaseAsync(PublishSubOptions opt
             }
         }
 
-        private static async Task<int> ExportReleasesAsync(ExportSubOptions options)
+        private static async Task<int> ExportReleasesAsync(ExportSubOptions subOptions)
         {
             try
             {
-                var github = options.CreateGitHubClient();
+                var github = subOptions.CreateGitHubClient();
 
-                var releasesMarkdown = await ExportReleases(github, options.RepositoryOwner, options.RepositoryName);
+                var releasesMarkdown = await ExportReleases(github, subOptions.RepositoryOwner, subOptions.RepositoryName);
 
-                using (var sw = new StreamWriter(File.Open(options.FileOutputPath, FileMode.OpenOrCreate)))
+                using (var sw = new StreamWriter(File.Open(subOptions.FileOutputPath, FileMode.OpenOrCreate)))
                 {
                     sw.Write(releasesMarkdown);
                 }
@@ -152,9 +166,9 @@ private static async Task<int> ExportReleasesAsync(ExportSubOptions options)
             }
         }
 
-        private static async Task CreateRelease(GitHubClient github, string owner, string repository, string milestone, string targetCommitish, string asset)
+        private static async Task CreateRelease(GitHubClient github, string owner, string repository, string milestone, string targetCommitish, string asset, Config configuration)
         {
-            var releaseNotesBuilder = new ReleaseNotesBuilder(new DefaultGitHubClient(github, owner, repository), owner, repository, milestone);
+            var releaseNotesBuilder = new ReleaseNotesBuilder(new DefaultGitHubClient(github, owner, repository), owner, repository, milestone, configuration);
 
             var result = await releaseNotesBuilder.BuildReleaseNotes();
 
@@ -219,5 +233,48 @@ private static async Task PublishRelease(GitHubClient github, string owner, stri
 
             await github.Release.Edit(owner, repository, release.Id, releaseUpdate);
         }
+
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "This is required here")]
+        private static void ConfigureLogging(string logFilePath)
+        {
+            var writeActions = new List<Action<string>>
+            {
+                s => log.AppendLine(s)
+            };
+
+            if (logFilePath == "console")
+            {
+                writeActions.Add(Console.WriteLine);
+            }
+            else if (!string.IsNullOrEmpty(logFilePath))
+            {
+                try
+                {
+                    Directory.CreateDirectory(Path.GetDirectoryName(logFilePath));
+                    if (File.Exists(logFilePath))
+                    {
+                        using (File.CreateText(logFilePath))
+                        {
+                        }
+                    }
+
+                    writeActions.Add(x => WriteLogEntry(logFilePath, x));
+                }
+                catch (Exception ex)
+                {
+                    Console.WriteLine("Failed to configure logging: " + ex.Message);
+                }
+            }
+
+            Logger.WriteInfo = s => writeActions.ForEach(a => a(s));
+            Logger.WriteWarning = s => writeActions.ForEach(a => a(s));
+            Logger.WriteError = s => writeActions.ForEach(a => a(s));
+        }
+
+        private static void WriteLogEntry(string logFilePath, string s)
+        {
+            var contents = string.Format(CultureInfo.InvariantCulture, "{0}\t\t{1}\r\n", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss", CultureInfo.InvariantCulture), s);
+            File.AppendAllText(logFilePath, contents);
+        }
     }
 }

Source/GitHubReleaseManager.Cli/ShowConfigSubOptions.cs

@@ -6,7 +6,7 @@
 
 namespace GitHubReleaseManager.Cli
 {
-    public class ShowConfigSubOptions
+    public class ShowConfigSubOptions : BaseSubOptions
     {
     }
 }

Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderIntegrationTests.cs

@@ -6,8 +6,12 @@
 
 namespace GitHubReleaseManager.Tests
 {
+    using System;
     using System.Diagnostics;
     using GitHubReleaseManager;
+    using GitHubReleaseManager.Configuration;
+    using GitHubReleaseManager.Helpers;
+
     using NUnit.Framework;
 
     [TestFixture]
@@ -18,8 +22,11 @@ public class ReleaseNotesBuilderIntegrationTests
         public async void SingleMilestone()
         {
             var gitHubClient = ClientBuilder.Build();
+            var fileSystem = new FileSystem();
+            var currentDirectory = Environment.CurrentDirectory;
+            var configuration = ConfigurationProvider.Provide(currentDirectory, fileSystem);
 
-            var releaseNotesBuilder = new ReleaseNotesBuilder(new DefaultGitHubClient(gitHubClient, "Particular", "NServiceBus"), "Particular", "NServiceBus", "5.1.0");
+            var releaseNotesBuilder = new ReleaseNotesBuilder(new DefaultGitHubClient(gitHubClient, "Particular", "NServiceBus"), "Particular", "NServiceBus", "5.1.0", configuration);
             var result = await releaseNotesBuilder.BuildReleaseNotes();
             Debug.WriteLine(result);
             ClipBoardHelper.SetClipboard(result);
@@ -30,8 +37,11 @@ public async void SingleMilestone()
         public async void SingleMilestone3()
         {
             var gitHubClient = ClientBuilder.Build();
+            var fileSystem = new FileSystem();
+            var currentDirectory = Environment.CurrentDirectory;
+            var configuration = ConfigurationProvider.Provide(currentDirectory, fileSystem);
 
-            var releaseNotesBuilder = new ReleaseNotesBuilder(new DefaultGitHubClient(gitHubClient, "Particular", "ServiceControl"), "Particular", "ServiceControl", "1.0.0-Beta4");
+            var releaseNotesBuilder = new ReleaseNotesBuilder(new DefaultGitHubClient(gitHubClient, "Particular", "ServiceControl"), "Particular", "ServiceControl", "1.0.0-Beta4", configuration);
             var result = await releaseNotesBuilder.BuildReleaseNotes();
             Debug.WriteLine(result);
             ClipBoardHelper.SetClipboard(result);

Source/GitHubReleaseManager.Tests/ReleaseNotesBuilderTests.NoCommitsSomeIssues.approved.txt

@@ -1,6 +1,10 @@
 As part of this release we had [3 issues](https://github.com/FakeRepo/issues/issues?milestone=0&state=closed) closed.
 
 
+__Bug__
+
+- [__#1__](http://example.com/1) Issue 1
+
 __Feature__
 
 - [__#2__](http://example.com/2) Issue 2
@@ -9,9 +13,5 @@ __Improvement__
 
 - [__#3__](http://example.com/3) Issue 3
 
-__Bug__
-
-- [__#1__](http://example.com/1) Issue 1
-
 ### Where to get it
 You can download this release from [chocolatey](https://chocolatey.org/packages/ChocolateyGUI/1.2.3)