Merge pull request #27 from nblumhardt/f-valueformatter

Update build and test infrastructure; move to standalone JSON formatter

Author: merbla

Build.ps1

@@ -1,16 +1,51 @@
+echo "build: Build started"
+
 Push-Location $PSScriptRoot
 
-if(Test-Path .\artifacts) { Remove-Item .\artifacts -Force -Recurse }
+if(Test-Path .\artifacts) {
+	echo "build: Cleaning .\artifacts"
+	Remove-Item .\artifacts -Force -Recurse
+}
 
-& dotnet restore
+& dotnet restore --no-cache
 
-$revision = @{ $true = $env:APPVEYOR_BUILD_NUMBER; $false = 1 }[$env:APPVEYOR_BUILD_NUMBER -ne $NULL];
+$branch = @{ $true = $env:APPVEYOR_REPO_BRANCH; $false = $(git symbolic-ref --short -q HEAD) }[$env:APPVEYOR_REPO_BRANCH -ne $NULL];
+$revision = @{ $true = "{0:00000}" -f [convert]::ToInt32("0" + $env:APPVEYOR_BUILD_NUMBER, 10); $false = "local" }[$env:APPVEYOR_BUILD_NUMBER -ne $NULL];
+$suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)))-$revision"}[$branch -eq "master" -and $revision -ne "local"]
 
-Push-Location src/Serilog.Sinks.Splunk
+echo "build: Version suffix is $suffix"
 
