Merge pull request #50 from ilamp/main

App Status Support

Author: wherewhere

AdvancedSharpAdbClient.Tests/AdvancedSharpAdbClient.Tests.csproj

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <NoWarn>CS1591</NoWarn>
     <LangVersion>latest</LangVersion>
+    <NoWarn>CS1591</NoWarn>
     <TargetFramework>net6.0</TargetFramework>
   </PropertyGroup>
 
@@ -16,6 +17,9 @@
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" PrivateAssets="all">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
+    <PackageReference Include="coverlet.msbuild" Version="3.2.0" PrivateAssets="all">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
   <ItemGroup>

AdvancedSharpAdbClient.Tests/Dummys/DummyAdbClient.cs

@@ -83,7 +83,7 @@ public Task ExecuteRemoteCommandAsync(string command, DeviceData device, IShellO
 
         public void ClearInput(DeviceData device, int charCount) => throw new NotImplementedException();
 
-        public Task ClearInputAsync(DeviceData device, int charcount, CancellationToken cancellationToken) => throw new NotImplementedException();
+        public Task ClearInputAsync(DeviceData device, int charCount, CancellationToken cancellationToken) => throw new NotImplementedException();
 
         public void Click(DeviceData device, Cords cords) => throw new NotImplementedException();
 
@@ -131,6 +131,10 @@ public Task ExecuteRemoteCommandAsync(string command, DeviceData device, IShellO
 
         public Task<int> GetAdbVersionAsync(CancellationToken cancellationToken) => throw new NotImplementedException();
 
+        public AppStatus GetAppStatus(DeviceData device, string packageName) => throw new NotImplementedException();
+
+        public Task<AppStatus> GetAppStatusAsync(DeviceData device, string packageName, CancellationToken cancellationToken) => throw new NotImplementedException();
+
         public List<DeviceData> GetDevices() => throw new NotImplementedException();
 
         public Task<List<DeviceData>> GetDevicesAsync(CancellationToken cancellationToken) => throw new NotImplementedException();
@@ -177,6 +181,14 @@ public Task ExecuteRemoteCommandAsync(string command, DeviceData device, IShellO
 
         public Task InstallWriteAsync(DeviceData device, Stream apk, string apkName, string session, CancellationToken cancellationToken) => throw new NotImplementedException();
 
+        public bool IsAppRunning(DeviceData device, string packageName) => throw new NotImplementedException();
+
+        public Task<bool> IsAppRunningAsync(DeviceData device, string packageName, CancellationToken cancellationToken) => throw new NotImplementedException();
+
+        public bool IsCurrentApp(DeviceData device, string packageName) => throw new NotImplementedException();
+
+        public Task<bool> IsCurrentAppAsync(DeviceData device, string packageName, CancellationToken cancellationToken) => throw new NotImplementedException();
+
         public void KillAdb() => throw new NotImplementedException();
 
         public Task KillAdbAsync(CancellationToken cancellationToken) => throw new NotImplementedException();

AdvancedSharpAdbClient/AdbClient.Async.cs

@@ -452,9 +452,9 @@ public async Task InstallAsync(DeviceData device, Stream apk, CancellationToken
                 throw new AdbException(value);
             }
         }
-        
+
         /// <inheritdoc/>
-        public Task InstallMultipleAsync(DeviceData device, Stream[] splitAPKs, string packageName, params string[] arguments)=>
+        public Task InstallMultipleAsync(DeviceData device, Stream[] splitAPKs, string packageName, params string[] arguments) =>
             InstallMultipleAsync(device, splitAPKs, packageName, default, arguments);
 
         /// <inheritdoc/>
@@ -709,7 +709,7 @@ public async Task<XmlDocument> DumpScreenAsync(DeviceData device, CancellationTo
             }
             return null;
         }
-        
+
         /// <inheritdoc/>
         public async Task ClickAsync(DeviceData device, Cords cords, CancellationToken cancellationToken = default)
         {
@@ -793,7 +793,46 @@ public async Task SwipeAsync(DeviceData device, int x1, int y1, int x2, int y2,
                 throw new ElementNotFoundException("Coordinates of element is invalid");
             }
         }
-        
+
+        /// <inheritdoc/>
+        public async Task<bool> IsCurrentAppAsync(DeviceData device, string packageName, CancellationToken cancellationToken = default)
+        {
+            ConsoleOutputReceiver receiver = new();
+            await ExecuteRemoteCommandAsync($"dumpsys activity activities | grep mResumedActivity", device, receiver, cancellationToken);
+            string response = receiver.ToString().Trim();
+            return response.ToString().Contains(packageName);
+        }
+
+        /// <inheritdoc/>
+        public async Task<bool> IsAppRunningAsync(DeviceData device, string packageName, CancellationToken cancellationToken = default)
+        {
+            ConsoleOutputReceiver receiver = new();
+            await ExecuteRemoteCommandAsync($"pidof {packageName}", device, receiver, cancellationToken);
+            string response = receiver.ToString().Trim();
+            bool intParsed = int.TryParse(response, out int pid);
+            return intParsed && pid > 0;
+        }
+
+        /// <inheritdoc/>
+        public async Task<AppStatus> GetAppStatusAsync(DeviceData device, string packageName, CancellationToken cancellationToken = default)
+        {
+            // Check if the app is in foreground
+            bool currentApp = await IsCurrentAppAsync(device, packageName, cancellationToken);
+            if (currentApp)
+            {
+                return AppStatus.Foreground;
+            }
+
+            // Check if the app is running in background
+            bool isAppRunning = await IsAppRunningAsync(device, packageName, cancellationToken);
+            if (isAppRunning)
+            {
+                return AppStatus.Background;
+            }
+
+            return AppStatus.Stopped;
+        }
+
         /// <inheritdoc/>
         public async Task<Element> FindElementAsync(DeviceData device, string xpath, CancellationToken cancellationToken = default)
         {

AdvancedSharpAdbClient/AdbClient.cs

@@ -755,6 +755,45 @@ public void Swipe(DeviceData device, int x1, int y1, int x2, int y2, long speed)
             }
         }
 
