testCSVConverter.ts 13.5 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
import {Converter} from "../src/Converter";
import csv from "../src";
var assert = require("assert");
var fs = require("fs");
var sandbox = require("sinon").sandbox.create();
var file = __dirname + "/data/testData";
var trailCommaData = __dirname + "/data/trailingComma";
describe("CSV Converter", function () {
  afterEach(function () {
    sandbox.restore();
  });

  it("should create new instance of csv", function () {
    var obj = new Converter();
    assert(obj);
  });

  it("should read from a stream", function (done) {
    var obj = new Converter();
    var stream = fs.createReadStream(file);
    obj.then(function (obj) {
      assert.equal(obj.length, 2);
      done();
    });
    stream.pipe(obj);
  });

  it("should call onNext once a row is parsed.", function (done) {
    var obj = new Converter();
    var stream = fs.createReadStream(file);
    var called = false;
    obj.subscribe(function (resultRow) {
      assert(resultRow);
      called = true;
    });
    obj.on("done", function () {
      assert(called);
      done();
    });
    stream.pipe(obj);
  });

  it("should emit end_parsed message once it is finished.", function (done) {
    var obj = new Converter();
    obj.then(function (result) {
      assert(result);
      assert(result.length === 2);
      assert(result[0].date);
      assert(result[0].employee);
      assert(result[0].employee.name);
      assert(result[0].employee.age);
      assert(result[0].employee.number);
      assert(result[0].employee.key.length === 2);
      assert(result[0].address.length === 2);
      done();
    });
    fs.createReadStream(file).pipe(obj);
  });

  it("should handle traling comma gracefully", function (done) {
    var stream = fs.createReadStream(trailCommaData);
    var obj = new Converter();
    obj.then(function (result) {
      assert(result);
      assert(result.length > 0);
      done();
    });
    stream.pipe(obj);
  });

  it("should handle comma in column which is surrounded by qoutes", function (done) {
    var testData = __dirname + "/data/dataWithComma";
    var rs = fs.createReadStream(testData);
    var obj = new Converter({
      "quote": "#"
    });
    obj.then(function (result) {
      assert(result[0].col1 === "\"Mini. Sectt");
      assert.equal(result[3].col2, "125001,fenvkdsf");
      // console.log(result);
      done();
    });
    rs.pipe(obj);
  });

  it("should be able to convert a csv to column array data", function (done) {
    var columArrData = __dirname + "/data/columnArray";
    var rs = fs.createReadStream(columArrData);
    var result:any = {};
    var csvConverter = new Converter();
    //end_parsed will be emitted once parsing finished
    csvConverter.then(function () {
      assert(result.TIMESTAMP.length === 5);
      done();
    });

    //record_parsed will be emitted each time a row has been parsed.
    csvConverter.subscribe(function (resultRow, rowIndex) {
      for (var key in resultRow) {
        if (resultRow.hasOwnProperty(key)) {
          if (!result[key] || !(result[key] instanceof Array)) {
            result[key] = [];
          }
          result[key][rowIndex] = resultRow[key];
        }
      }
    });
    rs.pipe(csvConverter);
  });

  it("should be able to convert csv string directly", function (done) {
    var testData = __dirname + "/data/testData";
    var data = fs.readFileSync(testData).toString();
    var csvConverter = new Converter();
    //end_parsed will be emitted once parsing finished
    csvConverter.then(function (jsonObj) {
      assert.equal(jsonObj.length, 2);
    });
    csvConverter.fromString(data).then(function (jsonObj) {
      assert(jsonObj.length === 2);
      done();
    });
  });

  it("should be able to convert csv string with error", function (done) {
    var testData = __dirname + "/data/dataWithUnclosedQuotes";
    var data = fs.readFileSync(testData).toString();
    var csvConverter = new Converter();
    csvConverter.fromString(data).then(undefined, function (err) {
      assert(err);
      assert.equal(err.err, "unclosed_quote");
      done();
    });
  });

  it("should be able to convert csv string without callback provided", function (done) {
    var testData = __dirname + "/data/testData";
    var data = fs.readFileSync(testData).toString();
    var csvConverter = new Converter();
    //end_parsed will be emitted once parsing finished
    csvConverter.then(function (jsonObj) {
      assert(jsonObj.length === 2);
      done();
    });
    csvConverter.fromString(data);
  });

  it("should be able to handle columns with double quotes", function (done) {
    var testData = __dirname + "/data/dataWithQoutes";
    var data = fs.readFileSync(testData).toString();
    var csvConverter = new Converter();
    csvConverter.fromString(data).then(function (jsonObj) {
      assert(jsonObj[0].TIMESTAMP === '13954264"22', JSON.stringify(jsonObj[0].TIMESTAMP));

      assert(jsonObj[1].TIMESTAMP === 'abc, def, ccc', JSON.stringify(jsonObj[1].TIMESTAMP));
      done();
    });
  });

  it("should be able to handle columns with two double quotes", function (done) {
    var testData = __dirname + "/data/twodoublequotes";
    var data = fs.readFileSync(testData).toString();
    var csvConverter = new Converter();
    csvConverter.fromString(data).then(function (jsonObj) {
      assert.equal(jsonObj[0].title, "\"");
      assert.equal(jsonObj[0].data, "xyabcde");
      assert.equal(jsonObj[0].uuid, "fejal\"eifa");
      assert.equal(jsonObj[0].fieldA, "bnej\"\"falkfe");
      assert.equal(jsonObj[0].fieldB, "\"eisjfes\"");
      done();
    });
  });

  it("should handle empty csv file", function (done) {
    var testData = __dirname + "/data/emptyFile";
    var rs = fs.createReadStream(testData);
    var csvConverter = new Converter();
    csvConverter.then(function (jsonObj) {
      assert(jsonObj.length === 0);
      done();
    });
    rs.pipe(csvConverter);
  });

  it("should parse large csv file", function (done) {
    var testData = __dirname + "/data/large-csv-sample.csv";
    var rs = fs.createReadStream(testData);
    var csvConverter = new Converter();
    var count = 0;
    csvConverter.subscribe(function () {
      //console.log(arguments);
      count++;
    });
    csvConverter.then(function () {
      assert(count === 5290);
      done();
    });
    rs.pipe(csvConverter);
  });

  it("should parse data and covert to specific types", function (done) {
    var testData = __dirname + "/data/dataWithType";
    var rs = fs.createReadStream(testData);
    var csvConverter = new Converter({
      checkType: true,
      colParser: {
        "column6": "string",
        "column7": "string"
      }
    });
    csvConverter.subscribe(function (d) {
      assert(typeof d.column1 === "number");
      assert(typeof d.column2 === "string");
      assert.equal(d["colume4"], "someinvaliddate");
      assert(d.column5.hello === "world");
      assert(d.column6 === '{"hello":"world"}');
      assert(d.column7 === "1234");
      assert(d.column8 === "abcd");
      assert(d.column9 === true);
      assert(d.column10[0] === 23);
      assert(d.column10[1] === 31);
      assert(d.column11[0].hello === "world");
      assert(d["name#!"] === false);
    });
    csvConverter.on("done", function () {
      done();
    });
    rs.pipe(csvConverter);
  });

  it("should turn off field type check", function (done) {
    var testData = __dirname + "/data/dataWithType";
    var rs = fs.createReadStream(testData);
    var csvConverter = new Converter({
      checkType: false
    });
    csvConverter.subscribe(function (d) {
      assert(typeof d.column1 === "string");
      assert(typeof d.column2 === "string");
      assert(d["column3"] === "2012-01-01");
      assert(d["colume4"] === "someinvaliddate");
      assert(d.column5 === '{"hello":"world"}');
      assert.equal(d["column6"], '{"hello":"world"}');
      assert(d["column7"] === "1234");
      assert(d["column8"] === "abcd");
      assert(d.column9 === "true");
      assert(d.column10[0] === "23");
      assert(d.column10[1] === "31");
      assert(d["name#!"] === 'false');
    });
    csvConverter.then(function () {
      done();
    });
    rs.pipe(csvConverter);
  });

  it("should emit data event correctly", function (done) {
    var testData = __dirname + "/data/large-csv-sample.csv";

    var csvConverter = new Converter({
    });
    var count = 0;
    csvConverter.on("data", function (d) {
      count++;
    });
    csvConverter.on("end", function () {
      assert.equal(count, 5290);
      done();
    });
    var rs = fs.createReadStream(testData);
    rs.pipe(csvConverter);
  });

  it("should process column with linebreaks", function (done) {
    var testData = __dirname + "/data/lineBreak";
    var rs = fs.createReadStream(testData);
    var csvConverter = new Converter({
      checkType: true
    });
    csvConverter.subscribe(function (d) {
      assert(d.Period === 13);
      assert(d["Apparent age"] === "Unknown");
      done();
    });
    rs.pipe(csvConverter);
  });

  it("be able to ignore empty columns", function (done) {
    var testData = __dirname + "/data/dataIgnoreEmpty";
    var rs = fs.createReadStream(testData);
    var st = rs.pipe(csv({ ignoreEmpty: true }));
    st.then(function (res) {
      var j = res[0];
      assert(res.length === 3);
      assert(j.col2.length === 2);
      assert(j.col2[1] === "d3");
      assert(j.col4.col3 === undefined);
      assert(j.col4.col5 === "world");
      assert(res[1].col1 === "d2");
      assert(res[2].col1 === "d4");
      done();
    });
  });

  it("should allow no header", function (done) {
    var testData = __dirname + "/data/noheadercsv";
    var rs = fs.createReadStream(testData);
    var st = rs.pipe(new Converter({ noheader: true }));
    st.then(function (res) {
      var j = res[0];
      assert(res.length === 5);
      assert(j.field1 === "CC102-PDMI-001");
      assert(j.field2 === "eClass_5.1.3");
      done();
    });
  });

  it("should allow customised header", function (done) {
    var testData = __dirname + "/data/noheadercsv";
    var rs = fs.createReadStream(testData);
    var st = rs.pipe(new Converter({
      noheader: true,
      headers: ["a", "b"]
    }));
    st.then(function (res) {
      var j = res[0];
      assert(res.length === 5);
      assert(j.a === "CC102-PDMI-001");
      assert(j.b === "eClass_5.1.3");
      assert(j.field3 === "10/3/2014");
      done();
    });
  });

  it("should allow customised header to override existing header", function (done) {
    var testData = __dirname + "/data/complexJSONCSV";
    var rs = fs.createReadStream(testData);
    var st = rs.pipe(new Converter({
      headers: []
    }));
    st.then(function (res) {
      var j = res[0];
      assert(res.length === 2);
      assert(j.field1 === "Food Factory");
      assert(j.field2 === "Oscar");
      done();
    });
  });

  it("should handle when there is an empty string", function (done) {
    var testData = __dirname + "/data/dataWithEmptyString";
    var rs = fs.createReadStream(testData);
    var st = rs.pipe(new Converter({
      noheader: true,
      headers: ["a", "b", "c"],
      checkType: true
    }));
    st.then(function (res) {
      var j = res[0];

      // assert(res.length===2);
      assert(j.a === "green");
      assert(j.b === 40);
      assert.equal(j.c, "");
      done();
    });
  });

  it("should detect eol correctly when first chunk is smaller than header row length", function (done) {
    var testData = __dirname + "/data/dataNoTrimCRLF";
    var rs = fs.createReadStream(testData, { highWaterMark: 3 });

    var st = rs.pipe(new Converter({
      trim: false
    }));
    st.then(function (res) {
      var j = res[0];
      assert(res.length === 2);
      assert(j.name === "joe");
      assert(j.age === "20");
      assert.equal(res[1].name, "sam");
      assert.equal(res[1].age, "30");
      done();
    });
  });

  it("should detect eol correctly when first chunk ends in middle of CRLF line break", function (done) {
    var testData = __dirname + "/data/dataNoTrimCRLF";
    var rs = fs.createReadStream(testData, { highWaterMark: 9 });

    var st = rs.pipe(new Converter({
      trim: false
    }));
    st.then(function (res) {
      var j = res[0];
      assert(res.length === 2);
      assert(j.name === "joe");
      assert(j.age === "20");
      assert.equal(res[1].name, "sam");
      assert.equal(res[1].age, "30");
      done();
    });
  });

  it("should emit eol event when line ending is detected as CRLF", function (done) {
    var testData = __dirname + "/data/dataNoTrimCRLF";
    var rs = fs.createReadStream(testData);

    var st = rs.pipe(new Converter());
    var eolCallback = sandbox.spy(function (eol) {
      assert.equal(eol, "\r\n");
    });
    st.on("eol", eolCallback);
    st.then(function () {
      assert.equal(eolCallback.callCount, 1, 'should emit eol event once');
      done();
    })
  });

  it("should emit eol event when line ending is detected as LF", function (done) {
    var testData = __dirname + "/data/columnArray";
    var rs = fs.createReadStream(testData);

    var st = rs.pipe(new Converter());
    var eolCallback = sandbox.spy(function (eol) {
      assert.equal(eol, "\n");
    });
    st.on("eol", eolCallback);
    st.then(function () {
      assert.equal(eolCallback.callCount, 1, 'should emit eol event once');
      done();
    })
  });

  it("should remove the Byte Order Mark (BOM) from input", function (done) {
    var testData = __dirname + "/data/dataNoTrimBOM";
    var rs = fs.createReadStream(testData);
    var st = rs.pipe(new Converter({
      trim: false
    }));
    st.then( function (res) {
      var j = res[0];

      assert(res.length===2);
      assert(j.name === "joe");
      assert(j.age === "20");
      done();
    });
  });
});