Merge pull request #219 from datalust/dev

2021.4.x Release

Author: nblumhardt

Build.Docker.ps1

@@ -2,7 +2,7 @@ $IsCIBuild = $null -ne $env:APPVEYOR_BUILD_NUMBER
 $IsPublishedBuild = ($env:APPVEYOR_REPO_BRANCH -eq "main" -or $env:APPVEYOR_REPO_BRANCH -eq "dev") -and $null -eq $env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH
 
 $version = @{ $true = $env:APPVEYOR_BUILD_VERSION; $false = "99.99.99" }[$env:APPVEYOR_BUILD_VERSION -ne $NULL];
-$framework = "net5.0"
+$framework = "net6.0"
 $rid = "linux-x64"
 $tag = "datalust/seqcli-ci:$version"
 
@@ -14,7 +14,11 @@ function Execute-Tests
     cd ./test/SeqCli.EndToEnd/
     docker pull datalust/seq:latest
     & dotnet run -f $framework -- --docker-server
-    if ($LASTEXITCODE -ne 0) { exit 1 }
+    if ($LASTEXITCODE -ne 0)
+    { 
+        cd ../..
+        exit 1 
+    }
     cd ../..
 }
 

Build.ps1

@@ -1,6 +1,6 @@
 $ErrorActionPreference = 'Stop'
 
-$framework = 'net5.0'
+$framework = 'net6.0'
 $windowsTfmSuffix = '-windows'
 
 function Clean-Output

README.md