+        /// <inheritdoc/>
+        public bool IsCurrentApp(DeviceData device, string packageName)
+        {
+            ConsoleOutputReceiver receiver = new();
+            ExecuteRemoteCommand($"dumpsys activity activities | grep mResumedActivity", device, receiver);
+            string response = receiver.ToString().Trim();
+            return response.ToString().Contains(packageName);
+        }
+
+        /// <inheritdoc/>
+        public bool IsAppRunning(DeviceData device, string packageName)
+        {
+            ConsoleOutputReceiver receiver = new();
+            ExecuteRemoteCommand($"pidof {packageName}", device, receiver);
+            string response = receiver.ToString().Trim();
+            bool intParsed = int.TryParse(response, out int pid);
+            return intParsed && pid > 0;
+        }
+
+        /// <inheritdoc/>
+        public AppStatus GetAppStatus(DeviceData device, string packageName)
+        {
+            // Check if the app is in foreground
+            bool currentApp = IsCurrentApp(device, packageName);
+            if (currentApp)
+            {
+                return AppStatus.Foreground;
+            }
+
+            // Check if the app is running in background
+            bool isAppRunning = IsAppRunning(device, packageName);
+            if (isAppRunning)
+            {
+                return AppStatus.Background;
+            }
+
+            return AppStatus.Stopped;
+        }
+
         /// <inheritdoc/>
         public Element FindElement(DeviceData device, string xpath, TimeSpan timeout = default)
         {
@@ -829,7 +868,7 @@ public Element[] FindElements(DeviceData device, string xpath, TimeSpan timeout
             }
             return null;
         }
