chore: Deprecate legacy app management helpers (#608)

Dor-bl · web-flow · commit 940fd0697eb5 · 2023-04-29T22:37:42.000+03:00
* chore: Deprecate legacy app management helpers

* chore: add link and clearer info on the Obsolete message
diff --git a/src/Appium.Net/Appium/AppiumCommand.cs b/src/Appium.Net/Appium/AppiumCommand.cs
@@ -114,12 +114,18 @@ public class AppiumCommand
                 "/session/{sessionId}/appium/getPerformanceData"),
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.GetPerformanceDataTypes,
                 "/session/{sessionId}/appium/performanceData/types"),
+
+            #region (Deprecated) legacy app management
+
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.LaunchApp,
                 "/session/{sessionId}/appium/app/launch"),
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.CloseApp,
                 "/session/{sessionId}/appium/app/close"),
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.ResetApp,
                 "/session/{sessionId}/appium/app/reset"),
+
+            #endregion (Deprecated) legacy app management
+
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.BackgroundApp,
                 "/session/{sessionId}/appium/app/background"),
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.EndTestCoverage,
@@ -144,8 +150,6 @@ public class AppiumCommand
                 "/session/{sessionId}/appium/device/finger_print"),
 
             #endregion Driver Commands
-
-            
             
             #region (Deprecated) Touch Commands 
             // TODO: Remove this region once we deprecate the touch actions
diff --git a/src/Appium.Net/Appium/AppiumDriver.cs b/src/Appium.Net/Appium/AppiumDriver.cs
@@ -178,10 +178,11 @@ public void PushFile(string pathOnDevice, byte[] base64Data) =>
         public void PushFile(string pathOnDevice, FileInfo file) =>
             AppiumCommandExecutionHelper.PushFile(this, pathOnDevice, file);
 
+        [Obsolete("The LaunchApp API is deprecated and will be removed in future versions. Please use ActivateApp instead \r\n See https://github.com/appium/appium/issues/15807")]
         public void LaunchApp() => ((IExecuteMethod)this).Execute(AppiumDriverCommand.LaunchApp);
-
+        [Obsolete("The CloseApp API is deprecated and will be removed in future versions. Please use TerminateApp instead \r\n See https://github.com/appium/appium/issues/15807")]
         public void CloseApp() => ((IExecuteMethod)this).Execute(AppiumDriverCommand.CloseApp);
-
+        [Obsolete("The ResetApp API is deprecated and will be removed in future versions. Please use TerminateApp & ActivateApp instead \r\n See https://github.com/appium/appium/issues/15807")]
         public void ResetApp() => ((IExecuteMethod)this).Execute(AppiumDriverCommand.ResetApp);
 
         public void FingerPrint(int fingerprintId) =>
diff --git a/src/Appium.Net/Appium/AppiumDriverCommand.cs b/src/Appium.Net/Appium/AppiumDriverCommand.cs
@@ -143,6 +143,8 @@ public class AppiumDriverCommand
         /// </summary>
         public const string ToggleLocationServices = "toggleLocationServices";
 
+        #region (Deprecated) legacy app management
+
         /// <summary>
         /// Launch App Command.
         /// </summary>
@@ -158,6 +160,8 @@ public class AppiumDriverCommand
         /// </summary>
         public const string ResetApp = "resetApp";
 
+        #endregion (Deprecated) legacy app management
+
         /// <summary>
         ///  Background App Command.
         /// </summary>
diff --git a/src/Appium.Net/Appium/Windows/WindowsDriver.cs b/src/Appium.Net/Appium/Windows/WindowsDriver.cs
@@ -141,5 +141,19 @@ public void PressKeyCode(int keyCode, int metastate = -1) =>
 
         public void LongPressKeyCode(int keyCode, int metastate = -1) =>
             AppiumCommandExecutionHelper.LongPressKeyCode(this, keyCode, metastate);
