feat(pactFileWriteMode): add pactFileWriteMode to server. Fixes #50

Author: mefellows

README.md

@@ -89,9 +89,11 @@ pact.verifyPacts({
 	pactBrokerUsername: <String>,        // Username for Pact Broker basic authentication. Optional.
 	pactBrokerPassword: <String>,        // Password for Pact Broker basic authentication. Optional
 	publishVerificationResult: <Boolean> // Publish verification result to Broker. Optional
-	customProviderHeaders: <Array>       // Header(s) to add to provider state set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'.
+	customProviderHeaders: <Array>       // Header(s) to add to provider state set up and pact verification 
+	requests. eg 'Authorization: Basic cGFjdDpwYWN0'.
 	providerVersion: <Boolean>           // Provider version, required to publish verification result to Broker. Optional otherwise.
 	timeout: <Number>                    // The duration in ms we should wait to confirm verification process was successful. Defaults to 30000, Optional.
+	pactFileWriteMode: <String>          // Control how the pact file is created. One of 'overwrite', 'update' or 'merge'. Defaults to 'overwrite'.
 });
 ```
 
@@ -184,6 +186,92 @@ server.on('stop', function() { console.log('stopped'); });
 server.on('delete', function() { console.log('deleted'); });
 ```
 
+<<<<<<< Updated upstream
+=======
+### Provider Verification
+
+Read more about [Verify Pacts](https://github.com/realestate-com-au/pact/wiki/Verifying-pacts).
+
+```js
+var pact = require('@pact-foundation/pact-node');
+
+pact.verifyPacts({
+	...
+});
+```
+
+**Options**:
+
+|Parameter | Required?  | Type        | Description |
+|----------|------------|-------------|-------------|
+| `providerBaseUrl` | true | string |  Running API provider host endpoint. |
+| `pactBrokerUrl` | false | string |  URL to fetch the pacts if pactUrls not supplied|
+| `provider` | false | string |  Name of the provider if fetching from a Broker|
+| `tags` | false | array |  Array of tags, used to filter pacts from the Broker|
+| `pactUrls` | false | array |  Array of local Pact file paths or HTTP-based URLs (e.g. from a broker). Required if not using a Broker. |
+| `providerStatesSetupUrl` | false | string |  URL to send PUT requests to setup a given provider state|
+| `pactBrokerUsername` | false | string |  Username for Pact Broker basic authentication|
+| `pactBrokerPassword` | false | string |  Password for Pact Broker basic authentication |
+| `publishVerificationResult` | false | boolean |  Publish verification result to Broker |
+| `customProviderHeaders` | false | array | Header(s) to add to provider state set up and pact verification `requests`. eg 'Authorization: Basic cGFjdDpwYWN0'.
+| `providerVersion` | false | boolean |  Provider version, required to publish verification result to Broker. Optional otherwise.
+| `timeout` | false | number |  The duration in ms we should wait to confirm verification process was successful. Defaults to 30000.
+
+
+### Pact Broker publishing
+
+```js
+var pact = require('@pact-foundation/pact-node');
+var opts = {
+	...
+};
+
+pact.publishPacts(opts).then(function () {
+	// do something
+});
+```
+
+**Options**:
+
+|Parameter              | Required?  | Type        | Description |
+|-----------------------|------------|-------------|-------------|
+| `pactFilesOrDirs` 	| false | array  | Array of local Pact files or directories containing them. Required. |
+| `pactBroker` 			| false | string | URL to fetch the provider states for the given provider API. Optional. |
+| `pactBrokerUsername`	| false | string | Username for Pact Broker basic authentication. Optional |
+| `pactBrokerPassword` 	| false | string | Password for Pact Broker basic authentication. Optional, |
+| `tags` 				| false | array  | An array of Strings to tag the Pacts being published. Optional |
+| `consumerVersion` 	| false | string | A string containing a semver-style version e.g. 1.0.0. Required. |
+
+
+### Stub Servers
+
+Stub servers create runnable APIs from existing pact files.
+
+The interface is comparable to the Mock Server API.
+
+#### Create Stub Server
+
+```js
+var pact = require('@pact-foundation/pact-node');
+var server = pact.createStub({
+	...
+});
+```
+**Options**:
+
+|Parameter  | Required?  | Type        | Description |
+|-----------|------------|-------------|-------------|
+| pactUrls 	| true  |  array |  List of local Pact files to create the stub service from|
+| port 		| false |  number |  Port number that the server runs on, defaults to random available port|
+| host 		| false |  string |  Host on which to bind the server on, defaults to 'localhost'. Supports '0.0.0.0' to bind on all IPv4  addresses on the local machine.|
+| log 		| false |  string |  File to log output on relative to current working directory, defaults to none|
+| ssl 		| false |  boolean |  Create a self-signed SSL cert to run the server over HTTPS , defaults to 'false'|
+| sslcert 	| false |  string |  Path to a custom self-signed SSL cert file, 'ssl' option must be set to true to use this option. Defaults false | to none|
+| sslkey 	| false |  string |  Path a custom key and self-signed SSL cert key file, 'ssl' option must be set to true to use this option false. Defaults to none|
+| cors 		| false |  boolean |  Allow CORS OPTION requests to be accepted, defaults to 'false'|
+
+
+>>>>>>> Stashed changes
 ## Contributing
 
 To develop this project, simply install the dependencies and run `npm run watch` to for continual development, linting and testing when a source file changes.

bin/pact-cli.ts

@@ -21,6 +21,7 @@ cli
 	.option("-o, --cors [boolean]", "Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses. Default is false.", cli.BOOL)
 	.option("-d, --pact-dir [directory]", "Directory to which the pacts will be written. Default is cwd.")
 	.option("-i, --pact-version [n]", "The Pact specification version to use when writing the Pact files. Default is 1.", cli.INT)
+	.option("-w, --pact-file-write-mode [m]", "Controls how pact files are written to disk. One of 'overwrite', 'update', 'merge'")
 	.option("--consumer [consumerName]", "Specify consumer name for written Pact files.")
 	.option("--provider [providerName]", "Specify provider name for written Pact files.")
 	.action((args: any, options: any) => pact.createServer(options).start());

src/server.ts

@@ -31,6 +31,7 @@ export class Server extends events.EventEmitter {
 		options.cors = options.cors || false;
 		options.dir = options.dir ? path.resolve(options.dir) : process.cwd(); // Use directory relative to cwd
 		options.host = options.host || "localhost";
+		options.pactFileWriteMode = options.pactFileWriteMode || "overwrite";
 
 		// port checking
 		if (options.port) {
@@ -135,6 +136,7 @@ export class Server extends events.EventEmitter {
 		"cors": "--cors",
 		"dir": "--pact_dir",
 		"spec": "--pact_specification_version",
+		"pactFileWriteMode": "--pact-file-write-mode",
 		"consumer": "--consumer",
 		"provider": "--provider"
 	};
@@ -286,4 +288,5 @@ export interface ServerOptions extends SpawnArguments {
 	spec?: number;
 	consumer?: string;
 	provider?: string;
+	pactFileWriteMode?: "overwrite" | "update" | "merge";
 }