Skip to content

Avoid logging lengthy StringBuilder in System.IO.Tests #120164

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
merged 1 commit into from
Sep 27, 2025
+44 −11
Merged

Avoid logging lengthy StringBuilder in System.IO.Tests #120164

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 44 additions & 11 deletions src/libraries/System.Runtime/tests/System.IO.Tests/TextWriter/TextWriterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

using System.CodeDom.Compiler;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.Linq;
using System.Reflection;
Expand Down Expand Up @@ -610,8 +611,10 @@ public async Task WriteLineCharMemoryTest()

[Theory]
[MemberData(nameof(GetStringBuilderTestData))]
public void WriteStringBuilderTest(bool isSynchronized, StringBuilder testData)
public void WriteStringBuilderTest(bool isSynchronized, TestStringBuilderKind testStringBuilderKind)
{
StringBuilder testData = GetTestStringBuilder(testStringBuilderKind);

using (CharArrayTextWriter ctw = NewTextWriter)
{
TextWriter tw = isSynchronized ? TextWriter.Synchronized(ctw) : ctw;
Expand All @@ -623,8 +626,10 @@ public void WriteStringBuilderTest(bool isSynchronized, StringBuilder testData)

[Theory]
[MemberData(nameof(GetStringBuilderTestData))]
public void WriteLineStringBuilderTest(bool isSynchronized, StringBuilder testData)
public void WriteLineStringBuilderTest(bool isSynchronized, TestStringBuilderKind testStringBuilderKind)
{
StringBuilder testData = GetTestStringBuilder(testStringBuilderKind);

using (CharArrayTextWriter ctw = NewTextWriter)
{
TextWriter tw = isSynchronized ? TextWriter.Synchronized(ctw) : ctw;
Expand All @@ -636,8 +641,10 @@ public void WriteLineStringBuilderTest(bool isSynchronized, StringBuilder testDa

[ConditionalTheory]
[MemberData(nameof(GetStringBuilderTestData))]
public async Task WriteAsyncStringBuilderTest(bool isSynchronized, StringBuilder testData)
public async Task WriteAsyncStringBuilderTest(bool isSynchronized, TestStringBuilderKind testStringBuilderKind)
{
StringBuilder testData = GetTestStringBuilder(testStringBuilderKind);

if (!isSynchronized && !PlatformDetection.IsThreadingSupported)
{
throw new SkipTestException(nameof(PlatformDetection.IsThreadingSupported));
Expand All @@ -654,8 +661,10 @@ public async Task WriteAsyncStringBuilderTest(bool isSynchronized, StringBuilder

[ConditionalTheory]
[MemberData(nameof(GetStringBuilderTestData))]
public async Task WriteLineAsyncStringBuilderTest(bool isSynchronized, StringBuilder testData)
public async Task WriteLineAsyncStringBuilderTest(bool isSynchronized, TestStringBuilderKind testStringBuilderKind)
{
StringBuilder testData = GetTestStringBuilder(testStringBuilderKind);

if (!isSynchronized && !PlatformDetection.IsThreadingSupported)
{
throw new SkipTestException(nameof(PlatformDetection.IsThreadingSupported));
Expand Down Expand Up @@ -948,20 +957,44 @@ private sealed class InvokeActionOnDisposeTextWriter : TextWriter
protected override void Dispose(bool disposing) => DisposeAction?.Invoke();
}

public enum TestStringBuilderKind
{
Empty,
Simple,
Complex
}

private static StringBuilder GetTestStringBuilder(TestStringBuilderKind kind)
{
switch (kind)
{
case TestStringBuilderKind.Empty:
return new StringBuilder("");
case TestStringBuilderKind.Simple:
return new StringBuilder(new string(TestDataProvider.CharData));
case TestStringBuilderKind.Complex:
{
// Make a string that has 10 or so 8K chunks (probably).
StringBuilder complexStringBuilder = new StringBuilder();
for (int i = 0; i < 4000; i++)
complexStringBuilder.Append(TestDataProvider.CharData); // CharData ~ 25 chars
return complexStringBuilder;
}
default:
throw new UnreachableException();
}
}

// Generate data for TextWriter.Write* methods that take a stringBuilder.
// We test both the synchronized and unsynchronized variation, on strinbuilder with 0, small and large values.
// We use an enum to represent the test StringBuilder to avoid logging the lengthy contents of the complex case.
public static IEnumerable<object[]> GetStringBuilderTestData()
{
// Make a string that has 10 or so 8K chunks (probably).
StringBuilder complexStringBuilder = new StringBuilder();
for (int i = 0; i < 4000; i++)
complexStringBuilder.Append(TestDataProvider.CharData); // CharData ~ 25 chars

foreach (StringBuilder testData in new StringBuilder[] { new StringBuilder(""), new StringBuilder(new string(TestDataProvider.CharData)), complexStringBuilder })
foreach (TestStringBuilderKind testStringBuilderKind in new[] { TestStringBuilderKind.Empty, TestStringBuilderKind.Simple, TestStringBuilderKind.Complex })
{
foreach (bool isSynchronized in new bool[] { true, false })
{
yield return new object[] { isSynchronized, testData };
yield return new object[] { isSynchronized, testStringBuilderKind };
}
}
}
Expand Down