Mark Test Utilities As Packable Nonshipping

Winforms.sln

@@ -111,7 +111,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DesignSurfaceExt", "src\Sys
 EndProject
 Project("{778DAE3C-4631-46EA-AA77-85C1314464D9}") = "Microsoft.VisualBasic.Forms.Tests", "src\Microsoft.VisualBasic.Forms\tests\UnitTests\Microsoft.VisualBasic.Forms.Tests.vbproj", "{FC75CB54-D8D0-4B41-9A4D-9F862F34A02D}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.Windows.Forms.Common.TestUtilities", "src\Common\tests\TestUtilities\System.Windows.Forms.Common.TestUtilities.csproj", "{05FD23CE-60AE-44A8-8DD6-1688F04BE385}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.Private.Windows.Core.TestUtilities", "src\Common\tests\TestUtilities\System.Private.Windows.Core.TestUtilities.csproj", "{05FD23CE-60AE-44A8-8DD6-1688F04BE385}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.Windows.Forms.Analyzers", "src\System.Windows.Forms.Analyzers\src\System.Windows.Forms.Analyzers.csproj", "{3596BDE6-B211-4BE7-810D-DC7A4315E296}"
 EndProject

pkg/Microsoft.Private.Winforms/Microsoft.Private.Winforms.csproj

@@ -82,7 +82,7 @@
     <!-- Reference and Source System.Windows.Forms -->
     <ProjectReference Include="..\..\src\System.Windows.Forms\src\System.Windows.Forms.csproj" />
 
-    <!-- Reference and Source System.Windows.Forms.Primitives -->
+    <!-- Reference and Source System.Private.Windows.Core -->
     <ProjectReference Include="..\..\src\System.Private.Windows.Core\src\System.Private.Windows.Core.csproj" />
 
     <!-- Reference and Source System.Windows.Forms.Primitives -->

src/Common/tests/TestUtilities/AppContextSwitchNames.cs

@@ -7,26 +7,6 @@ namespace System;
 
 public static class AppContextSwitchNames
 {
-    /// <summary>
-    ///  The switch that controls whether AnchorLayoutV2 feature is enabled.
-    /// </summary>
-    public const string AnchorLayoutV2
-        = "System.Windows.Forms.AnchorLayoutV2";
-
-    /// <summary>
-    ///  The switch that controls whether the parent font
-    ///  (as set by <see cref="M:System.Windows.Forms.Application.SetDefaultFont(System.Drawing.Font)" />
-    ///  or by the parent control or form's font) is applied to menus.
-    /// </summary>
-    public const string ApplyParentFontToMenus
-        = "System.Windows.Forms.ApplyParentFontToMenus";
-
-    /// <summary>
-    ///  The switch that controls whether or not the DataGridView starts its UI row count at zero.
-    /// </summary>
-    public const string DataGridViewUIAStartRowCountAtZero
-        = "System.Windows.Forms.DataGridViewUIAStartRowCountAtZero";
-
     /// <summary>
     ///  The switch that controls whether or not the <see cref="BinaryFormatter"/> is enabled.
     /// </summary>
@@ -38,30 +18,4 @@ public const string EnableUnsafeBinaryFormatterSerialization
     /// </summary>
     public const string LocalAppContext_DisableCaching
         = "TestSwitch.LocalAppContext.DisableCaching";
-
-    /// <summary>
-    ///  The switch that controls whether UIA notifications are raised.
-    /// </summary>
-    public const string NoClientNotifications
-        = "Switch.System.Windows.Forms.AccessibleObject.NoClientNotifications";
-
-    /// <summary>
-    ///  The switch that controls whether to scale the top level form min/max size for dpi.
-    /// </summary>
-    public const string ScaleTopLevelFormMinMaxSizeForDpi
-        = "System.Windows.Forms.ScaleTopLevelFormMinMaxSizeForDpi";
-
-    /// <summary>
-    ///  The switch that controls whether certificates are checked against the certificate authority revocation list.
-    ///  If true, revoked certificates will not be accepted by WebRequests and WebClients as valid.
-    ///  Otherwise, revoked certificates will be accepted as valid.
-    /// </summary>
-    public const string ServicePointManagerCheckCrl
-        = "System.Windows.Forms.ServicePointManagerCheckCrl";
-
-    /// <summary>
-    ///  The switch that controls whether the TreeNodeCollection will insert nodes in the sorted order.
-    /// </summary>
-    public const string TreeNodeCollectionAddRangeRespectsSortOrder
-        = "System.Windows.Forms.ApplyParentFontToMenus";
 }