-        
+
         /// <inheritdoc/>
         public void SendKeyEvent(DeviceData device, string key)
         {

AdvancedSharpAdbClient/DeviceCommands/Models/AndroidProcessState.cs

@@ -15,7 +15,7 @@ public enum AndroidProcessState
         Unknown,
 
         /// <summary>
-        /// Running or runnable (on run queue).
+        /// Foreground or runnable (on run queue).
         /// </summary>
         R,
 

AdvancedSharpAdbClient/Interfaces/IAdbClient.Async.cs

@@ -468,6 +468,33 @@ public partial interface IAdbClient
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
         Task SwipeAsync(DeviceData device, int x1, int y1, int x2, int y2, long speed, CancellationToken cancellationToken);
 
+        /// <summary>
+        /// Check if the app is running in foreground.
+        /// </summary>
+        /// <param name="device">The device on which to check.</param>
+        /// <param name="packageName">The package name of the app to check.</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
+        /// <returns>An <see cref="Task"/> which return the result. <see langword="true"/> if the app is running in foreground; otherwise, <see langword="false"/>.</returns>
+        Task<bool> IsCurrentAppAsync(DeviceData device, string packageName, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Check if the app is running in background.
+        /// </summary>
+        /// <param name="device">The device on which to check.</param>
+        /// <param name="packageName">The package name of the app to check.</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
+        /// <returns>An <see cref="Task"/> which return the result. <see langword="true"/> if the app is running in background; otherwise, <see langword="false"/>.</returns>
+        Task<bool> IsAppRunningAsync(DeviceData device, string packageName, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Get the <see cref="AppStatus"/> of the app.
+        /// </summary>
+        /// <param name="device">The device on which to get status.</param>
+        /// <param name="packageName">The package name of the app to check.</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
+        /// <returns>An <see cref="Task"/> which return the <see cref="AppStatus"/> of the app. Foreground, stopped or running in background.</returns>
+        Task<AppStatus> GetAppStatusAsync(DeviceData device, string packageName, CancellationToken cancellationToken);
+
         /// <summary>
         /// Get element by xpath asynchronously. You can specify the waiting time in timeout.
         /// </summary>

AdvancedSharpAdbClient/Interfaces/IAdbClient.cs

@@ -409,6 +409,30 @@ public partial interface IAdbClient
         /// <param name="speed"></param>
         void Swipe(DeviceData device, int x1, int y1, int x2, int y2, long speed);
 
+        /// <summary>
+        /// Check if the app is running in foreground.
+        /// </summary>
+        /// <param name="device">The device on which to check.</param>
+        /// <param name="packageName">The package name of the app to check.</param>
+        /// <returns><see langword="true"/> if the app is running in foreground; otherwise, <see langword="false"/>.</returns>
+        bool IsCurrentApp(DeviceData device, string packageName);
+
+        /// <summary>
+        /// Check if the app is running in background.
+        /// </summary>
+        /// <param name="device">The device on which to check.</param>
+        /// <param name="packageName">The package name of the app to check.</param>
+        /// <returns><see langword="true"/> if the app is running in background; otherwise, <see langword="false"/>.</returns>
+        bool IsAppRunning(DeviceData device, string packageName);
+
+        /// <summary>
+        /// Get the <see cref="AppStatus"/> of the app.
+        /// </summary>
+        /// <param name="device">The device on which to get status.</param>
+        /// <param name="packageName">The package name of the app to check.</param>
+        /// <returns>The <see cref="AppStatus"/> of the app. Foreground, stopped or running in background.</returns>
+        AppStatus GetAppStatus(DeviceData device, string packageName);
+
         /// <summary>
         /// Get element by xpath. You can specify the waiting time in timeout.
         /// </summary>

AdvancedSharpAdbClient/Models/Enums/AppStatus.cs

@@ -0,0 +1,29 @@
+// <copyright file="AppStatus.cs" company="The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere">
+// Copyright (c) The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere. All rights reserved.
+// </copyright>
+
+using System;
+
+namespace AdvancedSharpAdbClient
+{
+    /// <summary>
+    /// The status of an application if it is stopped or running in foreground or background.
+    /// </summary>
+    public enum AppStatus
+    {
+        /// <summary>
+        /// The application is stopped.
+        /// </summary>
+        Stopped = 0B00,
+
+        /// <summary>
+        /// The application is running in background.
+        /// </summary>
+        Background = 0B01,
+
+        /// <summary>
+        /// The application is running in foreground.
+        /// </summary>
+        Foreground = 0B11,
+    }
+}