Skip to content
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

Enable nullable for TestFramework.Extensions #1363

Merged
merged 1 commit into from
Nov 3, 2022
Merged

Enable nullable for TestFramework.Extensions #1363

Show file tree
Hide file tree
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
4 changes: 1 addition & 3 deletions src/TestFramework/TestFramework.Extensions/AppModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@
using System.Runtime.InteropServices;
using System.Text;

#nullable enable
#pragma warning disable SA1310 // Field names must not contain underscore

namespace Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.AppContainer;

/// <summary>
Expand Down Expand Up @@ -98,6 +95,7 @@ public static bool IsPackagedProcess()

private static class Interop
{
#pragma warning disable SA1310 // Field names must not contain underscore
public const int APPMODEL_ERROR_NO_PACKAGE = 0x00003D54;
public const int ERROR_INSUFFICIENT_BUFFER = 0x0000007A;
public const int ERROR_INVALID_PARAMETER = 0x00000057;
Expand Down
8 changes: 4 additions & 4 deletions src/TestFramework/TestFramework.Extensions/Attributes/DeploymentItemAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public sealed class DeploymentItemAttribute : Attribute
/// Initializes a new instance of the <see cref="DeploymentItemAttribute"/> class.
/// </summary>
/// <param name="path">The file or directory to deploy. The path is relative to the build output directory. The item will be copied to the same directory as the deployed test assemblies.</param>
public DeploymentItemAttribute(string path)
public DeploymentItemAttribute(string? path)
{
Path = path;
OutputDirectory = string.Empty;
Expand All @@ -41,7 +41,7 @@ public DeploymentItemAttribute(string path)
/// </summary>
/// <param name="path">The relative or absolute path to the file or directory to deploy. The path is relative to the build output directory. The item will be copied to the same directory as the deployed test assemblies.</param>
/// <param name="outputDirectory">The path of the directory to which the items are to be copied. It can be either absolute or relative to the deployment directory. All files and directories identified by <paramref name="path"/> will be copied to this directory.</param>
public DeploymentItemAttribute(string path, string outputDirectory)
public DeploymentItemAttribute(string? path, string? outputDirectory)
{
Path = path;
OutputDirectory = outputDirectory;
Expand All @@ -50,10 +50,10 @@ public DeploymentItemAttribute(string path, string outputDirectory)
/// <summary>
/// Gets the path of the source file or folder to be copied.
/// </summary>
public string Path { get; }
public string? Path { get; }

/// <summary>
/// Gets the path of the directory to which the item is copied.
/// </summary>
public string OutputDirectory { get; }
public string? OutputDirectory { get; }
}
10 changes: 5 additions & 5 deletions src/TestFramework/TestFramework.Extensions/Attributes/UWP_UITestMethodAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@ public class UITestMethodAttribute : TestMethodAttribute
/// </returns>
/// Throws <exception cref="NotSupportedException"> when run on an async test method.
/// </exception>
public override TestResult[] Execute(ITestMethod testMethod)
public override TestResult?[] Execute(ITestMethod testMethod)
{
var attrib = testMethod.GetAttributes<AsyncStateMachineAttribute>(false);
if (attrib.Length > 0)
var attribute = testMethod.GetAttributes<AsyncStateMachineAttribute>(false);
if (attribute.Length > 0)
{
throw new NotSupportedException(FrameworkMessages.AsyncUITestMethodNotSupported);
}

TestResult result = null;
TestResult? result = null;
Windows.ApplicationModel.Core.CoreApplication.MainView.CoreWindow.Dispatcher.RunAsync(
Windows.UI.Core.CoreDispatcherPriority.Normal,
() =>
{
result = testMethod.Invoke(null);
}).AsTask().GetAwaiter().GetResult();

return new TestResult[] { result };
return new TestResult?[] { result };
}
}
#endif
5 changes: 1 addition & 4 deletions src/TestFramework/TestFramework.Extensions/Attributes/WinUITestTargetAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,7 @@ public class WinUITestTargetAttribute : Attribute
/// </param>
public WinUITestTargetAttribute(Type applicationType)
{
if (applicationType == null)
{
throw new ArgumentNullException(nameof(applicationType));
}
_ = applicationType ?? throw new ArgumentNullException(nameof(applicationType));

if (!typeof(UI.Xaml.Application).IsAssignableFrom(applicationType))
{
Expand Down
28 changes: 15 additions & 13 deletions src/TestFramework/TestFramework.Extensions/Attributes/WinUI_UITestMethodAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace Microsoft.VisualStudio.TestTools.UnitTesting.AppContainer;
public class UITestMethodAttribute : TestMethodAttribute
{
private static bool s_isApplicationInitialized = false;
private static DispatcherQueue s_applicationDispatcherQueue;
private static DispatcherQueue? s_applicationDispatcherQueue;

/// <summary>
/// Initializes a new instance of the <see cref="UITestMethodAttribute"/> class.
Expand All @@ -45,7 +45,7 @@ public UITestMethodAttribute(string displayName)
/// If none is provided <see cref="UITestMethodAttribute"/> will check for <see cref="WinUITestTargetAttribute" />, if the attribute is defined it will start the App and use its <see cref="UI.Dispatching.DispatcherQueue"/>.
/// <see cref="UITestMethodAttribute"/> will try to use <c>Microsoft.UI.Xaml.Window.Current.DispatcherQueue</c> for the last resort, but that will only work on UWP.
/// </summary>
public static DispatcherQueue DispatcherQueue { get; set; }
public static DispatcherQueue? DispatcherQueue { get; set; }

/// <summary>
/// Executes the test method on the UI Thread.
Expand All @@ -58,17 +58,19 @@ public UITestMethodAttribute(string displayName)
/// </returns>
/// Throws <exception cref="NotSupportedException"> when run on an async test method.
/// </exception>
public override TestResult[] Execute(ITestMethod testMethod)
public override TestResult?[] Execute(ITestMethod testMethod)
{
var attrib = testMethod.GetAttributes<AsyncStateMachineAttribute>(false);
if (attrib.Length > 0)
var attribute = testMethod.GetAttributes<AsyncStateMachineAttribute>(false);
if (attribute.Length > 0)
{
throw new NotSupportedException(FrameworkMessages.AsyncUITestMethodNotSupported);
}

TestResult result = null;
TestResult? result = null;

var dispatcher = GetDispatcherQueue(testMethod.MethodInfo.DeclaringType.Assembly);
// TODO: Code seems to be assuming DeclaringType is never null, but it can be null.
// Using 'bang' notation for now to ensure same behavior.
var dispatcher = GetDispatcherQueue(testMethod.MethodInfo.DeclaringType!.Assembly);
if (dispatcher == null)
{
throw new InvalidOperationException(FrameworkMessages.AsyncUITestMethodWithNoDispatcherQueue);
Expand All @@ -87,7 +89,7 @@ public override TestResult[] Execute(ITestMethod testMethod)
}
else
{
var taskCompletionSource = new TaskCompletionSource<object>();
var taskCompletionSource = new TaskCompletionSource<object?>();

if (!dispatcher.TryEnqueue(DispatcherQueuePriority.Normal, () =>
{
Expand All @@ -109,10 +111,10 @@ public override TestResult[] Execute(ITestMethod testMethod)
taskCompletionSource.Task.GetAwaiter().GetResult();
}

return new TestResult[] { result };
return new TestResult?[] { result };
}

private static Type GetApplicationType(Assembly assembly)
private static Type? GetApplicationType(Assembly assembly)
{
var attribute = assembly.GetCustomAttribute<WinUITestTargetAttribute>();
if (attribute == null || attribute.ApplicationType == null)
Expand All @@ -123,7 +125,7 @@ private static Type GetApplicationType(Assembly assembly)
return attribute.ApplicationType;
}

private static DispatcherQueue GetApplicationDispatcherQueue(Assembly assembly)
private static DispatcherQueue? GetApplicationDispatcherQueue(Assembly assembly)
{
if (s_applicationDispatcherQueue != null)
{
Expand All @@ -145,7 +147,7 @@ private static DispatcherQueue GetApplicationDispatcherQueue(Assembly assembly)
try
{
// We need to execute all module initializers before doing any WinRT calls.
// This will cause the [ModuleInitialzer]s to execute, if they haven't yet.
// This will cause the [ModuleInitializer]s to execute, if they haven't yet.
var id = applicationType.Assembly.GetType("Microsoft.WindowsAppSDK.Runtime.Identity");
if (id != null)
{
Expand All @@ -159,7 +161,7 @@ private static DispatcherQueue GetApplicationDispatcherQueue(Assembly assembly)
return InitializeApplication(applicationType);
}

private static DispatcherQueue GetDispatcherQueue(Assembly assembly)
private static DispatcherQueue? GetDispatcherQueue(Assembly assembly)
{
if (DispatcherQueue != null)
{
Expand Down
Loading