Merge branch 'ChrisSimmons-dev' into dev

Author: nblumhardt

src/Serilog.Sinks.AzureTableStorage/ObjectNaming.cs

@@ -0,0 +1,28 @@
+using System.Text.RegularExpressions;
+
+namespace Serilog.Sinks.AzureTableStorage
+{
+    /// <summary>
+    /// Defines naming restrictions for Azure Table Storage objects
+    /// </summary>
+    public static class ObjectNaming
+    {
+        /// <summary>
+        /// The regex defining characters which are disallowed for key field values.
+        /// </summary>
+        /// <see href="https://msdn.microsoft.com/en-us/library/azure/dd179338.aspx"/>
+        public static readonly Regex KeyFieldValueCharactersNotAllowedMatch =
+            new Regex(@"(\\|/|#|\?|[\x00-\x1f]|[\x7f-\x9f])");
+
+        /// <summary>
+        /// Given a <param name="keyValue">key value</param>, returns a value
+        /// which has been 'cleaned' of any disallowed characters and trimmed
+        /// to the allowed length.
+        /// </summary>
+        public static string GetValidKeyValue(string keyValue)
+        {
+            keyValue = KeyFieldValueCharactersNotAllowedMatch.Replace(keyValue, "");
+            return keyValue.Length > 1024 ? keyValue.Substring(0, 1024) : keyValue;
+        }
+    }
+}

src/Serilog.Sinks.AzureTableStorage/Sinks/AzureTableStorage/LogEventEntity.cs

@@ -27,8 +27,6 @@ namespace Serilog.Sinks.AzureTableStorage
     /// </summary>
     public class LogEventEntity : TableEntity
     {
-        static readonly Regex RowKeyNotAllowedMatch = new Regex(@"(\\|/|#|\?|[\x00-\x1f]|[\x7f-\x9f])");
-
         /// <summary>
         /// Default constructor for the Storage Client library to re-hydrate entities when querying.
         /// </summary>
@@ -62,7 +60,7 @@ public LogEventEntity(
         // http://msdn.microsoft.com/en-us/library/windowsazure/dd179338.aspx
         static string GetValidRowKey(string rowKey)
         {
-            rowKey = RowKeyNotAllowedMatch.Replace(rowKey, "");
+            rowKey = ObjectNaming.KeyFieldValueCharactersNotAllowedMatch.Replace(rowKey, "");
             return rowKey.Length > 1024 ? rowKey.Substring(0, 1024) : rowKey;
         }
 

test/Serilog.Sinks.AzureTableStorageWithProperties.Tests/AzureTableStorageWithPropertiesSinkTests.cs

@@ -53,6 +53,75 @@ public async Task WhenALoggerWritesToTheSinkItIsRetrievableFromTheTableWithPrope
             Assert.Equal(" ", result.Properties["Space"].PropertyAsObject);
         }
 
+        [Fact]
+        public void WhenALoggerWritesToTheSinkWithAWindowsNewlineInTheTemplateItIsRetrievable()
+        {
+            // Prompted from https://github.com/serilog/serilog-sinks-azuretablestorage/issues/10
+            var storageAccount = CloudStorageAccount.DevelopmentStorageAccount;
+            var tableClient = storageAccount.CreateCloudTableClient();
+            var table = tableClient.GetTableReference("LogEventEntity");
+
+            table.DeleteIfExists();
+
+            var logger = new LoggerConfiguration()
+                .WriteTo.AzureTableStorageWithProperties(storageAccount)
+                .CreateLogger();
+
+            const string messageTemplate = "Line 1\r\nLine2";
+
+            logger.Information(messageTemplate);
+
+            var result = table.ExecuteQuery(new TableQuery().Take(1)).FirstOrDefault();
+
+            Assert.NotNull(result);
+        }
+
+        [Fact]
+        public void WhenALoggerWritesToTheSinkWithALineFeedInTheTemplateItIsRetrievable()
+        {
+            // Prompted from https://github.com/serilog/serilog-sinks-azuretablestorage/issues/10
+            var storageAccount = CloudStorageAccount.DevelopmentStorageAccount;
+            var tableClient = storageAccount.CreateCloudTableClient();
+            var table = tableClient.GetTableReference("LogEventEntity");
+
+            table.DeleteIfExists();
+
+            var logger = new LoggerConfiguration()
+                .WriteTo.AzureTableStorageWithProperties(storageAccount)
+                .CreateLogger();
+
+            const string messageTemplate = "Line 1\nLine2";
+
+            logger.Information(messageTemplate);
+
+            var result = table.ExecuteQuery(new TableQuery().Take(1)).FirstOrDefault();
+
+            Assert.NotNull(result);
+        }
+
+        [Fact]
+        public void WhenALoggerWritesToTheSinkWithACarriageReturnInTheTemplateItIsRetrievable()
+        {
+            // Prompted from https://github.com/serilog/serilog-sinks-azuretablestorage/issues/10
+            var storageAccount = CloudStorageAccount.DevelopmentStorageAccount;
+            var tableClient = storageAccount.CreateCloudTableClient();
+            var table = tableClient.GetTableReference("LogEventEntity");
+
+            table.DeleteIfExists();
+
+            var logger = new LoggerConfiguration()
+                .WriteTo.AzureTableStorageWithProperties(storageAccount)
+                .CreateLogger();
+
+            const string messageTemplate = "Line 1\rLine2";
+
+            logger.Information(messageTemplate);
+
+            var result = table.ExecuteQuery(new TableQuery().Take(1)).FirstOrDefault();
+
+            Assert.NotNull(result);
+        }
+
         [Fact]
         public async Task WhenALoggerWritesToTheSinkItStoresTheCorrectTypesForScalar()
         {