test-repl-save-load.js

// Copyright Joyent, Inc. and other Node contributors.
//
// 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.

'use strict';
const common = require('../common');
const ArrayStream = require('../common/arraystream');
const assert = require('assert');
const join = require('path').join;
const fs = require('fs');

const tmpdir = require('../common/tmpdir');
tmpdir.refresh();

const repl = require('repl');

const works = [['inner.one'], 'inner.o'];

const putIn = new ArrayStream();
const testMe = repl.start('', putIn);

// Some errors might be passed to the domain.
testMe._domain.on('error', function(reason) {
  const err = new Error('Test failed');
  err.reason = reason;
  throw err;
});

const testFile = [
  'let inner = (function() {',
  '  return {one:1};',
  '})()'
];
const saveFileName = join(tmpdir.path, 'test.save.js');

// Add some data.
putIn.run(testFile);

// Save it to a file.
putIn.run([`.save ${saveFileName}`]);

// The file should have what I wrote.
assert.strictEqual(fs.readFileSync(saveFileName, 'utf8'),
                   testFile.join('\n'));

// Make sure that the REPL data is "correct".
testMe.complete('inner.o', common.mustCall(function(error, data) {
  assert.ifError(error);
  assert.deepStrictEqual(data, works);
}));

// Clear the REPL.
putIn.run(['.clear']);

// Load the file back in.
putIn.run([`.load ${saveFileName}`]);

// Make sure that the REPL data is "correct".
testMe.complete('inner.o', common.mustCall(function(error, data) {
  assert.ifError(error);
  assert.deepStrictEqual(data, works);
}));

// Clear the REPL.
putIn.run(['.clear']);

let loadFile = join(tmpdir.path, 'file.does.not.exist');

// Should not break.
putIn.write = common.mustCall(function(data) {
  // Make sure I get a failed to load message and not some crazy error.
  assert.strictEqual(data, `Failed to load: ${loadFile}\n`);
  // Eat me to avoid work.
  putIn.write = () => {};
});
putIn.run([`.load ${loadFile}`]);

// Throw error on loading directory.
loadFile = tmpdir.path;
putIn.write = common.mustCall(function(data) {
  assert.strictEqual(data, `Failed to load: ${loadFile} is not a valid file\n`);
  putIn.write = () => {};
});
putIn.run([`.load ${loadFile}`]);

// Clear the REPL.
putIn.run(['.clear']);

// NUL (\0) is disallowed in filenames in UNIX-like operating systems and
// Windows so we can use that to test failed saves.
const invalidFileName = join(tmpdir.path, '\0\0\0\0\0');

// Should not break.
putIn.write = common.mustCall(function(data) {
  // Make sure I get a failed to save message and not some other error.
  assert.strictEqual(data, `Failed to save: ${invalidFileName}\n`);
  // Reset to no-op.
  putIn.write = () => {};
});

// Save it to a file.
putIn.run([`.save ${invalidFileName}`]);

{
  // Save .editor mode code.
  const cmds = [
    'function testSave() {',
    'return "saved";',
    '}'
  ];
  const putIn = new ArrayStream();
  const replServer = repl.start({ terminal: true, stream: putIn });

  putIn.run(['.editor']);
  putIn.run(cmds);
  replServer.write('', { ctrl: true, name: 'd' });

  putIn.run([`.save ${saveFileName}`]);
  replServer.close();
  assert.strictEqual(fs.readFileSync(saveFileName, 'utf8'),
                     `${cmds.join('\n')}\n`);
}