Merge pull request #244 from datalust/dev

2022.1.592 Release

Author: liammclennan

CONTRIBUTING.md

@@ -0,0 +1,57 @@
+Contributing to seqcli
+================
+
+Testing
+------
+
+`seqcli` has two test projects: `SeqCli.EndToEnd` and `SeqCli.Tests`.
+
+### SeqCli.EndToEnd 
+
+`/test/SeqCli.EndToEnd` is a console app that implements integration tests. It uses a custom testing framework and xunit for assertions. 
+
+Each test within the EndToEnd project (an implementation of the `ICliTestCase` interface) spans one child process for the Seq server and one child process for the seqcli command. 
+
+The Seq server can be run via the `seq` executable (windows only) or as a `datalust/seq:latest` docker container. Which to use is controlled via the `--docker-server` argument. 
+
+Some tests require a Seq license. These tests are run if a valid license is supplied via stdin and the `--license-certificate-stdin` argument is supplied. 
+
+#### Adding Tests
+
+The typical pattern is to execute a seqcli command, then make an assertion on the output of the command. E.g.
+
+```c#
+var exit = runner.Exec("apikey list", "-t Test --json --no-color");
+Assert.Equal(0, exit);
+
+var output = runner.LastRunProcess!.Output;
+Assert.Contains("\"AssignedPermissions\": [\"Ingest\"]", output);
+```
+
+#### Running Tests
+
+```shell
+/SeqCli.EndToEnd$ dotnet run -- --docker-server
+```
+
+The `--docker-server` is optional if you have a `seq` executable in your path.
+
+To run the multi user tests as well, save a valid license into a file and:
+
+```shell
+/SeqCli.EndToEnd$ cat license.txt | dotnet run -- --docker-server --license-certificate-stdin
+```
+
+To run a specific set of tests pass regular expressions matching the tests to run:
+
+```shell
+/SeqCli.EndToEnd$ dotnet run -- --docker-server *TestCase.cs Command*
+```
+
+### SeqCli.Tests
+
+`/test/SeqCli.Tests` is a regular xunit testing project. To run: 
+
+```shell
+/SeqCli.Tests$ dotnet test
+```

README.md