src/Common/tests/TestUtilities/BinarySerialization.cs

@@ -10,6 +10,10 @@ namespace System;
 
 public static class BinarySerialization
 {
+    /// <summary>
+    ///  Ensures the list of types marked as serializable under <paramref name="assemblyUnderTest"/> matches <paramref name="serializableTypes"/>.
+    ///  If not, <see cref="NotSupportedException"/> is thrown.
+    /// </summary>
     public static void EnsureSerializableAttribute(Assembly assemblyUnderTest, HashSet<string> serializableTypes)
     {
         foreach (Type type in assemblyUnderTest.GetTypes())
@@ -50,22 +54,24 @@ public static void EnsureSerializableAttribute(Assembly assemblyUnderTest, HashS
         }
     }
 
+    /// <summary>
+    ///  Binary deserializes a base 64 string to <typeparamref name="T"/>. <paramref name="blob"/> is binary
+    ///  deserialized with <see cref="BinaryFormatter"/> with <paramref name="assemblyStyle"/> taken into account.
+    /// </summary>
 #pragma warning disable SYSLIB0050 // Type or member is obsolete
-    public static T EnsureDeserialize<T>(string blob)
+    public static T EnsureDeserialize<T>(string blob, FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Simple)
     {
-        object @object = FromBase64String(blob);
+        object @object = FromBase64String(blob, assemblyStyle);
         Assert.NotNull(@object);
         return Assert.IsType<T>(@object);
 
-        static object FromBase64String(string base64String,
-            FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Simple)
+        static object FromBase64String(string base64String, FormatterAssemblyStyle assemblyStyle)
         {
             byte[] raw = Convert.FromBase64String(base64String);
             return FromByteArray(raw, assemblyStyle);
         }
 
-        static object FromByteArray(byte[] raw,
-            FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Simple)
+        static object FromByteArray(byte[] raw, FormatterAssemblyStyle assemblyStyle)
         {
 #pragma warning disable SYSLIB0011 // Type or member is obsolete
             // cs/binary-formatter-without-binder
@@ -82,14 +88,18 @@ static object FromByteArray(byte[] raw,
         }
     }
 
+    /// <summary>
+    ///  Returns a base 64 string of the binary serialized <paramref name="object"/>.
+    ///  <paramref name="object"/> is binary serialized using <see cref="BinaryFormatter"/>
+    ///  with <paramref name="assemblyStyle"/> taken into account.
+    /// </summary>
     public static string ToBase64String(object @object,
         FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Simple)
     {
         byte[] raw = ToByteArray(@object, assemblyStyle);
         return Convert.ToBase64String(raw);
 
-        static byte[] ToByteArray(object obj,
-            FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Simple)
+        static byte[] ToByteArray(object obj, FormatterAssemblyStyle assemblyStyle)
         {
 #pragma warning disable SYSLIB0011 // Type or member is obsolete
             // cs/binary-formatter-without-binder

src/Common/tests/TestUtilities/CommonTestHelper.cs

@@ -4,7 +4,7 @@
 using System.ComponentModel.Design.Serialization;
 using System.Drawing;
 
-namespace System.Windows.Forms.TestUtilities;
+namespace System.Private.Windows.Core.TestUtilities;
 
 public static class CommonTestHelper
 {

src/Common/tests/TestUtilities/FileCleanupTestBase.cs

@@ -3,6 +3,9 @@
 
 namespace System;
 
+/// <summary>
+///  Creates a test directory path and cleans it up when test class finishes execution.
+/// </summary>
 public abstract class FileCleanupTestBase : IDisposable
 {
     private string? _testDirectory;

src/Common/tests/TestUtilities/System.Windows.Forms.Common.TestUtilities.csproj → src/Common/tests/TestUtilities/System.Private.Windows.Core.TestUtilities.csproj

@@ -1,9 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <AssemblyName>System.Windows.Forms.Common.TestUtilities</AssemblyName>
+    <AssemblyName>System.Private.Windows.Core.TestUtilities</AssemblyName>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <RootNamespace>System</RootNamespace>
     <Nullable>enable</Nullable>
+    <IsPackable>true</IsPackable>
+    <IsShipping>false</IsShipping>
   </PropertyGroup>
 
   <ItemGroup>

src/Common/tests/TestUtilities/TempFile.cs

@@ -6,8 +6,8 @@
 namespace System.IO;
 
 /// <summary>
-/// Represents a temporary file. Creating an instance creates a file at the specified path,
-/// and disposing the instance deletes the file.
+///  Represents a temporary file. Creating an instance creates a file at the specified path,
+///  and disposing the instance deletes the file.
 /// </summary>
 /// <remarks>
 ///  <para>

src/Common/tests/TestUtilities/TestIncludeType.cs

@@ -1,8 +1,12 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-namespace System.Windows.Forms.TestUtilities;
+namespace System.Private.Windows.Core.TestUtilities;
 
+/// <summary>
+///  Specifies what type of test data to include in the <see cref="TheoryData"/>. This is
+///  used in <see cref="CommonMemberDataAttribute"/>
+/// </summary>
 [Flags]
 public enum TestIncludeType
 {

src/Common/tests/TestUtilities/ThreadCultureChange.cs

@@ -5,6 +5,9 @@
 
 namespace System;
 
+/// <summary>
+///  Facilitates temporarily changing the <see cref="CultureInfo.CurrentCulture"/> and <see cref="CultureInfo.CurrentUICulture"/>.
+/// </summary>
 public sealed class ThreadCultureChange : IDisposable
 {
     private readonly CultureInfo _origCulture = CultureInfo.CurrentCulture;

src/System.Windows.Forms.Analyzers.CSharp/tests/UnitTests/System.Windows.Forms.Analyzers.CSharp.Tests.csproj

@@ -20,7 +20,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\Common\tests\TestUtilities\System.Windows.Forms.Common.TestUtilities.csproj" />
+    <ProjectReference Include="..\..\..\Common\tests\TestUtilities\System.Private.Windows.Core.TestUtilities.csproj" />
     <ProjectReference Include="..\..\..\System.Windows.Forms.Analyzers.CodeFixes.CSharp\System.Windows.Forms.Analyzers.CodeFixes.CSharp.csproj" />
     <ProjectReference Include="..\..\..\System.Windows.Forms.Analyzers\src\System.Windows.Forms.Analyzers.csproj" />
     <ProjectReference Include="..\..\..\System.Windows.Forms.Analyzers\tests\UnitTests\System.Windows.Forms.Analyzers.Tests.csproj" />

src/System.Windows.Forms.Analyzers.VisualBasic/tests/UnitTests/System.Windows.Forms.Analyzers.VisualBasic.Tests/System.Windows.Forms.Analyzers.VisualBasic.Tests.vbproj

@@ -22,7 +22,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\..\Common\tests\TestUtilities\System.Windows.Forms.Common.TestUtilities.csproj" />
+    <ProjectReference Include="..\..\..\..\Common\tests\TestUtilities\System.Private.Windows.Core.TestUtilities.csproj" />
     <ProjectReference Include="..\..\..\..\System.Windows.Forms.Analyzers.CodeFixes.VisualBasic\System.Windows.Forms.Analyzers.CodeFixes.VisualBasic.vbproj" />
     <ProjectReference Include="..\..\..\..\System.Windows.Forms.Analyzers\src\System.Windows.Forms.Analyzers.csproj" />
     <ProjectReference Include="..\..\..\..\System.Windows.Forms.Analyzers\tests\UnitTests\System.Windows.Forms.Analyzers.Tests.csproj" />

src/System.Windows.Forms.Analyzers/tests/UnitTests/System.Windows.Forms.Analyzers.Tests.csproj

@@ -23,7 +23,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\Common\tests\TestUtilities\System.Windows.Forms.Common.TestUtilities.csproj" />
+    <ProjectReference Include="..\..\..\Common\tests\TestUtilities\System.Private.Windows.Core.TestUtilities.csproj" />
     <ProjectReference Include="..\..\src\System.Windows.Forms.Analyzers.csproj" />
   </ItemGroup>
 

src/System.Windows.Forms.Primitives/tests/TestUtilities/System.Windows.Forms.Primitives.TestUtilities.csproj

@@ -16,7 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\Common\tests\TestUtilities\System.Windows.Forms.Common.TestUtilities.csproj" />
+    <ProjectReference Include="..\..\..\Common\tests\TestUtilities\System.Private.Windows.Core.TestUtilities.csproj" />
     <ProjectReference Include="..\..\..\System.Windows.Forms\src\System.Windows.Forms.csproj" />
     <ProjectReference Include="..\..\src\System.Windows.Forms.Primitives.csproj" />
   </ItemGroup>

src/System.Windows.Forms/tests/IntegrationTests/UIIntegrationTests/System.Windows.Forms.UI.IntegrationTests.csproj

@@ -17,7 +17,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\..\Common\tests\TestUtilities\System.Windows.Forms.Common.TestUtilities.csproj" />
+    <ProjectReference Include="..\..\..\..\Common\tests\TestUtilities\System.Private.Windows.Core.TestUtilities.csproj" />
     <ProjectReference Include="..\..\..\..\System.Design\src\System.Design.Facade.csproj" />
     <ProjectReference Include="..\..\..\..\System.Drawing.Design\src\System.Drawing.Design.Facade.csproj" />
     <ProjectReference Include="..\..\..\..\System.Windows.Forms.Primitives\src\System.Windows.Forms.Primitives.csproj" />

src/Common/tests/TestUtilities/AnchorLayoutV2Scope.cs → src/System.Windows.Forms/tests/TestUtilities/AnchorLayoutV2Scope.cs

@@ -16,7 +16,7 @@ public AnchorLayoutV2Scope(bool enable)
         // Prevent multiple AnchorLayoutV2Scope instances from running simultaneously.
         // Using Monitor to allow recursion on the same thread.
         Monitor.Enter(typeof(AnchorLayoutV2Scope));
-        _switchScope = new(AppContextSwitchNames.AnchorLayoutV2, enable);
+        _switchScope = new(WinFormsAppContextSwitchNames.AnchorLayoutV2, enable);
     }
 
     public void Dispose()

src/Common/tests/TestUtilities/ApplyParentFontToMenusScope.cs → src/System.Windows.Forms/tests/TestUtilities/ApplyParentFontToMenusScope.cs

@@ -16,7 +16,7 @@ public ApplyParentFontToMenusScope(bool enable)
         // Prevent multiple ApplyParentFontToMenusScopes from running simultaneously. Using Monitor to allow recursion on
         // the same thread.
         Monitor.Enter(typeof(ApplyParentFontToMenusScope));
-        _switchScope = new(AppContextSwitchNames.ApplyParentFontToMenus, enable);
+        _switchScope = new(WinFormsAppContextSwitchNames.ApplyParentFontToMenus, enable);
     }
 
     public void Dispose()

src/Common/tests/TestUtilities/DataGridViewUIAStartRowCountAtZeroScope.cs → src/System.Windows.Forms/tests/TestUtilities/DataGridViewUIAStartRowCountAtZeroScope.cs

@@ -15,7 +15,7 @@ public DataGridViewUIAStartRowCountAtZeroScope(bool enable)
         // Prevent multiple BinaryFormatterScopes from running simultaneously. Using Monitor to allow recursion on
         // the same thread.
         Monitor.Enter(typeof(DataGridViewUIAStartRowCountAtZeroScope));
-        _switchScope = new(AppContextSwitchNames.DataGridViewUIAStartRowCountAtZero, enable);
+        _switchScope = new(WinFormsAppContextSwitchNames.DataGridViewUIAStartRowCountAtZero, enable);
     }
 
     public void Dispose()

src/Common/tests/TestUtilities/NoClientNotificationsScope.cs → src/System.Windows.Forms/tests/TestUtilities/NoClientNotificationsScope.cs

@@ -16,7 +16,7 @@ public NoClientNotificationsScope(bool enable)
         // Prevent multiple NoClientNotificationsScopes from running simultaneously. Using Monitor to allow recursion on
         // the same thread.
         Monitor.Enter(typeof(NoClientNotificationsScope));
-        _switchScope = new(AppContextSwitchNames.NoClientNotifications, enable);
+        _switchScope = new(WinFormsAppContextSwitchNames.NoClientNotifications, enable);
     }
 
     public void Dispose()

src/Common/tests/TestUtilities/ScaleTopLevelFormMinMaxSizeForDpiScope.cs → src/System.Windows.Forms/tests/TestUtilities/ScaleTopLevelFormMinMaxSizeForDpiScope.cs

@@ -16,7 +16,7 @@ public ScaleTopLevelFormMinMaxSizeForDpiScope(bool enable)
         // Prevent multiple ScaleTopLevelFormMinMaxSizeForDpi from running simultaneously.
         // Using Monitor to allow recursion on the same thread.
         Monitor.Enter(typeof(ScaleTopLevelFormMinMaxSizeForDpiScope));
-        _switchScope = new(AppContextSwitchNames.ScaleTopLevelFormMinMaxSizeForDpi, enable);
+        _switchScope = new(WinFormsAppContextSwitchNames.ScaleTopLevelFormMinMaxSizeForDpi, enable);
     }
 
     public void Dispose()

src/Common/tests/TestUtilities/ServicePointManagerCheckCrlScope.cs → src/System.Windows.Forms/tests/TestUtilities/ServicePointManagerCheckCrlScope.cs

@@ -16,7 +16,7 @@ public ServicePointManagerCheckCrlScope(bool enable)
         // Prevent multiple ServicePointManagerCheckCrlScope instances from running simultaneously.
         // Using Monitor to allow recursion on the same thread.
         Monitor.Enter(typeof(ServicePointManagerCheckCrlScope));
-        _switchScope = new(AppContextSwitchNames.ServicePointManagerCheckCrl, enable);
+        _switchScope = new(WinFormsAppContextSwitchNames.ServicePointManagerCheckCrl, enable);
     }
 
     public void Dispose()

src/Common/tests/TestUtilities/TreeNodeCollectionAddRangeRespectsSortOrderScope.cs → src/System.Windows.Forms/tests/TestUtilities/TreeNodeCollectionAddRangeRespectsSortOrderScope.cs

@@ -15,7 +15,7 @@ public TreeNodeCollectionAddRangeRespectsSortOrderScope(bool enable)
         // Prevent multiple TreeNodeCollectionAddRangeRespectsSortOrderScopes from running simultaneously.
         // Using Monitor to allow recursion on the same thread.
         Monitor.Enter(typeof(TreeNodeCollectionAddRangeRespectsSortOrderScope));
-        _switchScope = new(AppContextSwitchNames.TreeNodeCollectionAddRangeRespectsSortOrder, enable);
+        _switchScope = new(WinFormsAppContextSwitchNames.TreeNodeCollectionAddRangeRespectsSortOrder, enable);
     }
 
     public void Dispose()

src/System.Windows.Forms/tests/TestUtilities/WinFormsAppContextSwitchNames.cs

@@ -0,0 +1,53 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace System;
+
+public static class WinFormsAppContextSwitchNames
+{
+    /// <summary>
+    ///  The switch that controls whether AnchorLayoutV2 feature is enabled.
+    /// </summary>
+    public const string AnchorLayoutV2
+        = "System.Windows.Forms.AnchorLayoutV2";
+
+    /// <summary>
+    ///  The switch that controls whether the parent font
+    ///  (as set by <see cref="M:System.Windows.Forms.Application.SetDefaultFont(System.Drawing.Font)" />
+    ///  or by the parent control or form's font) is applied to menus.
+    /// </summary>
+    public const string ApplyParentFontToMenus
+        = "System.Windows.Forms.ApplyParentFontToMenus";
+
+    /// <summary>
+    ///  The switch that controls whether or not the DataGridView starts its UI row count at zero.
+    /// </summary>
+    public const string DataGridViewUIAStartRowCountAtZero
+        = "System.Windows.Forms.DataGridViewUIAStartRowCountAtZero";
+
+    /// <summary>
+    ///  The switch that controls whether UIA notifications are raised.
+    /// </summary>
+    public const string NoClientNotifications
+        = "Switch.System.Windows.Forms.AccessibleObject.NoClientNotifications";
+
+    /// <summary>
+    ///  The switch that controls whether to scale the top level form min/max size for dpi.
+    /// </summary>
+    public const string ScaleTopLevelFormMinMaxSizeForDpi
+        = "System.Windows.Forms.ScaleTopLevelFormMinMaxSizeForDpi";
+
+    /// <summary>
+    ///  The switch that controls whether certificates are checked against the certificate authority revocation list.
+    ///  If true, revoked certificates will not be accepted by WebRequests and WebClients as valid.
+    ///  Otherwise, revoked certificates will be accepted as valid.
+    /// </summary>
+    public const string ServicePointManagerCheckCrl
+        = "System.Windows.Forms.ServicePointManagerCheckCrl";
+
+    /// <summary>
+    ///  The switch that controls whether the TreeNodeCollection will insert nodes in the sorted order.
+    /// </summary>
+    public const string TreeNodeCollectionAddRangeRespectsSortOrder
+        = "System.Windows.Forms.ApplyParentFontToMenus";
+}

src/System.Windows.Forms/tests/UnitTests/DpiHelperTests.cs

@@ -2,7 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Drawing;
-using System.Windows.Forms.TestUtilities;
 
 namespace System.Windows.Forms.Tests;
 

src/System.Windows.Forms/tests/UnitTests/GlobalUsings.cs

@@ -4,6 +4,7 @@
 global using System.Diagnostics;
 global using System.Windows.Forms;
 global using System.Private.Windows.Core;
+global using System.Private.Windows.Core.TestUtilities;
 global using Windows.Win32;
 global using Windows.Win32.Foundation;
 global using Windows.Win32.Graphics.Gdi;

src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/ColumnHeaderConverterTests.cs

@@ -3,7 +3,6 @@
 
 using System.ComponentModel;
 using System.ComponentModel.Design.Serialization;
-using System.Windows.Forms.TestUtilities;
 
 namespace System.Windows.Forms.Tests;
 

src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/ControlTests.Internals.cs

@@ -3,7 +3,6 @@
 
 using System.Drawing;
 using System.Runtime.CompilerServices;
-using System.Windows.Forms.TestUtilities;
 
 namespace System.Windows.Forms.Tests;