(logging-log4net) branch master updated: Fix marshalling for OutputDebugString parameter, add unit test (#271)

[freeandnil]

This is an automated email from the ASF dual-hosted git repository.

freeandnil pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4net.git


The following commit(s) were added to refs/heads/master by this push:
     new 8d678e1a Fix marshalling for OutputDebugString parameter, add unit 
test (#271)
8d678e1a is described below

commit 8d678e1a7781f2b73e24355ad6ffbbcff4b09c50
Author: Michael Butvinnik <bandana2...@gmail.com>
AuthorDate: Sat Sep 13 00:07:58 2025 +0300

    Fix marshalling for OutputDebugString parameter, add unit test (#271)
    
    * Fix DllImport attribute for OutputDebugString function
    * Fix encoding issue, add test
    * Run OutputDebugStringAppenderTest on Windows only
---
 .../Appender/OutputDebugAppenderTest.cs            | 72 ++++++++++++++++++++++
 src/log4net/Util/NativeMethods.cs                  |  2 +-
 2 files changed, 73 insertions(+), 1 deletion(-)

diff --git a/src/log4net.Tests/Appender/OutputDebugAppenderTest.cs 
b/src/log4net.Tests/Appender/OutputDebugAppenderTest.cs
new file mode 100644
index 00000000..9659244c
--- /dev/null
+++ b/src/log4net.Tests/Appender/OutputDebugAppenderTest.cs
@@ -0,0 +1,72 @@
+#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;
+using System.Diagnostics;
+
+using log4net.Appender;
+using log4net.Config;
+using log4net.Core;
+using log4net.Layout;
+using log4net.Repository;
+using NUnit.Framework;
+
+namespace log4net.Tests.Appender;
+
+/// <summary>
+/// Used for internal unit testing the <see cref="OutputDebugStringAppender"/> 
class.
+/// </summary>
+/// <remarks>
+/// Used for internal unit testing the <see cref="OutputDebugStringAppender"/> 
class.
+/// </remarks>
+[TestFixture]
+[Platform(Include = "Win")]
+public sealed class OutputDebugStringAppenderTest
+{
+  /// <summary>
+  /// Verifies that the OutputDebugString api is called by the appender 
without issues
+  /// </summary>
+  [Test]
+  public void AppendShouldNotCauseAnyErrors()
+  {
+    ILoggerRepository rep = 
LogManager.CreateRepository(Guid.NewGuid().ToString());
+
+    OutputDebugStringAppender outputDebugStringAppender = new()
+    {
+      Layout = new SimpleLayout(),
+      ErrorHandler = new FailOnError()
+    };
+    outputDebugStringAppender.ActivateOptions();
+
+    BasicConfigurator.Configure(rep, outputDebugStringAppender);
+
+    ILog log = LogManager.GetLogger(rep.Name, GetType());
+    log.Debug("Message - Сообщение - הודעה");
+
+    // need a way to check that the api is actually called and the string is 
properly marshalled.
+  }
+}
+
+class FailOnError : IErrorHandler
+{
+  public void Error(string message, Exception? e, ErrorCode errorCode) => 
Assert.Fail($"Unexpected error: {message} exception: {e}, errorCode: 
{errorCode}");
+  public void Error(string message, Exception e) => Assert.Fail($"Unexpected 
error: {message} exception: {e}");
+  public void Error(string message) =>  Assert.Fail($"Unexpected error: 
{message}");
+}
diff --git a/src/log4net/Util/NativeMethods.cs 
b/src/log4net/Util/NativeMethods.cs
index 88e43c4c..96ca8918 100644
--- a/src/log4net/Util/NativeMethods.cs
+++ b/src/log4net/Util/NativeMethods.cs
@@ -139,7 +139,7 @@ internal struct ConsoleScreenBufferInfo
     /// Stub for OutputDebugString native method
     /// </summary>
     /// <param name="message">the string to output</param>
-    [DllImport("Kernel32.dll")]
+    [DllImport("Kernel32.dll", CharSet = CharSet.Unicode)]    
     [DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
     internal static extern void OutputDebugString(string message);