+
+        #region App management
+
+        public new void LaunchApp()
+        {
+            ((IExecuteMethod)this).Execute(AppiumDriverCommand.LaunchApp);
+        }
+
+        public new void CloseApp()
+        {
+            ((IExecuteMethod)this).Execute(AppiumDriverCommand.CloseApp);
+        }
+
+        #endregion App management
     }
 }
diff --git a/test/integration/Android/ActivityTest.cs b/test/integration/Android/ActivityTest.cs
@@ -9,6 +9,7 @@ public class ActivityTest
     {
         private AndroidDriver _driver;
         private const string ContactsActivity = ".activities.PeopleActivity";
+        private const string AppId = "io.appium.android.apis";
 
         [OneTimeSetUp]
         public void BeforeAll()
@@ -20,41 +21,41 @@ public void BeforeAll()
             var serverUri = Env.ServerIsRemote() ? AppiumServers.RemoteServerUri : AppiumServers.LocalServiceUri;
             _driver = new AndroidDriver(serverUri, capabilities, Env.InitTimeoutSec);
             _driver.Manage().Timeouts().ImplicitWait = Env.ImplicitTimeoutSec;
-            _driver.CloseApp();
+            _driver.TerminateApp(AppId);
         }
 
         [SetUp]
         public void SetUp()
         {
-            _driver?.LaunchApp();
+            _driver?.ActivateApp(AppId);
         }
 
         [TearDown]
         public void TearDowwn()
         {
-            _driver?.CloseApp();
+            _driver.TerminateApp(AppId);
         }
 
         [Test]
         public void StartActivityInThisAppTestCase()
         {
-            _driver.StartActivity("io.appium.android.apis", ".ApiDemos");
+            _driver.StartActivity(AppId, ".ApiDemos");
 
             Assert.AreEqual(_driver.CurrentActivity, ".ApiDemos");
 
-            _driver.StartActivity("io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity");
+            _driver.StartActivity(AppId, ".accessibility.AccessibilityNodeProviderActivity");
 
             Assert.AreEqual(_driver.CurrentActivity, ".accessibility.AccessibilityNodeProviderActivity");
         }
 
         [Test]
         public void StartActivityWithWaitingAppTestCase()
         {
-            _driver.StartActivity("io.appium.android.apis", ".ApiDemos", "io.appium.android.apis", ".ApiDemos");
+            _driver.StartActivity(AppId, ".ApiDemos", AppId, ".ApiDemos");
 
             Assert.AreEqual(_driver.CurrentActivity, ".ApiDemos");
 
-            _driver.StartActivity("io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity",
+            _driver.StartActivity(AppId, ".accessibility.AccessibilityNodeProviderActivity",
                 "io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity");
 
             Assert.AreEqual(_driver.CurrentActivity, ".accessibility.AccessibilityNodeProviderActivity");
@@ -63,7 +64,7 @@ public void StartActivityWithWaitingAppTestCase()
         [Test]
         public void StartActivityInNewAppTestCase()
         {
-            _driver.StartActivity("io.appium.android.apis", ".ApiDemos");
+            _driver.StartActivity(AppId, ".ApiDemos");
 
             Assert.AreEqual(_driver.CurrentActivity, ".ApiDemos");
 
@@ -77,7 +78,7 @@ public void StartActivityInNewAppTestCase()
         [Test]
         public void StartActivityInNewAppTestCaseWithoutClosingApp()
         {
-            _driver.StartActivity("io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity");
+            _driver.StartActivity(AppId, ".accessibility.AccessibilityNodeProviderActivity");
 
             Assert.AreEqual(_driver.CurrentActivity, ".accessibility.AccessibilityNodeProviderActivity");
 

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ public class ActivityTest`
`9`	`9`	`{`
`10`	`10`	`private AndroidDriver _driver;`
`11`	`11`	`private const string ContactsActivity = ".activities.PeopleActivity";`
	`12`	`+ private const string AppId = "io.appium.android.apis";`
`12`	`13`
`13`	`14`	`[OneTimeSetUp]`
`14`	`15`	`public void BeforeAll()`
`@@ -20,41 +21,41 @@ public void BeforeAll()`
`20`	`21`	`var serverUri = Env.ServerIsRemote() ? AppiumServers.RemoteServerUri : AppiumServers.LocalServiceUri;`
`21`	`22`	`_driver = new AndroidDriver(serverUri, capabilities, Env.InitTimeoutSec);`
`22`	`23`	`_driver.Manage().Timeouts().ImplicitWait = Env.ImplicitTimeoutSec;`
`23`		`- _driver.CloseApp();`
	`24`	`+ _driver.TerminateApp(AppId);`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`[SetUp]`
`27`	`28`	`public void SetUp()`
`28`	`29`	`{`
`29`		`- _driver?.LaunchApp();`
	`30`	`+ _driver?.ActivateApp(AppId);`
`30`	`31`	`}`
`31`	`32`
`32`	`33`	`[TearDown]`
`33`	`34`	`public void TearDowwn()`
`34`	`35`	`{`
`35`		`- _driver?.CloseApp();`
	`36`	`+ _driver.TerminateApp(AppId);`
`36`	`37`	`}`
`37`	`38`
`38`	`39`	`[Test]`
`39`	`40`	`public void StartActivityInThisAppTestCase()`
`40`	`41`	`{`
`41`		`- _driver.StartActivity("io.appium.android.apis", ".ApiDemos");`
	`42`	`+ _driver.StartActivity(AppId, ".ApiDemos");`
`42`	`43`
`43`	`44`	`Assert.AreEqual(_driver.CurrentActivity, ".ApiDemos");`
`44`	`45`
`45`		`- _driver.StartActivity("io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity");`
	`46`	`+ _driver.StartActivity(AppId, ".accessibility.AccessibilityNodeProviderActivity");`
`46`	`47`
`47`	`48`	`Assert.AreEqual(_driver.CurrentActivity, ".accessibility.AccessibilityNodeProviderActivity");`
`48`	`49`	`}`
`49`	`50`
`50`	`51`	`[Test]`
`51`	`52`	`public void StartActivityWithWaitingAppTestCase()`
`52`	`53`	`{`
`53`		`- _driver.StartActivity("io.appium.android.apis", ".ApiDemos", "io.appium.android.apis", ".ApiDemos");`
	`54`	`+ _driver.StartActivity(AppId, ".ApiDemos", AppId, ".ApiDemos");`
`54`	`55`
`55`	`56`	`Assert.AreEqual(_driver.CurrentActivity, ".ApiDemos");`
`56`	`57`
`57`		`- _driver.StartActivity("io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity",`
	`58`	`+ _driver.StartActivity(AppId, ".accessibility.AccessibilityNodeProviderActivity",`
`58`	`59`	`"io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity");`
`59`	`60`
`60`	`61`	`Assert.AreEqual(_driver.CurrentActivity, ".accessibility.AccessibilityNodeProviderActivity");`
`@@ -63,7 +64,7 @@ public void StartActivityWithWaitingAppTestCase()`
`63`	`64`	`[Test]`
`64`	`65`	`public void StartActivityInNewAppTestCase()`
`65`	`66`	`{`
`66`		`- _driver.StartActivity("io.appium.android.apis", ".ApiDemos");`
	`67`	`+ _driver.StartActivity(AppId, ".ApiDemos");`
`67`	`68`
`68`	`69`	`Assert.AreEqual(_driver.CurrentActivity, ".ApiDemos");`
`69`	`70`
`@@ -77,7 +78,7 @@ public void StartActivityInNewAppTestCase()`
`77`	`78`	`[Test]`
`78`	`79`	`public void StartActivityInNewAppTestCaseWithoutClosingApp()`
`79`	`80`	`{`
`80`		`- _driver.StartActivity("io.appium.android.apis", ".accessibility.AccessibilityNodeProviderActivity");`
	`81`	`+ _driver.StartActivity(AppId, ".accessibility.AccessibilityNodeProviderActivity");`
`81`	`82`
`82`	`83`	`Assert.AreEqual(_driver.CurrentActivity, ".accessibility.AccessibilityNodeProviderActivity");`
`83`	`84`