xod/packages/arduino-cli/test/optionParser.spec.js

import path from 'path';
import { assert } from 'chai';
import fse from 'fs-extra';

import {
  getBoardsTxtPath,
  getLines,
  parseOptionNames,
  parseIntermediateOptions,
  convertIntermediateOptions,
  parseOptions,
  patchBoardWithOptions,
  patchBoardsWithOptions,
} from '../src/optionParser';

const fixtureDir = path.resolve(__dirname, 'fixtures');

// =============================================================================
//
// Test data
//
// =============================================================================

const espOptionNames = {
  UploadSpeed: 'Uplo@d Speed (Скорость загрузки)',
  CpuFrequency: 'CPU Frequency 123,-_[]():@we$ome',
};

const espOptions = {
  UploadSpeed: [
    {
      name: '115200',
      value: '115200',
    },
    {
      name: '9600',
      value: '9600',
    },
    {
      name: '57600',
      value: '57600',
    },
    {
      name: '921600',
      value: '921600',
    },
  ],
  CpuFrequency: [
    {
      name: '80 MHz (!@#$$%^&*()[]_-+,./)',
      value: '80',
    },
    {
      name: '160 MHz',
      value: '160',
    },
  ],
};

const uploadSpeedOptions = {
  optionName: 'Uplo@d Speed (Скорость загрузки)',
  optionId: 'UploadSpeed',
  values: [
    {
      name: '115200',
      value: '115200',
    },
    {
      name: '9600',
      value: '9600',
    },
    {
      name: '57600',
      value: '57600',
    },
    {
      name: '921600',
      value: '921600',
    },
  ],
};
const cpuFrequencyOptions = {
  optionName: 'CPU Frequency 123,-_[]():@we$ome',
  optionId: 'CpuFrequency',
  values: [
    {
      name: '80 MHz (!@#$$%^&*()[]_-+,./)',
      value: '80',
    },
    {
      name: '160 MHz',
      value: '160',
    },
  ],
};

const boards = [
  {
    name: 'Generic ESP8266 Module',
    fqbn: 'esp8266:esp8266:generic',
  },
  {
    name: 'Amperka WiFi Slot',
    fqbn: 'esp8266:esp8266:wifi_slot',
  },
  {
    name: 'Arduino Due',
    fqbn: 'arduino:sam:due',
  },
  {
    name: 'Arduino/Genuino Uno (not installed)',
    package: 'arduino:avr',
    packageName: 'Arduino AVR Boards',
    version: '1.6.21',
  },
];

const expectedBoards = [
  {
    name: 'Generic ESP8266 Module',
    fqbn: 'esp8266:esp8266:generic',
    options: [cpuFrequencyOptions, uploadSpeedOptions],
  },
  {
    name: 'Amperka WiFi Slot',
    fqbn: 'esp8266:esp8266:wifi_slot',
    options: [cpuFrequencyOptions, uploadSpeedOptions],
  },
  {
    name: 'Arduino Due',
    fqbn: 'arduino:sam:due',
    options: [],
  },
  {
    name: 'Arduino/Genuino Uno (not installed)',
    package: 'arduino:avr',
    packageName: 'Arduino AVR Boards',
    version: '1.6.21',
  },
];

// =============================================================================
//
// Specs
//
// =============================================================================

describe('Option Parser', () => {
  let espBoardsTxtContent;
  let espBoardsTxtLines;
  before(async () => {
    const buf = await fse.readFile(
      getBoardsTxtPath(fixtureDir, 'esp8266:esp8266', '2.4.2')
    );
    espBoardsTxtContent = buf.toString();
    espBoardsTxtLines = getLines(espBoardsTxtContent);
  });

  it('Parses human-readable option names', () => {
    assert.deepEqual(parseOptionNames(espBoardsTxtLines), espOptionNames);
  });

  it('Parses options for each board into intermediate object', () => {
    assert.deepEqual(parseIntermediateOptions(espBoardsTxtLines), {
      generic: espOptions,
      wifi_slot: espOptions,
    });
  });

  it('Converts parsed intermediate options into final Option list', () => {
    assert.sameDeepMembers(
      convertIntermediateOptions(espOptionNames, espOptions),
      [uploadSpeedOptions, cpuFrequencyOptions]
    );
  });

  it('Parses options into final object, that should be merged into boards', () => {
    const res = parseOptions(espBoardsTxtContent);
    assert.hasAllKeys(res, ['generic', 'wifi_slot']);
    assert.sameDeepMembers(res.generic, [
      uploadSpeedOptions,
      cpuFrequencyOptions,
    ]);
    assert.sameDeepMembers(res.wifi_slot, [
      uploadSpeedOptions,
      cpuFrequencyOptions,
    ]);
  });

  it('Correctly patches Board objects with Options', () => {
    assert.deepEqual(
      patchBoardWithOptions(espBoardsTxtContent, boards[0]),
      expectedBoards[0]
    );
    assert.deepEqual(
      patchBoardWithOptions(espBoardsTxtContent, boards[1]),
      expectedBoards[1]
    );
    assert.deepEqual(
      patchBoardWithOptions(espBoardsTxtContent, boards[2]),
      expectedBoards[2]
    );
    assert.deepEqual(
      patchBoardWithOptions(espBoardsTxtContent, boards[3]),
      expectedBoards[3]
    );
  });

  it('Correctly loads boards.txt and patches all boards', () =>
    patchBoardsWithOptions(
      fixtureDir,
      [{ ID: 'esp8266:esp8266', Installed: '2.4.2' }],
      boards
    ).then(res => assert.sameDeepMembers(res, expectedBoards)));
});