Skip to content

Fixing 5424 serialization of multiple StructuredDataElements #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grubman merged 2 commits into from
Jul 16, 2017
Merged

Fixing 5424 serialization of multiple StructuredDataElements #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb6fe72
Adding tests on structured data element serialization.
Jun 23, 2017
792b4b5
Removing erroneous space when serializing multiple structured data el…
Jun 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 73 additions & 29 deletions SyslogNet.Client.Tests/Serialization/SyslogRfc5424MessageSerializerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using System.Text;
using SyslogNet.Client.Serialization;
using Xunit;
Expand Down Expand Up @@ -93,35 +94,78 @@ public void CanFormatSyslogMessageWithMsgId(string msgId, string expectedMsgId)

string serializedMsg = sut.Serialize(msg);
Assert.Equal(String.Format("<11>1 - - - - {0} -", expectedMsgId), serializedMsg);
}

[Theory]
[InlineData("The message", "The message")]
[InlineData("メッセージ", "メッセージ")]
public void CanFormatSyslogMessageWithUtf8Message(string message, string expectedMessage)
{
var msg = CreateMinimalSyslogMessage(Facility.UserLevelMessages, Severity.Error, message: message);

string serializedMsg = sut.Serialize(msg);

string messagePrefix = "<11>1 - - - - - - ";
Assert.True(serializedMsg.StartsWith(messagePrefix));

int messageIndex = 0;
var bom = new[] { (byte)239 /*EF*/, (byte)187 /*BB*/, (byte)191 /*BF*/ };

char[] bomChars = Encoding.UTF8.GetChars(bom);
foreach (char bomChar in bomChars)
{
char c = serializedMsg[messagePrefix.Length + messageIndex++];
Assert.Equal(bomChar, c);
}

string utf8MessagePart = serializedMsg.Substring(messagePrefix.Length + bomChars.Length);
Assert.Equal(expectedMessage, utf8MessagePart);
}

private static SyslogMessage CreateMinimalSyslogMessage(
}

[Theory]
[InlineData("The message", "The message")]
[InlineData("メッセージ", "メッセージ")]
public void CanFormatSyslogMessageWithUtf8Message(string message, string expectedMessage)
{
var msg = CreateMinimalSyslogMessage(Facility.UserLevelMessages, Severity.Error, message: message);

string serializedMsg = sut.Serialize(msg);

string messagePrefix = "<11>1 - - - - - - ";
Assert.True(serializedMsg.StartsWith(messagePrefix));

int messageIndex = 0;
var bom = new[] { (byte)239 /*EF*/, (byte)187 /*BB*/, (byte)191 /*BF*/ };

char[] bomChars = Encoding.UTF8.GetChars(bom);
foreach (char bomChar in bomChars)
{
char c = serializedMsg[messagePrefix.Length + messageIndex++];
Assert.Equal(bomChar, c);
}

string utf8MessagePart = serializedMsg.Substring(messagePrefix.Length + bomChars.Length);
Assert.Equal(expectedMessage, utf8MessagePart);
}

[Fact]
public void CanFormatSyslogMessageWithSingleStructuredDataElement()
{
var sdi = "test@12345";
var key = "key";
var value = "value";

var structuredDataElements = new List<StructuredDataElement>
{
new StructuredDataElement(sdi, new Dictionary<string, string> {{key, value}})
};
var msg = CreateMinimalSyslogMessage(Facility.UserLevelMessages, Severity.Error, structuredDataElements:structuredDataElements.ToArray());

string serializedMsg = sut.Serialize(msg);

string messagePrefix = $"<11>1 - - - - - [{sdi} {key}=\"{value}\"]";
Assert.True(serializedMsg.StartsWith(messagePrefix));
}

[Fact]
public void CanFormatSyslogMessageWithMultipleStructuredDataElement()
{
var sdi1 = "testA@12345";
var key1 = "key";
var value1 = "value";

var sdi2 = "testB@23456";
var key2 = "key";
var value2 = "value";

var structuredDataElements = new List<StructuredDataElement>
{
new StructuredDataElement(sdi1, new Dictionary<string, string> {{key1, value1}}),
new StructuredDataElement(sdi2, new Dictionary<string, string> {{key2, value2}}),
};
var msg = CreateMinimalSyslogMessage(Facility.UserLevelMessages, Severity.Error, structuredDataElements: structuredDataElements.ToArray());

string serializedMsg = sut.Serialize(msg);

string messagePrefix = $"<11>1 - - - - - [{sdi1} {key1}=\"{value1}\"][{sdi2} {key2}=\"{value2}\"]";
Assert.True(serializedMsg.StartsWith(messagePrefix));
}

private static SyslogMessage CreateMinimalSyslogMessage(
Facility facility,
Severity severity,
DateTimeOffset? dateTimeOffset = null,
Expand Down
8 changes: 5 additions & 3 deletions SyslogNet.Client/Serialization/SyslogRfc5424MessageSerializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@ public void Serialize(SyslogMessage message, Stream stream)
var structuredData = message.StructuredDataElements.ToList();
if (structuredData.Any())
{
// Structured data
foreach(StructuredDataElement sdElement in structuredData)
// Space
stream.WriteByte(32);

// Structured data
foreach (StructuredDataElement sdElement in structuredData)
{
messageBuilder.Clear()
.Append(" ")
.Append("[")
.Append(sdElement.SdId.FormatSyslogSdnameField(asciiCharsBuffer));

Expand Down