Merge pull request #66 from pact-foundation/feat/50-pactFileWriteMode

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'.
 });
 ```
 

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.spec.ts

@@ -54,6 +54,12 @@ describe("Server Spec", () => {
 					sslkey: path.resolve(__dirname, "../test/ssl/server.key")
 				})).to.throw(Error);
 			});
+
+			it("should fail if incorrect pactFileWriteMode provided", () => {
+				expect(() => serverFactory({
+					pactFileWriteMode: "notarealoption",
+				})).to.throw(Error);
+			});
 		});
 
 		context("when valid options are set", () => {

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) {
@@ -119,6 +120,9 @@ export class Server extends events.EventEmitter {
 			checkTypes.assert.string(options.provider);
 		}
 
+		// pactFileWriteMode check
+		checkTypes.assert.includes(["overwrite", "update", "merge"], options.pactFileWriteMode);
+
 		return new Server(options);
 	}
 
@@ -135,6 +139,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 +291,5 @@ export interface ServerOptions extends SpawnArguments {
 	spec?: number;
 	consumer?: string;
 	provider?: string;
+	pactFileWriteMode?: "overwrite" | "update" | "merge";
 }