add serial unit tests

Author: Alberto Iannaccone

Diff for: arduino-ide-extension/src/browser/boards/boards-service-provider.ts

@@ -64,7 +64,7 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
    * This even also fires, when the boards package was not available for the currently selected board,
    * and the user installs the board package. Note: installing a board package will set the `fqbn` of the
    * currently selected board.\
-   * This even also emitted when the board package for the currently selected board was uninstalled.
+   * This event is also emitted when the board package for the currently selected board was uninstalled.
    */
   readonly onBoardsConfigChanged = this.onBoardsConfigChangedEmitter.event;
   readonly onAvailableBoardsChanged =

Diff for: arduino-ide-extension/src/browser/monitor/monitor-connection.ts

@@ -1,4 +1,4 @@
-import { injectable, inject, postConstruct } from 'inversify';
+import { injectable, inject } from 'inversify';
 import { deepClone } from '@theia/core/lib/common/objects';
 import { Emitter, Event } from '@theia/core/lib/common/event';
 import { MessageService } from '@theia/core/lib/common/message-service';
@@ -24,31 +24,13 @@ import { nls } from '@theia/core/lib/browser/nls';
 
 @injectable()
 export class SerialConnectionManager {
-  @inject(MonitorModel)
-  protected readonly monitorModel: MonitorModel;
-
-  @inject(MonitorService)
-  protected readonly monitorService: MonitorService;
-
-  @inject(MonitorServiceClient)
-  protected readonly monitorServiceClient: MonitorServiceClient;
-
-  @inject(BoardsService)
-  protected readonly boardsService: BoardsService;
-
-  @inject(BoardsServiceProvider)
-  protected readonly boardsServiceProvider: BoardsServiceProvider;
-
-  @inject(NotificationCenter)
-  protected readonly notificationCenter: NotificationCenter;
-
-  @inject(MessageService)
-  protected messageService: MessageService;
-
-  @inject(ThemeService)
-  protected readonly themeService: ThemeService;
   protected _state: Serial.State = [];
-  protected _connected: boolean;
+  protected _connected = false;
+  protected config: Partial<MonitorConfig> = {
+    board: undefined,
+    port: undefined,
+    baudRate: undefined,
+  };
 
   /**
    * Note: The idea is to toggle this property from the UI (`Monitor` view)
@@ -73,17 +55,21 @@ export class SerialConnectionManager {
    * When the websocket server is up on the backend, we save the port here, so that the client knows how to connect to it
    * */
   protected wsPort?: number;
-
   protected webSocket?: WebSocket;
 
-  protected config: Partial<MonitorConfig> = {
-    board: undefined,
-    port: undefined,
-    baudRate: undefined,
-  };
-
-  @postConstruct()
-  protected init(): void {
+  constructor(
+    @inject(MonitorModel) protected readonly monitorModel: MonitorModel,
+    @inject(MonitorService) protected readonly monitorService: MonitorService,
+    @inject(MonitorServiceClient)
+    protected readonly monitorServiceClient: MonitorServiceClient,
+    @inject(BoardsService) protected readonly boardsService: BoardsService,
+    @inject(BoardsServiceProvider)
+    protected readonly boardsServiceProvider: BoardsServiceProvider,
+    @inject(NotificationCenter)
+    protected readonly notificationCenter: NotificationCenter,
+    @inject(MessageService) protected messageService: MessageService,
+    @inject(ThemeService) protected readonly themeService: ThemeService
+  ) {
     this.monitorServiceClient.onWebSocketChanged(
       this.handleWebSocketChanged.bind(this)
     );
@@ -136,7 +122,7 @@ export class SerialConnectionManager {
    *
    * @param newConfig the porperties of the config that has changed
    */
-  protected setConfig(newConfig: Partial<MonitorConfig>): void {
+  setConfig(newConfig: Partial<MonitorConfig>): void {
     let configHasChanged = false;
     Object.keys(this.config).forEach((key: keyof MonitorConfig) => {
       if (newConfig[key] && newConfig[key] !== this.config[key]) {
@@ -149,10 +135,18 @@ export class SerialConnectionManager {
     }
   }
 
+  getConfig(): Partial<MonitorConfig> {
+    return this.config;
+  }
+
   getWsPort(): number | undefined {
     return this.wsPort;
   }
 
+  isWebSocketConnected(): boolean {
+    return !!this.webSocket?.url;
+  }
+
   protected handleWebSocketChanged(wsPort: number): void {
     this.wsPort = wsPort;
   }

Diff for: arduino-ide-extension/src/browser/monitor/monitor-service-client-impl.ts

@@ -12,8 +12,8 @@ export class MonitorServiceClientImpl implements MonitorServiceClient {
   protected readonly onErrorEmitter = new Emitter<MonitorError>();
   readonly onError = this.onErrorEmitter.event;
 
-  protected readonly onMessageEmitter = new Emitter<number>();
-  readonly onWebSocketChanged = this.onMessageEmitter.event;
+  protected readonly onWebSocketChangedEmitter = new Emitter<number>();
+  readonly onWebSocketChanged = this.onWebSocketChangedEmitter.event;
 
   protected readonly onBaudEmitter = new Emitter<MonitorConfig.BaudRate>();
   readonly onBaudRateChanged = this.onBaudEmitter.event;
@@ -26,7 +26,7 @@ export class MonitorServiceClientImpl implements MonitorServiceClient {
   }
 
   notifyWebSocketChanged(message: number): void {
-    this.onMessageEmitter.fire(message);
+    this.onWebSocketChangedEmitter.fire(message);
   }
 
   notifyBaudRateChanged(message: MonitorConfig.BaudRate): void {

Diff for: arduino-ide-extension/src/common/protocol/monitor-service.ts

@@ -11,7 +11,7 @@ export interface ErrorStatus extends Status {
 }
 export namespace Status {
   export function isOK(status: Status & { message?: string }): status is OK {
-    return typeof status.message !== 'string';
+    return !!status && typeof status.message !== 'string';
   }
   export const OK: OK = {};
   export const NOT_CONNECTED: ErrorStatus = { message: 'Not connected.' };

Diff for: arduino-ide-extension/src/test/browser/boards-auto-installer.test.ts

@@ -11,52 +11,19 @@ import { MessageService } from '@theia/core';
 import { BoardsServiceProvider } from '../../browser/boards/boards-service-provider';
 import { BoardsListWidgetFrontendContribution } from '../../browser/boards/boards-widget-frontend-contribution';
 import {
-  Board,
   BoardsPackage,
   BoardsService,
-  Port,
   ResponseServiceArduino,
 } from '../../common/protocol';
 import { IMock, It, Mock, Times } from 'typemoq';
 import { Container, ContainerModule } from 'inversify';
 import { BoardsAutoInstaller } from '../../browser/boards/boards-auto-installer';
-import { BoardsConfig } from '../../browser/boards/boards-config';
 import { tick } from '../utils';
 import { ListWidget } from '../../browser/widgets/component-list/list-widget';
+import { aBoardConfig, anInstalledPackage, aPackage } from './fixtures/boards';
 
 disableJSDOM();
 
-const aBoard: Board = {
-  fqbn: 'some:board:fqbn',
-  name: 'Some Arduino Board',
-  port: { address: '/lol/port1234', protocol: 'serial' },
-};
-const aPort: Port = {
-  address: aBoard.port!.address,
-  protocol: aBoard.port!.protocol,
-};
-const aBoardConfig: BoardsConfig.Config = {
-  selectedBoard: aBoard,
-  selectedPort: aPort,
-};
-const aPackage: BoardsPackage = {
-  author: 'someAuthor',
-  availableVersions: ['some.ver.sion', 'some.other.version'],
-  boards: [aBoard],
-  deprecated: false,
-  description: 'Some Arduino Board, Some Other Arduino Board',
-  id: 'some:arduinoCoreId',
-  installable: true,
-  moreInfoLink: 'http://www.some-url.lol/',
-  name: 'Some Arduino Package',
-  summary: 'Boards included in this package:',
-};
-
-const anInstalledPackage: BoardsPackage = {
-  ...aPackage,
-  installedVersion: 'some.ver.sion',
-};
-
 describe('BoardsAutoInstaller', () => {
   let subject: BoardsAutoInstaller;
   let messageService: IMock<MessageService>;

Diff for: arduino-ide-extension/src/test/browser/fixtures/boards.ts

@@ -0,0 +1,47 @@
+import { BoardsConfig } from '../../../browser/boards/boards-config';
+import { Board, BoardsPackage, Port } from '../../../common/protocol';
+
+export const aBoard: Board = {
+  fqbn: 'some:board:fqbn',
+  name: 'Some Arduino Board',
+  port: { address: '/lol/port1234', protocol: 'serial' },
+};
+export const aPort: Port = {
+  address: aBoard.port!.address,
+  protocol: aBoard.port!.protocol,
+};
+export const aBoardConfig: BoardsConfig.Config = {
+  selectedBoard: aBoard,
+  selectedPort: aPort,
+};
+export const anotherBoard: Board = {
+  fqbn: 'another:board:fqbn',
+  name: 'Another Arduino Board',
+  port: { address: '/kek/port5678', protocol: 'serial' },
+};
+export const anotherPort: Port = {
+  address: anotherBoard.port!.address,
+  protocol: anotherBoard.port!.protocol,
+};
+export const anotherBoardConfig: BoardsConfig.Config = {
+  selectedBoard: anotherBoard,
+  selectedPort: anotherPort,
+};
+
+export const aPackage: BoardsPackage = {
+  author: 'someAuthor',
+  availableVersions: ['some.ver.sion', 'some.other.version'],
+  boards: [aBoard],
+  deprecated: false,
+  description: 'Some Arduino Board, Some Other Arduino Board',
+  id: 'some:arduinoCoreId',
+  installable: true,
+  moreInfoLink: 'http://www.some-url.lol/',
+  name: 'Some Arduino Package',
+  summary: 'Boards included in this package:',
+};
+
+export const anInstalledPackage: BoardsPackage = {
+  ...aPackage,
+  installedVersion: 'some.ver.sion',
+};

Diff for: arduino-ide-extension/src/test/browser/fixtures/serial.ts

@@ -0,0 +1,22 @@
+import { MonitorConfig } from '../../../common/protocol/monitor-service';
+import { aBoard, anotherBoard, anotherPort, aPort } from './boards';
+
+export const aSerialConfig: MonitorConfig = {
+  board: aBoard,
+  port: aPort,
+  baudRate: 9600,
+};
+
+export const anotherSerialConfig: MonitorConfig = {
+  board: anotherBoard,
+  port: anotherPort,
+  baudRate: 9600,
+};
+
+export class WebSocketMock {
+  readonly url: string;
+  constructor(url: string) {
+    this.url = url;
+  }
+  close() {}
+}