-
Notifications
You must be signed in to change notification settings - Fork 279
/
cli-test.coffee
827 lines (664 loc) · 27.5 KB
/
cli-test.coffee
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
net = require('net')
path = require('path')
{assert} = require('chai')
{exec} = require('child_process')
{isProcessRunning, killAll, createServer, runDreddCommandWithServer, runDreddCommand, DEFAULT_SERVER_PORT} = require('../helpers')
COFFEE_BIN = 'node_modules/.bin/coffee'
DEFAULT_HOOK_HANDLER_PORT = 61321
describe 'CLI', ->
describe "Arguments with existing API description document and responding server", ->
describe "when executing the command and the server is responding as specified in the API description", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = ['./test/fixtures/single-get.apib', "http://127.0.0.1:#{DEFAULT_SERVER_PORT}"]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'exit status should be 0', ->
assert.equal runtimeInfo.dredd.exitStatus, 0
describe "when executing the command and the server is responding as specified in the API description, endpoint with path", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/v2/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = ['./test/fixtures/single-get.apib', "http://127.0.0.1:#{DEFAULT_SERVER_PORT}/v2/"]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'exit status should be 0', ->
assert.equal runtimeInfo.dredd.exitStatus, 0
describe "when executing the command and the server is sending different response", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.status(201).json([{kind: 'bulldozer', imatriculation: 'willy'}])
args = ['./test/fixtures/single-get.apib', "http://127.0.0.1:#{DEFAULT_SERVER_PORT}"]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'exit status should be 1', ->
assert.equal runtimeInfo.dredd.exitStatus, 1
describe "when called with arguments", ->
describe 'when using language hook handler and spawning the server', ->
describe "and handler file doesn't exist", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--server-wait=0'
'--language=foo/bar/hook-handler'
'--hookfiles=./test/fixtures/scripts/emptyfile'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
after (done) ->
killAll('test/fixtures/scripts/', done)
it 'should return with status 1', ->
assert.equal runtimeInfo.dredd.exitStatus, 1
it 'should not return message containing exited or killed', ->
assert.notInclude runtimeInfo.dredd.stderr, 'exited'
assert.notInclude runtimeInfo.dredd.stderr, 'killed'
it 'should not return message announcing the fact', ->
assert.include runtimeInfo.dredd.stderr, 'not found'
it 'should term or kill the server', (done) ->
isProcessRunning('endless-ignore-term', (err, isRunning) ->
assert.isFalse isRunning unless err
done(err)
)
it 'should not execute any transaction', ->
assert.deepEqual runtimeInfo.server.requestCounts, {}
describe 'and handler crashes before execution', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--server-wait=0'
"--language=#{COFFEE_BIN} ./test/fixtures/scripts/exit-3.coffee"
'--hookfiles=./test/fixtures/scripts/emptyfile'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
after (done) ->
killAll('test/fixtures/scripts/', done)
it 'should return with status 1', ->
assert.equal runtimeInfo.dredd.exitStatus, 1
it 'should return message announcing the fact', ->
assert.include runtimeInfo.dredd.stderr, 'exited'
it 'should term or kill the server', (done) ->
isProcessRunning('endless-ignore-term', (err, isRunning) ->
assert.isFalse isRunning unless err
done(err)
)
it 'should not execute any transaction', ->
assert.deepEqual runtimeInfo.server.requestCounts, {}
describe "and handler is killed before execution", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
"--server=#{COFFEE_BIN} ./test/fixtures/scripts/endless-ignore-term.coffee"
'--server-wait=0'
"--language=#{COFFEE_BIN} ./test/fixtures/scripts/kill-self.coffee"
'--hookfiles=./test/fixtures/scripts/emptyfile'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
after (done) ->
killAll('test/fixtures/scripts/', done)
it 'should return with status 1', ->
assert.equal runtimeInfo.dredd.exitStatus, 1
it 'should return message announcing the fact', ->
if process.platform is 'win32'
# On Windows there's no way to detect a process was killed
assert.include runtimeInfo.dredd.stderr, 'exited'
else
assert.include runtimeInfo.dredd.stderr, 'killed'
it 'should term or kill the server', (done) ->
isProcessRunning('endless-ignore-term', (err, isRunning) ->
assert.isFalse isRunning unless err
done(err)
)
it 'should not execute any transaction', ->
assert.deepEqual runtimeInfo.server.requestCounts, {}
describe "and handler is killed during execution", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
# path.posix|win32.normalize and path.join do not do the job in this case,
# hence this ingenious hack
normalizedPath = path.normalize('foo/bar/hooks').replace(/\\/g, '\\\\')
killAll("endless-ignore-term.+[^=]#{normalizedPath}", (err) ->
done err if err
res.json([{type: 'bulldozer', name: 'willy'}])
)
# TCP server echoing transactions back
hookHandler = net.createServer (socket) ->
socket.on 'data', (data) -> socket.write data
socket.on 'error', (err) -> console.error err
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
"--server=#{COFFEE_BIN} ./test/fixtures/scripts/endless-ignore-term.coffee"
'--server-wait=0'
"--language=#{COFFEE_BIN} ./test/fixtures/scripts/endless-ignore-term.coffee"
'--hookfiles=foo/bar/hooks'
]
hookHandler.listen DEFAULT_HOOK_HANDLER_PORT, ->
runDreddCommandWithServer(args, app, (err, info) ->
hookHandler.close()
runtimeInfo = info
done(err)
)
after (done) ->
killAll('test/fixtures/scripts/', done)
it 'should return with status 1', ->
assert.equal runtimeInfo.dredd.exitStatus, 1
it 'should return message announcing the fact', ->
if process.platform is 'win32'
# On Windows there's no way to detect a process was killed
assert.include runtimeInfo.dredd.stderr, 'exited'
else
assert.include runtimeInfo.dredd.stderr, 'killed'
it 'should term or kill the server', (done) ->
isProcessRunning('endless-ignore-term', (err, isRunning) ->
assert.isFalse isRunning unless err
done(err)
)
it 'should execute the transaction', ->
assert.deepEqual runtimeInfo.server.requestCounts, {'/machines': 1}
describe "and handler didn't quit but all Dredd tests were OK", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
# TCP server echoing transactions back
hookHandler = net.createServer (socket) ->
socket.on 'data', (data) -> socket.write data
socket.on 'error', (err) -> console.error err
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
"--server=#{COFFEE_BIN} ./test/fixtures/scripts/endless-ignore-term.coffee"
'--server-wait=0'
"--language=#{COFFEE_BIN} ./test/fixtures/scripts/endless-ignore-term.coffee"
'--hookfiles=./test/fixtures/scripts/emptyfile'
]
hookHandler.listen DEFAULT_HOOK_HANDLER_PORT, ->
runDreddCommandWithServer(args, app, (err, info) ->
hookHandler.close()
runtimeInfo = info
done(err)
)
after (done) ->
killAll('test/fixtures/scripts/', done)
it 'should return with status 0', ->
assert.equal runtimeInfo.dredd.exitStatus, 0
it 'should not return any killed or exited message', ->
assert.notInclude runtimeInfo.dredd.stderr, 'killed'
assert.notInclude runtimeInfo.dredd.stderr, 'exited'
it 'should kill both the handler and the server', (done) ->
isProcessRunning('endless-ignore-term', (err, isRunning) ->
assert.isFalse isRunning unless err
done(err)
)
it 'should execute some transaction', ->
assert.deepEqual runtimeInfo.server.requestCounts, {'/machines': 1}
describe "when adding additional headers with -h", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-h'
'Accept:application/json'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should have an additional header in the request', ->
assert.nestedPropertyVal runtimeInfo.server.requests['/machines'][0], 'headers.accept', 'application/json'
describe "when adding basic auth credentials with -u", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-u'
'username:password'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should have an authorization header in the request', ->
assert.isOk runtimeInfo.server.requests['/machines'][0].headers.authorization
it 'should contain a base64 encoded string of the username and password', ->
assert.isOk runtimeInfo.server.requests['/machines'][0].headers.authorization is 'Basic ' + new Buffer('username:password').toString('base64')
describe "when sorting requests with -s", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/apiary.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-s'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should perform the POST, GET, PUT, DELETE in order', ->
assert.isOk runtimeInfo.dredd.stdout.indexOf('POST') < runtimeInfo.dredd.stdout.indexOf('GET') < runtimeInfo.dredd.stdout.indexOf('PUT') < runtimeInfo.dredd.stdout.indexOf('DELETE')
describe 'when displaying errors inline with -e', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.status(201).json([{kind: 'bulldozer', imatriculation: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-e'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should display errors inline', ->
# when displayed inline, a single fail request only creates two "fail:" messages,
# as opposed to the usual three
count = runtimeInfo.dredd.stdout.split("fail").length - 2 #says fail in the epilogue
assert.equal count, 2
describe 'when showing details for all requests with -d', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-d'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should display details on passing tests', ->
# the request: block is not shown for passing tests normally
assert.isOk runtimeInfo.dredd.stdout.indexOf('request') > -1
describe "when filtering request methods with -m", ->
describe 'when blocking a request', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-m',
'POST'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should not send the request request', ->
assert.deepEqual runtimeInfo.server.requestCounts, {}
describe 'when not blocking a request', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-m',
'GET'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should allow the request to go through', ->
assert.deepEqual runtimeInfo.server.requestCounts, {'/machines': 1}
describe "when filtering transaction to particular name with -x or --only", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
app.get '/message', (req, res) ->
res.type('text/plain').send "Hello World!\n"
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--path=./test/fixtures/multifile/*.apib'
'--only=Message API > /message > GET'
'--no-color'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should notify skipping to the stdout', ->
assert.include runtimeInfo.dredd.stdout, 'skip: GET (200) /machines'
it 'should hit the only transaction', ->
assert.deepEqual runtimeInfo.server.requestCounts, {'/message': 1}
it 'exit status should be 0', ->
assert.equal runtimeInfo.dredd.exitStatus, 0
describe 'when suppressing color with --no-color', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--no-color'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should print without colors', ->
# if colors are not on, there is no closing color code between
# the "pass" and the ":"
assert.include runtimeInfo.dredd.stdout, 'pass:'
describe 'when suppressing color with --color=false', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--color=false'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should print without colors', ->
# if colors are not on, there is no closing color code between
# the "pass" and the ":"
assert.include runtimeInfo.dredd.stdout, 'pass:'
describe 'when setting the log output level with -l', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-l=error'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should not display anything', ->
# at the "error" level, complete should not be shown
assert.isOk runtimeInfo.dredd.stdout.indexOf('complete') is -1
describe 'when showing timestamps with -t', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'-t'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should display timestamps', ->
# look for the prefix for cli output with timestamps
assert.notEqual runtimeInfo.dredd.stdout.indexOf('Z -'), -1
describe 'when loading hooks with --hookfiles', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--hookfiles=./test/fixtures/*_hooks.*'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should modify the transaction with hooks', ->
assert.equal runtimeInfo.server.requests['/machines'][0].headers['header'], '123232323'
describe 'when describing events in hookfiles', ->
runtimeInfo = undefined
containsLine = (str, expected) ->
lines = str.split('\n')
for line in lines
if line.indexOf(expected) > -1
return true
return false
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--hookfiles=./test/fixtures/*_events.*'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should execute the before and after events', ->
assert.isOk containsLine(runtimeInfo.dredd.stdout, 'hooks.beforeAll'), (runtimeInfo.dredd.stdout)
assert.isOk containsLine(runtimeInfo.dredd.stdout, 'hooks.afterAll'), (runtimeInfo.dredd.stdout)
describe 'when describing both hooks and events in hookfiles', ->
runtimeInfo = undefined
getResults = (str) ->
ret = []
lines = str.split('\n')
for line in lines
if line.indexOf('*** ') > -1
ret.push(line.substr(line.indexOf('*** ') + 4))
return ret.join(',')
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--hookfiles=./test/fixtures/*_all.*'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should execute hooks and events in order', ->
events = getResults(runtimeInfo.dredd.stdout)
assert.isOk events is 'beforeAll,before,after,afterAll'
describe "tests an API description containing an endpoint with schema", ->
describe "and server is responding in accordance with the schema", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/', (req, res) ->
res.json(
data:
expires: 1234,
token: 'this should pass since it is a string'
)
args = [
'./test/fixtures/schema.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'exit status should be 0 (success)', ->
assert.equal runtimeInfo.dredd.exitStatus, 0
describe "and server is NOT responding in accordance with the schema", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/', (req, res) ->
res.json(
data:
expires: 'this should fail since it is a string',
token: 'this should pass since it is a string'
)
args = [
'./test/fixtures/schema.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'exit status should be 1 (failure)', ->
assert.equal runtimeInfo.dredd.exitStatus, 1
describe "when API description document path is a glob", ->
describe "and called with --names options", ->
dreddCommandInfo = undefined
before (done) ->
args = [
'./test/fixtures/multifile/*.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--names'
]
runDreddCommand(args, (err, info) ->
dreddCommandInfo = info
done(err)
)
it 'it should include all paths from all API description documents matching the glob', ->
assert.include dreddCommandInfo.stdout, '> /greeting > GET'
assert.include dreddCommandInfo.stdout, '> /message > GET'
assert.include dreddCommandInfo.stdout, '> /name > GET'
it 'should exit with status 0', ->
assert.equal dreddCommandInfo.exitStatus, 0
describe 'and called with hooks', ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/name', (req, res) ->
res.type('text/plain').send "Adam\n"
app.get '/greeting', (req, res) ->
res.type('text/plain').send "Howdy!\n"
app.get '/message', (req, res) ->
res.type('text/plain').send "Hello World!\n"
args = [
'./test/fixtures/multifile/*.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--hookfiles=./test/fixtures/multifile/multifile_hooks.coffee'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should eval the hook for each transaction', ->
assert.include runtimeInfo.dredd.stdout, 'after name'
assert.include runtimeInfo.dredd.stdout, 'after greeting'
assert.include runtimeInfo.dredd.stdout, 'after message'
it 'should exit with status 0', ->
assert.equal runtimeInfo.dredd.exitStatus, 0, (runtimeInfo.dredd.output)
it 'server should receive 3 requests', ->
assert.deepEqual runtimeInfo.server.requestCounts,
'/name': 1
'/greeting': 1
'/message': 1
describe "when called with additional --path argument which is a glob", ->
describe "and called with --names options", ->
dreddCommandInfo = undefined
before (done) ->
args = [
'./test/fixtures/multiple-examples.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--path=./test/fixtures/multifile/*.apib'
'--names'
]
runDreddCommand(args, (err, info) ->
dreddCommandInfo = info
done(err)
)
it 'it should include all paths from all API description documents matching all paths and globs', ->
assert.include dreddCommandInfo.stdout, 'Greeting API > /greeting > GET'
assert.include dreddCommandInfo.stdout, 'Message API > /message > GET'
assert.include dreddCommandInfo.stdout, 'Name API > /name > GET'
assert.include dreddCommandInfo.stdout, 'Machines API > Machines > Machines collection > Get Machines > Example 1'
assert.include dreddCommandInfo.stdout, 'Machines API > Machines > Machines collection > Get Machines > Example 2'
it 'should exit with status 0', ->
assert.equal dreddCommandInfo.exitStatus, 0
describe "Using sandboxed hooks", ->
runtimeInfo = undefined
before (done) ->
app = createServer()
app.get '/machines', (req, res) ->
res.json([{type: 'bulldozer', name: 'willy'}])
args = [
'./test/fixtures/single-get.apib'
"http://127.0.0.1:#{DEFAULT_SERVER_PORT}"
'--sandbox'
'--hookfiles=./test/fixtures/sandboxed-hook.js'
]
runDreddCommandWithServer(args, app, (err, info) ->
runtimeInfo = info
done(err)
)
it 'should hit the resource', ->
assert.deepEqual runtimeInfo.server.requestCounts, {'/machines': 1}
it 'exit status should be 1', ->
assert.equal runtimeInfo.dredd.exitStatus, 1
it 'stdout should contain fail message', ->
assert.include runtimeInfo.dredd.stdout, 'failed in sandboxed hook'
it 'stdout should contain sandbox messagae', ->
assert.include runtimeInfo.dredd.stdout, 'Loading hook files in sandboxed context'