Merge pull request #279 from datalust/dev

2023.1 Maintenance Release

Author: nblumhardt

Build.Common.ps1

@@ -0,0 +1,12 @@
+function Get-SemVer($shortver)
+{
+    # This script originally (c) 2016 Serilog Contributors - license Apache 2.0
+    $branch = @{ $true = $env:APPVEYOR_REPO_BRANCH; $false = $(git symbolic-ref --short -q HEAD) }[$env:APPVEYOR_REPO_BRANCH -ne $NULL];
+    $suffix = @{ $true = ""; $false = ($branch.Substring(0, [math]::Min(10,$branch.Length)) -replace '[\/\+]','-').Trim("-")}[$branch -eq "main"]
+
+    if ($suffix) {
+        $shortver + "-" + $suffix
+    } else {
+        $shortver
+    }
+}

Build.Docker.ps1

@@ -1,7 +1,11 @@
+Push-Location $PSScriptRoot
+
+. ./Build.Common.ps1
+
 $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];
+$version = Get-SemVer(@{ $true = $env:APPVEYOR_BUILD_VERSION; $false = "99.99.99" }[$env:APPVEYOR_BUILD_VERSION -ne $NULL])
 $framework = "net7.0"
 $image = "datalust/seqcli"
 $archs = @(
@@ -50,7 +54,20 @@ function Publish-DockerImage($arch)
     $ErrorActionPreference = "Stop"
 }
 
-Push-Location $PSScriptRoot
+function Publish-DockerManifest($archs)
+{
+    $images = ""
+    foreach ($arch in $archs) {
+        $images += "$image-ci:$version-$($arch.rid) "
+    }
+
+    # We use `invoke-expression` here so each tag is treated as a separate arg
+    invoke-expression "docker manifest create $image-ci:$version $images"
+    if ($LASTEXITCODE) { exit 4 }
+    
+    docker manifest push $image-ci:$version
+    if ($LASTEXITCODE) { exit 4 }
+}
 
 Execute-Tests
 
@@ -62,4 +79,8 @@ foreach ($arch in $archs) {
     }
 }
 
+if ($IsPublishedBuild) {
+    Publish-DockerManifest($archs)
+}
+
 Pop-Location

Build.ps1

@@ -1,5 +1,10 @@
+Push-Location $PSScriptRoot
+
+. ./Build.Common.ps1
+
 $ErrorActionPreference = 'Stop'
 
+$version = Get-SemVer(@{ $true = $env:APPVEYOR_BUILD_VERSION; $false = "99.99.99" }[$env:APPVEYOR_BUILD_VERSION -ne $NULL])
 $framework = 'net7.0'
 $windowsTfmSuffix = '-windows'
 
@@ -73,9 +78,6 @@ function Publish-Docs($version)
     if($LASTEXITCODE -ne 0) { throw "Build failed" }
 }
 
-Push-Location $PSScriptRoot
-
-$version = @{ $true = $env:APPVEYOR_BUILD_VERSION; $false = "99.99.99" }[$env:APPVEYOR_BUILD_VERSION -ne $NULL];
 Write-Output "Building version $version"
 
 $env:Path = "$pwd/.dotnetcli;$env:Path"

appveyor.yml

@@ -25,7 +25,7 @@ for:
   - pwsh: ./Setup.ps1
 
   build_script:
-    - pwsh: ./Build.ps1 -shortver "$($env:APPVEYOR_BUILD_VERSION)"
+    - pwsh: ./Build.ps1
 
   deploy:
 
@@ -53,4 +53,4 @@ for:
   - pwsh: ./setup.sh
 
   build_script:
-  - pwsh: $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

global.json

@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "7.0.102"
+    "version": "7.0.201"
   }
 }

src/SeqCli/Cli/Command.cs

@@ -91,7 +91,7 @@ protected virtual async Task<int> Run(string[] unrecognized)
 
     protected virtual Task<int> Run() { return Task.FromResult(0); }
 
