Merge pull request #926 from ficristo/search-fix

[mirror_xterm.js.git] / src / test / escape-sequences-test.js

var glob = require('glob');
var fs = require('fs');
var os = require('os');
var pty = require('node-pty');
var Terminal = require('../xterm');

if (os.platform() === 'win32') {
  // Skip tests on Windows since pty.open isn't supported
  return;
}

var CONSOLE_LOG = console.log;

// expect files need terminal at 80x25!
var COLS = 80;
var ROWS = 25;

/** some helpers for pty interaction */
// we need a pty in between to get the termios decorations
// for the basic test cases a raw pty device is enough
var primitive_pty = pty.native.open(COLS, ROWS);

// fake sychronous pty write - read
// we just pipe the data from slave to master as a child program would do
// pty.js opens pipe fds with O_NONBLOCK
// just wait 10ms instead of setting fds to blocking mode
function ptyWriteRead(s, cb) {
  fs.writeSync(primitive_pty.slave, s);
  setTimeout(() => {
    var b = Buffer(64000);
    var bytes = fs.readSync(primitive_pty.master, b, 0, 64000);
    cb(b.toString('utf8', 0, bytes));
  });
}

// make sure raw pty is at x=0 and has no pending data
function ptyReset(cb) {
    ptyWriteRead('\r\n', cb);
}

/* debug helpers */
// generate colorful noisy output to compare xterm and emulator cell states
function formatError(in_, out_, expected) {
  function addLineNumber(start, color) {
    var counter = start || 0;
    return function(s) {
      counter += 1;
      return '\x1b[33m' + (' ' + counter).slice(-2) + color + s;
    }
  }
  var line80 = '12345678901234567890123456789012345678901234567890123456789012345678901234567890';
  var s = '';
  s += '\n\x1b[34m' + JSON.stringify(in_);
  s += '\n\x1b[33m  ' + line80 + '\n';
  s += out_.split('\n').map(addLineNumber(0, '\x1b[31m')).join('\n');
  s += '\n\x1b[33m  ' + line80 + '\n';
  s += expected.split('\n').map(addLineNumber(0, '\x1b[32m')).join('\n');
  return s;
}

// simple debug output of terminal cells
function terminalToString(term) {
  var result = '';
  var line_s = '';
  for (var line = term.buffer.ybase; line < term.buffer.ybase + term.rows; line++) {
    line_s = '';
    for (var cell=0; cell<term.cols; ++cell) {
      line_s += term.buffer.lines.get(line)[cell][1];
    }
    // rtrim empty cells as xterm does
    line_s = line_s.replace(/\s+$/, '');
    result += line_s;
    result += '\n';
  }
  return result;
}

/** tests */
describe('xterm output comparison', function() {
  var xterm;

  beforeEach(function () {
    xterm = new Terminal(COLS, ROWS);
    xterm.refresh = function() {};
    xterm.viewport = {
      syncScrollArea: function() {}
    };
  });

  // omit stack trace for escape sequence files
  Error.stackTraceLimit = 0;
  var files = glob.sync('**/escape_sequence_files/*.in');
  // only successful tests for now
  var skip = [
    10, 16, 17, 19, 32, 33, 34, 35, 36, 39,
    40, 42, 43, 44, 45, 46, 47, 48, 49, 50,
    51, 52, 54, 55, 56, 57, 58, 59, 60, 61,
    63, 68
  ];
  if (os.platform() === 'darwin') {
    // These are failing on macOS only
    skip.push(3, 7, 11, 67);
  }
  for (var i = 0; i < files.length; i++) {
    if (skip.indexOf(i) >= 0) {
      continue;
    }
    (function(filename) {
      it(filename.split('/').slice(-1)[0], done => {
        ptyReset(() => {
          var in_file = fs.readFileSync(filename, 'utf8');
          ptyWriteRead(in_file, from_pty => {
            // uncomment this to get log from terminal
            //console.log = function(){};

            // Perform a synchronous .write(data)
            xterm.writeBuffer.push(from_pty);
            xterm.innerWrite();

            var from_emulator = terminalToString(xterm);
            console.log = CONSOLE_LOG;
            var expected = fs.readFileSync(filename.split('.')[0] + '.text', 'utf8');
            // Some of the tests have whitespace on the right of lines, we trim all the linex
            // from xterm.js so ignore this for now at least.
            var expectedRightTrimmed = expected.split('\n').map(function (l) {
              return l.replace(/\s+$/, '');
            }).join('\n');
            if (from_emulator != expectedRightTrimmed) {
              // uncomment to get noisy output
              throw new Error(formatError(in_file, from_emulator, expected));
            //   throw new Error('mismatch');
            }
            done();
          });
        });
      });
    })(files[i]);
  }
});