Fix UITests so it can recover from unresponsive app (#22240)

dotnet · May 7, 2024 · 599af59 · 599af59
1 parent 752eed7
commit 599af59
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 26 deletions.
diff --git a/src/Controls/samples/Controls.Sample.UITests/Issues/Issue19786.xaml.cs b/src/Controls/samples/Controls.Sample.UITests/Issues/Issue19786.xaml.cs
@@ -55,7 +55,9 @@ public Issue19786()
 					Position++;
 			});
 
+#if !WINDOWS
 			BindingContext = this;
+#endif
 		}
 	}
 }
diff --git a/src/Controls/tests/UITests/Tests/Issues/Issue19786.cs b/src/Controls/tests/UITests/Tests/Issues/Issue19786.cs
@@ -16,15 +16,16 @@ public Issue19786(TestDevice device) : base(device)
 		[Category(UITestCategories.CarouselView)]
 		public void RemovingItemsShouldNotCauseCrash()
 		{
+			this.IgnoreIfPlatforms(new TestDevice[] { TestDevice.Windows });
 			_ = App.WaitForElement("addItemButton");
-			App.Click("addItemButton");
-			App.Click("addItemButton");
-			App.Click("addItemButton");
-			App.Click("goToNextItemButton");
-			App.Click("goToNextItemButton");
-			App.Click("removeLastItemButton");
-			App.Click("removeLastItemButton");
-			App.Click("removeLastItemButton");
+			App.Tap("addItemButton");
+			App.Tap("addItemButton");
+			App.Tap("addItemButton");
+			App.Tap("goToNextItemButton");
+			App.Tap("goToNextItemButton");
+			App.Tap("removeLastItemButton");
+			App.Tap("removeLastItemButton");
+			App.Tap("removeLastItemButton");
 		}
 
 	}

diff --git a/src/TestUtils/src/UITest.Appium/Actions/AppiumLifecycleActions.cs b/src/TestUtils/src/UITest.Appium/Actions/AppiumLifecycleActions.cs
@@ -120,8 +120,17 @@ CommandResponse CloseApp(IDictionary<string, object> parameters)
 			if (_app?.Driver is null)
 				return CommandResponse.FailedEmptyResponse;
 
-			if (_app.AppState == ApplicationState.NotRunning)
-				return CommandResponse.SuccessEmptyResponse;
+			try
+			{
+				if (_app.AppState == ApplicationState.NotRunning)
+					return CommandResponse.SuccessEmptyResponse;
+			}
+			catch (Exception)
+			{
+				// Occasionally the app seems to get so locked up it can't 
+				// even report back the appstate. In that case, we'll just
+				// try to trigger a reset.
+			}
 
 			if (_app.GetTestDevice() == TestDevice.Mac)
 			{

diff --git a/src/TestUtils/src/UITest.Appium/AppiumWindowsApp.cs b/src/TestUtils/src/UITest.Appium/AppiumWindowsApp.cs
@@ -26,6 +26,10 @@ public override ApplicationState AppState
 				{
 					return ApplicationState.NotRunning;
 				}
+				catch(Exception)
+				{
+					return ApplicationState.Unknown;
+				}
 			}
 		}
 

diff --git a/src/TestUtils/src/UITest.NUnit/UITestBase.cs b/src/TestUtils/src/UITest.NUnit/UITestBase.cs
@@ -47,7 +47,7 @@ protected virtual void FixtureSetup()
 			TestContext.Progress.WriteLine($">>>>> {DateTime.Now} {nameof(FixtureSetup)} for {name}");
 		}
 
-		protected virtual void FixtureTeardown()
+		protected virtual void FixtureOneTimeTearDown()
 		{
 			try
 			{
@@ -65,7 +65,7 @@ public void UITestBaseTearDown()
 		{
 			try
 			{
-				if (App.AppState == ApplicationState.NotRunning)
+				if (App.AppState != ApplicationState.Running)
 				{
 					SaveDeviceDiagnosticInfo();
 
@@ -117,37 +117,45 @@ public void OneTimeTearDown()
 			{
 				SaveDeviceDiagnosticInfo();
 
-				if (App.AppState != ApplicationState.NotRunning)
+				if (App.AppState == ApplicationState.Running)
 					SaveUIDiagnosticInfo();
 			}
 
-			FixtureTeardown();
+			FixtureOneTimeTearDown();
 		}
 
 		void SaveDeviceDiagnosticInfo([CallerMemberName] string? note = null)
 		{
-			var types = App.GetLogTypes().ToArray();
-			TestContext.Progress.WriteLine($">>>>> {DateTime.Now} Log types: {string.Join(", ", types)}");
-
-			foreach (var logType in new[] { "logcat" })
+			try
 			{
-				if (!types.Contains(logType, StringComparer.InvariantCultureIgnoreCase))
-					continue;
+				var types = App.GetLogTypes().ToArray();
+				TestContext.Progress.WriteLine($">>>>> {DateTime.Now} Log types: {string.Join(", ", types)}");
 
-				var logsPath = GetGeneratedFilePath($"AppLogs-{logType}.log", note);
-				if (logsPath is not null)
+				foreach (var logType in new[] { "logcat" })
 				{
-					var entries = App.GetLogEntries(logType);
-					File.WriteAllLines(logsPath, entries);
+					if (!types.Contains(logType, StringComparer.InvariantCultureIgnoreCase))
+						continue;
 
-					AddTestAttachment(logsPath, Path.GetFileName(logsPath));
+					var logsPath = GetGeneratedFilePath($"AppLogs-{logType}.log", note);
+					if (logsPath is not null)
+					{
+						var entries = App.GetLogEntries(logType);
+						File.WriteAllLines(logsPath, entries);
+
+						AddTestAttachment(logsPath, Path.GetFileName(logsPath));
+					}
 				}
 			}
+			catch (Exception e)
+			{
+				var name = TestContext.CurrentContext.Test.MethodName ?? TestContext.CurrentContext.Test.Name;
+				TestContext.Error.WriteLine($">>>>> {DateTime.Now} The SaveDeviceDiagnosticInfo threw an exception during {name}.{Environment.NewLine}Exception details: {e}");
+			}
 		}
 
 		protected bool SaveUIDiagnosticInfo([CallerMemberName] string? note = null)
 		{
-			if (App.AppState == ApplicationState.NotRunning)
+			if (App.AppState != ApplicationState.Running)
 				return false;
 
 			var screenshotPath = GetGeneratedFilePath("ScreenShot.png", note);