src/log4net.Tests/Appender/RemoteSyslogAppenderTest.cs

#region Apache License
//
// Licensed to the Apache Software Foundation (ASF) under one or more 
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership. 
// The ASF licenses this file to you under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with 
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#endregion

using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using log4net.Appender;
using log4net.Appender.Internal;
using log4net.Core;
using log4net.Layout;
using log4net.Tests.Appender.Internal;
using NUnit.Framework;

namespace log4net.Tests.Appender;

/// <summary>
/// Tests for <see cref="RemoteSyslogAppender"/>
/// </summary>
[TestFixture]
public sealed class RemoteSyslogAppenderTest
{
  private sealed class RemoteAppender : RemoteSyslogAppender
  {
    /// <summary>
    /// Mock
    /// </summary>
    internal UdpMock Mock { get; } = new();

    /// <inheritdoc/>
    protected override IUdpConnection CreateUdpConnection() => Mock;
  }

  /// <summary>
  /// Simple Test for the <see cref="RemoteSyslogAppender"/>
  /// </summary>
  /// <remarks>
  /// https://github.com/apache/logging-log4net/issues/255
  /// </remarks>
  [Test]
  public void RemoteSyslogTest()
  {
    List<byte[]> sentBytes = ExecuteAppend("Test message");
    const string expectedData = @"<14>TestDomain: INFO  - Test message";
    Assert.That(sentBytes, Has.Count.EqualTo(1));
    Assert.That(Encoding.ASCII.GetString(sentBytes[0]), Is.EqualTo(expectedData));
  }
  
  /// <summary>
  /// Test for the <see cref="RemoteSyslogAppender.NewLineHandling"/>
  /// with <see cref="RemoteSyslogAppender.SyslogNewLineHandling.Escape"/>
  /// </summary>
  /// <remarks>
  /// https://github.com/apache/logging-log4net/issues/274
  /// </remarks>
  [Test]
  public void RemoteSyslogNewLineHandlingEscapeTest()
  {
    List<byte[]> sentBytes = ExecuteAppend("Test\r\nmessage");
    // ReSharper disable once StringLiteralTypo
    const string expectedData = @"<14>TestDomain: INFO  - Test\r\nmessage";
    Assert.That(sentBytes, Has.Count.EqualTo(1));
    Assert.That(Encoding.ASCII.GetString(sentBytes[0]), Is.EqualTo(expectedData));
  }
  
  /// <summary>
  /// Test for the <see cref="RemoteSyslogAppender.NewLineHandling"/>
  /// with <see cref="RemoteSyslogAppender.SyslogNewLineHandling.Keep"/>
  /// </summary>
  /// <remarks>
  /// https://github.com/apache/logging-log4net/issues/274
  /// </remarks>
  [Test]
  public void RemoteSyslogNewLineHandlingKeepTest()
  {
    List<byte[]> sentBytes = ExecuteAppend("Test\r\nmessage",
      RemoteSyslogAppender.SyslogNewLineHandling.Keep);
    // ReSharper disable once StringLiteralTypo
    const string expectedData = "<14>TestDomain: INFO  - Test\r\nmessage";
    Assert.That(sentBytes, Has.Count.EqualTo(1));
    Assert.That(Encoding.ASCII.GetString(sentBytes[0]), Is.EqualTo(expectedData));
  }
  
  /// <summary>
  /// Test for the <see cref="RemoteSyslogAppender.NewLineHandling"/>
  /// with <see cref="RemoteSyslogAppender.SyslogNewLineHandling.Split"/>
  /// </summary>
  /// <remarks>
  /// https://github.com/apache/logging-log4net/issues/274
  /// </remarks>
  [Test]
  public void RemoteSyslogNewLineHandlingSplitTest()
  {
    List<byte[]> sentBytes = ExecuteAppend("Test\r\nmessage",
      RemoteSyslogAppender.SyslogNewLineHandling.Split);
    // ReSharper disable once StringLiteralTypo
    Assert.That(sentBytes, Has.Count.EqualTo(2));
    const string expectedData0 = "<14>TestDomain: INFO  - Test";
    Assert.That(Encoding.ASCII.GetString(sentBytes[0]), Is.EqualTo(expectedData0));
    const string expectedData1 = "<14>TestDomain: message";
    Assert.That(Encoding.ASCII.GetString(sentBytes[1]), Is.EqualTo(expectedData1));
  }
  
  private static List<byte[]> ExecuteAppend(string message,
    RemoteSyslogAppender.SyslogNewLineHandling newLineHandling = default)
  {
    System.Net.IPAddress ipAddress = new([127, 0, 0, 1]);
    RemoteAppender appender = new() 
    { 
      RemoteAddress = ipAddress, 
      Layout = new PatternLayout("%-5level - %message"),
      NewLineHandling = newLineHandling
    };
    appender.ActivateOptions();
    LoggingEvent loggingEvent = new(new()
    {
      Level = Level.Info,
      Message = message,
      LoggerName = "TestLogger",
      Domain = "TestDomain",
    });
    appender.DoAppend(loggingEvent);
    for (int i = 0; i < 20; i++)
    {
      if (appender.Mock.Sent.Count == 0)
      {
        Thread.Sleep(10);
      }
    }
    appender.Close();
    Assert.That(appender.Mock.ConnectedTo, Is.EqualTo((0, ipAddress, 514)));
    Assert.That(appender.Mock.WasDisposed, Is.True);
    return appender.Mock.Sent.Select(item => item.Datagram).ToList();
  }
}