jsdoc/test/specs/plugins/plugins.js

58 lines
2.8 KiB
JavaScript

/*global afterEach: true, app: true, beforeEach: true, describe: true, env: true, expect: true,
it: true, jasmine: true */
// TODO: consolidate with specs/jsdoc/parser and specs/jsdoc/plugins
describe("plugins", function() {
var path = require('jsdoc/path');
var docSet;
var pluginPaths = [
path.normalize(env.dirname + '/test/fixtures/testPlugin1'),
path.normalize(env.dirname + '/test/fixtures/testPlugin2')
];
// TODO: decouple this from the global parser
app.jsdoc.parser = jasmine.createParser();
global.jsdocPluginsTest = global.jsdocPluginsTest || {};
require('jsdoc/plugins').installPlugins(pluginPaths, app.jsdoc.parser);
docSet = jasmine.getDocSetFromFile('test/fixtures/plugins.js', app.jsdoc.parser, false);
it("should fire the plugin's event handlers", function() {
expect(global.jsdocPluginsTest.plugin1.fileBegin).toBeDefined();
expect(global.jsdocPluginsTest.plugin1.fileBegin).toEqual(true);
expect(global.jsdocPluginsTest.plugin1.beforeParse).toBeDefined();
expect(global.jsdocPluginsTest.plugin1.beforeParse).toEqual(true);
expect(global.jsdocPluginsTest.plugin1.jsdocCommentFound).toBeDefined();
expect(global.jsdocPluginsTest.plugin1.jsdocCommentFound).toEqual(true);
expect(global.jsdocPluginsTest.plugin1.symbolFound).toBeDefined();
expect(global.jsdocPluginsTest.plugin1.symbolFound).toEqual(true);
expect(global.jsdocPluginsTest.plugin1.newDoclet).toBeDefined();
expect(global.jsdocPluginsTest.plugin1.newDoclet).toEqual(true);
expect(global.jsdocPluginsTest.plugin1.fileComplete).toBeDefined();
expect(global.jsdocPluginsTest.plugin1.fileComplete).toEqual(true);
expect(global.jsdocPluginsTest.plugin2.fileBegin).toBeDefined();
expect(global.jsdocPluginsTest.plugin2.fileBegin).toEqual(true);
expect(global.jsdocPluginsTest.plugin2.beforeParse).toBeDefined();
expect(global.jsdocPluginsTest.plugin2.beforeParse).toEqual(true);
expect(global.jsdocPluginsTest.plugin2.jsdocCommentFound).toBeDefined();
expect(global.jsdocPluginsTest.plugin2.jsdocCommentFound).toEqual(true);
expect(global.jsdocPluginsTest.plugin2.symbolFound).toBeDefined();
expect(global.jsdocPluginsTest.plugin2.symbolFound).toEqual(true);
expect(global.jsdocPluginsTest.plugin2.newDoclet).toBeDefined();
expect(global.jsdocPluginsTest.plugin2.newDoclet).toEqual(true);
expect(global.jsdocPluginsTest.plugin2.fileComplete).toBeDefined();
expect(global.jsdocPluginsTest.plugin2.fileComplete).toEqual(true);
});
it("should add the plugin's tag definitions to the dictionary", function() {
var test = docSet.getByLongname("test");
expect(test[0].longname).toEqual("test");
expect(test[0].foo).toEqual(true);
});
});