-    protected virtual void ShowUsageErrors(IEnumerable<string> errors)
+    protected static void ShowUsageErrors(IEnumerable<string> errors)
     {
         foreach (var error in errors)
         {

src/SeqCli/Cli/Commands/ApiKey/ListCommand.cs

@@ -47,13 +47,9 @@ protected override async Task<int> Run()
         var list = _entityIdentity.Id != null ?
             new[] { await connection.ApiKeys.FindAsync(_entityIdentity.Id) } :
             (await connection.ApiKeys.ListAsync())
-            .Where(ak => _entityIdentity.Title == null || _entityIdentity.Title == ak.Title)
-            .ToArray();
+            .Where(ak => _entityIdentity.Title == null || _entityIdentity.Title == ak.Title);
 
-        foreach (var apiKey in list)
-        {
-            _output.WriteEntity(apiKey);
-        }
+        _output.ListEntities(list);
 
         return 0;
     }

src/SeqCli/Cli/Commands/App/DefineCommand.cs

@@ -16,7 +16,6 @@
 using System.Threading.Tasks;
 using SeqCli.Apps;
 using SeqCli.Apps.Definitions;
-using SeqCli.Config;
 using SeqCli.Util;
 
 namespace SeqCli.Cli.Commands.App;

src/SeqCli/Cli/Commands/App/ListCommand.cs

@@ -0,0 +1,60 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using SeqCli.Cli.Features;
+using SeqCli.Config;
+using SeqCli.Connection;
+
+namespace SeqCli.Cli.Commands.App;
+
+[Command("app", "list", "List installed app packages", Example="seqcli app list")]
+class ListCommand : Command
+{
+    readonly SeqConnectionFactory _connectionFactory;
+
+    string? _title, _id;
+    readonly ConnectionFeature _connection;
+    readonly OutputFormatFeature _output;
+
+    string? PackageId => string.IsNullOrWhiteSpace(_title) ? null : _title.Trim();
+    string? Id => string.IsNullOrWhiteSpace(_id) ? null : _id.Trim();
+
+    public ListCommand(SeqConnectionFactory connectionFactory, SeqCliConfig config)
+    {
+        if (config == null) throw new ArgumentNullException(nameof(config));
+        _connectionFactory = connectionFactory ?? throw new ArgumentNullException(nameof(connectionFactory));
+
+        Options.Add(
+            "package-id=",
+            "The package id of the app(s) to list",
+            t => _title = t);
+
+        Options.Add(
+            "i=|id=",
+            "The id of a single app to list",
+            t => _id = t);
+
+        _output = Enable(new OutputFormatFeature(config.Output));
+        _connection = Enable<ConnectionFeature>();
+    }
+    
+    protected override async Task<int> Run()
+    {
+        if (PackageId != null && Id != null)
+        {
+            ShowUsageErrors(new[] {"Only one of either `package-id` or `id` can be specified"});
+            return 1;
+        }
+
+        var connection = _connectionFactory.Connect(_connection);
+
+        var list = Id != null ?
+            new[] { await connection.Apps.FindAsync(Id) } :
+            (await connection.Apps.ListAsync())
+            .Where(ak => PackageId == null || PackageId == ak.Package.PackageId);
+
+        _output.ListEntities(list);
+            
+        return 0;
+    }
+}

src/SeqCli/Cli/Commands/AppInstance/CreateCommand.cs

@@ -0,0 +1,103 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Seq.Api.Model.AppInstances;
+using SeqCli.Cli.Features;
+using SeqCli.Config;
+using SeqCli.Connection;
+using SeqCli.Util;
+using Serilog;
+
+namespace SeqCli.Cli.Commands.AppInstance;
+
+[Command("appinstance", "create", "Create an instance of an installed app",
+    Example = "seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]")]
+class CreateCommand : Command
+{
+    readonly SeqConnectionFactory _connectionFactory;
+
+    readonly ConnectionFeature _connection;
+    readonly OutputFormatFeature _output;
+
+    string? _title, _appId;
+    readonly Dictionary<string, string> _settings = new();
+    readonly List<string> _overridable = new();
+
+    public CreateCommand(SeqConnectionFactory connectionFactory, SeqCliConfig config)
+    {
+        _connectionFactory = connectionFactory ?? throw new ArgumentNullException(nameof(connectionFactory));
+
+        Options.Add(
+            "t=|title=",
+            "A title for the app instance",
+            t => _title = ArgumentString.Normalize(t));
+
+        Options.Add(
+            "app=",
+            "The id of the installed app package to instantiate",
+            app => _appId = ArgumentString.Normalize(app));
+
+        Options.Add(
+            "p={=}|property={=}",
+            "Specify name/value settings for the app, e.g. `-p [email protected] -p Subject=\"Alert!\"`",
+            (n, v) =>
+            {
+                var name = n.Trim();
+                var valueText = v?.Trim();
+                _settings.Add(name, valueText ?? "");
+            });
+
+        Options.Add(
+            "overridable=",
+            "Specify setting names that may be overridden by users when invoking the app",
+            s => _overridable.Add(s));
+        
+        // The command doesn't yet implement "Stream incoming events".
+
+        _connection = Enable<ConnectionFeature>();
+        _output = Enable(new OutputFormatFeature(config.Output));
+    }
+
+    protected override async Task<int> Run()
+    {
+        var connection = _connectionFactory.Connect(_connection);
+        
+        AppInstanceEntity instance = await connection.AppInstances.TemplateAsync(_appId)!;
+
+        bool ValidateSettingName(string settingName)
+        {
+            if (!instance.Settings!.ContainsKey(settingName))
+            {
+                Log.Error("The app does not accept a setting with name {SettingName}; available settings are: {AvailableSettings}", settingName, instance.Settings.Keys.ToArray());
+                return false;
+            }
+
+            return true;
+        }
+
+        instance.Title = _title;
+
+        foreach (var setting in _settings)
+        {
+            if (!ValidateSettingName(setting.Key))
+                return 1;
+                
+            instance.Settings![setting.Key] = setting.Value;
+        }
+
+        foreach (var overridable in _overridable)
+        {
+            if (!ValidateSettingName(overridable))
+                return 1;
+            
+            instance.InvocationOverridableSettings!.Add(overridable);
+        }
+        
+        instance = await connection.AppInstances.AddAsync(instance);
+
+        _output.WriteEntity(instance);
+
+        return 0;
+    }
+}