@@ -6,7 +6,7 @@ The [Seq](https://datalust.co/seq) client command-line app. Supports logging (`s
 
 ## Getting started
 
-Install or unzip the [release for your operating system](https://github.com/datalust/seqcli/releases). Or, if you have `dotnet` installed, `seqcli` can be installed as a global tool using:
+The Seq installer for Windows includes `seqcli`. Otherwise, download the [release for your operating system](https://github.com/datalust/seqcli/releases). Or, if you have `dotnet` installed, `seqcli` can be installed as a global tool using:
 
 ```
 dotnet tool install --global seqcli
@@ -27,6 +27,8 @@ The API key will be stored in your `SeqCli.json` configuration file; on Windows,
 docker run --rm datalust/seqcli:latest <command> [<args>]
 ```
 
+To connect to Seq in a docker container on the local machine use the machine's IP address (not localhost) or specify [docker host networking](https://docs.docker.com/network/host/) with `--net host`.
+
 Use Docker networks and volumes to make local files and other containers accessible to `seqcli` within its container.
 
 ## Commands
@@ -152,7 +154,7 @@ seqcli apikey create -t 'Test API Key' -p Environment=Test
 |       `--filter=VALUE` | A filter to apply to incoming events |
 |       `--minimum-level=VALUE` | The minimum event level/severity to accept; the default is to accept all events |
 |       `--use-server-timestamps` | Discard client-supplied timestamps and use server clock values |
-|       `--permissions=VALUE` | The permissions to delegate to the API key; the default is `Ingest` |
+|       `--permissions=VALUE` | A comma-separated list of permissions to delegate to the API key; valid permissions are `Ingest` (default), `Read`, `Setup`, and `Write` |
 |       `--connect-username=VALUE` | A username to connect with, useful primarily when setting up the first API key |
 |       `--connect-password=VALUE` | When `connect-username` is specified, a corresponding password |
 |       `--connect-password-stdin` | When `connect-username` is specified, read the corresponding password from `STDIN` |
@@ -459,7 +461,7 @@ Begin demotion of the current leader node.
 Example:
 
 ```
-seqcli node demote -v --wait
+seqcli node demote --verbose --wait
 ```
 
 | Option | Description |
@@ -740,6 +742,7 @@ seqcli signal create -t 'Exceptions' -f "@Exception is not null"
 | `-t`, `--title=VALUE` | A title for the signal |
 |       `--description=VALUE` | A description for the signal |
 | `-f`, `--filter=VALUE` | Filter to associate with the signal |
+| `-c`, `--column=VALUE` | Column to associate with the signal; this argument can be used multiple times |
 |       `--group=VALUE` | An explicit group name to associate with the signal; the default is to infer the group from the filter |
 |       `--no-group` | Specify that no group should be inferred; the default is to infer the group from the filter |
 |       `--protected` | Specify that the signal is editable only by administrators |

appveyor.yml

@@ -1,7 +1,7 @@
-version: 2021.3.{build}
+version: 2021.4.{build}
 skip_tags: true
 image:
-- Visual Studio 2019
+- Visual Studio 2022
 - Ubuntu1804
 environment:
   DOCKER_TOKEN:
@@ -19,13 +19,13 @@ for:
 -
   matrix:
     only:
-      - image: Visual Studio 2019
+      - image: Visual Studio 2022
 
   install:
-  - ps: ./Setup.ps1
+  - pwsh: ./Setup.ps1
 
   build_script:
-    - ps: ./Build.ps1 -shortver "$($env:APPVEYOR_BUILD_VERSION)"
+    - pwsh: ./Build.ps1 -shortver "$($env:APPVEYOR_BUILD_VERSION)"
 
   deploy:
 
@@ -53,4 +53,4 @@ for:
   - ./setup.sh
 
   build_script:
-  - ps: $env:PATH = "$env:HOME/.dotnetcli:$env:PATH"; ./Build.Docker.ps1 -shortver "$($env:APPVEYOR_BUILD_VERSION)"
+  - pwsh: $env:PATH = "$env:HOME/.dotnetcli:$env:PATH"; ./Build.Docker.ps1 -shortver "$($env:APPVEYOR_BUILD_VERSION)"

dockerfiles/seqcli/Dockerfile

@@ -1,24 +1,22 @@
 # based on: https://github.com/dotnet/dotnet-docker/blob/master/2.0/runtime-deps/jessie/amd64/Dockerfile
 
-FROM ubuntu:18.04
+FROM ubuntu:20.04
 
 RUN apt-get update \
     && apt-get install -y --no-install-recommends \
         ca-certificates \
-        liblmdb-dev \
         libc6 \
         libgcc1 \
         libgssapi-krb5-2 \
-        libicu60 \
+        libicu66 \
         liblttng-ust0 \
-        libssl1.0.0 \
+        libssl1.1 \
         libstdc++6 \
         zlib1g \
 && rm -rf /var/lib/apt/lists/*
 
-COPY dockerfiles/seqcli/run.sh /run.sh
-COPY src/SeqCli/bin/Release/net5.0/linux-x64/publish /bin/seqcli
+COPY src/SeqCli/bin/Release/net6.0/linux-x64/publish /bin/seqcli
 
-ENTRYPOINT ["/run.sh"]
+ENTRYPOINT ["/bin/seqcli/seqcli"]
 
 LABEL Description="seqcli" Vendor="Datalust Pty Ltd"

dockerfiles/seqcli/run.sh

@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "5.0.400"
+    "version": "6.0.100"
   }
 }

global.json

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>net5.0</TargetFramework>
+        <TargetFramework>net6.0</TargetFramework>
         <Nullable>enable</Nullable>
     </PropertyGroup>
 

src/Roastery/Roastery.csproj

@@ -12,20 +12,41 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#nullable enable
+
 using System.Collections.Generic;
+using Newtonsoft.Json;
 
 namespace SeqCli.Apps.Definitions
 {
     // ReSharper disable all
     class AppDefinition
     {
+        public AppDefinition(string name)
+        {
+            Name = name;
+        }
+        
         public string Name { get; set; }
-        public string Description { get; set; }
+ 
+        [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public string? Description { get; set; }
+
+        [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
         public bool AllowReprocessing { get; set; }
-        public string Executable { get; set; }
-        public string Arguments { get; set; }
+        
+        [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public string? Executable { get; set; }
+        
+        [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public string? Arguments { get; set; }
+        
         public List<string> Capabilities { get; set; } = new List<string>();
-        public Dictionary<string, AppPlatformDefinition> Platform { get; set; }
-        public Dictionary<string, AppSettingDefinition> Settings { get; set; }
+        
+        [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public Dictionary<string, AppPlatformDefinition>? Platform { get; set; }
+        
+        [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public Dictionary<string, AppSettingDefinition>? Settings { get; set; }
     }
 }

src/SeqCli/Apps/Definitions/AppDefinition.cs

@@ -19,6 +19,8 @@
 using System.Reflection;
 using Seq.Apps;
 
+#nullable  enable
+
 namespace SeqCli.Apps.Definitions
 {
     static class AppMetadataReader
@@ -31,16 +33,15 @@ public static AppDefinition ReadFromSeqAppType(Type seqAppType)
             if (declared == null)
                 throw new ArgumentException($"The provided type '{seqAppType}' is not marked with [SeqApp].");
 
-            var app = new AppDefinition
+            var app = new AppDefinition(declared.Name)
             {
-                Name = declared.Name,
                 Description = declared.Description,
                 AllowReprocessing = declared.AllowReprocessing,
                 Settings = GetAvailableSettings(seqAppType),
                 Capabilities = GetCapabilities(seqAppType),
                 Platform = new Dictionary<string, AppPlatformDefinition>
                 {
-                    ["hosted-dotnet"] = new AppPlatformDefinition
+                    ["hosted-dotnet"] = new()
                     {
                         SeqAppTypeName = seqAppType.FullName
                     }
@@ -68,29 +69,30 @@ static Dictionary<string, AppSettingDefinition> GetAvailableSettings(Type mainRe
                     p => p.pi.Name,
                     p => new AppSettingDefinition
                     {
-                        DisplayName = p.attr!.DisplayName,
+                        DisplayName = Normalize(p.attr!.DisplayName),
                         IsOptional = p.attr.IsOptional,
-                        HelpText = p.attr.HelpText,
+                        HelpText = Normalize(p.attr.HelpText),
                         InputType = p.attr.InputType == SettingInputType.Unspecified ?
                             GetSettingType(p.pi.PropertyType) :
                             (AppSettingType)Enum.Parse(typeof(AppSettingType), p.attr.InputType.ToString()),
                         IsInvocationParameter = p.attr.IsInvocationParameter,
-                        AllowedValues = TryGetAllowedValues(p.pi.PropertyType)
+                        AllowedValues = TryGetAllowedValues(p.pi.PropertyType),
+                        Syntax = Normalize(p.attr.Syntax)
                     });
         }
 
-        static readonly HashSet<Type> IntegerTypes = new HashSet<Type>
+        static readonly HashSet<Type> IntegerTypes = new()
         {
             typeof(short), typeof(ushort), typeof(int), typeof(uint),
             typeof(long), typeof(ulong)
         };
 
-        static readonly HashSet<Type> DecimalTypes = new HashSet<Type>
+        static readonly HashSet<Type> DecimalTypes = new()
         {
             typeof(float), typeof(double), typeof(decimal)
         };
 
-        static readonly HashSet<Type> BooleanTypes = new HashSet<Type>
+        static readonly HashSet<Type> BooleanTypes = new()
         {
             typeof(bool)
         };
@@ -114,7 +116,7 @@ internal static AppSettingType GetSettingType(Type type)
             return AppSettingType.Text;
         }
 
-        internal static AppSettingValue[] TryGetAllowedValues(Type type)
+        internal static AppSettingValue[]? TryGetAllowedValues(Type type)
         {
             var targetType = Nullable.GetUnderlyingType(type) ?? type;
 
@@ -130,5 +132,10 @@ from name in Enum.GetNames(targetType)
 
             return values.ToArray();
         }
+
+        static string? Normalize(string? s)
+        {
+            return string.IsNullOrWhiteSpace(s) ? null : s;
+        }
     }
 }