@@ -50,6 +50,10 @@ $token = (
 )
 ```
 
+## Contributing
+
+See `CONTRIBUTING.md`.
+
 ## Commands
 
 Usage:

global.json

@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "6.0.201"
+    "version": "6.0.301"
   }
 }

seqcli.sln

@@ -17,6 +17,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "sln", "sln", "{2EA56595-519
 		Build.Docker.ps1 = Build.Docker.ps1
 		docker-publish.ps1 = docker-publish.ps1
 		Setup.ps1 = Setup.ps1
+		CONTRIBUTING.md = CONTRIBUTING.md
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{3587B633-0C03-4235-8903-6226900328F1}"

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

@@ -28,7 +28,7 @@
 
 namespace SeqCli.Cli.Commands.ApiKey
 {
-    [Command("apikey", "create", "Create an API key for ingestion",
+    [Command("apikey", "create", "Create an API key for automation or ingestion",
         Example = "seqcli apikey create -t 'Test API Key' -p Environment=Test")]
     class CreateCommand : Command
     {

src/SeqCli/Cli/Commands/PrintCommand.cs

@@ -35,12 +35,13 @@ class PrintCommand : Command
         readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
 
         string _filter, _template = OutputFormatFeature.DefaultOutputTemplate;
-        bool _noColor;
+        bool _noColor, _forceColor;
 
         public PrintCommand(SeqCliOutputConfig outputConfig)
         {
             if (outputConfig == null) throw new ArgumentNullException(nameof(outputConfig));
             _noColor = outputConfig.DisableColor;
+            _forceColor = outputConfig.ForceColor;
 
             _fileInputFeature = Enable(new FileInputFeature("CLEF file to read", supportsWildcard: true));
 
@@ -55,17 +56,30 @@ public PrintCommand(SeqCliOutputConfig outputConfig)
             _invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();
 
             Options.Add("no-color", "Don't colorize text output", v => _noColor = true);
+
+            Options.Add("force-color",
+                "Force redirected output to have ANSI color (unless `--no-color` is also specified)",
+                v => _forceColor = true);
         }
 
         protected override async Task<int> Run()
         {
+            var applyThemeToRedirectedOutput
+                = _noColor == false && _forceColor == true;
+
+            var theme
+                = _noColor                      ? ConsoleTheme.None
+                :  applyThemeToRedirectedOutput ? OutputFormatFeature.DefaultAnsiTheme
+                :                                 OutputFormatFeature.DefaultTheme;
+
             var outputConfiguration = new LoggerConfiguration()
                 .MinimumLevel.Is(LevelAlias.Minimum)
                 .Enrich.With<RedundantEventTypeRemovalEnricher>()
                 .Enrich.With<SurrogateLevelRemovalEnricher>()
                 .WriteTo.Console(
                     outputTemplate: _template,
-                    theme: _noColor ? ConsoleTheme.None : OutputFormatFeature.DefaultTheme);
+                    theme: theme,
+                    applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);
 
             if (_filter != null)
                 outputConfiguration.Filter.ByIncludingOnly(_filter);

src/SeqCli/Cli/Commands/Sample/SetupCommand.cs

@@ -59,11 +59,7 @@ protected override async Task<int> Run()
             }
 
             var templateArgs = new Dictionary<string, JsonTemplate>();
-            var users = await connection.Users.ListAsync();
-            if (users.Count == 1)
-                templateArgs["ownerId"] = new JsonTemplateString(users.Single().Id);
-            else
-                templateArgs["ownerId"] = new JsonTemplateNull();
+            templateArgs["ownerId"] = new JsonTemplateNull();
 
             var templatesPath = Content.GetPath(Path.Combine("Sample", "Templates"));
             var templateFiles = Directory.GetFiles(templatesPath);

src/SeqCli/Cli/Features/OutputFormatFeature.cs

@@ -34,18 +34,25 @@ class OutputFormatFeature : CommandFeature
         public const string DefaultOutputTemplate =
             "[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
 
-        public static readonly ConsoleTheme DefaultTheme = SystemConsoleTheme.Literate;
+        public static readonly ConsoleTheme DefaultTheme     = SystemConsoleTheme.Literate;
+        public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
 
-        bool _json, _noColor;
+        bool _json, _noColor, _forceColor;
 
         public OutputFormatFeature(SeqCliOutputConfig outputConfig)
         {
             _noColor = outputConfig.DisableColor;
+            _forceColor = outputConfig.ForceColor;
         }
 
         public bool Json => _json;
 
-        ConsoleTheme Theme => _noColor ? ConsoleTheme.None : DefaultTheme;
+        bool ApplyThemeToRedirectedOutput => _noColor == false && _forceColor == true;
+
+        ConsoleTheme Theme
+            => _noColor                     ? ConsoleTheme.None
+            :  ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
+            :                                 DefaultTheme;
 
         public override void Enable(OptionSet options)
         {
@@ -55,6 +62,10 @@ public override void Enable(OptionSet options)
                 v => _json = true);
 
             options.Add("no-color", "Don't colorize text output", v => _noColor = true);
+
+            options.Add("force-color",
+                "Force redirected output to have ANSI color (unless `--no-color` is also specified)",
+                v => _forceColor = true);
         }
 
         public Logger CreateOutputLogger()
@@ -72,7 +83,8 @@ public Logger CreateOutputLogger()
                 outputConfiguration.Enrich.With<SurrogateLevelRemovalEnricher>();
                 outputConfiguration.WriteTo.Console(
                     outputTemplate: DefaultOutputTemplate,
-                    theme: Theme);
+                    theme: Theme,
+                    applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
             }
 
             return outputConfiguration.CreateLogger();
@@ -115,7 +127,8 @@ public void WriteEntity(Entity entity)
                     .Enrich.With<StripStructureTypeEnricher>()
                     .WriteTo.Console(
                         outputTemplate: "{@Message:j}{NewLine}",
-                        theme: Theme)
+                        theme: Theme,
+                        applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput)
                     .CreateLogger();
                 writer.Information("{@Entity}", jo);
             }

src/SeqCli/Config/SeqCliOutputConfig.cs

@@ -17,5 +17,6 @@ namespace SeqCli.Config
     class SeqCliOutputConfig
     {
         public bool DisableColor { get; set; }
+        public bool ForceColor   { get; set; }
     }
 }

src/SeqCli/SeqCli.csproj

@@ -23,12 +23,12 @@
   <ItemGroup>
     <PackageReference Include="Destructurama.JsonNet" Version="2.0.0" />
     <PackageReference Include="newtonsoft.json" Version="13.0.1" />
-    <PackageReference Include="Serilog" Version="2.10.0" />
+    <PackageReference Include="Serilog" Version="2.11.0" />
     <PackageReference Include="serilog.filters.expressions" Version="2.1.0" />
     <PackageReference Include="Serilog.Formatting.Compact" Version="1.1.0" />
     <PackageReference Include="Serilog.Formatting.Compact.Reader" Version="1.0.5" />
     <PackageReference Include="Serilog.Sinks.Console" Version="4.0.1" />
-    <PackageReference Include="Autofac" Version="6.3.0" />
+    <PackageReference Include="Autofac" Version="6.4.0" />
     <PackageReference Include="Superpower" Version="3.0.0" />
     <PackageReference Include="System.Reactive" Version="5.0.0" />
     <PackageReference Include="System.Security.Cryptography.ProtectedData" Version="6.0.0" />