Merge pull request #123 from datalust/dev

5.1 Maintenance Release
datalust · Sep 28, 2019 · 272f0dc · 272f0dc
2 parents fb74157 + a36a223
commit 272f0dc
Show file tree

Hide file tree

Showing 16 changed files with 299 additions and 41 deletions.
diff --git a/docker-publish.ps1 b/docker-publish.ps1
@@ -0,0 +1,28 @@
+param (
+  [Parameter(Mandatory=$true)]
+  [string] $version
+)
+
+$versionParts = $version.Split('.')
+
+$major = $versionParts[0]
+$minor = $versionParts[1]
+
+$baseImage = "datalust/seqcli-ci:$version"
+$publishImages = "datalust/seqcli:latest", "datalust/seqcli:$major", "datalust/seqcli:$major.$minor", "datalust/seqcli:$version"
+
+$choices  = "&Yes", "&No"
+$decision = $Host.UI.PromptForChoice("Publishing ($baseImage) as ($publishImages)", "Does this look right?", $choices, 1)
+if ($decision -eq 0) {
+    foreach ($publishImage in $publishImages) {
+        Write-Host "Publishing $publishImage"
+
+        docker tag $baseImage $publishImage
+        if ($LASTEXITCODE) { exit 1 }
+
+        docker push $publishImage
+        if ($LASTEXITCODE) { exit 1 }
+    }
+} else {
+    Write-Host "Cancelled"
+}
diff --git a/seqcli.sln.DotSettings b/seqcli.sln.DotSettings
@@ -1,5 +1,15 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=apikey/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Camelize/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=cmds/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=command_0027s/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Datalust/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=hackily/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=mdash/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=seqcli/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Serilog/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=serilogdt/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=STDIN/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=syslogdt/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=trailingindent/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=trailingindent/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=unawaited/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
diff --git a/src/SeqCli/Cli/Commands/ConfigCommand.cs b/src/SeqCli/Cli/Commands/ConfigCommand.cs
@@ -1,4 +1,4 @@
-// Copyright 2018 Datalust Pty Ltd
+// Copyright 2018-2019 Datalust Pty Ltd
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -13,11 +13,13 @@
 // limitations under the License.
 
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
 using System.Threading.Tasks;
 using SeqCli.Config;
+using SeqCli.Util;
 using Serilog;
 
 namespace SeqCli.Cli.Commands
