Skip to content

Commit 7182c7b

Browse files
mefellowsmefellows
committed
feat(karma): update tests for karma suite and adapted Pact API for Karma
1 parent bc3120d commit 7182c7b

File tree

8 files changed

+429
-126
lines changed

8 files changed

+429
-126
lines changed

‎.istanbul.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ check:
88
functions: 80
99
excludes: []
1010
each:
11-
statements: 80
12-
lines: 80
11+
statements: 60
12+
lines: 60
1313
branches: 80
1414
functions: 80
1515
excludes: []

‎config/webpack.web.config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ var DIST = path.resolve(__dirname, '../dist');
66
var APP = path.resolve(__dirname, '../src');
77

88
module.exports = {
9-
entry: path.resolve(APP, 'pact.js'),
9+
entry: path.resolve(APP, 'pact-karma.js'),
1010
output: {
1111
path: DIST,
1212
library: 'Pact',

‎docs/index.html

+191-25
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ <h3 class='mb0 no-anchor'>Pact</h3>
4242
.create
4343
</a></li>
4444

45+
<li><a
46+
href='#Pact.Verifier'
47+
class='regular pre-open'>
48+
.Verifier
49+
</a></li>
50+
4551
<li><a
4652
href='#Pact.Matchers'
4753
class='regular pre-open'>
@@ -108,6 +114,16 @@ <h3 class='mb0 no-anchor'>Pact</h3>
108114
</li>
109115

110116

117+
<li><a
118+
href='#setup'
119+
class="">
120+
setup
121+
122+
</a>
123+
124+
</li>
125+
126+
111127
<li><a
112128
href='#matchers'
113129
class=" toggle-sibling">
@@ -147,6 +163,16 @@ <h3 class='mb0 no-anchor'>Pact</h3>
147163
</li>
148164

149165

166+
<li><a
167+
href='#providerverifier'
168+
class="">
169+
ProviderVerifier
170+
171+
</a>
172+
173+
</li>
174+
175+
150176
<li><a
151177
href='#mockservice'
152178
class=" toggle-sibling">
@@ -272,7 +298,7 @@ <h3 class='fl m0' id='pact'>
272298
Pact
273299
</h3>
274300

275-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/82f203c5355df50798abd239590142715b69b113/src/pact.js#L6-L6'>
301+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/bc3120d6b7d890e9561709537ff76cfc6df84995/src/pact.js#L6-L6'>
276302
<span>src/pact.js</span>
277303
</a>
278304

@@ -405,6 +431,51 @@ <h3 class='fl m0' id='pact'>
405431

406432

407433

434+
435+
436+
437+
438+
</section>
439+
440+
</div>
441+
</div>
442+
443+
<div class='border-bottom' id='Pact.Verifier'>
444+
<div class="clearfix small pointer toggle-sibling">
445+
<div class="py1 contain">
446+
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
447+
<span class='code strong strong truncate'>Verifier</span>
448+
</div>
449+
</div>
450+
<div class="clearfix display-none toggle-target">
451+
<section class='p2 mb2 clearfix bg-white minishadow'>
452+
453+
454+
455+
<p>Exposes <a href="Verifier">Verifier</a></p>
456+
457+
458+
<div class='pre p1 fill-light mt0'>Verifier</div>
459+
460+
461+
462+
463+
464+
465+
466+
467+
468+
469+
470+
471+
472+
473+
474+
475+
476+
477+
478+
408479

409480

410481

@@ -479,7 +550,7 @@ <h3 class='fl m0' id='pactprovider'>
479550
PactProvider
480551
</h3>
481552

482-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/82f203c5355df50798abd239590142715b69b113/src/pact.js#L51-L115'>
553+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/bc3120d6b7d890e9561709537ff76cfc6df84995/src/pact.js#L66-L142'>
483554
<span>src/pact.js</span>
484555
</a>
485556

@@ -582,18 +653,19 @@ <h3 class='fl m0' id='pactprovider'>
582653
<div class="clearfix small pointer toggle-sibling">
583654
<div class="py1 contain">
584655
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
585-
<span class='code strong strong truncate'>verify(response)</span>
656+
<span class='code strong strong truncate'>verify()</span>
586657
</div>
587658
</div>
588659
<div class="clearfix display-none toggle-target">
589660
<section class='p2 mb2 clearfix bg-white minishadow'>
590661

591662

592663

593-
<p>Executes a promise chain that will eventually write the Pact file if successful.</p>
664+
<p>Checks with the Mock Service if the expected interactions have been exercised.
665+
TODO: Should this finalise and write pact also?</p>
594666

595667

596-
<div class='pre p1 fill-light mt0'>verify(response: (<a href="https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5">Response</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5">Response</a>&gt;)): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></div>
668+
<div class='pre p1 fill-light mt0'>verify(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></div>
597669

598670

599671

@@ -604,19 +676,6 @@ <h3 class='fl m0' id='pactprovider'>
604676

605677

606678

607-
<div class='py1 quiet mt1 prose-big'>Parameters</div>
608-
<div class='prose'>
609-
610-
<div class='space-bottom0'>
611-
<div>
612-
<span class='code bold'>response</span> <code class='quiet'>((<a href="https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5">Response</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5">Response</a>&gt;))</code> the response object or an Array of response objects of the Request(s) issued
613-
614-
</div>
615-
616-
</div>
617-
618-
</div>
619-
620679

621680

622681

@@ -655,7 +714,8 @@ <h3 class='fl m0' id='pactprovider'>
655714

656715

657716

658-
<p>Writes the Pact and clears any interactions left behind.</p>
717+
<p>Writes the Pact and clears any interactions left behind and shutdown the
718+
mock server</p>
659719

660720

661721
<div class='pre p1 fill-light mt0'>finalize(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></div>
@@ -707,7 +767,9 @@ <h3 class='fl m0' id='pactprovider'>
707767

708768

709769

710-
<p>Writes the Pact file but leave interactions in.</p>
770+
<p>Writes the pact file out to file. Should be called when all tests have been performed for a
771+
given Consumer &lt;-&gt; Provider pair. It will write out the Pact to the
772+
configured file.</p>
711773

712774

713775
<div class='pre p1 fill-light mt0'>writePact(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></div>
@@ -804,6 +866,61 @@ <h3 class='fl m0' id='pactprovider'>
804866

805867

806868

869+
</section>
870+
871+
872+
873+
874+
<section class='p2 mb2 clearfix bg-white minishadow'>
875+
876+
877+
<div class='clearfix'>
878+
<h3 class='fl m0' id='setup'>
879+
setup
880+
</h3>
881+
882+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/bc3120d6b7d890e9561709537ff76cfc6df84995/src/pact.js#L72-L72'>
883+
<span>src/pact.js</span>
884+
</a>
885+
886+
</div>
887+
888+
889+
<p>Start the Mock Server.</p>
890+
891+
892+
<div class='pre p1 fill-light mt0'>setup(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></div>
893+
894+
895+
896+
897+
898+
899+
900+
901+
902+
903+
904+
905+
906+
907+
908+
<div class='py1 quiet mt1 prose-big'>Returns</div>
909+
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></code>:
910+
911+
912+
913+
914+
915+
916+
917+
918+
919+
920+
921+
922+
923+
807924
</section>
808925

809926

@@ -817,7 +934,7 @@ <h3 class='fl m0' id='matchers'>
817934
Matchers
818935
</h3>
819936

820-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/82f203c5355df50798abd239590142715b69b113/src/dsl/matchers.js#L3-L3'>
937+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/bc3120d6b7d890e9561709537ff76cfc6df84995/src/dsl/matchers.js#L3-L3'>
821938
<span>src/dsl/matchers.js</span>
822939
</a>
823940

@@ -1084,6 +1201,54 @@ <h3 class='fl m0' id='matchers'>
10841201
</div>
10851202

10861203

1204+
1205+
1206+
1207+
1208+
</section>
1209+
1210+
1211+
1212+
1213+
<section class='p2 mb2 clearfix bg-white minishadow'>
1214+
1215+
1216+
<div class='clearfix'>
1217+
<h3 class='fl m0' id='providerverifier'>
1218+
ProviderVerifier
1219+
</h3>
1220+
1221+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/bc3120d6b7d890e9561709537ff76cfc6df84995/src/dsl/verifier.js#L6-L6'>
1222+
<span>src/dsl/verifier.js</span>
1223+
</a>
1224+
1225+
</div>
1226+
1227+
1228+
<p>Provider Verifier service</p>
1229+
1230+
1231+
<div class='pre p1 fill-light mt0'>ProviderVerifier</div>
1232+
1233+
1234+
1235+
1236+
1237+
1238+
1239+
1240+
1241+
1242+
1243+
1244+
1245+
1246+
1247+
1248+
1249+
1250+
1251+
10871252

10881253

10891254

@@ -1101,15 +1266,16 @@ <h3 class='fl m0' id='mockservice'>
11011266
MockService
11021267
</h3>
11031268

1104-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/82f203c5355df50798abd239590142715b69b113/src/dsl/mockService.js#L7-L7'>
1269+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/bc3120d6b7d890e9561709537ff76cfc6df84995/src/dsl/mockService.js#L8-L8'>
11051270
<span>src/dsl/mockService.js</span>
11061271
</a>
11071272

11081273
</div>
11091274

11101275

1111-
<p>A Mock Service is the interaction mechanism through which pacts get written and verified.
1112-
This should be transparent to the end user.</p>
1276+
<p>Mock Service is the HTTP interface to setup the Pact Mock Service.
1277+
See <a href="https://github.com/bethesque/pact-mock_service">https://github.com/bethesque/pact-mock_service</a> and
1278+
<a href="https://gist.github.com/bethesque/9d81f21d6f77650811f4">https://gist.github.com/bethesque/9d81f21d6f77650811f4</a>.</p>
11131279

11141280

11151281
<div class='pre p1 fill-light mt0'>MockService</div>
@@ -1465,7 +1631,7 @@ <h3 class='fl m0' id='interaction'>
14651631
Interaction
14661632
</h3>
14671633

1468-
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/82f203c5355df50798abd239590142715b69b113/src/dsl/interaction.js#L6-L6'>
1634+
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/pact-foundation/pact-js/blob/bc3120d6b7d890e9561709537ff76cfc6df84995/src/dsl/interaction.js#L6-L6'>
14691635
<span>src/dsl/interaction.js</span>
14701636
</a>
14711637

‎examples/mocha/test/index.spec.js

-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ describe('The Dog API', () => {
4848
const urlAndPort = { url: url, port: port }
4949
getMeDogs(urlAndPort)
5050
.then(response => {
51-
console.log(response)
5251
expect(response.data).to.eql(EXPECTED_BODY)
5352
done()
5453
})

0 commit comments

Comments
 (0)