Merge pull request #96 from maejima-fumika/feature/bscript-update

Add an update command  to CLI and  refactor tests for CLI

Author: maejima-fumika

cli/.gitignore

@@ -4,3 +4,4 @@ node_modules/
 .idea/
 a.out.dSYM/
 tsconfig.tsbuildinfo
+temp-files/

cli/src/commands/board/flash-runtime.ts

@@ -2,24 +2,17 @@ import { Command } from "commander";
 import inquirer from 'inquirer';
 import * as path from 'path';
 import { SerialPort } from 'serialport'
-import { GlobalConfigHandler } from "../../config/global-config";
 import { BoardName } from "../../config/board-utils";
 import { logger, LogStep, showErrorMessages } from "../../core/logger";
 import { exec } from '../../core/shell';
 import chalk from "chalk";
+import { CommandHandler } from "../command";
 
 
 const RUNTIME_ESP_PORT_DIR = (runtimeDir: string) => path.join(runtimeDir, 'ports/esp32');
 
-abstract class FlashRuntimeHandler {
-    globalConfigHandler: GlobalConfigHandler;
-    
-    constructor() {
-        this.globalConfigHandler = GlobalConfigHandler.load();
-    }
-
+abstract class FlashRuntimeHandler extends CommandHandler {
     abstract isSetup(): boolean;
-
     abstract flashRuntime(port: string, monitor: boolean): Promise<void>;
 }
 

cli/src/commands/board/full-clean.ts

@@ -2,10 +2,26 @@ import { Command } from "commander";
 import inquirer from 'inquirer';
 import { logger, showErrorMessages } from "../../core/logger";
 import * as fs from '../../core/fs';
-import { GLOBAL_BLUESCRIPT_PATH } from "../../config/global-config";
+import { CommandHandler } from "../command";
+import { GLOBAL_SETTINGS } from "../../config/constants";
 
-export async function handleFullcleanCommand(options: { force: boolean }) {
+
+class FullcleanHandler extends CommandHandler {
+    constructor() {
+        super(false);
+    }
+
+    fullclean() {
+        if (fs.exists(GLOBAL_SETTINGS.BLUESCRIPT_DIR)) {
+            fs.removeDir(GLOBAL_SETTINGS.BLUESCRIPT_DIR);
+        }
+    }
+}
+
+export async function handleFullcleanCommand(options: { force?: boolean }) {
     try {
+        const fullcleanHandler = new FullcleanHandler();
+
         let confirmed = options.force;
         if (!confirmed) {
             const { proceed } = await inquirer.prompt([
@@ -24,9 +40,7 @@ export async function handleFullcleanCommand(options: { force: boolean }) {
         }
 
         // Fullclean
-        if (fs.exists(GLOBAL_BLUESCRIPT_PATH)) {
-            fs.removeDir(GLOBAL_BLUESCRIPT_PATH);
-        }
+        fullcleanHandler.fullclean();
 
         logger.br();
         logger.success(`Success to delete entire settings.`);

cli/src/commands/board/list.ts

@@ -1,19 +1,25 @@
 import { Command } from "commander";
 import chalk from 'chalk';
-import { GlobalConfigHandler } from "../../config/global-config";
 import { BOARD_NAMES } from "../../config/board-utils";
 import { logger, showErrorMessages } from "../../core/logger";
+import { CommandHandler } from "../command";
 
-export async function handleListCommand() {
-    try {
-        const supportedBoards = BOARD_NAMES;
-        const globalConfigHandler = GlobalConfigHandler.load();
 
+class ListHandler extends CommandHandler {
+    list() {
+        const supportedBoards = BOARD_NAMES;
         logger.log('Available boards:');
         supportedBoards.forEach(board => {
-            const isSetup = globalConfigHandler.isBoardSetup(board);
+            const isSetup = this.globalConfigHandler.isBoardSetup(board);
             logger.log(' --', board, isSetup ? ` - ${chalk.green('set up')}` : ` - ${chalk.gray('not set up')}`);
         });
+    }
+}
+
+export async function handleListCommand() {
+    try {
+        const listHandler = new ListHandler();
+        listHandler.list();
 
         logger.br();
         logger.info(`To set up a new board, run ${chalk.yellow('bscript board setup <board-name>')}`);

cli/src/commands/board/remove.ts

@@ -1,25 +1,17 @@
 import { Command } from "commander";
 import inquirer from 'inquirer';
-import { GlobalConfigHandler } from "../../config/global-config";
 import { BoardName } from "../../config/board-utils";
 import { logger, LogStep, showErrorMessages } from "../../core/logger";
 import * as fs from '../../core/fs';
+import { CommandHandler } from "../command";
 
 
-abstract class RemoveHandler {
-    globalConfigHandler: GlobalConfigHandler;
-    
-    constructor() {
-        this.globalConfigHandler = GlobalConfigHandler.load();
-    }
-
+abstract class RemoveHandler extends CommandHandler {
     async remove() {
         await this.removeBoard();
         this.globalConfigHandler.save();
     }
-
     abstract isSetup(): boolean;
-
     abstract removeBoard(): Promise<void>;
 }
 
@@ -52,7 +44,7 @@ function getRemoveHandler(board: string) {
     }
 }
 
-export async function handleRemoveCommand(board: string, options: { force: boolean }) {
+export async function handleRemoveCommand(board: string, options: { force?: boolean }) {
     try {
         const removeHandler = getRemoveHandler(board);
 

cli/src/commands/board/setup.ts

@@ -3,33 +3,19 @@ import * as path from 'path';
 import * as os from 'os';
 import inquirer from 'inquirer';
 import { logger, LogStep, showErrorMessages, SkipStep } from "../../core/logger";
-import { VM_VERSION, GLOBAL_BLUESCRIPT_PATH, GlobalConfigHandler } from "../../config/global-config";
 import { BoardName } from "../../config/board-utils";
 import { exec } from '../../core/shell';
 import * as fs from '../../core/fs';
 import chalk from "chalk";
+import { CommandHandler } from "../command";
+import { GLOBAL_SETTINGS } from "../../config/constants";
 
 
-const RUNTIME_ZIP_URL = `https://github.com/csg-tokyo/bluescript/releases/download/v${VM_VERSION}/release-microcontroller-v${VM_VERSION}.zip`;
-const RUNTIME_DIR = path.join(GLOBAL_BLUESCRIPT_PATH, 'microcontroller');
-
-const ESP_IDF_VERSION = 'v5.4';
-const ESP_IDF_GIT_REPO = 'https://github.com/espressif/esp-idf.git';
-const ESP_ROOT_DIR = path.join(GLOBAL_BLUESCRIPT_PATH, 'esp');
-const ESP_IDF_EXPORT_FILE = path.join(ESP_ROOT_DIR, 'esp-idf/export.sh');
-const ESP_IDF_INSTALL_FILE = path.join(ESP_ROOT_DIR, 'esp-idf/install.sh');
-
-
-abstract class SetupHandler {
-    protected globalConfigHandler: GlobalConfigHandler;
-
-    constructor() {
-        this.globalConfigHandler = GlobalConfigHandler.load();
-    }
+abstract class SetupHandler extends CommandHandler {
 
     getSetupPlan(): string[] {
         const plan: string[] = [];
-        plan.push(`Download BlueScript runtime from ${RUNTIME_ZIP_URL}`);
+        plan.push(`Download BlueScript runtime from ${GLOBAL_SETTINGS.RUNTIME_ZIP_URL}`);
         plan.push(...this.getBoardSetupPlan());
         return plan;
     }
@@ -42,8 +28,8 @@ abstract class SetupHandler {
     }
 
     private ensureBlueScriptDir() {
-        if (!fs.exists(GLOBAL_BLUESCRIPT_PATH)) {
-            fs.makeDir(GLOBAL_BLUESCRIPT_PATH);
+        if (!fs.exists(GLOBAL_SETTINGS.BLUESCRIPT_DIR)) {
+            fs.makeDir(GLOBAL_SETTINGS.BLUESCRIPT_DIR);
         }
     }
 
@@ -56,18 +42,16 @@ abstract class SetupHandler {
         if (!this.needToDownloadBlueScriptRuntime()) {
            throw new SkipStep('already downloaded.', undefined);
         }
-        if (fs.exists(RUNTIME_DIR)) {
-            fs.removeDir(RUNTIME_DIR);
+        if (fs.exists(GLOBAL_SETTINGS.RUNTIME_DIR)) {
+            fs.removeDir(GLOBAL_SETTINGS.RUNTIME_DIR);
         }
 
-        await fs.downloadAndUnzip(RUNTIME_ZIP_URL, GLOBAL_BLUESCRIPT_PATH);
-        this.globalConfigHandler.setRuntimeDir(RUNTIME_DIR);
+        await fs.downloadAndUnzip(GLOBAL_SETTINGS.RUNTIME_ZIP_URL, GLOBAL_SETTINGS.BLUESCRIPT_DIR);
+        this.globalConfigHandler.setRuntimeDir(GLOBAL_SETTINGS.RUNTIME_DIR);
     }
 
     abstract needSetup(): boolean;
-
     abstract getBoardSetupPlan(): string[];
-
     abstract setupBoard(): Promise<void>;
 }
 
@@ -103,7 +87,7 @@ export class ESP32SetupHandler extends SetupHandler {
         } else {
             throw new Error('Unknown OS.');
         }
-        plan.push(`Clone ESP-IDF ${ESP_IDF_VERSION} from ${ESP_IDF_GIT_REPO}.`);
+        plan.push(`Clone ESP-IDF ${GLOBAL_SETTINGS.ESP_IDF_VERSION} from ${GLOBAL_SETTINGS.ESP_IDF_GIT_REPO}.`);
         plan.push('Run ESP-IDF install script.');
         return plan;
     }
@@ -115,9 +99,9 @@ export class ESP32SetupHandler extends SetupHandler {
         await this.runEspIdfInstallScript();
 
         this.globalConfigHandler.updateBoardConfig(this.boardName, {
-            idfVersion: ESP_IDF_VERSION,
-            rootDir: ESP_ROOT_DIR,
-            exportFile: ESP_IDF_EXPORT_FILE,
+            idfVersion: GLOBAL_SETTINGS.ESP_IDF_VERSION,
+            rootDir: GLOBAL_SETTINGS.ESP_ROOT_DIR,
+            exportFile: GLOBAL_SETTINGS.ESP_IDF_EXPORT_FILE,
             xtensaGccDir: await this.getXtensaGccDir(),
         });
     }
@@ -179,28 +163,29 @@ export class ESP32SetupHandler extends SetupHandler {
     }
 
     @LogStep(
-        `Cloning ESP-IDF ${ESP_IDF_VERSION} from ${ESP_IDF_GIT_REPO}... It may take a while.`
+        `Cloning ESP-IDF ${GLOBAL_SETTINGS.ESP_IDF_VERSION} from ${GLOBAL_SETTINGS.ESP_IDF_GIT_REPO}... It may take a while.`
     )
     private async cloneEspIdf() {
-        if (fs.exists(ESP_ROOT_DIR)) {
-            fs.removeDir(ESP_ROOT_DIR);
+        if (fs.exists(GLOBAL_SETTINGS.ESP_ROOT_DIR)) {
+            fs.removeDir(GLOBAL_SETTINGS.ESP_ROOT_DIR);
         }
         if (!(await this.isPackageInstalled('git'))) {
             throw new Error('Cannot find git command. Please install git and try again.');
         }
 
-        fs.makeDir(ESP_ROOT_DIR);
-        await exec(`git clone --depth 1 -b ${ESP_IDF_VERSION} --recursive ${ESP_IDF_GIT_REPO}`, { cwd: ESP_ROOT_DIR });
+        fs.makeDir(GLOBAL_SETTINGS.ESP_ROOT_DIR);
+        await exec(`git clone --depth 1 -b ${GLOBAL_SETTINGS.ESP_IDF_VERSION} --recursive ${GLOBAL_SETTINGS.ESP_IDF_GIT_REPO}`, 
+            { cwd: GLOBAL_SETTINGS.ESP_ROOT_DIR });
     }
 
     @LogStep('Running ESP-IDF install script...')
     private async runEspIdfInstallScript() {
-        await exec(ESP_IDF_INSTALL_FILE);
+        await exec(GLOBAL_SETTINGS.ESP_IDF_INSTALL_FILE);
     }
 
     private async getXtensaGccDir() {
         try {
-            const gccPath = await exec(`source ${ESP_IDF_EXPORT_FILE} > /dev/null 2>&1 && which xtensa-esp32-elf-gcc`, { silent:true });
+            const gccPath = await exec(`source ${GLOBAL_SETTINGS.ESP_IDF_EXPORT_FILE} > /dev/null 2>&1 && which xtensa-esp32-elf-gcc`, { silent:true });
             return path.dirname(gccPath);
         } catch (error) {
             throw new Error('Failed to get xtensa gcc path.', {cause: error});
@@ -249,7 +234,7 @@ export async function handleSetupCommand(board: string) {
         await setupHandler.setup();
 
         logger.br();
-        logger.success(`Success to se tup ${board}`);
+        logger.success(`Success to set up ${board}`);
         logger.info(`Next step: run ${chalk.yellow(`bscript board flash-runtime ${board}`)}`);
 
     } catch (error) {