roundhouse/config/index.spec.js

Database Migration Utility using SQL files and versioning based on source control.

'use strict';

const { readFileSync, writeFileSync, unlinkSync } = require('fs');

const mockFs = require('mock-fs');
const sinon = require('sinon');

const CONFIG_FILE = './node-template.config';

const sut = require('./index');

const consoleError = console.error;

beforeEach(() => {
  mockFs({ './': {} });
  console.error = () => {};
  sinon.spy(console, 'log');
  sinon.spy(console, 'error');
});

afterEach(() => {
  mockFs.restore();
  console.log.restore();
  console.error.restore();
  console.error = consoleError;
});

describe('#config', () => {
  it('writes a value to the config file', () => {
    sut.writeConfig('setting', 'value');
    // Run a second time to run thru' if the config file was missing.
    sut.writeConfig('setting', 'value');

    const result = readFileSync(CONFIG_FILE, { encoding: 'utf8' });
    expect(result).toBe(JSON.stringify({ setting: 'value' }));
  });

  it('errors writing an invalid setting to the config file', () => {
    const result = sut.writeConfig(undefined, 'value');

    expect(result).toBeFalsy();

    expect(console.error.calledWith('Error in writeConfig: ')).toBeTruthy();
  });

  it('reads a setting from the config file', () => {
    writeFileSync(CONFIG_FILE, JSON.stringify({ setting: 'value' }));

    const setting = sut.readConfig('setting');

    expect(setting).toBe('value');
  });

  it("returns the default value when reading a setting if the setting doesn't exist and there is a default", () => {
    writeFileSync(CONFIG_FILE, JSON.stringify({ setting: 'value' }));

    const setting = sut.readConfig('missing_setting', '/path/to/files');

    expect(setting).toBe('/path/to/files');
  });

  it("errors when reading a setting from the config file if the setting doesn't exist and there is no default", () => {
    writeFileSync(CONFIG_FILE, JSON.stringify({ setting: 'value' }));

    const setting = sut.readConfig('invalid_setting');

    expect(setting).toBe(undefined);

    expect(console.error.calledWith('Config setting does not exist')).toBeTruthy();
  });

  it("errors when reading a setting from the config file if the config file doesn't exist", () => {
    writeFileSync(CONFIG_FILE, JSON.stringify({ setting: 'value' }));

    unlinkSync(CONFIG_FILE);

    const setting = sut.readConfig('setting');

    expect(setting).toBe(undefined);

    expect(console.error.calledWith('Config file does not exist')).toBeTruthy();
  });
});