ide_tooling/cros-ide/src/ide_utilities.ts

// Copyright 2022 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

/**
 * Keep all general utility functions here, or in common_util.
 */
import * as vscode from 'vscode';
import * as childProcess from 'child_process';
import * as cros from './common/cros';

export function runSSH(host: string, args: string[]): Promise<string> {
  return new Promise((resolve, reject) => {
    childProcess.execFile('ssh', [host].concat(args), (error, stdout) => {
      if (error) {
        reject(error);
        return;
      }
      resolve(stdout);
    });
  });
}

export function getConfigRoot(): vscode.WorkspaceConfiguration {
  return vscode.workspace.getConfiguration('cros-ide');
}

export function createTerminalForHost(
    host: string, namePrefix: string, extensionUri: vscode.Uri,
    extraOptions: string): vscode.Terminal {
  const testingRsa =
      vscode.Uri.joinPath(extensionUri, 'resources', 'testing_rsa');
  const terminal = vscode.window.createTerminal(`${namePrefix} ${host}`);
  const splitHost = host.split(':');
  let portOption = '';
  if (splitHost.length === 2) {
    host = splitHost[0];
    portOption = `-p ${splitHost[1]}`;
  }
  terminal.sendText(
      `ssh -i ${testingRsa.fsPath} ${extraOptions} ${portOption} ` +
      `root@${host}; exit $?`);
  return terminal;
}

const loggerInstance = vscode.window.createOutputChannel('cros');
export function getLogger(): vscode.OutputChannel {
  return loggerInstance;
}

// Config section name for the target board.
export const BOARD = 'board';

export async function getOrSelectTargetBoard(): Promise<string | null> {
  const board = getConfigRoot().get<string>(BOARD);
  if (board) {
    return board;
  }
  return await selectAndUpdateTargetBoard({suggestMostRecent: true});
}

/**
 * Ask user to select the board to use. If user selects a board, the config
 * is updated with the board name.
 *
 * @params config If config.suggestMostRecent is true, the board most recently
 * used is proposed to the user, before showing the board picker.
 *
 * TODO(oka): unit test this function (consider stubbing vscode APIs).
 */
export async function selectAndUpdateTargetBoard(
    config: {suggestMostRecent: boolean}): Promise<string | null> {
  const boards = await cros.getSetupBoards();
  if (boards.length === 0) {
    await vscode.window.showErrorMessage('No board has been setup; run ' +
        'setup_board for a board you want to work on.');
    return null;
  }
  const mostRecent = boards[0];

  if (config.suggestMostRecent) {
    const selection = await vscode.window.showWarningMessage(
        `Target board is not set. Do you use ${mostRecent}?`, {
          title: 'Yes',
        }, {
          title: 'Customize',
        });
    if (!selection) {
      return null;
    }
    switch (selection.title) {
      case 'Yes':
        await getConfigRoot().update(BOARD, mostRecent);
        return mostRecent;
      case 'Customize':
        break;
      default:
        return null;
    }
  }

  const board = await vscode.window.showQuickPick(boards, {
    title: 'Target board',
  }) || null;
  if (!board) {
    return null;
  }
  await getConfigRoot().update(BOARD, board);
  return board;
}