-& dotnet pack -c Release -o ..\..\.\artifacts --version-suffix=$revision
-if($LASTEXITCODE -ne 0) { exit 1 }    
+foreach ($src in ls src/*) {
+    Push-Location $src
 
+	echo "build: Packaging project in $src"
+
+    & dotnet pack -c Release -o ..\..\artifacts --version-suffix=$suffix
+    if($LASTEXITCODE -ne 0) { exit 1 }    
+
+    Pop-Location
+}
+
+foreach ($test in ls test/*.PerformanceTests) {
+    Push-Location $test
+
+	echo "build: Building performance test project in $test"
+
+    & dotnet build -c Release
+    if($LASTEXITCODE -ne 0) { exit 2 }
+
+    Pop-Location
+}
+
+foreach ($test in ls test/*.Tests) {
+    Push-Location $test
+
+	echo "build: Testing project in $test"
+
+    & dotnet test -c Release
+    if($LASTEXITCODE -ne 0) { exit 3 }
+
+    Pop-Location
+}
 
-Pop-Location
 Pop-Location

appveyor.yml

@@ -19,10 +19,10 @@ deploy:
     secure: nvZ/z+pMS91b3kG4DgfES5AcmwwGoBYQxr9kp4XiJHj25SAlgdIxFx++1N0lFH2x
   skip_symbols: true
   on:
-    branch: master
+    branch: /^(master|dev)$/
 - provider: GitHub
   auth_token:
-    secure: ggZTqqV1z0xecDoQbeoy3A7xikShCt9FWZIGp95dG9Fo0p5RAT9oGU0ZekHfUIwk
+    secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX
   artifact: /Serilog.*\.nupkg/
   tag: v$(appveyor_build_version)
   on:

global.json

@@ -1,6 +1,6 @@
-{
+{
   "projects": [ "src", "test" ],
   "sdk": {
-    "version": "1.0.0-preview1-002702"
+    "version": "1.0.0-preview2-003121"
   }
 }

serilog-sinks-splunk.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 14
-VisualStudioVersion = 14.0.24720.0
+VisualStudioVersion = 14.0.25420.1
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{7A774CBB-A6E9-4854-B4DB-4CF860B0C1C5}"
 EndProject
@@ -25,6 +25,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "sample", "sample", "{1C75E4
 EndProject
 Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Sample", "src\sample\Sample.xproj", "{17497155-5D94-45DF-81D9-BD960E8CF217}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{B9451AD8-09B9-4C09-A152-FBAE24806614}"
+EndProject
+Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Serilog.Sinks.Splunk.Tests", "test\Serilog.Sinks.Splunk.Tests\Serilog.Sinks.Splunk.Tests.xproj", "{3C2D8E01-5580-426A-BDD9-EC59CD98E618}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -39,12 +43,17 @@ Global
 		{17497155-5D94-45DF-81D9-BD960E8CF217}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{17497155-5D94-45DF-81D9-BD960E8CF217}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{17497155-5D94-45DF-81D9-BD960E8CF217}.Release|Any CPU.Build.0 = Release|Any CPU
+		{3C2D8E01-5580-426A-BDD9-EC59CD98E618}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{3C2D8E01-5580-426A-BDD9-EC59CD98E618}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{3C2D8E01-5580-426A-BDD9-EC59CD98E618}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{3C2D8E01-5580-426A-BDD9-EC59CD98E618}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{32CF915C-3ECD-496C-8FDB-1214581274A6} = {7A774CBB-A6E9-4854-B4DB-4CF860B0C1C5}
 		{17497155-5D94-45DF-81D9-BD960E8CF217} = {1C75E4A9-4CB1-497C-AD17-B438882051A1}
+		{3C2D8E01-5580-426A-BDD9-EC59CD98E618} = {B9451AD8-09B9-4C09-A152-FBAE24806614}
 	EndGlobalSection
 EndGlobal

src/Serilog.Sinks.Splunk/Properties/AssemblyInfo.cs

@@ -2,3 +2,5 @@
 using System.Runtime.CompilerServices;
 
 [assembly: AssemblyVersion("2.0.0.0")]
+
+[assembly: InternalsVisibleTo("Serilog.Sinks.Splunk.Tests")]

src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorRequest.cs

@@ -14,55 +14,11 @@
 
 
 using System;
-using System.Globalization;
 using System.Net.Http;
 using System.Text;
 
 namespace Serilog.Sinks.Splunk
 {
-    internal class SplunkEvent
-    {
-        private string _payload;
-
-        internal SplunkEvent(string logEvent, string source, string sourceType, string host, string index, double time)
-        {
-            _payload = string.Empty;
-
-            var jsonPayLoad = @"{""event"":" + logEvent
-            .Replace("\r\n", string.Empty);
-
-            if (!string.IsNullOrWhiteSpace(source))
-            {
-                jsonPayLoad = jsonPayLoad + @",""source"":""" + source + @"""";
-            }
-            if (!string.IsNullOrWhiteSpace(sourceType))
-            {
-                jsonPayLoad = jsonPayLoad + @",""sourceType"":""" + sourceType + @"""";
-            }
-            if (!string.IsNullOrWhiteSpace(host))
-            {
-                jsonPayLoad = jsonPayLoad + @",""host"":""" + host + @"""";
-            }
-            if (!string.IsNullOrWhiteSpace(index))
-            {
-                jsonPayLoad = jsonPayLoad + @",""index"":""" + index + @"""";
-            }
-
-            if (time > 0)
-            {
-                jsonPayLoad = jsonPayLoad + @",""time"":" +  time.ToString(CultureInfo.InvariantCulture);
-            }
-
-            jsonPayLoad = jsonPayLoad + "}";
-            _payload = jsonPayLoad;
-        }
-
-        public string Payload
-        {
-            get { return _payload; }
-        }
-    }
-
     internal class EventCollectorRequest : HttpRequestMessage
     {
         internal EventCollectorRequest(string splunkHost, string jsonPayLoad, string uri ="services/collector")

src/Serilog.Sinks.Splunk/Sinks/Splunk/EventCollectorSink.cs

@@ -18,7 +18,6 @@
 using System.IO;
 using System.Linq;
 using System.Net;
-using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
 using Serilog.Core;
@@ -33,20 +32,11 @@ namespace Serilog.Sinks.Splunk
     public class EventCollectorSink : ILogEventSink, IDisposable
     {
         private readonly string _splunkHost;
-        private readonly string _eventCollectorToken;
-        private readonly string _source;
-        private readonly string _sourceType;
-        private readonly string _host;
-        private readonly string _index;
         private readonly string _uriPath;
         private readonly int _batchSizeLimitLimit;
         private readonly SplunkJsonFormatter _jsonFormatter;
         private readonly ConcurrentQueue<LogEvent> _queue;
         private readonly EventCollectorClient _httpClient;
-        private const string DefaultSource = "";
-        private const string DefaultSourceType = "";
-        private const string DefaultHost = "";
-        private const string DefaultIndex = "";
 
         /// <summary>
         /// Taken from Splunk.Logging.Common
@@ -56,7 +46,7 @@ public class EventCollectorSink : ILogEventSink, IDisposable
             HttpStatusCode.Forbidden,
             HttpStatusCode.MethodNotAllowed,
             HttpStatusCode.BadRequest
-        }; 
+        };
 
         /// <summary>
         /// Creates a new instance of the sink
@@ -73,24 +63,16 @@ public EventCollectorSink(
             int batchIntervalInSeconds = 5,
             int batchSizeLimit = 100,
             IFormatProvider formatProvider = null,
-            bool renderTemplate = true
-            )
+            bool renderTemplate = true)
+            : this(
+                splunkHost,
+                eventCollectorToken,
+                null, null, null, null, null, 
+                batchIntervalInSeconds, 
+                batchSizeLimit,
+                formatProvider,
+                renderTemplate)
         {
-            _splunkHost = splunkHost;
-            _eventCollectorToken = eventCollectorToken;
-            _queue = new ConcurrentQueue<LogEvent>();
-            _jsonFormatter = new SplunkJsonFormatter(renderMessage: true, formatProvider: formatProvider, renderTemplate: renderTemplate);
-            _batchSizeLimitLimit = batchSizeLimit;
-
-            var batchInterval = TimeSpan.FromSeconds(batchIntervalInSeconds);
-            _httpClient = new EventCollectorClient(_eventCollectorToken);
-            
-            var cancellationToken = new CancellationToken();
-            
-            RepeatAction.OnInterval(
-                batchInterval,
-                async () => await ProcessQueue(),
-                cancellationToken);
         } 
 
         /// <summary>
@@ -118,19 +100,23 @@ public EventCollectorSink(
             int batchIntervalInSeconds,
             int batchSizeLimit,
             IFormatProvider formatProvider = null,
-            bool renderTemplate = true
-            ) : this(splunkHost,
-                eventCollectorToken,
-                batchIntervalInSeconds,
-                batchSizeLimit,
-                formatProvider,
-                renderTemplate)
+            bool renderTemplate = true)
         {
-            _source = source;
-            _sourceType = sourceType;
-            _host = host;
-            _index = index;
             _uriPath = uriPath;
+            _splunkHost = splunkHost;
+            _queue = new ConcurrentQueue<LogEvent>();
+            _jsonFormatter = new SplunkJsonFormatter(renderTemplate, formatProvider, source, sourceType, host, index);
+            _batchSizeLimitLimit = batchSizeLimit;
+
+            var batchInterval = TimeSpan.FromSeconds(batchIntervalInSeconds);
+            _httpClient = new EventCollectorClient(eventCollectorToken);
+
+            var cancellationToken = new CancellationToken();
+
+            RepeatAction.OnInterval(
+                batchInterval,
+                async () => await ProcessQueue(),
+                cancellationToken);
         }
 
         /// <summary>
@@ -175,21 +161,14 @@ private async Task ProcessQueue()
 
         private async Task Send(IEnumerable<LogEvent> events)
         {
-            string allEvents = string.Empty;
+            var allEvents = new StringWriter();
 
             foreach (var logEvent in events)
             {
-                var sw = new StringWriter();
-                _jsonFormatter.Format(logEvent, sw);
-
-                var serialisedEvent = sw.ToString();
-
-                var splunkEvent = new SplunkEvent(serialisedEvent, _source, _sourceType, _host, _index, logEvent.Timestamp.ToEpoch());
-
-                allEvents = $"{allEvents}{splunkEvent.Payload}";
+                _jsonFormatter.Format(logEvent, allEvents);
             }
 
-            var request = new EventCollectorRequest(_splunkHost, allEvents, _uriPath);
+            var request = new EventCollectorRequest(_splunkHost, allEvents.ToString(), _uriPath);
             var response = await _httpClient.SendAsync(request);
 
             if (response.IsSuccessStatusCode)