|
| 1 | +import * as net from 'net'; |
| 2 | +import { expect } from 'chai'; |
| 3 | +import adb from '@devicefarmer/adbkit'; |
| 4 | +import { delay } from '@httptoolkit/util'; |
| 5 | + |
| 6 | +import { |
| 7 | + isDevicePortOpen, |
| 8 | + isProbablyRooted, |
| 9 | + run |
| 10 | +} from '../../src/interceptors/android/adb-commands'; |
| 11 | + |
| 12 | +type ServiceHandler = (service: string, socket: net.Socket) => void; |
| 13 | + |
| 14 | +// A fake ADB server, which accepts transport requests for any device, and then |
| 15 | +// passes each device service request to the current test's handler. |
| 16 | +async function startFakeAdbServer( |
| 17 | + handler: ServiceHandler, |
| 18 | + options: { answerTransport: () => boolean } |
| 19 | +) { |
| 20 | + const openSockets = new Set<net.Socket>(); |
| 21 | + |
| 22 | + const server = net.createServer((socket) => { |
| 23 | + openSockets.add(socket); |
| 24 | + socket.on('close', () => openSockets.delete(socket)); |
| 25 | + socket.on('error', () => {}); |
| 26 | + |
| 27 | + let buffer = Buffer.alloc(0); |
| 28 | + socket.on('data', (data) => { |
| 29 | + buffer = Buffer.concat([buffer, data]); |
| 30 | + while (buffer.length >= 4) { |
| 31 | + const length = parseInt(buffer.subarray(0, 4).toString('ascii'), 16); |
| 32 | + if (buffer.length < 4 + length) break; |
| 33 | + const request = buffer.subarray(4, 4 + length).toString('utf8'); |
| 34 | + buffer = buffer.subarray(4 + length); |
| 35 | + |
| 36 | + if (request.startsWith('host:transport:')) { |
| 37 | + if (options.answerTransport()) socket.write('OKAY'); |
| 38 | + } else { |
| 39 | + handler(request, socket); |
| 40 | + } |
| 41 | + } |
| 42 | + }); |
| 43 | + }); |
| 44 | + |
| 45 | + await new Promise<void>((resolve) => server.listen(0, '127.0.0.1', resolve)); |
| 46 | + |
| 47 | + return { |
| 48 | + client: adb.createClient({ port: (server.address() as net.AddressInfo).port }), |
| 49 | + openSockets, |
| 50 | + stop: async () => { |
| 51 | + openSockets.forEach((socket) => socket.destroy()); |
| 52 | + await new Promise((resolve) => server.close(resolve)); |
| 53 | + } |
| 54 | + }; |
| 55 | +} |
| 56 | + |
| 57 | +async function expectAllClosed(openSockets: Set<net.Socket>) { |
| 58 | + for (let i = 0; i < 20 && openSockets.size > 0; i++) await delay(10); |
| 59 | + expect(openSockets.size).to.equal(0); |
| 60 | +} |
| 61 | + |
| 62 | +describe("ADB connection management", function () { |
| 63 | + this.timeout(5000); |
| 64 | + |
| 65 | + let fakeAdb: Awaited<ReturnType<typeof startFakeAdbServer>> | undefined; |
| 66 | + let handler: ServiceHandler; |
| 67 | + let answerTransport: boolean; |
| 68 | + |
| 69 | + beforeEach(async () => { |
| 70 | + handler = () => {}; |
| 71 | + answerTransport = true; |
| 72 | + fakeAdb = await startFakeAdbServer( |
| 73 | + (service, socket) => handler(service, socket), |
| 74 | + { answerTransport: () => answerTransport } |
| 75 | + ); |
| 76 | + }); |
| 77 | + |
| 78 | + afterEach(async () => { |
| 79 | + await fakeAdb?.stop(); |
| 80 | + fakeAdb = undefined; |
| 81 | + }); |
| 82 | + |
| 83 | + it("detects an open device port, and closes the connection", async () => { |
| 84 | + handler = (_service, socket) => socket.write('OKAY'); |
| 85 | + const device = fakeAdb!.client.getDevice('test-device'); |
| 86 | + |
| 87 | + expect(await isDevicePortOpen(device, 1234)).to.equal(true); |
| 88 | + await expectAllClosed(fakeAdb!.openSockets); |
| 89 | + }); |
| 90 | + |
| 91 | + it("detects a closed device port, and closes the connection", async () => { |
| 92 | + handler = (_service, socket) => socket.write('FAIL0006closed'); |
| 93 | + const device = fakeAdb!.client.getDevice('test-device'); |
| 94 | + |
| 95 | + expect(await isDevicePortOpen(device, 1234)).to.equal(false); |
| 96 | + await expectAllClosed(fakeAdb!.openSockets); |
| 97 | + }); |
| 98 | + |
| 99 | + it("closes port checks that never respond", async () => { |
| 100 | + const device = fakeAdb!.client.getDevice('test-device'); |
| 101 | + |
| 102 | + expect(await isDevicePortOpen(device, 1234)).to.equal(false); |
| 103 | + await expectAllClosed(fakeAdb!.openSockets); |
| 104 | + }); |
| 105 | + |
| 106 | + it("closes port checks that respond after timing out", async () => { |
| 107 | + const services: string[] = []; |
| 108 | + handler = (service, socket) => { |
| 109 | + services.push(service); |
| 110 | + setTimeout(() => socket.write('OKAY'), 1200); |
| 111 | + }; |
| 112 | + const device = fakeAdb!.client.getDevice('test-device'); |
| 113 | + |
| 114 | + expect(await isDevicePortOpen(device, 1234)).to.equal(false); |
| 115 | + expect(services).to.deep.equal(['tcp:1234']); |
| 116 | + await expectAllClosed(fakeAdb!.openSockets); |
| 117 | + }); |
| 118 | + |
| 119 | + it("reads shell command results, and closes the connection", async () => { |
| 120 | + handler = (_service, socket) => socket.end('OKAYuid=0(root) gid=0(root)\n'); |
| 121 | + const device = fakeAdb!.client.getDevice('test-device'); |
| 122 | + |
| 123 | + expect(await isProbablyRooted(device)).to.equal(true); |
| 124 | + await expectAllClosed(fakeAdb!.openSockets); |
| 125 | + }); |
| 126 | + |
| 127 | + it("closes shell commands that time out", async () => { |
| 128 | + const services: string[] = []; |
| 129 | + handler = (service, socket) => { |
| 130 | + services.push(service); |
| 131 | + socket.write('OKAY'); // Started, but never completes |
| 132 | + }; |
| 133 | + const device = fakeAdb!.client.getDevice('test-device'); |
| 134 | + |
| 135 | + expect(await isProbablyRooted(device)).to.equal(false); |
| 136 | + expect(services).to.deep.equal([ |
| 137 | + "shell:'command' '-v' 'su'", |
| 138 | + "shell:'id'" |
| 139 | + ]); |
| 140 | + await expectAllClosed(fakeAdb!.openSockets); |
| 141 | + }); |
| 142 | + |
| 143 | + it("closes probes whose device transport is never connected", async () => { |
| 144 | + answerTransport = false; |
| 145 | + const device = fakeAdb!.client.getDevice('test-device'); |
| 146 | + |
| 147 | + expect(await isDevicePortOpen(device, 1234)).to.equal(false); |
| 148 | + await expectAllClosed(fakeAdb!.openSockets); |
| 149 | + }); |
| 150 | + |
| 151 | + it("lets other timed-out commands run to completion", async () => { |
| 152 | + let completeCommand: (() => void) | undefined; |
| 153 | + handler = (_service, socket) => { |
| 154 | + socket.write('OKAY'); |
| 155 | + completeCommand = () => socket.end('done\n'); |
| 156 | + }; |
| 157 | + const device = fakeAdb!.client.getDevice('test-device'); |
| 158 | + |
| 159 | + const result = await run(device, ['some-command'], { timeout: 100, skipLogging: true }) |
| 160 | + .catch((e) => e); |
| 161 | + expect(result).to.be.instanceOf(Error); |
| 162 | + |
| 163 | + await delay(200); |
| 164 | + expect(fakeAdb!.openSockets.size).to.equal(1); |
| 165 | + |
| 166 | + completeCommand!(); |
| 167 | + await expectAllClosed(fakeAdb!.openSockets); |
| 168 | + }); |
| 169 | +}); |
0 commit comments