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
|
var _ = require('lodash');
var path = require('path');
var mock = require('./mock');
var registry = require('../lib/plugins/registry');
var Output = require('../lib/output/base');
var PluginsManager = require('../lib/plugins');
var BookPlugin = require('../lib/plugins/plugin');
var JSONOutput = require('../lib/output/json');
var PLUGINS_ROOT = path.resolve(__dirname, 'node_modules');
function TestPlugin(book, name) {
return new BookPlugin(book, name, path.resolve(PLUGINS_ROOT, 'gitbook-plugin-'+name));
}
describe('Plugins', function() {
var book;
before(function() {
return mock.setupBook({})
.then(function(_book) {
book = _book;
});
});
describe('Resolve Version', function() {
it('should resolve a plugin version', function() {
return registry.resolve('ga')
.should.be.fulfilled();
});
});
describe('Installation', function() {
it('should install a plugin from NPM without a specific version', function() {
return registry.install(book, 'ga')
.should.be.fulfilled();
});
it('should install a plugin from NPM with a specific version', function() {
return registry.install(book, 'ga', '1.0.0')
.should.be.fulfilled();
});
it('should correctly install all dependencies (if none)', function() {
return mock.setupBook({})
.then(function(book) {
var plugins = new PluginsManager(book);
return plugins.install()
.should.be.fulfilledWith(0);
});
});
it('should correctly install all dependencies (if any)', function() {
return mock.setupBook({
'book.json': {
plugins: ['ga']
}
})
.then(function(book) {
return book.prepareConfig()
.then(function() {
var plugins = new PluginsManager(book);
return plugins.install();
});
})
.should.be.fulfilledWith(1);
});
it('should correctly install dependencies from GitHub', function() {
return mock.setupBook({
'book.json': {
plugins: ['ga@git+https://github.com/GitbookIO/plugin-ga#master']
}
})
.then(function(book) {
return book.prepareConfig()
.then(function() {
var plugins = new PluginsManager(book);
return plugins.install();
});
})
.should.be.fulfilledWith(1);
});
// This test requires a SSH key, we only run it locally
if (!process.env.CI) {
it('should correctly install dependencies from GitHub via ssh', function() {
return mock.setupBook({
'book.json': {
plugins: ['ga@git@github.com:GitbookIO/plugin-ga.git#master']
}
})
.then(function(book) {
return book.prepareConfig()
.then(function() {
var plugins = new PluginsManager(book);
return plugins.install();
});
})
.should.be.fulfilledWith(1);
});
}
});
describe('Loading', function() {
it('should load default plugins', function() {
return mock.outputDefaultBook(Output)
.then(function(output) {
output.plugins.count().should.be.greaterThan(0);
});
});
});
describe('Configuration', function() {
it('should fail loading a plugin with an invalid configuration', function() {
var plugin = TestPlugin(book, 'test-config');
return plugin.load(PLUGINS_ROOT)
.should.be.rejectedWith('Error with book\'s configuration: pluginsConfig.test-config.myProperty is required');
});
it('should extend configuration with default properties', function() {
return mock.setupBook({
'book.json': {
pluginsConfig: {
'test-config': {
'myProperty': 'world'
}
}
}
})
.then(function(book2) {
return book2.prepareConfig()
.then(function() {
var plugin = TestPlugin(book2, 'test-config');
return plugin.load(PLUGINS_ROOT);
})
.then(function() {
book2.config.get('pluginsConfig.test-config.myDefaultProperty', '').should.equal('hello');
});
});
});
});
describe('Resources', function() {
var plugin;
before(function() {
plugin = TestPlugin(book, 'test-resources');
return plugin.load(PLUGINS_ROOT);
});
it('should list all resources for website', function() {
return plugin.getResources('website')
.then(function(resources) {
resources.assets.should.equal('./assets');
resources.js.should.have.lengthOf(2);
resources.js[0].path.should.equal('gitbook-plugin-test-resources/myfile.js');
resources.js[1].url.should.equal('https://ajax.googleapis.com/ajax/libs/angularjs/1.4.9/angular.min.js');
resources.css.should.have.lengthOf(1);
resources.css[0].path.should.equal('gitbook-plugin-test-resources/myfile.css');
});
});
});
describe('Filters', function() {
var plugin, filters;
before(function() {
plugin = TestPlugin(book, 'test-filters');
return plugin.load(PLUGINS_ROOT)
.then(function() {
filters = plugin.getFilters();
});
});
it('should list all filters', function() {
_.size(filters).should.equal(2);
});
it('should correctly execute a filter', function() {
filters.hello('World').should.equal('Hello World!');
});
it('should correctly set contexts for filter', function() {
filters.testContext('Hello');
});
});
describe('Blocks', function() {
var plugin, blocks;
before(function() {
plugin = TestPlugin(book, 'test-blocks');
return plugin.load(PLUGINS_ROOT)
.then(function() {
blocks = plugin.getBlocks();
});
});
it('should list all blocks', function() {
_.size(blocks).should.equal(2);
});
it('should correctly normalize block', function() {
blocks.hello.process({ body: 'World' }).should.equal('Hello World!');
});
it('should correctly set contexts for filter', function() {
blocks.testContext.process({ body: 'Hello' });
});
});
describe('Hooks', function() {
var plugin;
before(function() {
plugin = TestPlugin(book, 'test-hooks');
return plugin.load(PLUGINS_ROOT);
});
it('can call a hook', function() {
return plugin.hook('init')
.then(function() {
global._hooks.should.deepEqual(['init']);
});
});
describe('Hook "page"', function() {
var pluginDeprecated;
before(function() {
pluginDeprecated = TestPlugin(book, 'test-deprecated');
return pluginDeprecated.load(PLUGINS_ROOT);
});
it('should update content using "content" property', function() {
return mock.setupDefaultOutput(JSONOutput)
.then(function(output) {
output.plugins.load(plugin);
return output.generate()
.then(function() {
var json = require(output.resolve('README.json'));
json.page.content.should.equal('Hello <p>Hello</p>\n');
});
});
});
it('should update content using deprecated "sections" property', function() {
return mock.setupDefaultOutput(JSONOutput)
.then(function(output) {
output.plugins.load(pluginDeprecated);
return output.generate()
.then(function() {
var json = require(output.resolve('README.json'));
json.page.content.should.equal('Hello (sections) <p>Hello</p>\n');
});
});
});
});
});
});
|
