plato/test/plato_test.js

JavaScript source analysis and visualizer

'use strict';

var plato = require('../lib/plato');

/*
  ======== A Handy Little Nodeunit Reference ========
  https://github.com/caolan/nodeunit

  Test methods:
    test.expect(numAssertions)
    test.done()
  Test assertions:
    test.ok(value, [message])
    test.equal(actual, expected, [message])
    test.notEqual(actual, expected, [message])
    test.deepEqual(actual, expected, [message])
    test.notDeepEqual(actual, expected, [message])
    test.strictEqual(actual, expected, [message])
    test.notStrictEqual(actual, expected, [message])
    test.throws(block, [error], [message])
    test.doesNotThrow(block, [error], [message])
    test.ifError(value)
*/

exports['plato'] = {
  setUp: function(done) {
    // setup here
    done();
  },
  'test empty file' : function(test) {
    test.expect(1);

    var files = [
      'test/fixtures/a.js',
      'test/fixtures/b.js',
      'test/fixtures/c-es6.js',
      'test/fixtures/d-es6.js',
      'test/fixtures/empty.js'
    ];

    plato.inspect(files, null, {}, function(reports) {
      test.equal(reports.length, 4, 'Should not attempt to report on empty files');
      test.done();
    });
  },
  'test file glob' : function(test) {
    test.expect(1);

    var files = './test/fixtures/*.js';

    plato.inspect(files, null, {}, function(reports) {
      test.equal(reports.length, 7, 'Should properly test against the array produced by the glob');
      test.done();
    });
  },
  'test report structure' : function(test) {
    test.expect(8);

    var files = [
      'test/fixtures/a.js',
      'test/fixtures/b.js',
      'test/fixtures/c-es6.js',
      'test/fixtures/d-es6.js'
    ];

    plato.inspect(files, null, {}, function(reports) {
      reports.forEach(function(report) {
        test.ok(report.complexity, 'Should contain a complexity report');
        test.ok(report.jshint, 'Should contain a jshint report');
      });
      test.done();
    });
  },
  'test overview report structure' : function(test) {

    var files = [
      'test/fixtures/a.js',
      'test/fixtures/b.js',
      'test/fixtures/c-es6.js',
      'test/fixtures/d-es6.js'
    ];

//    test.expect((files.length * 3) + 1);
    test.expect(7);

    plato.inspect(files, null, {}, function(reports) {
      var overview = plato.getOverviewReport(reports);
      test.ok(overview.summary.total.jshint >= 0, 'Should contain total jshint issues');
      test.ok(overview.summary.total.sloc > 0, 'Should contain total sloc');
      test.ok(overview.summary.total.maintainability > 0, 'Should contain total maintainability');
      test.ok(overview.summary.average.jshint >= 0, 'Should contain average jshint issues');
      test.ok(overview.summary.average.sloc > 0, 'Should contain average sloc');
      test.ok(overview.summary.average.maintainability > 0, 'Should contain average maintainability');
      test.equal(overview.reports.length, files.length,'Should contain right number of reports');
      test.done();
    });
  },
  'test file with shebang' : function(test) {
    test.expect(1);

    var files = [
      'test/fixtures/a.js',
      'test/fixtures/b.js',
      'test/fixtures/c-es6.js',
      'test/fixtures/d-es6.js',
      'test/fixtures/shebang.js'
    ];

    plato.inspect(files, null, {}, function(reports) {
      test.equal(reports.length, 5, 'Should report on files starting with a shebang');
      test.done();
    });
  },
  'test noempty line option' : function(test) {
    test.expect(1);

    var files = [
      'test/fixtures/multipleEmptyLines.js'
    ];

    plato.inspect(files, null, {noempty : true}, function(reports) {
      var overview = plato.getOverviewReport(reports);
      test.ok(overview.summary.total.sloc === 10, 'Should contain total sloc without empty lines counted');
      test.done();
     });
  },

  'should run jshint with default config' : function(test) {

    var files = [
      'test/fixtures/a.js',
      'test/fixtures/b.js',
      'test/fixtures/c-es6.js',
      'test/fixtures/d-es6.js'
    ];

    test.expect(1);

    plato.inspect(files, null, {}, function(reports) {
      var overview = plato.getOverviewReport(reports);
      test.ok(overview.summary.total.jshint === 4, 'Should contain total jshint issues');
      test.done();
    });
  }
};