@@ -37,6 +39,8 @@ public ConfigCommand()
 
         protected override Task<int> Run()
         {
+            var verb = "read";
+
             try
             {
                 var config = SeqCliConfig.Read();
@@ -45,11 +49,13 @@ protected override Task<int> Run()
                 {
                     if (_clear)
                     {
+                        verb = "clear";
                         Clear(config, _key);
                         SeqCliConfig.Write(config);
                     }
                     else if (_value != null)
                     {
+                        verb = "update";
                         Set(config, _key, _value);
                         SeqCliConfig.Write(config);
                     }
@@ -67,7 +73,7 @@ protected override Task<int> Run()
             }
             catch (Exception ex)
             {
-                Log.Fatal(ex, "Could not update config: {ErrorMessage}", ex.Message);
+                Log.Error(ex, "Could not {Verb} config: {ErrorMessage}", verb, Presentation.FormattedMessage(ex));
                 return Task.FromResult(1);
             }
         }
@@ -94,20 +100,25 @@ static void Set(SeqCliConfig config, string key, string value)
                 throw new ArgumentException("The format of the key is incorrect; run the command without any arguments to view all keys.");
 
             var first = config.GetType().GetTypeInfo().DeclaredProperties
-                .Where(p => p.GetMethod.IsPublic && !p.GetMethod.IsStatic)
+                .Where(p => p.CanRead && p.GetMethod.IsPublic && !p.GetMethod.IsStatic)
                 .SingleOrDefault(p => Camelize(p.Name) == steps[0]);
 
             if (first == null)
                 throw new ArgumentException("The key could not be found; run the command without any arguments to view all keys.");
 
             var v = first.GetValue(config);
+            if (v is Dictionary<string, SeqCliConnectionConfig>)
+                throw new NotSupportedException("Use `seqcli profile create` to configure connection profiles.");
 
             var second = v.GetType().GetTypeInfo().DeclaredProperties
-                .Where(p => p.GetMethod.IsPublic && p.SetMethod.IsPublic && !p.GetMethod.IsStatic)
+                .Where(p => p.CanRead && p.GetMethod.IsPublic && !p.GetMethod.IsStatic)
                 .SingleOrDefault(p => Camelize(p.Name) == steps[1]);
 
             if (second == null)
                 throw new ArgumentException("The key could not be found; run the command without any arguments to view all keys.");
+
+            if (!second.SetMethod.IsPublic)
+                throw new ArgumentException("The value is not writeable.");
 
             var targetValue = Convert.ChangeType(value, second.PropertyType);
             second.SetValue(v, targetValue);
@@ -120,37 +131,53 @@ static void Clear(SeqCliConfig config, string key)
 
         static void List(SeqCliConfig config)
         {
-            foreach (var pr in ReadPairs(config))
+            foreach (var (key, value) in ReadPairs(config))
             {
-                Console.WriteLine($"{pr.Key}:");
-                Console.WriteLine($"  {pr.Value}");
+                Console.WriteLine($"{key}:");
+                Console.WriteLine($"  {value}");
             }
         }
 
         static IEnumerable<KeyValuePair<string, object>> ReadPairs(object config)
         {
-            foreach (var first in config.GetType().GetTypeInfo().DeclaredProperties
-                .Where(p => p.GetMethod.IsPublic && !p.GetMethod.IsStatic)
+            foreach (var property in config.GetType().GetTypeInfo().DeclaredProperties
+                .Where(p => p.CanRead && p.GetMethod.IsPublic && !p.GetMethod.IsStatic && !p.Name.StartsWith("Encoded"))
                 .OrderBy(p => p.Name))
             {
-                var step1 = Camelize(first.Name) + ".";
-                var v = first.GetValue(config);
+                var propertyName = Camelize(property.Name);
+                var propertyValue = property.GetValue(config);
 
-                foreach (var second in v.GetType().GetTypeInfo().DeclaredProperties
-                    .Where(p => p.GetMethod.IsPublic && p.SetMethod.IsPublic && !p.GetMethod.IsStatic && !p.Name.StartsWith("Encoded"))
-                    .OrderBy(p => p.Name))
+                if (propertyValue is IDictionary dict)
                 {
-                    var name = step1 + Camelize(second.Name);
-                    var v2 = second.GetValue(v);
-                    yield return new KeyValuePair<string, object>(name, v2);
+                    foreach (var elementKey in dict.Keys)
+                    {
+                        foreach (var elementPair in ReadPairs(dict[elementKey]))
+                        {
+                            yield return new KeyValuePair<string, object>(
+                                $"{propertyName}[{elementKey}].{elementPair.Key}",
+                                elementPair.Value);
+                        }
+                    }
+                }
+                else if (propertyValue?.GetType().Namespace?.StartsWith("SeqCli.Config") ?? false)
+                {
+                    foreach (var childPair in ReadPairs(propertyValue))
+                    {
+                        var name = propertyName + "." + childPair.Key;
+                        yield return new KeyValuePair<string, object>(name, childPair.Value);
+                    }
+                }
+                else
+                {
+                    yield return new KeyValuePair<string, object>(propertyName, propertyValue);
                 }
             }
         }
 
         static string Camelize(string s)
         {
             if (s.Length < 2)
-                throw new NotImplementedException("No camel-case support for short names");
+                throw new NotSupportedException("No camel-case support for short names");
             return char.ToLowerInvariant(s[0]) + s.Substring(1);
         }
     }

diff --git a/src/SeqCli/Cli/Commands/HelpCommand.cs b/src/SeqCli/Cli/Commands/HelpCommand.cs
@@ -36,6 +36,7 @@ public HelpCommand(IEnumerable<Meta<Lazy<Command>, CommandMetadata>> availableCo
         protected override Task<int> Run(string[] unrecognised)
         {
             var ea = Assembly.GetEntryAssembly();
+            // ReSharper disable once PossibleNullReferenceException
             var name = ea.GetName().Name;
 
             if (_markdown)
@@ -61,8 +62,8 @@ protected override Task<int> Run(string[] unrecognised)
                 {
                     var cmd = cmds.Single();
                     var argHelp = cmd.Value.Value.HasArgs ? " [<args>]" : "";
-                    var subcommandHelp = subCommand == null ? "" : " " + subCommand;
-                    Console.WriteLine(name + " " + cmd.Metadata.Name + subcommandHelp + argHelp);
+                    var subCommandHelp = subCommand == null ? "" : " " + subCommand;
+                    Console.WriteLine(name + " " + cmd.Metadata.Name + subCommandHelp + argHelp);
                     Console.WriteLine();
                     Console.WriteLine(cmd.Metadata.HelpText);
                     Console.WriteLine();
@@ -93,7 +94,7 @@ void PrintMarkdownHelp(string executableName)
             Console.WriteLine("Available commands:");
             Console.WriteLine();
 
-            foreach (var cmd in _availableCommands.GroupBy(cmd => cmd.Metadata.Name))
+            foreach (var cmd in _availableCommands.GroupBy(cmd => cmd.Metadata.Name).OrderBy(c => c.Key))
             {
                 if (cmd.Count() == 1)
                 {
@@ -102,7 +103,7 @@ void PrintMarkdownHelp(string executableName)
                 else
                 {
                     Console.WriteLine($" - `{cmd.Key}`");
-                    foreach (var sub in cmd)
+                    foreach (var sub in cmd.OrderBy(s => s.Metadata.SubCommand))
                     {
                         Console.WriteLine($"   - [`{cmd.Key} {sub.Metadata.SubCommand}`](#{cmd.Key}-{sub.Metadata.SubCommand}) &mdash; {sub.Metadata.HelpText}.");
                     }
@@ -161,7 +162,7 @@ void PrintHelp(string executableName)
             Console.WriteLine("Available commands are:");
 
             var printedGroups = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
-            foreach (var avail in _availableCommands)
+            foreach (var avail in _availableCommands.OrderBy(c => c.Metadata.Name))
             {
                 if (avail.Metadata.SubCommand != null)
                 {
@@ -187,7 +188,7 @@ void PrintHelp(string executableName, string topLevelCommand)
             Console.WriteLine();
             Console.WriteLine("Available sub-commands are:");
 
-            foreach (var avail in _availableCommands.Where(c => c.Metadata.Name == topLevelCommand))
+            foreach (var avail in _availableCommands.Where(c => c.Metadata.Name == topLevelCommand).OrderBy(c => c.Metadata.SubCommand))
             {
                 Printing.Define($"  {avail.Metadata.SubCommand}", avail.Metadata.HelpText, 13, Console.Out);
             }

diff --git a/src/SeqCli/Cli/Commands/Profile/CreateCommand.cs b/src/SeqCli/Cli/Commands/Profile/CreateCommand.cs
@@ -0,0 +1,63 @@
+using System;
+using System.Threading.Tasks;
+using SeqCli.Config;
+using SeqCli.Util;
+using Serilog;
+
+namespace SeqCli.Cli.Commands.Profile
+{
+    [Command("profile", "create", "Create or replace a connection profile",
+        Example = "seqcli profile create -n Production -s https://seq.example.com -a th15ISanAPIk3y")]
+    class CreateCommand : Command
+    {
+        string _url, _apiKey, _name;
+
+        public CreateCommand()
+        {
+            Options.Add("n=|name=",
+                "The name of the connection profile",
+                v => _name = ArgumentString.Normalize(v));
+
+            Options.Add("s=|server=",
+                "The URL of the Seq server",
+                v => _url = ArgumentString.Normalize(v));
+
+            Options.Add("a=|apikey=",
+                "The API key to use when connecting to the server, if required",
+                v => _apiKey = ArgumentString.Normalize(v));
+        }
+
+        protected override Task<int> Run()
+        {
+            return Task.FromResult(RunSync());
+        }
+
+        int RunSync()
+        {
+            if (_name == null)
+            {
+                Log.Error("A profile name is required");
+                return 1;
+            }
+
+            if (_url == null)
+            {
+                Log.Error("A server URL is required");
+                return 1;
+            }
+
+            try
+            {
+                var config = SeqCliConfig.Read();
+                config.Profiles[_name] = new SeqCliConnectionConfig { ServerUrl = _url, ApiKey = _apiKey };
+                SeqCliConfig.Write(config);
+                return 0;
+            }
+            catch (Exception ex)
+            {
+                Log.Error("Could not create profile: {ErrorMessage}", Presentation.FormattedMessage(ex));
+                return 1;
+            }
+        }
+    }
+}
diff --git a/src/SeqCli/Cli/Commands/Profile/ListCommand.cs b/src/SeqCli/Cli/Commands/Profile/ListCommand.cs
@@ -0,0 +1,24 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using SeqCli.Config;
+
+namespace SeqCli.Cli.Commands.Profile
+{
+    [Command("profile", "list", "List connection profiles",
+        Example = "seqcli profile list")]
+    class ListCommand : Command
+    {
+        protected override Task<int> Run()
+        {
+            var config = SeqCliConfig.Read();
+
+            foreach (var profile in config.Profiles.OrderBy(p => p.Key))
+            {
+                Console.WriteLine($"{profile.Key} ({profile.Value.ServerUrl})");
+            }
+
+            return Task.FromResult(0);
+        }
+    }
+}
diff --git a/src/SeqCli/Cli/Commands/Profile/RemoveCommand.cs b/src/SeqCli/Cli/Commands/Profile/RemoveCommand.cs
@@ -0,0 +1,55 @@
+using System;
+using System.Threading.Tasks;
+using SeqCli.Config;
+using SeqCli.Util;
+using Serilog;
+
+namespace SeqCli.Cli.Commands.Profile
+{
+    [Command("profile", "remove", "Remove a connection profile",
+        Example = "seqcli profile remove -n Production")]
+    class RemoveCommand : Command
+    {
+        string _name;
+
+        public RemoveCommand()
+        {
+            Options.Add("n=|name=",
+                "The name of the connection profile to remove",
+                v => _name = ArgumentString.Normalize(v));
+        }
+
+        protected override Task<int> Run()
+        {
+            return Task.FromResult(RunSync());
+        }
+
+        int RunSync()
+        {
+            if (_name == null)
+            {
+                Log.Error("A profile name is required");
+                return 1;
+            }
+
+            try
+            {
+                var config = SeqCliConfig.Read();
+                if (!config.Profiles.Remove(_name))
+                {
+                    Log.Error("No profile with name {ProfileName} was found", _name);
+                    return 1;
+                }
+
+                SeqCliConfig.Write(config);
+
+                return 0;
+            }
+            catch (Exception ex)
+            {
+                Log.Error("Could not create profile: {ErrorMessage}", Presentation.FormattedMessage(ex));
+                return 1;
+            }
+        }
+    }
+}