From e96d7499c0d4b7c71d62559fe59e84c08e787892 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Amaury=20Lev=C3=A9?= Date: Thu, 30 Jan 2025 13:55:12 +0100 Subject: [PATCH] Fix some missing xml docs --- Directory.Build.props | 8 -------- .../MSTest.TestAdapter/Execution/TestClassInfo.cs | 1 + .../MSTest.TestAdapter/Execution/TestMethodInfo.cs | 4 ++++ .../MSTest.TestAdapter/Execution/UnitTestRunner.cs | 5 +++++ .../MSTest.TestAdapter/IPlatformServiceProvider.cs | 5 +++++ src/Adapter/MSTest.TestAdapter/MSTestSettings.cs | 6 +++--- .../MSTest.TestAdapter/PlatformServiceProvider.cs | 2 ++ .../TestApplicationBuilderExtensions.cs | 8 ++++++++ .../Deployment/AssemblyLoadWorker.cs | 1 + .../RoslynAnalyzerHelpers/CompilationExtensions.cs | 3 ++- .../Helpers/TestApplicationBuilderExtensions.cs | 9 +++++++++ .../TestFramework/Assertions/CollectionAssert.cs | 2 ++ .../Attributes/TestMethod/OSConditionAttribute.cs | 1 + test/Utilities/Automation.CLI/CLITestBase.e2e.cs | 3 +++ 14 files changed, 46 insertions(+), 12 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index dd7a10a14a..dd5636ac41 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -13,14 +13,6 @@ preview enable true - - $(NoWarn),1573,1591 diff --git a/src/Adapter/MSTest.TestAdapter/Execution/TestClassInfo.cs b/src/Adapter/MSTest.TestAdapter/Execution/TestClassInfo.cs index 016a68d2c6..9863905522 100644 --- a/src/Adapter/MSTest.TestAdapter/Execution/TestClassInfo.cs +++ b/src/Adapter/MSTest.TestAdapter/Execution/TestClassInfo.cs @@ -38,6 +38,7 @@ public class TestClassInfo /// /// Underlying test class type. /// Constructor for the test class. + /// Whether or not the test class constructor has no parameters. /// Test class attribute. /// Parent assembly info. internal TestClassInfo( diff --git a/src/Adapter/MSTest.TestAdapter/Execution/TestMethodInfo.cs b/src/Adapter/MSTest.TestAdapter/Execution/TestMethodInfo.cs index d914105015..3eeb4b88fb 100644 --- a/src/Adapter/MSTest.TestAdapter/Execution/TestMethodInfo.cs +++ b/src/Adapter/MSTest.TestAdapter/Execution/TestMethodInfo.cs @@ -302,6 +302,7 @@ private void ThrowMultipleAttributesException(string attributeName) /// Execute test without timeout. /// /// Arguments to be passed to the method. + /// The timeout token source. /// The result of the execution. [SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "Requirement is to handle all kinds of user exceptions and message appropriately.")] private TestResult ExecuteInternal(object?[]? arguments, CancellationTokenSource? timeoutTokenSource) @@ -490,6 +491,7 @@ private static Exception GetRealException(Exception ex) /// be expected or not expected. /// /// Exception that was thrown. + /// Real exception thrown by the test method. /// The class name. /// The method name. /// Test framework exception with details. @@ -561,6 +563,7 @@ private static TestFailedException HandleMethodException(Exception ex, Exception /// Runs TestCleanup methods of parent TestClass and base classes. /// /// Instance of TestResult. + /// The timeout token source. [SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "Requirement is to handle all kinds of user exceptions and message appropriately.")] private void RunTestCleanupMethod(TestResult result, CancellationTokenSource? timeoutTokenSource) { @@ -696,6 +699,7 @@ private void RunTestCleanupMethod(TestResult result, CancellationTokenSource? ti /// /// Instance of TestClass. /// Instance of TestResult. + /// The timeout token source. /// True if the TestInitialize method(s) did not throw an exception. [SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "Requirement is to handle all kinds of user exceptions and message appropriately.")] private bool RunTestInitializeMethod(object classInstance, TestResult result, CancellationTokenSource? timeoutTokenSource) diff --git a/src/Adapter/MSTest.TestAdapter/Execution/UnitTestRunner.cs b/src/Adapter/MSTest.TestAdapter/Execution/UnitTestRunner.cs index 99c46cdded..1e8d3072a8 100644 --- a/src/Adapter/MSTest.TestAdapter/Execution/UnitTestRunner.cs +++ b/src/Adapter/MSTest.TestAdapter/Execution/UnitTestRunner.cs @@ -31,6 +31,8 @@ internal sealed class UnitTestRunner : MarshalByRefObject /// Initializes a new instance of the class. /// /// Specifies adapter settings that need to be instantiated in the domain running these tests. + /// The tests to run. + /// The class cleanup lifecycle. public UnitTestRunner(MSTestSettings settings, UnitTestElement[] testsToRun, int? classCleanupLifecycle) : this(settings, testsToRun, classCleanupLifecycle, ReflectHelper.Instance) { @@ -40,6 +42,8 @@ public UnitTestRunner(MSTestSettings settings, UnitTestElement[] testsToRun, int /// Initializes a new instance of the class. /// /// Specifies adapter settings. + /// The tests to run. + /// The class cleanup lifecycle. /// The reflect Helper. internal UnitTestRunner(MSTestSettings settings, UnitTestElement[] testsToRun, int? classCleanupLifecycle, ReflectHelper reflectHelper) { @@ -134,6 +138,7 @@ internal TestResult[] RunSingleTest(TestMethod testMethod, IDictionary /// The test Method. /// The test context properties. + /// The message logger. /// The . internal async Task RunSingleTestAsync(TestMethod testMethod, IDictionary testContextProperties, IMessageLogger messageLogger) { diff --git a/src/Adapter/MSTest.TestAdapter/IPlatformServiceProvider.cs b/src/Adapter/MSTest.TestAdapter/IPlatformServiceProvider.cs index 487e5fe10a..9df85c3521 100644 --- a/src/Adapter/MSTest.TestAdapter/IPlatformServiceProvider.cs +++ b/src/Adapter/MSTest.TestAdapter/IPlatformServiceProvider.cs @@ -59,6 +59,9 @@ internal interface IPlatformServiceProvider /// TestRunCancellationToken? TestRunCancellationToken { get; set; } + /// + /// Gets or sets a value indicating whether a graceful stop is requested. + /// bool IsGracefulStopRequested { get; set; } /// @@ -120,6 +123,8 @@ ITestSourceHost CreateTestSourceHost( /// /// The default set of properties the test context needs to be filled with. /// + /// The message logger. + /// The test outcome. /// /// The instance. /// diff --git a/src/Adapter/MSTest.TestAdapter/MSTestSettings.cs b/src/Adapter/MSTest.TestAdapter/MSTestSettings.cs index c371cd755c..e48059d665 100644 --- a/src/Adapter/MSTest.TestAdapter/MSTestSettings.cs +++ b/src/Adapter/MSTest.TestAdapter/MSTestSettings.cs @@ -292,10 +292,9 @@ private static bool IsRunSettingsFileHasSettingName(string? runSettingsXml, stri /// /// Populate adapter settings from the context. /// - /// + /// The discovery context. /// The logger for messages. - /// The discovery context that contains the runsettings. - /// + /// The configuration. internal static void PopulateSettings(IDiscoveryContext? context, IMessageLogger? logger, IConfiguration? configuration) { #if !WINDOWS_UWP @@ -916,6 +915,7 @@ private static void ParseIntegerSetting(IConfiguration configuration, string key /// /// Configuration to load the settings from. /// The logger for messages. + /// The MSTest settings. internal static void SetSettingsFromConfig(IConfiguration configuration, IMessageLogger? logger, MSTestSettings settings) { // Expected format of the json is: - diff --git a/src/Adapter/MSTest.TestAdapter/PlatformServiceProvider.cs b/src/Adapter/MSTest.TestAdapter/PlatformServiceProvider.cs index 1a5880c966..6edb8553c6 100644 --- a/src/Adapter/MSTest.TestAdapter/PlatformServiceProvider.cs +++ b/src/Adapter/MSTest.TestAdapter/PlatformServiceProvider.cs @@ -191,6 +191,8 @@ public ITestSourceHost CreateTestSourceHost( /// /// The default set of properties the test context needs to be filled with. /// + /// The message logger. + /// The test outcome. /// /// The instance. /// diff --git a/src/Adapter/MSTest.TestAdapter/TestingPlatformAdapter/TestApplicationBuilderExtensions.cs b/src/Adapter/MSTest.TestAdapter/TestingPlatformAdapter/TestApplicationBuilderExtensions.cs index f16999eb17..436ce80215 100644 --- a/src/Adapter/MSTest.TestAdapter/TestingPlatformAdapter/TestApplicationBuilderExtensions.cs +++ b/src/Adapter/MSTest.TestAdapter/TestingPlatformAdapter/TestApplicationBuilderExtensions.cs @@ -11,9 +11,17 @@ namespace Microsoft.VisualStudio.TestTools.UnitTesting; +/// +/// Extension methods for . +/// [SuppressMessage("ApiDesign", "RS0030:Do not use banned APIs", Justification = "We can use MTP from this folder")] public static class TestApplicationBuilderExtensions { + /// + /// Register MSTest as the test framework and register the necessary services. + /// + /// The test application builder on which to register. + /// The function to get the test assemblies. public static void AddMSTest(this ITestApplicationBuilder testApplicationBuilder, Func> getTestAssemblies) { MSTestExtension extension = new(); diff --git a/src/Adapter/MSTestAdapter.PlatformServices/Deployment/AssemblyLoadWorker.cs b/src/Adapter/MSTestAdapter.PlatformServices/Deployment/AssemblyLoadWorker.cs index 848a7bc96d..323487a79f 100644 --- a/src/Adapter/MSTestAdapter.PlatformServices/Deployment/AssemblyLoadWorker.cs +++ b/src/Adapter/MSTestAdapter.PlatformServices/Deployment/AssemblyLoadWorker.cs @@ -79,6 +79,7 @@ public IReadOnlyCollection GetFullPathToDependentAssemblies(string assem /// Get the target dotNet framework string for the assembly. /// /// Path of the assembly file. + /// Error message if any. /// String representation of the target dotNet framework e.g. .NETFramework,Version=v4.0. internal string GetTargetFrameworkVersionStringFromPath(string path, out string? errorMessage) { diff --git a/src/Analyzers/MSTest.Analyzers/RoslynAnalyzerHelpers/CompilationExtensions.cs b/src/Analyzers/MSTest.Analyzers/RoslynAnalyzerHelpers/CompilationExtensions.cs index e740b609c9..4147d77081 100644 --- a/src/Analyzers/MSTest.Analyzers/RoslynAnalyzerHelpers/CompilationExtensions.cs +++ b/src/Analyzers/MSTest.Analyzers/RoslynAnalyzerHelpers/CompilationExtensions.cs @@ -21,7 +21,8 @@ internal static class CompilationExtensions /// /// The compilation. /// Namespace + type name, e.g. "System.Exception". - /// The if found, null otherwise. + /// The if found, null otherwise. + /// A boolean indicating whether or not the service was found. internal static bool TryGetOrCreateTypeByMetadataName(this Compilation compilation, string fullTypeName, [NotNullWhen(returnValue: true)] out INamedTypeSymbol? namedTypeSymbol) => WellKnownTypeProvider.GetOrCreate(compilation).TryGetOrCreateTypeByMetadataName(fullTypeName, out namedTypeSymbol); } diff --git a/src/Platform/Microsoft.Testing.Platform/Helpers/TestApplicationBuilderExtensions.cs b/src/Platform/Microsoft.Testing.Platform/Helpers/TestApplicationBuilderExtensions.cs index 6ebc717cdc..6e8c3d6e6c 100644 --- a/src/Platform/Microsoft.Testing.Platform/Helpers/TestApplicationBuilderExtensions.cs +++ b/src/Platform/Microsoft.Testing.Platform/Helpers/TestApplicationBuilderExtensions.cs @@ -7,10 +7,18 @@ namespace Microsoft.Testing.Platform.Helpers; +/// +/// A collection of extension methods for . +/// [Experimental("TPEXP", UrlFormat = "https://aka.ms/testingplatform/diagnostics#{0}")] [SuppressMessage("ApiDesign", "RS0016:Add public types and members to the declared API", Justification = "Experimental API")] public static class TestApplicationBuilderExtensions { + /// + /// Registers the command-line options provider for '--treenode-filter'. + /// + /// The test application builder. + /// The extension owner of the tree node filter service. public static void AddTreeNodeFilterService(this ITestApplicationBuilder testApplicationBuilder, IExtension extension) => testApplicationBuilder.CommandLine.AddProvider(() => new TreeNodeFilterCommandLineOptionsProvider(extension)); @@ -18,6 +26,7 @@ public static void AddTreeNodeFilterService(this ITestApplicationBuilder testApp /// Registers the command-line options provider for '--maximum-failed-tests'. /// /// The test application builder. + /// The extension owner of the maximum failed tests service. [Experimental("TPEXP", UrlFormat = "https://aka.ms/testingplatform/diagnostics#{0}")] public static void AddMaximumFailedTestsService(this ITestApplicationBuilder builder, IExtension extension) => builder.CommandLine.AddProvider(serviceProvider => new MaxFailedTestsCommandLineOptionsProvider(extension, serviceProvider)); diff --git a/src/TestFramework/TestFramework/Assertions/CollectionAssert.cs b/src/TestFramework/TestFramework/Assertions/CollectionAssert.cs index 1ddbe5a731..e6a53f987c 100644 --- a/src/TestFramework/TestFramework/Assertions/CollectionAssert.cs +++ b/src/TestFramework/TestFramework/Assertions/CollectionAssert.cs @@ -1486,6 +1486,7 @@ internal static bool IsSubsetOfHelper(ICollection subset, ICollection superset) /// /// The collection to process. /// + /// The equality comparer to use when comparing items. /// /// The number of null elements in the collection. /// @@ -1531,6 +1532,7 @@ private static Dictionary GetElementCounts(IEnumerable collection /// /// The second collection to compare. /// + /// The equality comparer to use when comparing items. /// /// The expected number of occurrences of /// or 0 if there is no mismatched diff --git a/src/TestFramework/TestFramework/Attributes/TestMethod/OSConditionAttribute.cs b/src/TestFramework/TestFramework/Attributes/TestMethod/OSConditionAttribute.cs index 9827332549..ce1a2c7ccf 100644 --- a/src/TestFramework/TestFramework/Attributes/TestMethod/OSConditionAttribute.cs +++ b/src/TestFramework/TestFramework/Attributes/TestMethod/OSConditionAttribute.cs @@ -26,6 +26,7 @@ public sealed class OSConditionAttribute : ConditionBaseAttribute /// /// Initializes a new instance of the class. /// + /// Decides whether the OSes will be included or excluded. /// The operating systems that this test supports. public OSConditionAttribute(ConditionMode mode, OperatingSystems operatingSystems) : base(mode) diff --git a/test/Utilities/Automation.CLI/CLITestBase.e2e.cs b/test/Utilities/Automation.CLI/CLITestBase.e2e.cs index ebbdedaae4..9b24f8647e 100644 --- a/test/Utilities/Automation.CLI/CLITestBase.e2e.cs +++ b/test/Utilities/Automation.CLI/CLITestBase.e2e.cs @@ -28,6 +28,7 @@ public CLITestBase() /// /// Collection of test containers. /// Run settings for execution. + /// Target framework for the test run. public void InvokeVsTestForDiscovery(string[] sources, string runSettings = "", string targetFramework = null) { ExpandTestSourcePaths(sources, targetFramework); @@ -44,6 +45,7 @@ public void InvokeVsTestForDiscovery(string[] sources, string runSettings = "", /// List of test assemblies. /// Run settings for execution. /// Test Case filter for execution. + /// Target framework for the test run. public void InvokeVsTestForExecution(string[] sources, string runSettings = "", string testCaseFilter = null, string targetFramework = null) { ExpandTestSourcePaths(sources, targetFramework); @@ -297,6 +299,7 @@ private static string GetTestMethodName(string testFullName) /// Converts relative paths to absolute. /// /// An array of file paths, elements may be modified to absolute paths. + /// Target framework for the test run. private void ExpandTestSourcePaths(string[] paths, string targetFramework = null) { for (int i = 0; i < paths.Length; i++)