Merge branch 'mloskot-ml/feat/config-path-via-env-var' into dev

Author: nblumhardt

README.md

@@ -19,7 +19,7 @@ seqcli config -k connection.serverUrl -v https://your-seq-server
 seqcli config -k connection.apiKey -v your-api-key
 ```
 
-The API key will be stored in your `SeqCli.json` configuration file; on Windows, this is encrypted using DPAPI; on Mac/Linux the key is currently stored in plain text. As an alternative to storing the API key in configuration, it can be passed to each command via the `--apikey=` argument.
+The API key will be stored in your `SeqCli.json` configuration file; on Windows, this is encrypted using DPAPI; on Mac/Linux the key is stored in plain text unless an encryptor is defined in `encryption.encryptor`. As an alternative to storing the API key in configuration, it can be passed to each command via the `--apikey=` argument.
 
 `seqcli` is also available as a Docker container under [`datalust/seqcli`](https://store.docker.com/community/images/datalust/seqcli):
 

build/Build.Windows.ps1

@@ -28,7 +28,7 @@ function Restore-Packages
 
 function Execute-Tests($version)
 {
-    & dotnet test ./test/SeqCli.Tests/SeqCli.Tests.csproj -c Release /p:Configuration=Release /p:Platform=x64 /p:VersionPrefix=$version
+    & dotnet test ./test/SeqCli.Tests/SeqCli.Tests.csproj -c Release --framework "$framework$windowsTfmSuffix" /p:Configuration=Release /p:Platform=x64 /p:VersionPrefix=$version
     if($LASTEXITCODE -ne 0) { throw "Build failed" }
 }
 

src/SeqCli/Cli/Commands/ConfigCommand.cs

@@ -21,7 +21,7 @@
 
 namespace SeqCli.Cli.Commands;
 
-[Command("config", "View and set fields in the `SeqCli.json` file; run with no arguments to list all fields")]
+[Command("config", "View and set fields in `SeqCli.json`; run with no arguments to list all fields")]
 class ConfigCommand : Command
 {
     string? _key, _value;

src/SeqCli/Cli/Commands/Profile/RemoveCommand.cs

@@ -46,7 +46,6 @@ int RunSync()
             }
 
             SeqCliConfig.WriteToFile(config, _storagePath.ConfigFilePath);
-
             return 0;
         }
         catch (Exception ex)

src/SeqCli/Cli/Features/StoragePathFeature.cs

@@ -9,7 +9,20 @@ namespace SeqCli.Cli.Features;
 
 class StoragePathFeature : CommandFeature
 {
+    const string StoragePathVarName = "SEQCLI_STORAGE_PATH";
+    
     string? _storageRoot;
+    readonly Func<string, string?> _getEnvironmentVariable;
+
+    public StoragePathFeature()
+    : this(Environment.GetEnvironmentVariable)
+    {
+    }
+
+    public StoragePathFeature(Func<string, string?> getEnvironmentVariable)
+    {
+        _getEnvironmentVariable = getEnvironmentVariable;
+    }
 
     public string StorageRootPath
     {
@@ -18,7 +31,13 @@ public string StorageRootPath
             if (!string.IsNullOrWhiteSpace(_storageRoot))
                 return _storageRoot;
 
-            return TryQueryInstalledStorageRoot() ?? GetDefaultStorageRoot();
+            if (_getEnvironmentVariable(StoragePathVarName) is {} fromVar && !string.IsNullOrWhiteSpace(fromVar))
+                return fromVar;
+            
+            if (TryQueryInstalledStorageRoot() is { } installed)
+                return installed;
+            
+            return GetDefaultStorageRoot();
         }
     }
 
@@ -31,8 +50,9 @@ public string StorageRootPath
     public override void Enable(OptionSet options)
     {
         options.Add("storage=",
-            "The folder where `SeqCli.json` and other data will be stored; " +
-            "`" + GetDefaultStorageRoot() + "` is used by default",
+            $"The folder where `SeqCli.json` and other data will be stored; falls back to `{StoragePathVarName}` from " +
+            $"the environment, then the `seqcli forwarder` service's configured storage path (Windows only), then " +
+            "`" + GetDefaultStorageRoot() + "`",
             v => _storageRoot = Path.GetFullPath(v));
     }
 

src/SeqCli/SeqCli.csproj

@@ -46,7 +46,6 @@
     </Content>
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="newtonsoft.json" Version="13.0.3" />
     <PackageReference Include="Seq.Api" Version="2025.2.0" />
     <PackageReference Include="Serilog" Version="4.3.0" />
     <PackageReference Include="Serilog.Expressions" Version="5.0.0" />

test/SeqCli.EndToEnd/SeqCli.EndToEnd.csproj

@@ -2,7 +2,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFrameworks>net9.0;net9.0-windows</TargetFrameworks>
+    <TargetFrameworks>net9.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Windows)))' == 'true'">$(TargetFrameworks);net9.0-windows</TargetFrameworks>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="xunit" Version="2.9.3" />

test/SeqCli.Tests/Config/ConfigFileLocationTests.cs

@@ -0,0 +1,34 @@
+using System;
+using System.IO;
+using SeqCli.Cli.Features;
+using Xunit;
+
+namespace SeqCli.Tests.Config;
+
+public class ConfigFileLocationTests
+{
+    [Fact]
+    public void DefaultConfigFilename()
+    {
+        var storagePathFeature = new StoragePathFeature(_ => null);
+
+        // GetDefaultStorageRoot() isn't exposed by StoragePathFeature because it would introduce the risk we'd
+        // use it accidentally elsewhere.
+        var defaultPath = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile);
+        
+        Assert.Equal(defaultPath, storagePathFeature.StorageRootPath);
+    }
+
+    [Fact]
+    public void EnvironmentOverridenConfigFilename()
+    {
+        var customStoragePath = Path.GetTempPath();
+        
+        var storagePathFeature = new StoragePathFeature(
+            name => "SEQCLI_STORAGE_PATH".Equals(name, StringComparison.OrdinalIgnoreCase)
+                ? customStoragePath 
+                : null);
+        
+        Assert.Equal(customStoragePath, storagePathFeature.StorageRootPath);
+    }
+}

test/SeqCli.Tests/SeqCli.Tests.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net9.0;net9.0-windows</TargetFrameworks>
+    <TargetFrameworks>net9.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Windows)))' == 'true'">$(TargetFrameworks);net9.0-windows</TargetFrameworks>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />