Skip to content

Commit

Permalink
feat: support promises in filters + state handlers
Browse files Browse the repository at this point in the history 
Adds back the proxy infrastructure to allow native promises
in the request filters and provider state handlers.

BREAKING CHANGE: the signature of state handlers has been updated to
accept either a single function with parameters, or an object that
can specify optional teardown and setup functions that run on the
different state phases.

BREAKING CHANGE: callbackTimeout is now timeout
  • Loading branch information
@mefellows
mefellows committed Jun 26, 2021
1 parent 24742e4 commit 456567c
Show file tree
Hide file tree
Showing 21 changed files with 570 additions and 477 deletions.
4 changes: 2 additions & 2 deletions .istanbul.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ check:
statements: 80
lines: 80
branches: 80
functions: 80
functions: 75
excludes: []
each:
statements: 60
lines: 60
branches: 65
functions: 80
functions: 75
excludes: ['src/dsl/verifier.ts']
2 changes: 1 addition & 1 deletion .nycrc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@
"instrument": true,
"lines": 80,
"statements": 80,
"functions": 80,
"functions": 75,
"branches": 80
}
88 changes: 45 additions & 43 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ Read [Getting started with Pact] for more information for beginners.
- [Match based on type](#match-based-on-type)
- [Match based on arrays](#match-based-on-arrays)
- [Match by regular expression](#match-by-regular-expression)
- [A note about typescript](#a-note-about-typescript)
- [GraphQL API](#graphql-api)
- [Tutorial (60 minutes)](#tutorial-60-minutes)
- [Examples](#examples)
Expand Down Expand Up @@ -325,7 +326,7 @@ new Verifier(opts).verifyProvider().then(function () {
| `pactUrls` | false | array | Array of local pact file paths or HTTP-based URLs. Required if _not_ using a Pact Broker. |
| `providerStatesSetupUrl` | false | string | Deprecated (use URL to send PUT requests to setup a given provider state |
| `stateHandlers` | false | object | Map of "state" to a function that sets up a given provider state. See docs below for more information |
| `requestFilter` | false | function | Function that may be used to alter the incoming request or outgoing response from the verification process. See below for use. |
| `requestFilter` | false | function ([Express middleware](https://expressjs.com/en/guide/using-middleware.html)) | Function that may be used to alter the incoming request or outgoing response from the verification process. See below for use. |
| `beforeEach` | false | function | Function to execute prior to each interaction being validated |
| `afterEach` | false | function | Function to execute after each interaction has been validated |
| `pactBrokerUsername` | false | string | Username for Pact Broker basic authentication |
Expand Down Expand Up @@ -1096,21 +1097,15 @@ Then when the provider is verified, the provider state callback can return a map
For example:

```js
stateHandlers: {
"Account Test001 exists": (setup, params) => {
if (setup) {
const account = new Account(0, 0, "Test001", params.accountRef, new AccountNumber(0), Date.now(), Date.now())
const persistedAccount = accountRepository.save(account)
return { accountNumber: persistedAccount.accountNumber.id }
} else {
return null
}
}
},
stateHandlers: {
"Account Test001 exists": (params) => {
const account = new Account(0, 0, "Test001", params.accountRef, new AccountNumber(0), Date.now(), Date.now())
const persistedAccount = accountRepository.save(account)
return { accountNumber: persistedAccount.accountNumber.id }
}
},
```

**NOTE:** Async callbacks and returning promises from the provider state callbacks is not currently supported.

### Using Pact with XML

You can write both consumer and provider verification tests with XML requests or responses. For an example, see [examples/v3/todo-consumer/test/consumer.spec.js](https://github.com/pact-foundation/pact-js/blob/feat/v3.0.0/examples/v3/todo-consumer/test/consumer.spec.js).
Expand Down Expand Up @@ -1173,7 +1168,7 @@ The `VerifierV3` class can verify your provider in a similar way to the existing
| `callbackTimeout` | false | number | Timeout in milliseconds for request filters and provider state handlers to execute within |
| `publishVerificationResult` | false | boolean | Publish verification result to Broker (_NOTE_: you should only enable this during CI builds) |
| `providerVersion` | false | string | Provider version, required to publish verification result to Broker. Optional otherwise. |
| `requestFilter ` | false | RequestHandler | |
| `requestFilter` | false | function ([Express middleware](https://expressjs.com/en/guide/using-middleware.html)) | |
| `stateHandlers` | false | object | Map of "state" to a function that sets up a given provider state. See docs [below](#provider-state-callbacks) for more information |
| `consumerVersionTags` | false | string\|array | Retrieve the latest pacts with given tag(s) |
| `providerVersionTags` | false | string\|array | Tag(s) to apply to the provider application |
Expand All @@ -1186,57 +1181,64 @@ The `VerifierV3` class can verify your provider in a similar way to the existing

#### Request Filters

Request filters now take a request object as a parameter, and need to return the mutated one.
Request filters are simple [Express middleware functions](https://expressjs.com/en/guide/using-middleware.html):

```javascript
requestFilter: req => {
requestFilter: (req, res, next) => {
req.headers["MY_SPECIAL_HEADER"] = "my special value"

// e.g. ADD Bearer token
req.headers["authorization"] = `Bearer ${token}`

// Need to return the request back again
return req
// Need to call the next middleware in the chain
next()
},
```

#### Provider state callbacks

Provider state callbacks have been updated to support parameters and return values. The first parameter is a boolean indicating whether it is a setup call
(run before the verification) or a tear down call (run afterwards). The second optional parameter is a key-value map of any parameters defined in the
pact file. Provider state callbacks can also return a map of key-value values. These are used with provider-state injected values (see the section on that above).
Provider state callbacks have been updated to support parameters and return values.

Simple callbacks run before the verification and receive optional parameters containing any key-value parameters defined in the pact file.

The second form of callback accepts a `setup` and `teardown` function that execute on the lifecycle of the state setup. `setup` runs prior to the test, and `teardown` runs after the actual request has been sent to the provider.

Provider state callbacks can also return a map of key-value values. These are used with provider-state injected values (see the section on that above).

```javascript
stateHandlers: {
"Has no animals": setup => {
if (setup) {
animalRepository.clear()
return { description: `Animals removed to the db` }
// Simple state handler, runs before the verification
"Has no animals": () => {
return animalRepository.clear()
},
// Runs only on setup phase (no teardown)
"Has some animals": {
setup: () => {
return importData()
}
},
"Has some animals": setup => {
if (setup) {
importData()
return {
description: `Animals added to the db`,
count: animalRepository.count(),
}
// Runs only on teardown phase (no setup)
"Has a broken dependency": {
setup: () => {
// make some dependency fail...
return Promise.resolve()
},
teardown: () => {
// fix the broken dependency!
return Promise.resolve()
}
},
"Has an animal with ID": (setup, parameters) => {
if (setup) {
importData()
animalRepository.first().id = parameters.id
return {
description: `Animal with ID ${parameters.id} added to the db`,
id: parameters.id,
}
// Return provider specific IDs
"Has an animal with ID": async (parameters) => {
await importData()
animalRepository.first().id = parameters.id
return {
description: `Animal with ID ${parameters.id} added to the db`,
id: parameters.id,
}
},
```
**NOTE:** Async callbacks and returning promises from the provider state callbacks is not currently supported.
### Debugging issues with Pact-JS V3
You can change the log levels using the `LOG_LEVEL` environment variable.
Expand Down
50 changes: 21 additions & 29 deletions examples/v3/e2e/test/provider.spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,49 +20,41 @@ describe('Pact Verification', () => {
let token = 'INVALID TOKEN';

return new VerifierV3({
logLevel: 'info',
provider: 'Animal Profile Service V3',
providerBaseUrl: 'http://localhost:8081',

requestFilter: (req) => {
requestFilter: (req, res, next) => {
console.log(
'Middleware invoked before provider API - injecting Authorization token'
);

req.headers['MY_SPECIAL_HEADER'] = 'my special value';

// e.g. ADD Bearer token
req.headers['authorization'] = `Bearer ${token}`;

return req;
next();
},

stateHandlers: {
'Has no animals': (setup) => {
if (setup) {
animalRepository.clear();
return Promise.resolve({
description: `Animals removed to the db`,
});
}
'Has no animals': () => {
animalRepository.clear();
return Promise.resolve({
description: `Animals removed to the db`,
});
},
'Has some animals': (setup) => {
if (setup) {
importData();
return Promise.resolve({
description: `Animals added to the db`,
count: animalRepository.count(),
});
}
'Has some animals': () => {
importData();
return Promise.resolve({
description: `Animals added to the db`,
count: animalRepository.count(),
});
},
'Has an animal with ID': (setup, parameters) => {
if (setup) {
importData();
animalRepository.first().id = parameters.id;
return Promise.resolve({
description: `Animal with ID ${parameters.id} added to the db`,
id: parameters.id,
});
}
'Has an animal with ID': (parameters) => {
importData();
animalRepository.first().id = parameters.id;
return Promise.resolve({
description: `Animal with ID ${parameters.id} added to the db`,
id: parameters.id,
});
},
'is not authenticated': () => {
token = '';
Expand Down
31 changes: 31 additions & 0 deletions examples/v3/provider-state-injected/consumer/transaction-service.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,37 @@ module.exports = {
});
},

// same as createTransaction, but demonstrating using a PostBody
createTransactionWithPostBody: (accountId, amountInCents) => {
return axios
.post(
accountServiceUrl + '/accounts/search/findOneByAccountNumberIdInBody',
{
accountNumber: accountId,
},
{
headers: {
Accept: 'application/hal+json',
},
}
)
.then(({ data }) => {
// This is the point where a real transaction service would create the transaction, but for the purpose
// of this example we'll assume this has happened here
let id = Math.floor(Math.random() * Math.floor(100000));
return {
account: {
accountNumber: data.accountNumber.id,
accountReference: data.accountRef,
},
transaction: {
id,
amount: amountInCents,
},
};
});
},

getText: (id) => {
return axios.get(accountServiceUrl + '/data/' + id).then((data) => {
return data;
Expand Down
56 changes: 55 additions & 1 deletion examples/v3/provider-state-injected/consumer/transaction-service.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,61 @@ describe('Transaction service - create a new transaction for an account', () =>
});
});

// Uncomment when https://github.com/pact-foundation/pact-reference/issues/116 is resolved
it.skip('queries the account service for the account details using POST body', () => {
provider
.given('Account Test001 exists', { accountRef: 'Test001' })
.uponReceiving('a request to get the account details via POST')
.withRequest({
method: 'POST',
path: '/accounts/search/findOneByAccountNumberIdInBody',
body: { accountNumber: fromProviderState('${accountNumber}', 100) },
headers: {
Accept: 'application/hal+json',
'Content-Type': 'application/json; charset=utf-8',
},
})
.willRespondWith({
status: 200,
headers: { 'Content-Type': 'application/hal+json' },
body: {
id: integer(1),
version: integer(0),
name: string('Test'),
accountRef: string('Test001'),
createdDate: datetime("yyyy-MM-dd'T'HH:mm:ss.SSSX"),
lastModifiedDate: datetime("yyyy-MM-dd'T'HH:mm:ss.SSSX"),
accountNumber: {
id: fromProviderState('${accountNumber}', 100),
},
_links: {
self: {
href: url2('http://localhost:8080', [
'accounts',
regex('\\d+', '100'),
]),
},
account: {
href: url2('http://localhost:8080', [
'accounts',
regex('\\d+', '100'),
]),
},
},
},
});

return provider.executeTest(async (mockserver) => {
transactionService.setAccountServiceUrl(mockserver.url);
return transactionService
.createTransactionWithPostBody(100, 100000)
.then((result) => {
expect(result.account.accountNumber).to.equal(100);
expect(result.transaction.amount).to.equal(100000);
});
});
});

// MatchersV3.fromProviderState on body
it('test text data', () => {
provider
Expand Down Expand Up @@ -127,7 +182,6 @@ describe('Transaction service - create a new transaction for an account', () =>
return provider.executeTest(async (mockserver) => {
transactionService.setAccountServiceUrl(mockserver.url);
return transactionService.getXml(42).then((result) => {
console.log(result.data);
expect(result.data).to.equal(
`<?xml version='1.0'?><root xmlns:h='http://www.w3.org/TR/html4/'><data><h:data>random</h:data><id>42</id></data></root>`
);
Expand Down
42 changes: 42 additions & 0 deletions examples/v3/provider-state-injected/provider/account-service.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,48 @@ server.get('/accounts/search/findOneByAccountNumberId', (req, res) => {
});
});

server.post('/accounts/search/findOneByAccountNumberIdInBody', (req, res) => {
// To check and demonstrate typed responses. See https://github.com/pact-foundation/pact-reference/issues/116
if (typeof req.body.accountNumber !== 'number') {
console.log(
`accountNumber should be a number, got a ${typeof req.body.accountNumber}`
);
return res.status(400);
}

return accountRepository
.findByAccountNumber(req.body.accountNumber)
.then((account) => {
if (account) {
res.header('Content-Type', 'application/hal+json; charset=utf-8');
let baseUrl =
req.protocol + '://' + req.hostname + ':' + req.socket.localPort;
let body = {
_links: {
account: {
href: baseUrl + '/accounts/' + account.accountNumber.id,
},
self: {
href: baseUrl + '/accounts/' + account.accountNumber.id,
},
},
accountNumber: {
id: +account.accountNumber.id,
},
accountRef: account.referenceId,
createdDate: new Date(account.created).toISOString(),
id: account.id,
lastModifiedDate: new Date(account.updated).toISOString(),
name: account.name,
version: account.version,
};
res.json(body);
} else {
res.status(404).end();
}
});
});

server.get('/data/xml/:id', (req, res) => {
res.header('Content-Type', 'application/xml; charset=utf-8');
res.send(`<?xml version="1.0" encoding="UTF-8"?>
Expand Down
Loading

0 comments on commit 456567c

Please sign in to comment.