ui/src/controller/adb_interfaces.ts

// Copyright (C) 2019 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

export interface Adb {
  connect(device: USBDevice): Promise<void>;
  disconnect(): Promise<void>;
  // Executes a shell command non-interactively.
  shell(cmd: string): Promise<AdbStream>;
  // Waits until the shell get closed, and returns all the output.
  shellOutputAsString(cmd: string): Promise<string>;
  // Opens a connection to a UNIX socket.
  socket(path: string): Promise<AdbStream>;
}

export interface AdbStream {
  write(msg: string | Uint8Array): Promise<void>;
  onMessage(message: AdbMsg): void;
  close(): void;
  setClosed(): void;

  onConnect: VoidCallback;
  onClose: VoidCallback;
  onData: (raw: Uint8Array) => void;
}

export class MockAdb implements Adb {
  connect(_: USBDevice): Promise<void> {
    return Promise.resolve();
  }

  disconnect(): Promise<void> {
    return Promise.resolve();
  }

  shell(_: string): Promise<AdbStream> {
    return Promise.resolve(new MockAdbStream());
  }

  shellOutputAsString(_: string): Promise<string> {
    return Promise.resolve('');
  }

  socket(_: string): Promise<AdbStream> {
    return Promise.resolve(new MockAdbStream());
  }
}

export class MockAdbStream implements AdbStream {
  write(_: string | Uint8Array): Promise<void> {
    return Promise.resolve();
  }
  onMessage = (_: AdbMsg) => {};
  close() {}
  setClosed() {}

  onConnect = () => {};
  onClose = () => {};
  onData = (_: Uint8Array) => {};
}

export declare type CmdType =
  | 'CNXN'
  | 'AUTH'
  | 'CLSE'
  | 'OKAY'
  | 'WRTE'
  | 'OPEN';

export interface AdbMsg {
  cmd: CmdType;
  arg0: number;
  arg1: number;
  data: Uint8Array;
  dataLen: number;
  dataChecksum: number;
}