imptest/src/lib/ImpTestFile.js

Electric Imp Test Runner

// MIT License
//
// Copyright 2016 Electric Imp
//
// SPDX-License-Identifier: MIT
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
// EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.

/**
 * .imptest file abstraction
 *
 * @see https://github.com/electricimp/impTest/blob/develop/docs/imptest-spec.md
 */

'use strict';

const c = require('colors');
const fs = require('fs');
const path = require('path');
const DebugMixin = require('./DebugMixin');
const stripJsonComments = require('strip-json-comments');

/**
 * Config file abstraction
 */
class ImpTestFile {

  /**
   * @param {string} configPath
   */
  constructor(configPath) {
    DebugMixin.call(this);
    this._deviceNames = {};
    this._path = path.resolve(configPath);
  }

  /**
   * Write config
   */
  write() {
    fs.writeFileSync(this.path, this.json);
  }

  get defaultValues() {
    return {
      apiKey: null,
      modelId: '',
      devices: [],
      agentFile: '',
      deviceFile: '',
      stopOnFailure: false,
      builderCache: false,
      allowDisconnect: false,
      timeout: 30,
      tests: ['*.test.nut', 'tests/**/*.test.nut']
    };
  }

  /**
   * Read values
   * @return {{}}
   * @private
   */
  _read() {
    this._debug(c.blue('Using config file:'), this.path);

    let values = {};

    if (this.exists) {
      values = fs.readFileSync(this.path).toString();
      values = stripJsonComments(values);
      values = JSON.parse(values);
    }

    values = Object.assign(this.defaultValues, values);

    if (this.debug) {
      // hide api key
      const debugValues = /* clone value */ JSON.parse(JSON.stringify(values));
      debugValues.apiKey = '[hidden]';
      this._debug(c.blue('Config values:'), debugValues);
    }

    return values;
  }

  /**
   * @returns {{}}
   */
  get values() {
    if (!this._values) {
      this._values = this._read();
    }

    return this._values;
  }

  /**
   * @return {bool}
   */
  get exists() {
    return fs.existsSync(this._path);
  }

  /**
   * Get config as json
   * @return {string}
   */
  get json() {
    const v = this.values;
    if (v.apiKey === null) delete v.apiKey;
    if (v.deviceFile === null) v.deviceFile = false;
    if (v.agentFile === null) v.agentFile = false;

    let json = JSON.stringify(v, null, 4);

    // insert device name
    for (const deviceId in this.deviceNames) {
      if (this.deviceNames[deviceId]) {
        json = json.replace(
          '"' + deviceId + '"',
          '"' + deviceId + '" /* ' + this.deviceNames[deviceId] + ' */'
        );
      }
    }

    // insert model name
    if (this.modelName) {
      json = json.replace(
        '"' + this.values.modelId + '"',
        '"' + this.values.modelId + '" /* ' + this.modelName + ' */'
      );
    }

    return json;
  }

  /**
   * @returns {string}
   */
  get path() {
    return this._path;
  }

  /**
   * @returns {string}
   */
  get dir() {
    return path.dirname(this._path);
  }

  /**
   * @return {id: name}
   */
  get deviceNames() {
    return this._deviceNames;
  }

  /**
   * @param {id: name} value
   */
  set deviceNames(value) {
    this._deviceNames = value;
  }

  /**
   * @return {string|null}
   */
  get modelName() {
    return this._modelName;
  }

  /**
   * @param {string|null} value
   */
  set modelName(value) {
    this._modelName = value;
  }
}

module.exports = ImpTestFile;