chore: refactor parts of code add rest of tests for ADB module

Author: okwasniewski

MiniSim/Service/Adb.swift

@@ -6,29 +6,22 @@
 //
 
 import Foundation
-import ShellOut
 
 protocol ADBProtocol {
     static var shell: ShellProtocol.Type { get set }
 
     static func getAdbPath() throws -> String
     static func getEmulatorPath() throws -> String
-    static func getAdbId(
-        for deviceName: String,
-        adbPath: String
-    ) throws -> String
+    static func getAdbId(for deviceName: String) throws -> String
     static func checkAndroidHome(
         path: String,
         fileManager: FileManager
     ) throws -> Bool
-    static func isAccesibilityOn(
-        deviceId: String,
-        adbPath: String
-    ) -> Bool
+    static func isAccesibilityOn(deviceId: String) -> Bool
+    static func toggleAccesibility(deviceId: String)
 }
 
 final class ADB: ADBProtocol {
-
     static var shell: ShellProtocol.Type = Shell.self
 
     static let talkbackOn = "com.google.android.marvin.talkback/com.google.android.marvin.talkback.TalkBackService"
@@ -89,10 +82,8 @@ final class ADB: ADBProtocol {
         try getAndroidHome() + Paths.emulator.rawValue
     }
 
-    static func getAdbId(
-        for deviceName: String,
-        adbPath: String
-    ) throws -> String {
+    static func getAdbId(for deviceName: String) throws -> String {
+        let adbPath = try Self.getAdbPath()
         let onlineDevices = try shell.execute(command: "\(adbPath) devices")
         let splitted = onlineDevices.components(separatedBy: "\n")
 
@@ -116,9 +107,12 @@ final class ADB: ADBProtocol {
         throw DeviceError.deviceNotFound
     }
 
-    static func isAccesibilityOn(deviceId: String, adbPath: String) -> Bool {
+    static func isAccesibilityOn(deviceId: String) -> Bool {
+        guard let adbPath = try? Self.getAdbPath() else {
+            return false
+        }
         let shellCommand = "\(adbPath) -s \(deviceId) shell settings get secure enabled_accessibility_services"
-        guard let result = try? shellOut(to: [shellCommand]) else {
+        guard let result = try? shell.execute(command: shellCommand) else {
             return false
         }
 
@@ -128,4 +122,16 @@ final class ADB: ADBProtocol {
 
         return false
     }
+
+    static func toggleAccesibility(deviceId: String) {
+        guard let adbPath = try? Self.getAdbPath() else {
+            return
+        }
+        let a11yIsEnabled = Self.isAccesibilityOn(deviceId: deviceId)
+        let value = a11yIsEnabled ? ADB.talkbackOff : ADB.talkbackOn
+        let shellCmd = "\(adbPath) -s \(deviceId) shell settings put secure enabled_accessibility_services \(value)"
+
+        // Ignore the error if toggling a11y fails.
+        _ = try? shell.execute(command: shellCmd)
+    }
 }

MiniSim/Service/DeviceService.swift

@@ -385,21 +385,16 @@ extension DeviceService {
         return splitted
             .filter { !$0.isEmpty }
             .map { deviceName in
-                let adbId = try? ADB.getAdbId(for: deviceName, adbPath: adbPath)
+                let adbId = try? ADB.getAdbId(for: deviceName)
                 return Device(name: deviceName, identifier: adbId, booted: adbId != nil, platform: .android)
             }
     }
 
     static func toggleA11y(device: Device) throws {
-        let adbPath = try ADB.getAdbPath()
         guard let adbId = device.identifier else {
             throw DeviceError.deviceNotFound
         }
-
-        let a11yIsEnabled = ADB.isAccesibilityOn(deviceId: adbId, adbPath: adbPath)
-        let value = a11yIsEnabled ? ADB.talkbackOff : ADB.talkbackOn
-        let shellCmd = "\(adbPath) -s \(adbId) shell settings put secure enabled_accessibility_services \(value)"
-        _ = try? shellOut(to: shellCmd)
+        ADB.toggleAccesibility(deviceId: adbId)
     }
 
     static func sendText(device: Device, text: String) throws {

MiniSimTests/ADBTests.swift

@@ -49,8 +49,8 @@ final class ADBTests: XCTestCase {
             fileManager: FileManagerStub()
         )
         XCTAssertEqual(output, true)
-        XCTAssertEqual(ShellStub.executedCommand, defaultHomePath + "/emulator/emulator")
-        XCTAssertEqual(ShellStub.passedParameters, ["-list-avds"])
+        XCTAssertEqual(ShellStub.lastExecutedCommand, defaultHomePath + "/emulator/emulator")
+        XCTAssertEqual(ShellStub.lastPassedArguments, ["-list-avds"])
 
         XCTAssertThrowsError(
             try ADB.checkAndroidHome(
@@ -73,4 +73,55 @@ final class ADBTests: XCTestCase {
             defaultHomePath + "/cmdline-tools/latest/bin/avdmanager"
         )
     }
+
+    func testGetAdbId() throws {
+        ShellStub.mockedExecute = { command, _, _ in
+            if command.contains("devices") {
+                return """
+                List of devices attached
+                emulator-5554    device
+                emulator-5556    device
+                """
+            }
+
+            if command.contains("avd name") {
+                return """
+                Pixel_XL_API_32
+                OK
+                """
+            }
+
+            return ""
+        }
+        let adbId = try ADB.getAdbId(for: "Pixel_XL_API_32")
+
+        XCTAssertEqual(adbId, "emulator-5554")
+
+        XCTAssertThrowsError(
+            try ADB.getAdbId(for: "Pixel_Not_Found")
+        )
+    }
+
+    func testIsAccesibilityOn() throws {
+        var isA11yOn: Bool
+        isA11yOn = ADB.isAccesibilityOn(deviceId: "emulator-5544")
+        XCTAssertFalse(isA11yOn)
+
+        ShellStub.mockedExecute = { _, _, _ in
+            "com.google.android.marvin.talkback/com.google.android.marvin.talkback.TalkBackService"
+        }
+        isA11yOn = ADB.isAccesibilityOn(deviceId: "emulator-5544")
+        XCTAssertTrue(isA11yOn)
+    }
+
+    func testToggle11y() {
+        UserDefaults.standard.androidHome = "adbPath"
+        let expectedCommand = """
+        adbPath/platform-tools/adb -s emulator-5544 shell settings put secure enabled_accessibility_services com.google.android.marvin.talkback/com.google.android.marvin.talkback.TalkBackService
+        """
+
+        ADB.toggleAccesibility(deviceId: "emulator-5544")
+        XCTAssertEqual(ShellStub.lastExecutedCommand, expectedCommand)
+        XCTAssertEqual(ShellStub.lastPassedArguments, [])
+    }
 }

MiniSimTests/Mocks/ShellStub.swift

@@ -3,20 +3,25 @@ import Foundation
 @testable import MiniSim
 
 class ShellStub: ShellProtocol {
-    private(set) static var executedCommand: String = ""
-    private(set) static var passedParameters: [String] = []
-    private(set) static var passedPath: String = ""
+    private(set) static var lastExecutedCommand: String = ""
+    private(set) static var lastPassedArguments: [String] = []
+    private(set) static var lastPassedPath: String = ""
+    static var mockedExecute: ((_ command: String, _ arguments: [String], _ atPath: String) -> String)?
 
     static func execute(command: String, arguments: [String], atPath: String) throws -> String {
-        executedCommand = command
-        passedParameters = arguments
-        passedPath = atPath
+        lastExecutedCommand = command
+        lastPassedArguments = arguments
+        lastPassedPath = atPath
+        if let mockedExecute {
+            return mockedExecute(command, arguments, atPath)
+        }
         return ""
     }
 
     static func tearDown() {
-        executedCommand = ""
-        passedParameters = []
-        passedPath = ""
+        lastExecutedCommand = ""
+        lastPassedArguments = []
+        lastPassedPath = ""
+        mockedExecute = nil
     }
 }